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