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