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