build(deps-dev): bump @types/node
[poolifier.git] / CHANGELOG.md
... / ...
CommitLineData
1# Changelog
2
3All notable changes to this project will be documented in this file.
4
5The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
7
8## [Unreleased]
9
10## [3.1.22] - 2024-03-15
11
12### Fixed
13
14- Fix pool event emitter registered callbacks removal at `destroy()`.
15
16## [3.1.21] - 2024-02-22
17
18### Fixed
19
20- Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
21
22## [3.1.20] - 2024-02-11
23
24### Fixed
25
26- Ensure `worker_threads` workers are unreferenced at termination.
27
28## [3.1.19] - 2024-01-16
29
30### Fixed
31
32- Fix possible null exception at task finishing handling.
33
34### Changed
35
36- Optimize Deque implementation to improve tasks queueing performance.
37
38## [3.1.18] - 2024-01-06
39
40### Fixed
41
42- Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
43
44## [3.1.17] - 2024-01-05
45
46### Changed
47
48- Improve performance by clean up unneeded condition checks on hot code paths.
49
50## [3.1.16] - 2024-01-03
51
52### Fixed
53
54- Add missing type to TS type definitions.
55
56## [3.1.15] - 2024-01-02
57
58### Fixed
59
60- Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
61
62## [3.1.15-0] - 2024-01-02
63
64### Fixed
65
66- Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
67
68## [3.1.14] - 2024-01-01
69
70### Fixed
71
72- Properly handle dynamic pool with zero minimum size.
73
74## [3.1.13] - 2023-12-30
75
76### Changed
77
78- Reduce branching in several hot code paths.
79- Use faster object cloning implementation.
80
81## [3.1.12] - 2023-12-27
82
83### Fixed
84
85- Fix tasks redistribution triggers at pool destroying.
86
87### Changed
88
89- Switch TypeScript module resolution to Node16.
90
91## [3.1.12-0] - 2023-12-27
92
93### Fixed
94
95- Fix tasks redistribution triggers at pool destroying.
96
97## [3.1.11] - 2023-12-24
98
99### Fixed
100
101- Avoid worker node cross tasks stealing.
102- Ensure only half the pool worker nodes can steal tasks.
103
104## [3.1.10] - 2023-12-23
105
106### Changed
107
108- Avoid useless branching on pool type.
109
110## [3.1.9] - 2023-12-22
111
112### Changed
113
114- Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
115
116## [3.1.8] - 2023-12-21
117
118### Fixed
119
120- Fix default worker weight computation.
121- Fix possible null exception at pool destroying.
122
123## [3.1.7] - 2023-12-20
124
125### Fixed
126
127- Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
128
129## [3.1.6] - 2023-12-18
130
131### Fixed
132
133- Fix pool destroying with tasks queuing enabled.
134
135## [3.1.5] - 2023-12-18
136
137### Added
138
139- Add queued tasks end timeout support to worker node termination.
140
141## [3.1.4] - 2023-12-18
142
143### Fixed
144
145- Make more robust the fix for possible null exception at handling task execution response.
146
147## [3.1.3] - 2023-12-17
148
149### Fixed
150
151- Fix possible null exception at handling task execution response.
152
153## [3.1.2] - 2023-12-17
154
155### Fixed
156
157- Wait for queued tasks to end at worker node termination.
158
159## [3.1.1] - 2023-12-16
160
161### Fixed
162
163- Fix pool options TS type definition.
164
165## [3.1.0] - 2023-12-16
166
167### Changed
168
169- TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
170
171## [3.0.14] - 2023-12-13
172
173### Fixed
174
175- Fix possible null exception with worker_threads pools.
176
177## [3.0.13] - 2023-12-12
178
179### Fixed
180
181- Ensure worker choice strategy wait for worker nodes readiness.
182
183### Changed
184
185- Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
186
187## [3.0.12] - 2023-12-12
188
189### Changed
190
191- Add infinite retries support in worker choice strategy.
192
193## [3.0.11] - 2023-12-11
194
195### Fixed
196
197- Ensure pool asynchronous resource properly track tasks execution.
198
199## [3.0.10] - 2023-12-08
200
201### Changed
202
203- Add a fastpath when tasks stealing or redistribution is impossible.
204
205## [3.0.9] - 2023-11-26
206
207### Fixed
208
209- Remove all pool events listener at pool destroying.
210- Remove all worker node events listener at worker node destroying.
211- Fix worker node event emitter listeners handling memory leak at pool options runtime change.
212
213## [3.0.8] - 2023-11-25
214
215### Fixed
216
217- Ensure continuous tasks stealing on idle start at worker node idling.
218
219## [3.0.7] - 2023-11-24
220
221### Changed
222
223- Make continuous tasks stealing start at worker node idling.
224
225## [3.0.6] - 2023-11-24
226
227### Fixed
228
229- Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
230- Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
231
232## [3.0.5] - 2023-10-27
233
234### Fixed
235
236- Ensure pool `ready` event can be emitted only once.
237
238## [3.0.4] - 2023-10-20
239
240### Changed
241
242- Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
243- Use builtin retry mechanism in worker choice strategies instead of custom one.
244
245## [3.0.3] - 2023-10-19
246
247### Fixed
248
249- Avoid null exception at sending message to worker.
250- Avoid null exception at checking worker node readiness.
251
252## [3.0.2] - 2023-10-17
253
254### Fixed
255
256- Fix race condition at dynamic worker node task assignment and scheduled removal. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468) and [#1496](https://github.com/poolifier/poolifier/issues/1496).
257
258## [3.0.1] - 2023-10-16
259
260### Fixed
261
262- Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
263
264### Changed
265
266- Switch the worker node eventing code to `EventTarget` API.
267
268## [3.0.0] - 2023-10-08
269
270### Changed
271
272- Remove Node.js 16.x.x (EOL) support.
273
274## [2.7.5] - 2023-10-03
275
276### Changed
277
278- Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
279
280## [2.7.4] - 2023-09-25
281
282### Fixed
283
284- Fix source maps (bundler issue).
285
286## [2.7.3] - 2023-09-24
287
288### Changed
289
290- Convert pool event emitter to event emitter async resource.
291
292## [2.7.2] - 2023-09-23
293
294### Changed
295
296- Add source maps to npm package to ease debugging.
297
298### Added
299
300- Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
301
302## [2.7.1] - 2023-09-20
303
304### Fixed
305
306- Ensure worker message listener used one time are removed after usage.
307
308## [2.7.0] - 2023-09-19
309
310### Fixed
311
312- Fix task stealing related tasks queue options handling at runtime.
313
314### Changed
315
316- Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
317
318### Added
319
320- Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
321- Stricter worker constructor arguments validation.
322
323## [2.6.45] - 2023-09-17
324
325### Changed
326
327- Disable publication on GitHub packages registry on release until authentication issue is fixed.
328
329### Added
330
331- Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
332- Add `start()` method to pool API to start the minimum number of workers.
333- Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not.
334- Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
335
336## [2.6.44] - 2023-09-08
337
338### Fixed
339
340- Use a dedicated PAT to publish on GitHub packages registry.
341
342### Added
343
344- Publish on GitHub packages registry on release.
345
346### Changed
347
348- Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
349
350## [2.6.43] - 2023-09-08
351
352### Added
353
354- Publish on GitHub packages registry on release.
355
356### Changed
357
358- Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
359
360## [2.6.42] - 2023-09-06
361
362### Changed
363
364- Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
365
366## [2.6.41] - 2023-09-03
367
368### Changed
369
370- Optimize worker choice strategies implementation.
371
372## [2.6.40] - 2023-09-01
373
374### Fixed
375
376- Do not pre-choose in WRR worker choice strategy to avoid bias.
377- Avoid array out of bound in worker choice strategies after worker node removal.
378
379## [2.6.39] - 2023-08-30
380
381### Fixed
382
383- Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
384
385## [2.6.38] - 2023-08-30
386
387### Added
388
389- Bundle typescript types declaration into one file.
390
391### Changed
392
393- Improve interleaved weighted round robin worker choice strategy implementation.
394
395## [2.6.37] - 2023-08-28
396
397### Fixed
398
399- Ensure unused worker usage statistics are deleted at runtime.
400
401### Changed
402
403- Rename worker choice strategy options `choiceRetries` to `retries`.
404- Avoid unnecessary branching in worker choice strategies.
405
406## [2.6.36] - 2023-08-27
407
408### Fixed
409
410- Fix pool `execute()` arguments check.
411
412### Changed
413
414- Make continuous tasks stealing algorithm less aggressive.
415- Fine tune tasks stealing algorithm under back pressure.
416
417## [2.6.35] - 2023-08-25
418
419### Fixed
420
421- Don't account worker usage statistics for tasks that have failed.
422- Fix pool information runtime and wait time median computation.
423
424### Changed
425
426- Update simple moving average implementation to use a circular buffer.
427- Update simple moving median implementation to use a circular buffer.
428- Account for stolen tasks in worker usage statistics and pool information.
429
430### Added
431
432- Continuous tasks stealing algorithm.
433
434## [2.6.34] - 2023-08-24
435
436### Fixes
437
438- Avoid cascading tasks stealing under back pressure.
439
440### Changed
441
442- Add fastpath to queued tasks rescheduling.
443
444## [2.6.33] - 2023-08-24
445
446### Fixed
447
448- Fix queued tasks rescheduling.
449
450### Changed
451
452- Rename tasks queue options `queueMaxSize` to `size`.
453
454### Added
455
456- Task stealing scheduling algorithm if tasks queueing is enabled.
457
458## [2.6.32] - 2023-08-23
459
460### Fixed
461
462- Ensure no task can be executed when the pool is destroyed.
463
464### Added
465
466- Add `queueMaxSize` option to tasks queue options.
467- Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
468- Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
469
470## [2.6.31] - 2023-08-20
471
472### Fixed
473
474- Fix worker choice strategy retries mechanism in some edge cases.
475
476### Changed
477
478- Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
479- Remove the experimental status of the `LEAST_ELU` worker choice strategy.
480
481## [2.6.30] - 2023-08-19
482
483### Fixed
484
485- Ensure pool event `backPressure` is emitted.
486- Ensure pool event `full` is emitted only once.
487- Ensure worker node cannot be instantiated without proper arguments.
488
489## [2.6.29] - 2023-08-18
490
491### Fixed
492
493- Fix race condition between readiness and task functions worker message handling at startup.
494- Fix duplicate task function worker usage statistics computation per task function.
495- Update task function worker usage statistics if and only if there's at least two different task functions.
496- Fix race condition at task function worker usage executing task computation leading to negative value.
497
498### Added
499
500- Add back pressure detection on the worker node queue. Event `backPressure` is emitted when all worker node queues are full (worker node queue size >= poolMaxSize^2).
501- Use back pressure detection in worker choice strategies.
502- Add worker choice strategies retries mechanism if no worker is eligible.
503
504## [2.6.28] - 2023-08-16
505
506### Fixed
507
508- Ensure pool workers are properly initialized.
509
510### Added
511
512- HTTP server pool examples: express-cluster, express-hybrid.
513
514### Changed
515
516- Remove now useless branching in worker hot code path.
517
518## [2.6.27] - 2023-08-15
519
520### Fixed
521
522- Add `KillHandler` type definition to exported types.
523
524### Added
525
526- Add `destroy` event to pool API.
527
528## [2.6.26] - 2023-08-15
529
530### Added
531
532- Add kill handler to worker options allowing to execute custom code when worker is killed.
533- Add `listTaskFunctions()` method to pool API.
534- SMTP client pool example: nodemailer.
535
536## [2.6.25] - 2023-08-13
537
538### Added
539
540- HTTP server pool examples: fastify-cluster, fastify-hybrid.
541- WebSocket server pool examples: ws-cluster, ws-hybrid.
542
543## [2.6.24] - 2023-08-12
544
545### Added
546
547- Add array of transferable objects to the `execute()` method arguments.
548- WebSocket server pool examples: ws-worker_threads.
549
550## [2.6.23] - 2023-08-11
551
552### Fixed
553
554- Fix pool busyness semantic when tasks queueing is enabled: the pool is busy when the number of executing tasks on each worker has reached the maximum tasks concurrency per worker.
555
556### Added
557
558- HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
559- HTTP server pool examples: express-worker_threads, fastify-worker_threads.
560
561## [2.6.22] - 2023-08-10
562
563### Fixed
564
565- Add missing `types` field to package.json `exports`.
566
567### Changed
568
569- Structure markdown documentation (PR #811).
570
571## [2.6.21] - 2023-08-03
572
573### Changed
574
575- Improve code documentation.
576- Code refactoring and cleanup for better maintainability and readability.
577
578## [2.6.20] - 2023-07-21
579
580### Fixed
581
582- Fix queued tasks redistribution on error task execution starvation.
583- Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
584
585### Changed
586
587- Drastically reduce lookups by worker in the worker nodes.
588
589## [2.6.19] - 2023-07-20
590
591### Added
592
593- Dedicated internal communication channel for worker_threads pools.
594
595## [2.6.18] - 2023-07-19
596
597### Changed
598
599- Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
600
601## [2.6.17] - 2023-07-16
602
603### Added
604
605- Add `listTaskFunctions()` method to worker API.
606
607## [2.6.16] - 2023-07-12
608
609### Fixed
610
611- Fix pool startup detection.
612- Fix worker task functions handling.
613
614## [2.6.15] - 2023-07-11
615
616### Added
617
618- Take into account worker node readiness in worker choice strategies.
619
620## [2.6.14] - 2023-07-10
621
622### Fixed
623
624- Fix task function statistics tracking.
625
626## [2.6.13] - 2023-07-10
627
628### Added
629
630- Add per task function statistics tracking.
631- Add public methods to manipulate the worker task functions at runtime.
632
633## [2.6.12] - 2023-07-09
634
635### Fixed
636
637- Workaround import issue with `node:os` module in node 16.x.x.
638
639## [2.6.11] - 2023-07-09
640
641### Fixed
642
643- Fix pool readiness semantic.
644
645## [2.6.10] - 2023-07-08
646
647### Fixed
648
649- Ensure workers are not recreated on error at pool startup.
650
651### Added
652
653- Add `ready` and `strategy` fields to pool information.
654- Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
655- Add dynamic pool sizing checks.
656
657## [2.6.9] - 2023-07-07
658
659### Fixed
660
661- Recreate the right worker type on uncaught exception.
662
663### Added
664
665- Add minimum and maximum to internal measurement statistics.
666- Add `runTime` and `waitTime` to pool information.
667- Check worker inactive time only on dynamic worker.
668
669## [2.6.8] - 2023-07-03
670
671### Fixed
672
673- Brown paper bag release to fix version handling in pool information.
674
675## [2.6.7] - 2023-07-03
676
677### Fixed
678
679- Ensure worker queued tasks at error are reassigned to other pool workers.
680
681### Added
682
683- Add pool `utilization` ratio to pool information.
684- Add `version` to pool information.
685- Add worker information to worker nodes.
686
687## [2.6.6] - 2023-07-01
688
689### Added
690
691- Add safe helper `availableParallelism()` to help sizing the pool.
692
693### Fixed
694
695- Ensure message handler is only registered in worker.
696
697## [2.6.5] - 2023-06-27
698
699### Known issues
700
701- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
702
703### Fixed
704
705- Artificial version bump to 2.6.5 to workaround publication issue.
706- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
707- Ensure pool event is emitted before task error promise rejection.
708- Fix queued tasks count computation.
709
710### Removed
711
712- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
713
714## [2.6.4] - 2023-06-27
715
716### Known issues
717
718- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
719
720### Fixed
721
722- Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
723- Ensure pool event is emitted before task error promise rejection.
724- Fix queued tasks count computation.
725
726### Removed
727
728- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
729
730## [2.6.3] - 2023-06-19
731
732### Fixed
733
734- Ensure no tasks are queued when trying to soft kill a dynamic worker.
735- Update strategies internals after statistics computation.
736
737### Changed
738
739- Optimize O(1) queue implementation.
740
741## [2.6.2] - 2023-06-12
742
743### Fixed
744
745- Fix new worker use after creation in dynamic pool given the current worker choice strategy.
746
747## [2.6.1] - 2023-06-10
748
749### Added
750
751- Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
752
753### Fixed
754
755- Fix average statistics computation: ensure failed tasks are not accounted.
756
757## [2.6.0] - 2023-06-09
758
759### Added
760
761- Add `LEAST_ELU` worker choice strategy (experimental).
762- Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
763
764### Changed
765
766- Refactor pool worker node usage internals.
767- Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
768- Breaking change: pool information `info` property object fields have been renamed.
769
770### Fixed
771
772- Fix wait time accounting.
773- Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
774- Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
775
776## [2.5.4] - 2023-06-07
777
778### Added
779
780- Add Event Loop Utilization (ELU) statistics to worker tasks usage.
781
782### Changed
783
784- Compute statistics at the worker level only if needed.
785- Add `worker_threads` options to thread pool options.
786
787### Fixed
788
789- Make the `LEAST_BUSY` strategy only relies on task runtime.
790
791## [2.5.3] - 2023-06-04
792
793### Changed
794
795- Refine pool information content.
796- Limit pool internals public exposure.
797
798## [2.5.2] - 2023-06-02
799
800### Added
801
802- Add `taskError` pool event for task execution error.
803- Add pool information `info` property to pool.
804- Emit pool information on `busy` and `full` pool events.
805
806## [2.5.1] - 2023-06-01
807
808### Added
809
810- Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
811- Add `error` pool event for uncaught worker error.
812
813## [2.5.0] - 2023-05-31
814
815### Added
816
817- Switch pool event emitter to `EventEmitterAsyncResource`.
818- Add tasks wait time accounting in per worker tasks usage.
819- Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
820
821### Changed
822
823- Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
824
825## [2.4.14] - 2023-05-09
826
827### Fixed
828
829- Ensure no undefined task runtime can land in the tasks history.
830- Fix median computation implementation once again.
831
832### Added
833
834- Unit tests for median and queue implementations.
835
836## [2.4.13] - 2023-05-08
837
838### Fixed
839
840- Fix worker choice strategy options validation.
841- Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
842
843## [2.4.12] - 2023-05-06
844
845### Added
846
847- Support multiple task functions per worker.
848- Add custom worker weights support to worker choice strategies options.
849
850### Changed
851
852- Use O(1) queue implementation for tasks queueing.
853
854### Fixed
855
856- Fix median computation implementation.
857- Fix fair share worker choice strategy internals update.
858
859## [2.4.11] - 2023-04-23
860
861### Changed
862
863- Optimize free worker finding in worker choice strategies.
864
865## [2.4.10] - 2023-04-15
866
867### Fixed
868
869- Fix typescript type definition for task function: ensure the input data is optional.
870- Fix typescript type definition for pool execute(): ensure the input data is optional.
871
872## [2.4.9] - 2023-04-15
873
874### Added
875
876- Add tasks queue enablement runtime setter to pool.
877- Add tasks queue options runtime setter to pool.
878- Add worker choice strategy options runtime setter to pool.
879
880### Changed
881
882- Remove the tasks queuing experimental status.
883
884### Fixed
885
886- Fix task function type definition and validation.
887- Fix worker choice strategy options handling.
888
889## [2.4.8] - 2023-04-12
890
891### Fixed
892
893- Fix message between main worker and worker type definition for tasks.
894- Fix code documentation.
895
896## [2.4.7] - 2023-04-11
897
898### Added
899
900- Add worker tasks queue options to pool options.
901
902### Fixed
903
904- Fix missing documentation.
905
906## [2.4.6] - 2023-04-10
907
908### Fixed
909
910- Ensure one task at a time is executed per worker with tasks queueing enabled.
911- Properly count worker executing tasks with tasks queueing enabled.
912
913## [2.4.5] - 2023-04-09
914
915### Added
916
917- Use monotonic high resolution timer for worker tasks runtime.
918- Add worker tasks median runtime to statistics.
919- Add worker tasks queue (experimental).
920
921## [2.4.4] - 2023-04-07
922
923### Added
924
925- Add `PoolEvents` enumeration and `PoolEvent` type.
926
927### Fixed
928
929- Destroy worker only on alive check.
930
931## [2.4.3] - 2023-04-07
932
933### Fixed
934
935- Fix typedoc generation with inheritance.
936
937## [2.4.2] - 2023-04-06
938
939### Added
940
941- Add `full` event to dynamic pool.
942- Keep worker choice strategy in memory for conditional reuse.
943
944### Fixed
945
946- Fix possible negative worker key at worker removal in worker choice strategies.
947
948## [2.4.1] - 2023-04-05
949
950### Changed
951
952- Optimize worker choice strategy for dynamic pool.
953
954### Fixed
955
956- Ensure dynamic pool does not alter worker choice strategy expected behavior.
957
958## [2.4.0] - 2023-04-04
959
960### Added
961
962- Add `LESS_BUSY` worker choice strategy.
963
964### Changed
965
966- Optimize worker storage in pool.
967- Optimize worker alive status check.
968- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
969- Optimize `LESS_USED` worker choice strategy.
970- Update benchmark versus external threads pools.
971- Optimize tasks usage statistics requirements for worker choice strategy.
972
973### Fixed
974
975- Ensure trimmable characters are checked at pool initialization.
976- Fix message id integer overflow.
977- Fix pool worker removal in worker choice strategy internals.
978- Fix package publication with pnpm.
979
980## [2.4.0-3] - 2023-04-04
981
982### Added
983
984- Add `LESS_BUSY` worker choice strategy.
985
986### Changed
987
988- Optimize worker storage in pool.
989- Optimize worker alive status check.
990- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
991- Optimize `LESS_USED` worker choice strategy.
992- Update benchmark versus external threads pools.
993
994### Fixed
995
996- Ensure trimmable characters are checked at pool initialization.
997- Fix message id integer overflow.
998- Fix pool worker removal in worker choice strategy internals.
999- Fix package publication with pnpm.
1000
1001## [2.4.0-2] - 2023-04-03
1002
1003### Added
1004
1005- Add `LESS_BUSY` worker choice strategy.
1006
1007### Changed
1008
1009- Optimize worker storage in pool.
1010- Optimize worker alive status check.
1011- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1012- Optimize `LESS_USED` worker choice strategy.
1013
1014### Fixed
1015
1016- Ensure trimmable characters are checked at pool initialization.
1017- Fix message id integer overflow.
1018- Fix pool worker removal in worker choice strategy internals.
1019- Fix package publication with pnpm.
1020
1021## [2.4.0-1] - 2023-04-03
1022
1023### Added
1024
1025- Add `LESS_BUSY` worker choice strategy.
1026
1027### Changed
1028
1029- Optimize worker storage in pool.
1030- Optimize worker alive status check.
1031- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1032- Optimize `LESS_USED` worker choice strategy.
1033
1034### Fixed
1035
1036- Ensure trimmable characters are checked at pool initialization.
1037- Fix message id integer overflow.
1038- Fix pool worker removal in worker choice strategy internals.
1039
1040## [2.4.0-0] - 2023-04-03
1041
1042### Added
1043
1044- Add `LESS_BUSY` worker choice strategy.
1045
1046### Changed
1047
1048- Optimize worker storage in pool.
1049- Optimize worker alive status check.
1050- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1051- Optimize `LESS_USED` worker choice strategy.
1052
1053### Fixed
1054
1055- Ensure trimmable characters are checked at pool initialization.
1056- Fix message id integer overflow.
1057- Fix pool worker removal in worker choice strategy internals.
1058
1059## [2.3.10] - 2023-03-18
1060
1061### Fixed
1062
1063- Fix package.json `exports` syntax for ESM and CommonJS.
1064
1065### Changed
1066
1067- Permit SemVer pre-release publication.
1068
1069## [2.3.10-2] - 2023-03-18
1070
1071### Fixed
1072
1073- Fix package.json `exports` syntax for ESM and CommonJS.
1074
1075## [2.3.10-1] - 2023-03-18
1076
1077### Changed
1078
1079- Permit SemVer pre-release publication.
1080
1081## [2.3.10-0] - 2023-03-18
1082
1083### Fixed
1084
1085- Fix package.json `exports` syntax for ESM and CommonJS.
1086
1087## [2.3.9] - 2023-03-18
1088
1089### Changed
1090
1091- Introduce ESM module support along with CommonJS one.
1092
1093### Fixed
1094
1095- Fix brown paper bag bug referencing the same object literal.
1096
1097## [2.3.8] - 2023-03-18
1098
1099### Changed
1100
1101- Switch internal benchmarking code to benny.
1102- Switch to TypeScript 5.x.x.
1103- Switch rollup bundler plugins to core ones.
1104- Switch to TSDoc syntax.
1105- Enforce conventional commits.
1106
1107### Fixed
1108
1109- Fix random integer generator.
1110- Fix worker choice strategy pool type identification at initialization.
1111
1112## [2.3.7] - 2022-10-23
1113
1114### Changed
1115
1116- Switch to open collective FOSS project funding platform.
1117- Switch to ts-standard linter configuration on TypeScript code.
1118
1119### Fixed
1120
1121- Fixed missing async on pool execute method.
1122- Fixed typing in TypeScript example.
1123- Fixed types in unit tests.
1124
1125## [2.3.6] - 2022-10-22
1126
1127### Changed
1128
1129- Cleanup pool attributes and methods.
1130- Refine error types thrown.
1131
1132### Fixed
1133
1134- Fix continuous integration build on windows.
1135- Fix code coverage reporting by using c8 instead of nyc.
1136
1137## [2.3.5] - 2022-10-21
1138
1139### Changed
1140
1141- Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1142- Optimize tasks usage lookup implementation.
1143
1144### Fixed
1145
1146- Fix missed pool event emitter type export.
1147- Fix typedoc documentation generation.
1148
1149## [2.3.4] - 2022-10-17
1150
1151### Added
1152
1153- Fully automate release process with release-it.
1154
1155### Changed
1156
1157- Optimize fair share task scheduling algorithm implementation.
1158- Update benchmark versus external pools results with latest version.
1159
1160## [2.3.3] - 2022-10-15
1161
1162### Added
1163
1164- Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1165
1166## [2.3.2] - 2022-10-14
1167
1168### Changed
1169
1170- Optimize fair share worker selection strategy implementation.
1171
1172### Fixed
1173
1174- Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1175
1176## [2.3.1] - 2022-10-13
1177
1178### Added
1179
1180- Pool worker choice strategies:
1181 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1182 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1183
1184## [2.2.2] - 2022-10-09
1185
1186### Fixed
1187
1188- Fixed `README.md` file.
1189
1190## [2.2.1] - 2022-10-08
1191
1192### Added
1193
1194- Dynamic worker choice strategy change at runtime.
1195
1196## [2.2.0] - 2022-01-05
1197
1198### Breaking Changes
1199
1200- Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1201
1202## [2.1.0] - 2021-08-29
1203
1204### Added
1205
1206- Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1207
1208### Breaking Changes
1209
1210- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1211- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1212- `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1213- `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1214
1215## [2.0.2] - 2021-05-12
1216
1217### Bug fixes
1218
1219- Fix `busy` event emission on fixed pool type
1220
1221## [2.0.1] - 2021-03-16
1222
1223### Bug fixes
1224
1225- Check if pool options are properly set.
1226- `busy` event is emitted on all pool types.
1227
1228## [2.0.0] - 2021-03-01
1229
1230### Bug fixes
1231
1232- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1233
1234### Breaking Changes
1235
1236- `FullPool` event is now renamed to `busy`.
1237- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1238 _Find more details on our JSDoc._
1239
1240- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1241
1242- We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1243
1244### Pool options types declaration merge
1245
1246`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1247
1248#### New `export` strategy
1249
1250```js
1251// Before
1252const DynamicThreadPool = require('poolifier/lib/dynamic')
1253// After
1254const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1255```
1256
1257But you should always prefer just using
1258
1259```js
1260const { DynamicThreadPool } = require('poolifier')
1261```
1262
1263#### New type definitions for input data and response
1264
1265For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1266_This is not a limitation by poolifier but Node.js._
1267
1268#### Public property replacements
1269
1270`numWorkers` property is now `numberOfWorkers`
1271
1272#### Internal (protected) properties and methods renaming
1273
1274These properties are not intended for end users
1275
1276- `id` => `nextMessageId`
1277
1278These methods are not intended for end users
1279
1280- `_chooseWorker` => `chooseWorker`
1281- `_newWorker` => `createWorker`
1282- `_execute` => `internalExecute`
1283- `_chooseWorker` => `chooseWorker`
1284- `_checkAlive` => `checkAlive`
1285- `_run` => `run`
1286- `_runAsync` => `runAsync`
1287
1288## [1.1.0] - 2020-05-21
1289
1290### Added
1291
1292- ThreadWorker support async functions as option
1293- Various external library patches
1294
1295## [1.0.0] - 2020-01-24
1296
1297### Added
1298
1299- FixedThreadPool implementation
1300- DynamicThreadPool implementation
1301- WorkerThread implementation to improve developer experience