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