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