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