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 - Fix default task function worker choice strategy and priority handling.
14 ## [4.0.7] - 2024-05-13
18 - Add ELU statistics to pool information.
20 ## [4.0.6] - 2024-05-10
24 - Fix pools' `addTaskFunction()` type definition.
26 ## [4.0.5] - 2024-05-09
30 - Avoid queued tasks redistribution on the errored worker node.
32 ## [4.0.4] - 2024-05-08
36 - Disable `tasksStealingOnBackPressure` by default until performance issues under heavy load are sorted out.
38 ## [4.0.3] - 2024-05-08
42 - Optimize task(s) stealing by dequeuing task(s) from the last prioritized bucket.
44 ## [4.0.2] - 2024-05-06
48 - Ensure poolifier worker task performance measurement requirements are synchronized with task function objects' worker choice strategies.
50 ## [4.0.1] - 2024-05-02
54 - Ensure dynamic worker node are initialized with sensible worker node usage default values to avoid worker choice strategies biased decisions.
55 - Account for tasks wait time in task execution time computation in worker choice strategies to avoid biased decisions under load with several prioritized task functions and tasks queue enabled.
57 ## [4.0.0] - 2024-04-30
61 - Support per task function(s) priority and worker choice strategy definition via a task function object: `{ taskFunction: (data?: Data) => Response | Promise<Response>, priority?: number, strategy?: WorkerChoiceStrategy }`.
62 - Add priority queue based tasks queueing. One priority queue is divided into prioritized buckets to avoid queued tasks starvation under load.
63 - BREAKING CHANGE: `listTaskFunctionNames()` to `listTaskFunctionsProperties()` in pool and worker API returning registered task functions properties.
64 - BREAKING CHANGE: `strategy` field in pool information renamed to `defaultStrategy`.
68 - Ensure worker choice strategy options changes at runtime are propagated to poolifier workers.
70 ## [3.1.30] - 2024-04-22
74 - Fix `transferList` argument type definition.
76 ## [3.1.29] - 2024-04-02
80 - Fix possible race condition at worker node recreation on worker `error` and `exit` events.
82 ## [3.1.28] - 2024-04-01
86 - Ensure the minimum number of workers on a started pool is guaranteed.
88 ## [3.1.27] - 2024-03-27
92 - Fix publishing on JSR, take 4.
94 ## [3.1.26] - 2024-03-27
98 - Fix publishing on JSR, take 3.
100 ## [3.1.25] - 2024-03-27
104 - Fix publishing on JSR, take 2.
106 ## [3.1.24] - 2024-03-27
110 - Fix publishing on JSR.
112 ## [3.1.23] - 2024-03-27
118 ## [3.1.22] - 2024-03-15
122 - Fix pool event emitter registered callbacks removal at `destroy()`.
124 ## [3.1.21] - 2024-02-22
128 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
130 ## [3.1.20] - 2024-02-11
134 - Ensure `worker_threads` workers are unreferenced at termination.
136 ## [3.1.19] - 2024-01-16
140 - Fix possible null exception at task finishing handling.
144 - Optimize Deque implementation to improve tasks queueing performance.
146 ## [3.1.18] - 2024-01-06
150 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
152 ## [3.1.17] - 2024-01-05
156 - Improve performance by clean up unneeded condition checks on hot code paths.
158 ## [3.1.16] - 2024-01-03
162 - Add missing type to TS type definitions.
164 ## [3.1.15] - 2024-01-02
168 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
170 ## [3.1.15-0] - 2024-01-02
174 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
176 ## [3.1.14] - 2024-01-01
180 - Properly handle dynamic pool with zero minimum size.
182 ## [3.1.13] - 2023-12-30
186 - Reduce branching in several hot code paths.
187 - Use faster object cloning implementation.
189 ## [3.1.12] - 2023-12-27
193 - Fix tasks redistribution triggers at pool destroying.
197 - Switch TypeScript module resolution to Node16.
199 ## [3.1.12-0] - 2023-12-27
203 - Fix tasks redistribution triggers at pool destroying.
205 ## [3.1.11] - 2023-12-24
209 - Avoid worker node cross tasks stealing.
210 - Ensure only half the pool worker nodes can steal tasks.
212 ## [3.1.10] - 2023-12-23
216 - Avoid useless branching on pool type.
218 ## [3.1.9] - 2023-12-22
222 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
224 ## [3.1.8] - 2023-12-21
228 - Fix default worker weight computation.
229 - Fix possible null exception at pool destroying.
231 ## [3.1.7] - 2023-12-20
235 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
237 ## [3.1.6] - 2023-12-18
241 - Fix pool destroying with tasks queuing enabled.
243 ## [3.1.5] - 2023-12-18
247 - Add queued tasks end timeout support to worker node termination.
249 ## [3.1.4] - 2023-12-18
253 - Make more robust the fix for possible null exception at handling task execution response.
255 ## [3.1.3] - 2023-12-17
259 - Fix possible null exception at handling task execution response.
261 ## [3.1.2] - 2023-12-17
265 - Wait for queued tasks to end at worker node termination.
267 ## [3.1.1] - 2023-12-16
271 - Fix pool options TS type definition.
273 ## [3.1.0] - 2023-12-16
277 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
279 ## [3.0.14] - 2023-12-13
283 - Fix possible null exception with worker_threads pools.
285 ## [3.0.13] - 2023-12-12
289 - Ensure worker choice strategy wait for worker nodes readiness.
293 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
295 ## [3.0.12] - 2023-12-12
299 - Add infinite retries support in worker choice strategy.
301 ## [3.0.11] - 2023-12-11
305 - Ensure pool asynchronous resource properly track tasks execution.
307 ## [3.0.10] - 2023-12-08
311 - Add a fastpath when tasks stealing or redistribution is impossible.
313 ## [3.0.9] - 2023-11-26
317 - Remove all pool events listener at pool destroying.
318 - Remove all worker node events listener at worker node destroying.
319 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
321 ## [3.0.8] - 2023-11-25
325 - Ensure continuous tasks stealing on idle start at worker node idling.
327 ## [3.0.7] - 2023-11-24
331 - Make continuous tasks stealing start at worker node idling.
333 ## [3.0.6] - 2023-11-24
337 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
338 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
340 ## [3.0.5] - 2023-10-27
344 - Ensure pool `ready` event can be emitted only once.
346 ## [3.0.4] - 2023-10-20
350 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
351 - Use builtin retry mechanism in worker choice strategies instead of custom one.
353 ## [3.0.3] - 2023-10-19
357 - Avoid null exception at sending message to worker.
358 - Avoid null exception at checking worker node readiness.
360 ## [3.0.2] - 2023-10-17
364 - 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).
366 ## [3.0.1] - 2023-10-16
370 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
374 - Switch the worker node eventing code to `EventTarget` API.
376 ## [3.0.0] - 2023-10-08
380 - Remove Node.js 16.x.x (EOL) support.
382 ## [2.7.5] - 2023-10-03
386 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
388 ## [2.7.4] - 2023-09-25
392 - Fix source maps (bundler issue).
394 ## [2.7.3] - 2023-09-24
398 - Convert pool event emitter to event emitter async resource.
400 ## [2.7.2] - 2023-09-23
404 - Add source maps to npm package to ease debugging.
408 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
410 ## [2.7.1] - 2023-09-20
414 - Ensure worker message listener used one time are removed after usage.
416 ## [2.7.0] - 2023-09-19
420 - Fix task stealing related tasks queue options handling at runtime.
424 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
428 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
429 - Stricter worker constructor arguments validation.
431 ## [2.6.45] - 2023-09-17
435 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
439 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
440 - Add `start()` method to pool API to start the minimum number of workers.
441 - Add `taskStealing` and `tasksStealingOnBackPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not.
442 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
444 ## [2.6.44] - 2023-09-08
448 - Use a dedicated PAT to publish on GitHub packages registry.
452 - Publish on GitHub packages registry on release.
456 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
458 ## [2.6.43] - 2023-09-08
462 - Publish on GitHub packages registry on release.
466 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
468 ## [2.6.42] - 2023-09-06
472 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
474 ## [2.6.41] - 2023-09-03
478 - Optimize worker choice strategies implementation.
480 ## [2.6.40] - 2023-09-01
484 - Do not pre-choose in WRR worker choice strategy to avoid bias.
485 - Avoid array out of bound in worker choice strategies after worker node removal.
487 ## [2.6.39] - 2023-08-30
491 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
493 ## [2.6.38] - 2023-08-30
497 - Bundle typescript types declaration into one file.
501 - Improve interleaved weighted round robin worker choice strategy implementation.
503 ## [2.6.37] - 2023-08-28
507 - Ensure unused worker usage statistics are deleted at runtime.
511 - Rename worker choice strategy options `choiceRetries` to `retries`.
512 - Avoid unnecessary branching in worker choice strategies.
514 ## [2.6.36] - 2023-08-27
518 - Fix pool `execute()` arguments check.
522 - Make continuous tasks stealing algorithm less aggressive.
523 - Fine tune tasks stealing algorithm under back pressure.
525 ## [2.6.35] - 2023-08-25
529 - Don't account worker usage statistics for tasks that have failed.
530 - Fix pool information runtime and wait time median computation.
534 - Update simple moving average implementation to use a circular buffer.
535 - Update simple moving median implementation to use a circular buffer.
536 - Account for stolen tasks in worker usage statistics and pool information.
540 - Continuous tasks stealing algorithm.
542 ## [2.6.34] - 2023-08-24
546 - Avoid cascading tasks stealing under back pressure.
550 - Add fastpath to queued tasks rescheduling.
552 ## [2.6.33] - 2023-08-24
556 - Fix queued tasks rescheduling.
560 - Rename tasks queue options `queueMaxSize` to `size`.
564 - Task stealing scheduling algorithm if tasks queueing is enabled.
566 ## [2.6.32] - 2023-08-23
570 - Ensure no task can be executed when the pool is destroyed.
574 - Add `queueMaxSize` option to tasks queue options.
575 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
576 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
578 ## [2.6.31] - 2023-08-20
582 - Fix worker choice strategy retries mechanism in some edge cases.
586 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
587 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
589 ## [2.6.30] - 2023-08-19
593 - Ensure pool event `backPressure` is emitted.
594 - Ensure pool event `full` is emitted only once.
595 - Ensure worker node cannot be instantiated without proper arguments.
597 ## [2.6.29] - 2023-08-18
601 - Fix race condition between readiness and task functions worker message handling at startup.
602 - Fix duplicate task function worker usage statistics computation per task function.
603 - Update task function worker usage statistics if and only if there's at least two different task functions.
604 - Fix race condition at task function worker usage executing task computation leading to negative value.
608 - 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).
609 - Use back pressure detection in worker choice strategies.
610 - Add worker choice strategies retries mechanism if no worker is eligible.
612 ## [2.6.28] - 2023-08-16
616 - Ensure pool workers are properly initialized.
620 - HTTP server pool examples: express-cluster, express-hybrid.
624 - Remove now useless branching in worker hot code path.
626 ## [2.6.27] - 2023-08-15
630 - Add `KillHandler` type definition to exported types.
634 - Add `destroy` event to pool API.
636 ## [2.6.26] - 2023-08-15
640 - Add kill handler to worker options allowing to execute custom code when worker is killed.
641 - Add `listTaskFunctions()` method to pool API.
642 - SMTP client pool example: nodemailer.
644 ## [2.6.25] - 2023-08-13
648 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
649 - WebSocket server pool examples: ws-cluster, ws-hybrid.
651 ## [2.6.24] - 2023-08-12
655 - Add array of transferable objects to the `execute()` method arguments.
656 - WebSocket server pool examples: ws-worker_threads.
658 ## [2.6.23] - 2023-08-11
662 - 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.
666 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
667 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
669 ## [2.6.22] - 2023-08-10
673 - Add missing `types` field to package.json `exports`.
677 - Structure markdown documentation (PR #811).
679 ## [2.6.21] - 2023-08-03
683 - Improve code documentation.
684 - Code refactoring and cleanup for better maintainability and readability.
686 ## [2.6.20] - 2023-07-21
690 - Fix queued tasks redistribution on error task execution starvation.
691 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
695 - Drastically reduce lookups by worker in the worker nodes.
697 ## [2.6.19] - 2023-07-20
701 - Dedicated internal communication channel for worker_threads pools.
703 ## [2.6.18] - 2023-07-19
707 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
709 ## [2.6.17] - 2023-07-16
713 - Add `listTaskFunctions()` method to worker API.
715 ## [2.6.16] - 2023-07-12
719 - Fix pool startup detection.
720 - Fix worker task functions handling.
722 ## [2.6.15] - 2023-07-11
726 - Take into account worker node readiness in worker choice strategies.
728 ## [2.6.14] - 2023-07-10
732 - Fix task function statistics tracking.
734 ## [2.6.13] - 2023-07-10
738 - Add per task function statistics tracking.
739 - Add public methods to manipulate the worker task functions at runtime.
741 ## [2.6.12] - 2023-07-09
745 - Workaround import issue with `node:os` module in node 16.x.x.
747 ## [2.6.11] - 2023-07-09
751 - Fix pool readiness semantic.
753 ## [2.6.10] - 2023-07-08
757 - Ensure workers are not recreated on error at pool startup.
761 - Add `ready` and `strategy` fields to pool information.
762 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
763 - Add dynamic pool sizing checks.
765 ## [2.6.9] - 2023-07-07
769 - Recreate the right worker type on uncaught exception.
773 - Add minimum and maximum to internal measurement statistics.
774 - Add `runTime` and `waitTime` to pool information.
775 - Check worker inactive time only on dynamic worker.
777 ## [2.6.8] - 2023-07-03
781 - Brown paper bag release to fix version handling in pool information.
783 ## [2.6.7] - 2023-07-03
787 - Ensure worker queued tasks at error are reassigned to other pool workers.
791 - Add pool `utilization` ratio to pool information.
792 - Add `version` to pool information.
793 - Add worker information to worker nodes.
795 ## [2.6.6] - 2023-07-01
799 - Add safe helper `availableParallelism()` to help sizing the pool.
803 - Ensure message handler is only registered in worker.
805 ## [2.6.5] - 2023-06-27
809 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
813 - Artificial version bump to 2.6.5 to workaround publication issue.
814 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
815 - Ensure pool event is emitted before task error promise rejection.
816 - Fix queued tasks count computation.
820 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
822 ## [2.6.4] - 2023-06-27
826 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
830 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
831 - Ensure pool event is emitted before task error promise rejection.
832 - Fix queued tasks count computation.
836 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
838 ## [2.6.3] - 2023-06-19
842 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
843 - Update strategies internals after statistics computation.
847 - Optimize O(1) queue implementation.
849 ## [2.6.2] - 2023-06-12
853 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
855 ## [2.6.1] - 2023-06-10
859 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
863 - Fix average statistics computation: ensure failed tasks are not accounted.
865 ## [2.6.0] - 2023-06-09
869 - Add `LEAST_ELU` worker choice strategy (experimental).
870 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
874 - Refactor pool worker node usage internals.
875 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
876 - Breaking change: pool information `info` property object fields have been renamed.
880 - Fix wait time accounting.
881 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
882 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
884 ## [2.5.4] - 2023-06-07
888 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
892 - Compute statistics at the worker level only if needed.
893 - Add `worker_threads` options to thread pool options.
897 - Make the `LEAST_BUSY` strategy only relies on task runtime.
899 ## [2.5.3] - 2023-06-04
903 - Refine pool information content.
904 - Limit pool internals public exposure.
906 ## [2.5.2] - 2023-06-02
910 - Add `taskError` pool event for task execution error.
911 - Add pool information `info` property to pool.
912 - Emit pool information on `busy` and `full` pool events.
914 ## [2.5.1] - 2023-06-01
918 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
919 - Add `error` pool event for uncaught worker error.
921 ## [2.5.0] - 2023-05-31
925 - Switch pool event emitter to `EventEmitterAsyncResource`.
926 - Add tasks wait time accounting in per worker tasks usage.
927 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
931 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
933 ## [2.4.14] - 2023-05-09
937 - Ensure no undefined task runtime can land in the tasks history.
938 - Fix median computation implementation once again.
942 - Unit tests for median and queue implementations.
944 ## [2.4.13] - 2023-05-08
948 - Fix worker choice strategy options validation.
949 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
951 ## [2.4.12] - 2023-05-06
955 - Support multiple task functions per worker.
956 - Add custom worker weights support to worker choice strategies options.
960 - Use O(1) queue implementation for tasks queueing.
964 - Fix median computation implementation.
965 - Fix fair share worker choice strategy internals update.
967 ## [2.4.11] - 2023-04-23
971 - Optimize free worker finding in worker choice strategies.
973 ## [2.4.10] - 2023-04-15
977 - Fix typescript type definition for task function: ensure the input data is optional.
978 - Fix typescript type definition for pool execute(): ensure the input data is optional.
980 ## [2.4.9] - 2023-04-15
984 - Add tasks queue enablement runtime setter to pool.
985 - Add tasks queue options runtime setter to pool.
986 - Add worker choice strategy options runtime setter to pool.
990 - Remove the tasks queuing experimental status.
994 - Fix task function type definition and validation.
995 - Fix worker choice strategy options handling.
997 ## [2.4.8] - 2023-04-12
1001 - Fix message between main worker and worker type definition for tasks.
1002 - Fix code documentation.
1004 ## [2.4.7] - 2023-04-11
1008 - Add worker tasks queue options to pool options.
1012 - Fix missing documentation.
1014 ## [2.4.6] - 2023-04-10
1018 - Ensure one task at a time is executed per worker with tasks queueing enabled.
1019 - Properly count worker executing tasks with tasks queueing enabled.
1021 ## [2.4.5] - 2023-04-09
1025 - Use monotonic high resolution timer for worker tasks runtime.
1026 - Add worker tasks median runtime to statistics.
1027 - Add worker tasks queue (experimental).
1029 ## [2.4.4] - 2023-04-07
1033 - Add `PoolEvents` enumeration and `PoolEvent` type.
1037 - Destroy worker only on alive check.
1039 ## [2.4.3] - 2023-04-07
1043 - Fix typedoc generation with inheritance.
1045 ## [2.4.2] - 2023-04-06
1049 - Add `full` event to dynamic pool.
1050 - Keep worker choice strategy in memory for conditional reuse.
1054 - Fix possible negative worker key at worker removal in worker choice strategies.
1056 ## [2.4.1] - 2023-04-05
1060 - Optimize worker choice strategy for dynamic pool.
1064 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
1066 ## [2.4.0] - 2023-04-04
1070 - Add `LESS_BUSY` worker choice strategy.
1074 - Optimize worker storage in pool.
1075 - Optimize worker alive status check.
1076 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1077 - Optimize `LESS_USED` worker choice strategy.
1078 - Update benchmark versus external threads pools.
1079 - Optimize tasks usage statistics requirements for worker choice strategy.
1083 - Ensure trimmable characters are checked at pool initialization.
1084 - Fix message id integer overflow.
1085 - Fix pool worker removal in worker choice strategy internals.
1086 - Fix package publication with pnpm.
1088 ## [2.4.0-3] - 2023-04-04
1092 - Add `LESS_BUSY` worker choice strategy.
1096 - Optimize worker storage in pool.
1097 - Optimize worker alive status check.
1098 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1099 - Optimize `LESS_USED` worker choice strategy.
1100 - Update benchmark versus external threads pools.
1104 - Ensure trimmable characters are checked at pool initialization.
1105 - Fix message id integer overflow.
1106 - Fix pool worker removal in worker choice strategy internals.
1107 - Fix package publication with pnpm.
1109 ## [2.4.0-2] - 2023-04-03
1113 - Add `LESS_BUSY` worker choice strategy.
1117 - Optimize worker storage in pool.
1118 - Optimize worker alive status check.
1119 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1120 - Optimize `LESS_USED` worker choice strategy.
1124 - Ensure trimmable characters are checked at pool initialization.
1125 - Fix message id integer overflow.
1126 - Fix pool worker removal in worker choice strategy internals.
1127 - Fix package publication with pnpm.
1129 ## [2.4.0-1] - 2023-04-03
1133 - Add `LESS_BUSY` worker choice strategy.
1137 - Optimize worker storage in pool.
1138 - Optimize worker alive status check.
1139 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1140 - Optimize `LESS_USED` worker choice strategy.
1144 - Ensure trimmable characters are checked at pool initialization.
1145 - Fix message id integer overflow.
1146 - Fix pool worker removal in worker choice strategy internals.
1148 ## [2.4.0-0] - 2023-04-03
1152 - Add `LESS_BUSY` worker choice strategy.
1156 - Optimize worker storage in pool.
1157 - Optimize worker alive status check.
1158 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1159 - Optimize `LESS_USED` worker choice strategy.
1163 - Ensure trimmable characters are checked at pool initialization.
1164 - Fix message id integer overflow.
1165 - Fix pool worker removal in worker choice strategy internals.
1167 ## [2.3.10] - 2023-03-18
1171 - Fix package.json `exports` syntax for ESM and CommonJS.
1175 - Permit SemVer pre-release publication.
1177 ## [2.3.10-2] - 2023-03-18
1181 - Fix package.json `exports` syntax for ESM and CommonJS.
1183 ## [2.3.10-1] - 2023-03-18
1187 - Permit SemVer pre-release publication.
1189 ## [2.3.10-0] - 2023-03-18
1193 - Fix package.json `exports` syntax for ESM and CommonJS.
1195 ## [2.3.9] - 2023-03-18
1199 - Introduce ESM module support along with CommonJS one.
1203 - Fix brown paper bag bug referencing the same object literal.
1205 ## [2.3.8] - 2023-03-18
1209 - Switch internal benchmarking code to benny.
1210 - Switch to TypeScript 5.x.x.
1211 - Switch rollup bundler plugins to core ones.
1212 - Switch to TSDoc syntax.
1213 - Enforce conventional commits.
1217 - Fix random integer generator.
1218 - Fix worker choice strategy pool type identification at initialization.
1220 ## [2.3.7] - 2022-10-23
1224 - Switch to open collective FOSS project funding platform.
1225 - Switch to ts-standard linter configuration on TypeScript code.
1229 - Fixed missing async on pool execute method.
1230 - Fixed typing in TypeScript example.
1231 - Fixed types in unit tests.
1233 ## [2.3.6] - 2022-10-22
1237 - Cleanup pool attributes and methods.
1238 - Refine error types thrown.
1242 - Fix continuous integration build on windows.
1243 - Fix code coverage reporting by using c8 instead of nyc.
1245 ## [2.3.5] - 2022-10-21
1249 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1250 - Optimize tasks usage lookup implementation.
1254 - Fix missed pool event emitter type export.
1255 - Fix typedoc documentation generation.
1257 ## [2.3.4] - 2022-10-17
1261 - Fully automate release process with release-it.
1265 - Optimize fair share task scheduling algorithm implementation.
1266 - Update benchmark versus external pools results with latest version.
1268 ## [2.3.3] - 2022-10-15
1272 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1274 ## [2.3.2] - 2022-10-14
1278 - Optimize fair share worker selection strategy implementation.
1282 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1284 ## [2.3.1] - 2022-10-13
1288 - Pool worker choice strategies:
1289 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1290 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1292 ## [2.2.2] - 2022-10-09
1296 - Fixed `README.md` file.
1298 ## [2.2.1] - 2022-10-08
1302 - Dynamic worker choice strategy change at runtime.
1304 ## [2.2.0] - 2022-01-05
1306 ### Breaking Changes
1308 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1310 ## [2.1.0] - 2021-08-29
1314 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1316 ### Breaking Changes
1318 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1319 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1320 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1321 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1323 ## [2.0.2] - 2021-05-12
1327 - Fix `busy` event emission on fixed pool type
1329 ## [2.0.1] - 2021-03-16
1333 - Check if pool options are properly set.
1334 - `busy` event is emitted on all pool types.
1336 ## [2.0.0] - 2021-03-01
1340 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1342 ### Breaking Changes
1344 - `FullPool` event is now renamed to `busy`.
1345 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1346 _Find more details on our JSDoc._
1348 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1350 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1352 ### Pool options types declaration merge
1354 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1356 #### New `export` strategy
1360 const DynamicThreadPool = require('poolifier/lib/dynamic')
1362 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1365 But you should always prefer just using
1368 const { DynamicThreadPool } = require('poolifier')
1371 #### New type definitions for input data and response
1373 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1374 _This is not a limitation by poolifier but Node.js._
1376 #### Public property replacements
1378 `numWorkers` property is now `numberOfWorkers`
1380 #### Internal (protected) properties and methods renaming
1382 These properties are not intended for end users
1384 - `id` => `nextMessageId`
1386 These methods are not intended for end users
1388 - `_chooseWorker` => `chooseWorker`
1389 - `_newWorker` => `createWorker`
1390 - `_execute` => `internalExecute`
1391 - `_chooseWorker` => `chooseWorker`
1392 - `_checkAlive` => `checkAlive`
1394 - `_runAsync` => `runAsync`
1396 ## [1.1.0] - 2020-05-21
1400 - ThreadWorker support async functions as option
1401 - Various external library patches
1403 ## [1.0.0] - 2020-01-24
1407 - FixedThreadPool implementation
1408 - DynamicThreadPool implementation
1409 - WorkerThread implementation to improve developer experience