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