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