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