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