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