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