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