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