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