3 All notable changes to this project will be documented in this file.
5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
12 - BREAKING CHANGE: `listTaskFunctionNames()` to `listTaskFunctionsProperties()` in pool and worker API returning registered task functions properties.
14 ## [3.1.30] - 2024-04-22
18 - Fix `transferList` argument type definition.
20 ## [3.1.29] - 2024-04-02
24 - Fix possible race condition at worker node recreation on worker `error` and `exit` events.
26 ## [3.1.28] - 2024-04-01
30 - Ensure the minimum number of workers on a started pool is guaranteed.
32 ## [3.1.27] - 2024-03-27
36 - Fix publishing on JSR, take 4.
38 ## [3.1.26] - 2024-03-27
42 - Fix publishing on JSR, take 3.
44 ## [3.1.25] - 2024-03-27
48 - Fix publishing on JSR, take 2.
50 ## [3.1.24] - 2024-03-27
54 - Fix publishing on JSR.
56 ## [3.1.23] - 2024-03-27
62 ## [3.1.22] - 2024-03-15
66 - Fix pool event emitter registered callbacks removal at `destroy()`.
68 ## [3.1.21] - 2024-02-22
72 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
74 ## [3.1.20] - 2024-02-11
78 - Ensure `worker_threads` workers are unreferenced at termination.
80 ## [3.1.19] - 2024-01-16
84 - Fix possible null exception at task finishing handling.
88 - Optimize Deque implementation to improve tasks queueing performance.
90 ## [3.1.18] - 2024-01-06
94 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
96 ## [3.1.17] - 2024-01-05
100 - Improve performance by clean up unneeded condition checks on hot code paths.
102 ## [3.1.16] - 2024-01-03
106 - Add missing type to TS type definitions.
108 ## [3.1.15] - 2024-01-02
112 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
114 ## [3.1.15-0] - 2024-01-02
118 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
120 ## [3.1.14] - 2024-01-01
124 - Properly handle dynamic pool with zero minimum size.
126 ## [3.1.13] - 2023-12-30
130 - Reduce branching in several hot code paths.
131 - Use faster object cloning implementation.
133 ## [3.1.12] - 2023-12-27
137 - Fix tasks redistribution triggers at pool destroying.
141 - Switch TypeScript module resolution to Node16.
143 ## [3.1.12-0] - 2023-12-27
147 - Fix tasks redistribution triggers at pool destroying.
149 ## [3.1.11] - 2023-12-24
153 - Avoid worker node cross tasks stealing.
154 - Ensure only half the pool worker nodes can steal tasks.
156 ## [3.1.10] - 2023-12-23
160 - Avoid useless branching on pool type.
162 ## [3.1.9] - 2023-12-22
166 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
168 ## [3.1.8] - 2023-12-21
172 - Fix default worker weight computation.
173 - Fix possible null exception at pool destroying.
175 ## [3.1.7] - 2023-12-20
179 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
181 ## [3.1.6] - 2023-12-18
185 - Fix pool destroying with tasks queuing enabled.
187 ## [3.1.5] - 2023-12-18
191 - Add queued tasks end timeout support to worker node termination.
193 ## [3.1.4] - 2023-12-18
197 - Make more robust the fix for possible null exception at handling task execution response.
199 ## [3.1.3] - 2023-12-17
203 - Fix possible null exception at handling task execution response.
205 ## [3.1.2] - 2023-12-17
209 - Wait for queued tasks to end at worker node termination.
211 ## [3.1.1] - 2023-12-16
215 - Fix pool options TS type definition.
217 ## [3.1.0] - 2023-12-16
221 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
223 ## [3.0.14] - 2023-12-13
227 - Fix possible null exception with worker_threads pools.
229 ## [3.0.13] - 2023-12-12
233 - Ensure worker choice strategy wait for worker nodes readiness.
237 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
239 ## [3.0.12] - 2023-12-12
243 - Add infinite retries support in worker choice strategy.
245 ## [3.0.11] - 2023-12-11
249 - Ensure pool asynchronous resource properly track tasks execution.
251 ## [3.0.10] - 2023-12-08
255 - Add a fastpath when tasks stealing or redistribution is impossible.
257 ## [3.0.9] - 2023-11-26
261 - Remove all pool events listener at pool destroying.
262 - Remove all worker node events listener at worker node destroying.
263 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
265 ## [3.0.8] - 2023-11-25
269 - Ensure continuous tasks stealing on idle start at worker node idling.
271 ## [3.0.7] - 2023-11-24
275 - Make continuous tasks stealing start at worker node idling.
277 ## [3.0.6] - 2023-11-24
281 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
282 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
284 ## [3.0.5] - 2023-10-27
288 - Ensure pool `ready` event can be emitted only once.
290 ## [3.0.4] - 2023-10-20
294 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
295 - Use builtin retry mechanism in worker choice strategies instead of custom one.
297 ## [3.0.3] - 2023-10-19
301 - Avoid null exception at sending message to worker.
302 - Avoid null exception at checking worker node readiness.
304 ## [3.0.2] - 2023-10-17
308 - 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).
310 ## [3.0.1] - 2023-10-16
314 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
318 - Switch the worker node eventing code to `EventTarget` API.
320 ## [3.0.0] - 2023-10-08
324 - Remove Node.js 16.x.x (EOL) support.
326 ## [2.7.5] - 2023-10-03
330 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
332 ## [2.7.4] - 2023-09-25
336 - Fix source maps (bundler issue).
338 ## [2.7.3] - 2023-09-24
342 - Convert pool event emitter to event emitter async resource.
344 ## [2.7.2] - 2023-09-23
348 - Add source maps to npm package to ease debugging.
352 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
354 ## [2.7.1] - 2023-09-20
358 - Ensure worker message listener used one time are removed after usage.
360 ## [2.7.0] - 2023-09-19
364 - Fix task stealing related tasks queue options handling at runtime.
368 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
372 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
373 - Stricter worker constructor arguments validation.
375 ## [2.6.45] - 2023-09-17
379 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
383 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
384 - Add `start()` method to pool API to start the minimum number of workers.
385 - 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.
386 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
388 ## [2.6.44] - 2023-09-08
392 - Use a dedicated PAT to publish on GitHub packages registry.
396 - Publish on GitHub packages registry on release.
400 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
402 ## [2.6.43] - 2023-09-08
406 - Publish on GitHub packages registry on release.
410 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
412 ## [2.6.42] - 2023-09-06
416 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
418 ## [2.6.41] - 2023-09-03
422 - Optimize worker choice strategies implementation.
424 ## [2.6.40] - 2023-09-01
428 - Do not pre-choose in WRR worker choice strategy to avoid bias.
429 - Avoid array out of bound in worker choice strategies after worker node removal.
431 ## [2.6.39] - 2023-08-30
435 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
437 ## [2.6.38] - 2023-08-30
441 - Bundle typescript types declaration into one file.
445 - Improve interleaved weighted round robin worker choice strategy implementation.
447 ## [2.6.37] - 2023-08-28
451 - Ensure unused worker usage statistics are deleted at runtime.
455 - Rename worker choice strategy options `choiceRetries` to `retries`.
456 - Avoid unnecessary branching in worker choice strategies.
458 ## [2.6.36] - 2023-08-27
462 - Fix pool `execute()` arguments check.
466 - Make continuous tasks stealing algorithm less aggressive.
467 - Fine tune tasks stealing algorithm under back pressure.
469 ## [2.6.35] - 2023-08-25
473 - Don't account worker usage statistics for tasks that have failed.
474 - Fix pool information runtime and wait time median computation.
478 - Update simple moving average implementation to use a circular buffer.
479 - Update simple moving median implementation to use a circular buffer.
480 - Account for stolen tasks in worker usage statistics and pool information.
484 - Continuous tasks stealing algorithm.
486 ## [2.6.34] - 2023-08-24
490 - Avoid cascading tasks stealing under back pressure.
494 - Add fastpath to queued tasks rescheduling.
496 ## [2.6.33] - 2023-08-24
500 - Fix queued tasks rescheduling.
504 - Rename tasks queue options `queueMaxSize` to `size`.
508 - Task stealing scheduling algorithm if tasks queueing is enabled.
510 ## [2.6.32] - 2023-08-23
514 - Ensure no task can be executed when the pool is destroyed.
518 - Add `queueMaxSize` option to tasks queue options.
519 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
520 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
522 ## [2.6.31] - 2023-08-20
526 - Fix worker choice strategy retries mechanism in some edge cases.
530 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
531 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
533 ## [2.6.30] - 2023-08-19
537 - Ensure pool event `backPressure` is emitted.
538 - Ensure pool event `full` is emitted only once.
539 - Ensure worker node cannot be instantiated without proper arguments.
541 ## [2.6.29] - 2023-08-18
545 - Fix race condition between readiness and task functions worker message handling at startup.
546 - Fix duplicate task function worker usage statistics computation per task function.
547 - Update task function worker usage statistics if and only if there's at least two different task functions.
548 - Fix race condition at task function worker usage executing task computation leading to negative value.
552 - 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).
553 - Use back pressure detection in worker choice strategies.
554 - Add worker choice strategies retries mechanism if no worker is eligible.
556 ## [2.6.28] - 2023-08-16
560 - Ensure pool workers are properly initialized.
564 - HTTP server pool examples: express-cluster, express-hybrid.
568 - Remove now useless branching in worker hot code path.
570 ## [2.6.27] - 2023-08-15
574 - Add `KillHandler` type definition to exported types.
578 - Add `destroy` event to pool API.
580 ## [2.6.26] - 2023-08-15
584 - Add kill handler to worker options allowing to execute custom code when worker is killed.
585 - Add `listTaskFunctions()` method to pool API.
586 - SMTP client pool example: nodemailer.
588 ## [2.6.25] - 2023-08-13
592 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
593 - WebSocket server pool examples: ws-cluster, ws-hybrid.
595 ## [2.6.24] - 2023-08-12
599 - Add array of transferable objects to the `execute()` method arguments.
600 - WebSocket server pool examples: ws-worker_threads.
602 ## [2.6.23] - 2023-08-11
606 - 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.
610 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
611 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
613 ## [2.6.22] - 2023-08-10
617 - Add missing `types` field to package.json `exports`.
621 - Structure markdown documentation (PR #811).
623 ## [2.6.21] - 2023-08-03
627 - Improve code documentation.
628 - Code refactoring and cleanup for better maintainability and readability.
630 ## [2.6.20] - 2023-07-21
634 - Fix queued tasks redistribution on error task execution starvation.
635 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
639 - Drastically reduce lookups by worker in the worker nodes.
641 ## [2.6.19] - 2023-07-20
645 - Dedicated internal communication channel for worker_threads pools.
647 ## [2.6.18] - 2023-07-19
651 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
653 ## [2.6.17] - 2023-07-16
657 - Add `listTaskFunctions()` method to worker API.
659 ## [2.6.16] - 2023-07-12
663 - Fix pool startup detection.
664 - Fix worker task functions handling.
666 ## [2.6.15] - 2023-07-11
670 - Take into account worker node readiness in worker choice strategies.
672 ## [2.6.14] - 2023-07-10
676 - Fix task function statistics tracking.
678 ## [2.6.13] - 2023-07-10
682 - Add per task function statistics tracking.
683 - Add public methods to manipulate the worker task functions at runtime.
685 ## [2.6.12] - 2023-07-09
689 - Workaround import issue with `node:os` module in node 16.x.x.
691 ## [2.6.11] - 2023-07-09
695 - Fix pool readiness semantic.
697 ## [2.6.10] - 2023-07-08
701 - Ensure workers are not recreated on error at pool startup.
705 - Add `ready` and `strategy` fields to pool information.
706 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
707 - Add dynamic pool sizing checks.
709 ## [2.6.9] - 2023-07-07
713 - Recreate the right worker type on uncaught exception.
717 - Add minimum and maximum to internal measurement statistics.
718 - Add `runTime` and `waitTime` to pool information.
719 - Check worker inactive time only on dynamic worker.
721 ## [2.6.8] - 2023-07-03
725 - Brown paper bag release to fix version handling in pool information.
727 ## [2.6.7] - 2023-07-03
731 - Ensure worker queued tasks at error are reassigned to other pool workers.
735 - Add pool `utilization` ratio to pool information.
736 - Add `version` to pool information.
737 - Add worker information to worker nodes.
739 ## [2.6.6] - 2023-07-01
743 - Add safe helper `availableParallelism()` to help sizing the pool.
747 - Ensure message handler is only registered in worker.
749 ## [2.6.5] - 2023-06-27
753 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
757 - Artificial version bump to 2.6.5 to workaround publication issue.
758 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
759 - Ensure pool event is emitted before task error promise rejection.
760 - Fix queued tasks count computation.
764 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
766 ## [2.6.4] - 2023-06-27
770 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
774 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
775 - Ensure pool event is emitted before task error promise rejection.
776 - Fix queued tasks count computation.
780 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
782 ## [2.6.3] - 2023-06-19
786 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
787 - Update strategies internals after statistics computation.
791 - Optimize O(1) queue implementation.
793 ## [2.6.2] - 2023-06-12
797 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
799 ## [2.6.1] - 2023-06-10
803 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
807 - Fix average statistics computation: ensure failed tasks are not accounted.
809 ## [2.6.0] - 2023-06-09
813 - Add `LEAST_ELU` worker choice strategy (experimental).
814 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
818 - Refactor pool worker node usage internals.
819 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
820 - Breaking change: pool information `info` property object fields have been renamed.
824 - Fix wait time accounting.
825 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
826 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
828 ## [2.5.4] - 2023-06-07
832 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
836 - Compute statistics at the worker level only if needed.
837 - Add `worker_threads` options to thread pool options.
841 - Make the `LEAST_BUSY` strategy only relies on task runtime.
843 ## [2.5.3] - 2023-06-04
847 - Refine pool information content.
848 - Limit pool internals public exposure.
850 ## [2.5.2] - 2023-06-02
854 - Add `taskError` pool event for task execution error.
855 - Add pool information `info` property to pool.
856 - Emit pool information on `busy` and `full` pool events.
858 ## [2.5.1] - 2023-06-01
862 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
863 - Add `error` pool event for uncaught worker error.
865 ## [2.5.0] - 2023-05-31
869 - Switch pool event emitter to `EventEmitterAsyncResource`.
870 - Add tasks wait time accounting in per worker tasks usage.
871 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
875 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
877 ## [2.4.14] - 2023-05-09
881 - Ensure no undefined task runtime can land in the tasks history.
882 - Fix median computation implementation once again.
886 - Unit tests for median and queue implementations.
888 ## [2.4.13] - 2023-05-08
892 - Fix worker choice strategy options validation.
893 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
895 ## [2.4.12] - 2023-05-06
899 - Support multiple task functions per worker.
900 - Add custom worker weights support to worker choice strategies options.
904 - Use O(1) queue implementation for tasks queueing.
908 - Fix median computation implementation.
909 - Fix fair share worker choice strategy internals update.
911 ## [2.4.11] - 2023-04-23
915 - Optimize free worker finding in worker choice strategies.
917 ## [2.4.10] - 2023-04-15
921 - Fix typescript type definition for task function: ensure the input data is optional.
922 - Fix typescript type definition for pool execute(): ensure the input data is optional.
924 ## [2.4.9] - 2023-04-15
928 - Add tasks queue enablement runtime setter to pool.
929 - Add tasks queue options runtime setter to pool.
930 - Add worker choice strategy options runtime setter to pool.
934 - Remove the tasks queuing experimental status.
938 - Fix task function type definition and validation.
939 - Fix worker choice strategy options handling.
941 ## [2.4.8] - 2023-04-12
945 - Fix message between main worker and worker type definition for tasks.
946 - Fix code documentation.
948 ## [2.4.7] - 2023-04-11
952 - Add worker tasks queue options to pool options.
956 - Fix missing documentation.
958 ## [2.4.6] - 2023-04-10
962 - Ensure one task at a time is executed per worker with tasks queueing enabled.
963 - Properly count worker executing tasks with tasks queueing enabled.
965 ## [2.4.5] - 2023-04-09
969 - Use monotonic high resolution timer for worker tasks runtime.
970 - Add worker tasks median runtime to statistics.
971 - Add worker tasks queue (experimental).
973 ## [2.4.4] - 2023-04-07
977 - Add `PoolEvents` enumeration and `PoolEvent` type.
981 - Destroy worker only on alive check.
983 ## [2.4.3] - 2023-04-07
987 - Fix typedoc generation with inheritance.
989 ## [2.4.2] - 2023-04-06
993 - Add `full` event to dynamic pool.
994 - Keep worker choice strategy in memory for conditional reuse.
998 - Fix possible negative worker key at worker removal in worker choice strategies.
1000 ## [2.4.1] - 2023-04-05
1004 - Optimize worker choice strategy for dynamic pool.
1008 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
1010 ## [2.4.0] - 2023-04-04
1014 - Add `LESS_BUSY` worker choice strategy.
1018 - Optimize worker storage in pool.
1019 - Optimize worker alive status check.
1020 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1021 - Optimize `LESS_USED` worker choice strategy.
1022 - Update benchmark versus external threads pools.
1023 - Optimize tasks usage statistics requirements for worker choice strategy.
1027 - Ensure trimmable characters are checked at pool initialization.
1028 - Fix message id integer overflow.
1029 - Fix pool worker removal in worker choice strategy internals.
1030 - Fix package publication with pnpm.
1032 ## [2.4.0-3] - 2023-04-04
1036 - Add `LESS_BUSY` worker choice strategy.
1040 - Optimize worker storage in pool.
1041 - Optimize worker alive status check.
1042 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1043 - Optimize `LESS_USED` worker choice strategy.
1044 - Update benchmark versus external threads pools.
1048 - Ensure trimmable characters are checked at pool initialization.
1049 - Fix message id integer overflow.
1050 - Fix pool worker removal in worker choice strategy internals.
1051 - Fix package publication with pnpm.
1053 ## [2.4.0-2] - 2023-04-03
1057 - Add `LESS_BUSY` worker choice strategy.
1061 - Optimize worker storage in pool.
1062 - Optimize worker alive status check.
1063 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1064 - Optimize `LESS_USED` worker choice strategy.
1068 - Ensure trimmable characters are checked at pool initialization.
1069 - Fix message id integer overflow.
1070 - Fix pool worker removal in worker choice strategy internals.
1071 - Fix package publication with pnpm.
1073 ## [2.4.0-1] - 2023-04-03
1077 - Add `LESS_BUSY` worker choice strategy.
1081 - Optimize worker storage in pool.
1082 - Optimize worker alive status check.
1083 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1084 - Optimize `LESS_USED` worker choice strategy.
1088 - Ensure trimmable characters are checked at pool initialization.
1089 - Fix message id integer overflow.
1090 - Fix pool worker removal in worker choice strategy internals.
1092 ## [2.4.0-0] - 2023-04-03
1096 - Add `LESS_BUSY` worker choice strategy.
1100 - Optimize worker storage in pool.
1101 - Optimize worker alive status check.
1102 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1103 - Optimize `LESS_USED` worker choice strategy.
1107 - Ensure trimmable characters are checked at pool initialization.
1108 - Fix message id integer overflow.
1109 - Fix pool worker removal in worker choice strategy internals.
1111 ## [2.3.10] - 2023-03-18
1115 - Fix package.json `exports` syntax for ESM and CommonJS.
1119 - Permit SemVer pre-release publication.
1121 ## [2.3.10-2] - 2023-03-18
1125 - Fix package.json `exports` syntax for ESM and CommonJS.
1127 ## [2.3.10-1] - 2023-03-18
1131 - Permit SemVer pre-release publication.
1133 ## [2.3.10-0] - 2023-03-18
1137 - Fix package.json `exports` syntax for ESM and CommonJS.
1139 ## [2.3.9] - 2023-03-18
1143 - Introduce ESM module support along with CommonJS one.
1147 - Fix brown paper bag bug referencing the same object literal.
1149 ## [2.3.8] - 2023-03-18
1153 - Switch internal benchmarking code to benny.
1154 - Switch to TypeScript 5.x.x.
1155 - Switch rollup bundler plugins to core ones.
1156 - Switch to TSDoc syntax.
1157 - Enforce conventional commits.
1161 - Fix random integer generator.
1162 - Fix worker choice strategy pool type identification at initialization.
1164 ## [2.3.7] - 2022-10-23
1168 - Switch to open collective FOSS project funding platform.
1169 - Switch to ts-standard linter configuration on TypeScript code.
1173 - Fixed missing async on pool execute method.
1174 - Fixed typing in TypeScript example.
1175 - Fixed types in unit tests.
1177 ## [2.3.6] - 2022-10-22
1181 - Cleanup pool attributes and methods.
1182 - Refine error types thrown.
1186 - Fix continuous integration build on windows.
1187 - Fix code coverage reporting by using c8 instead of nyc.
1189 ## [2.3.5] - 2022-10-21
1193 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1194 - Optimize tasks usage lookup implementation.
1198 - Fix missed pool event emitter type export.
1199 - Fix typedoc documentation generation.
1201 ## [2.3.4] - 2022-10-17
1205 - Fully automate release process with release-it.
1209 - Optimize fair share task scheduling algorithm implementation.
1210 - Update benchmark versus external pools results with latest version.
1212 ## [2.3.3] - 2022-10-15
1216 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1218 ## [2.3.2] - 2022-10-14
1222 - Optimize fair share worker selection strategy implementation.
1226 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1228 ## [2.3.1] - 2022-10-13
1232 - Pool worker choice strategies:
1233 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1234 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1236 ## [2.2.2] - 2022-10-09
1240 - Fixed `README.md` file.
1242 ## [2.2.1] - 2022-10-08
1246 - Dynamic worker choice strategy change at runtime.
1248 ## [2.2.0] - 2022-01-05
1250 ### Breaking Changes
1252 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1254 ## [2.1.0] - 2021-08-29
1258 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1260 ### Breaking Changes
1262 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1263 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1264 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1265 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1267 ## [2.0.2] - 2021-05-12
1271 - Fix `busy` event emission on fixed pool type
1273 ## [2.0.1] - 2021-03-16
1277 - Check if pool options are properly set.
1278 - `busy` event is emitted on all pool types.
1280 ## [2.0.0] - 2021-03-01
1284 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1286 ### Breaking Changes
1288 - `FullPool` event is now renamed to `busy`.
1289 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1290 _Find more details on our JSDoc._
1292 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1294 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1296 ### Pool options types declaration merge
1298 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1300 #### New `export` strategy
1304 const DynamicThreadPool = require('poolifier/lib/dynamic')
1306 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1309 But you should always prefer just using
1312 const { DynamicThreadPool } = require('poolifier')
1315 #### New type definitions for input data and response
1317 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1318 _This is not a limitation by poolifier but Node.js._
1320 #### Public property replacements
1322 `numWorkers` property is now `numberOfWorkers`
1324 #### Internal (protected) properties and methods renaming
1326 These properties are not intended for end users
1328 - `id` => `nextMessageId`
1330 These methods are not intended for end users
1332 - `_chooseWorker` => `chooseWorker`
1333 - `_newWorker` => `createWorker`
1334 - `_execute` => `internalExecute`
1335 - `_chooseWorker` => `chooseWorker`
1336 - `_checkAlive` => `checkAlive`
1338 - `_runAsync` => `runAsync`
1340 ## [1.1.0] - 2020-05-21
1344 - ThreadWorker support async functions as option
1345 - Various external library patches
1347 ## [1.0.0] - 2020-01-24
1351 - FixedThreadPool implementation
1352 - DynamicThreadPool implementation
1353 - WorkerThread implementation to improve developer experience