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