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