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