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