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