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