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 - Add ELU `utilization` statistics to pool information.
14 ## [4.0.8] - 2024-05-15
18 - Fix default task function worker choice strategy and priority handling.
20 ## [4.0.7] - 2024-05-13
24 - Add ELU statistics to pool information.
26 ## [4.0.6] - 2024-05-10
30 - Fix pools' `addTaskFunction()` type definition.
32 ## [4.0.5] - 2024-05-09
36 - Avoid queued tasks redistribution on the errored worker node.
38 ## [4.0.4] - 2024-05-08
42 - Disable `tasksStealingOnBackPressure` by default until performance issues under heavy load are sorted out.
44 ## [4.0.3] - 2024-05-08
48 - Optimize task(s) stealing by dequeuing task(s) from the last prioritized bucket.
50 ## [4.0.2] - 2024-05-06
54 - Ensure poolifier worker task performance measurement requirements are synchronized with task function objects' worker choice strategies.
56 ## [4.0.1] - 2024-05-02
60 - Ensure dynamic worker node are initialized with sensible worker node usage default values to avoid worker choice strategies biased decisions.
61 - 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.
63 ## [4.0.0] - 2024-04-30
67 - 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 }`.
68 - Add priority queue based tasks queueing. One priority queue is divided into prioritized buckets to avoid queued tasks starvation under load.
69 - BREAKING CHANGE: `listTaskFunctionNames()` to `listTaskFunctionsProperties()` in pool and worker API returning registered task functions properties.
70 - BREAKING CHANGE: `strategy` field in pool information renamed to `defaultStrategy`.
74 - Ensure worker choice strategy options changes at runtime are propagated to poolifier workers.
76 ## [3.1.30] - 2024-04-22
80 - Fix `transferList` argument type definition.
82 ## [3.1.29] - 2024-04-02
86 - Fix possible race condition at worker node recreation on worker `error` and `exit` events.
88 ## [3.1.28] - 2024-04-01
92 - Ensure the minimum number of workers on a started pool is guaranteed.
94 ## [3.1.27] - 2024-03-27
98 - Fix publishing on JSR, take 4.
100 ## [3.1.26] - 2024-03-27
104 - Fix publishing on JSR, take 3.
106 ## [3.1.25] - 2024-03-27
110 - Fix publishing on JSR, take 2.
112 ## [3.1.24] - 2024-03-27
116 - Fix publishing on JSR.
118 ## [3.1.23] - 2024-03-27
124 ## [3.1.22] - 2024-03-15
128 - Fix pool event emitter registered callbacks removal at `destroy()`.
130 ## [3.1.21] - 2024-02-22
134 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
136 ## [3.1.20] - 2024-02-11
140 - Ensure `worker_threads` workers are unreferenced at termination.
142 ## [3.1.19] - 2024-01-16
146 - Fix possible null exception at task finishing handling.
150 - Optimize Deque implementation to improve tasks queueing performance.
152 ## [3.1.18] - 2024-01-06
156 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
158 ## [3.1.17] - 2024-01-05
162 - Improve performance by clean up unneeded condition checks on hot code paths.
164 ## [3.1.16] - 2024-01-03
168 - Add missing type to TS type definitions.
170 ## [3.1.15] - 2024-01-02
174 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
176 ## [3.1.15-0] - 2024-01-02
180 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
182 ## [3.1.14] - 2024-01-01
186 - Properly handle dynamic pool with zero minimum size.
188 ## [3.1.13] - 2023-12-30
192 - Reduce branching in several hot code paths.
193 - Use faster object cloning implementation.
195 ## [3.1.12] - 2023-12-27
199 - Fix tasks redistribution triggers at pool destroying.
203 - Switch TypeScript module resolution to Node16.
205 ## [3.1.12-0] - 2023-12-27
209 - Fix tasks redistribution triggers at pool destroying.
211 ## [3.1.11] - 2023-12-24
215 - Avoid worker node cross tasks stealing.
216 - Ensure only half the pool worker nodes can steal tasks.
218 ## [3.1.10] - 2023-12-23
222 - Avoid useless branching on pool type.
224 ## [3.1.9] - 2023-12-22
228 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
230 ## [3.1.8] - 2023-12-21
234 - Fix default worker weight computation.
235 - Fix possible null exception at pool destroying.
237 ## [3.1.7] - 2023-12-20
241 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
243 ## [3.1.6] - 2023-12-18
247 - Fix pool destroying with tasks queuing enabled.
249 ## [3.1.5] - 2023-12-18
253 - Add queued tasks end timeout support to worker node termination.
255 ## [3.1.4] - 2023-12-18
259 - Make more robust the fix for possible null exception at handling task execution response.
261 ## [3.1.3] - 2023-12-17
265 - Fix possible null exception at handling task execution response.
267 ## [3.1.2] - 2023-12-17
271 - Wait for queued tasks to end at worker node termination.
273 ## [3.1.1] - 2023-12-16
277 - Fix pool options TS type definition.
279 ## [3.1.0] - 2023-12-16
283 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
285 ## [3.0.14] - 2023-12-13
289 - Fix possible null exception with worker_threads pools.
291 ## [3.0.13] - 2023-12-12
295 - Ensure worker choice strategy wait for worker nodes readiness.
299 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
301 ## [3.0.12] - 2023-12-12
305 - Add infinite retries support in worker choice strategy.
307 ## [3.0.11] - 2023-12-11
311 - Ensure pool asynchronous resource properly track tasks execution.
313 ## [3.0.10] - 2023-12-08
317 - Add a fastpath when tasks stealing or redistribution is impossible.
319 ## [3.0.9] - 2023-11-26
323 - Remove all pool events listener at pool destroying.
324 - Remove all worker node events listener at worker node destroying.
325 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
327 ## [3.0.8] - 2023-11-25
331 - Ensure continuous tasks stealing on idle start at worker node idling.
333 ## [3.0.7] - 2023-11-24
337 - Make continuous tasks stealing start at worker node idling.
339 ## [3.0.6] - 2023-11-24
343 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
344 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
346 ## [3.0.5] - 2023-10-27
350 - Ensure pool `ready` event can be emitted only once.
352 ## [3.0.4] - 2023-10-20
356 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
357 - Use builtin retry mechanism in worker choice strategies instead of custom one.
359 ## [3.0.3] - 2023-10-19
363 - Avoid null exception at sending message to worker.
364 - Avoid null exception at checking worker node readiness.
366 ## [3.0.2] - 2023-10-17
370 - 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).
372 ## [3.0.1] - 2023-10-16
376 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
380 - Switch the worker node eventing code to `EventTarget` API.
382 ## [3.0.0] - 2023-10-08
386 - Remove Node.js 16.x.x (EOL) support.
388 ## [2.7.5] - 2023-10-03
392 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
394 ## [2.7.4] - 2023-09-25
398 - Fix source maps (bundler issue).
400 ## [2.7.3] - 2023-09-24
404 - Convert pool event emitter to event emitter async resource.
406 ## [2.7.2] - 2023-09-23
410 - Add source maps to npm package to ease debugging.
414 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
416 ## [2.7.1] - 2023-09-20
420 - Ensure worker message listener used one time are removed after usage.
422 ## [2.7.0] - 2023-09-19
426 - Fix task stealing related tasks queue options handling at runtime.
430 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
434 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
435 - Stricter worker constructor arguments validation.
437 ## [2.6.45] - 2023-09-17
441 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
445 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
446 - Add `start()` method to pool API to start the minimum number of workers.
447 - 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.
448 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
450 ## [2.6.44] - 2023-09-08
454 - Use a dedicated PAT to publish on GitHub packages registry.
458 - Publish on GitHub packages registry on release.
462 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
464 ## [2.6.43] - 2023-09-08
468 - Publish on GitHub packages registry on release.
472 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
474 ## [2.6.42] - 2023-09-06
478 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
480 ## [2.6.41] - 2023-09-03
484 - Optimize worker choice strategies implementation.
486 ## [2.6.40] - 2023-09-01
490 - Do not pre-choose in WRR worker choice strategy to avoid bias.
491 - Avoid array out of bound in worker choice strategies after worker node removal.
493 ## [2.6.39] - 2023-08-30
497 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
499 ## [2.6.38] - 2023-08-30
503 - Bundle typescript types declaration into one file.
507 - Improve interleaved weighted round robin worker choice strategy implementation.
509 ## [2.6.37] - 2023-08-28
513 - Ensure unused worker usage statistics are deleted at runtime.
517 - Rename worker choice strategy options `choiceRetries` to `retries`.
518 - Avoid unnecessary branching in worker choice strategies.
520 ## [2.6.36] - 2023-08-27
524 - Fix pool `execute()` arguments check.
528 - Make continuous tasks stealing algorithm less aggressive.
529 - Fine tune tasks stealing algorithm under back pressure.
531 ## [2.6.35] - 2023-08-25
535 - Don't account worker usage statistics for tasks that have failed.
536 - Fix pool information runtime and wait time median computation.
540 - Update simple moving average implementation to use a circular buffer.
541 - Update simple moving median implementation to use a circular buffer.
542 - Account for stolen tasks in worker usage statistics and pool information.
546 - Continuous tasks stealing algorithm.
548 ## [2.6.34] - 2023-08-24
552 - Avoid cascading tasks stealing under back pressure.
556 - Add fastpath to queued tasks rescheduling.
558 ## [2.6.33] - 2023-08-24
562 - Fix queued tasks rescheduling.
566 - Rename tasks queue options `queueMaxSize` to `size`.
570 - Task stealing scheduling algorithm if tasks queueing is enabled.
572 ## [2.6.32] - 2023-08-23
576 - Ensure no task can be executed when the pool is destroyed.
580 - Add `queueMaxSize` option to tasks queue options.
581 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
582 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
584 ## [2.6.31] - 2023-08-20
588 - Fix worker choice strategy retries mechanism in some edge cases.
592 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
593 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
595 ## [2.6.30] - 2023-08-19
599 - Ensure pool event `backPressure` is emitted.
600 - Ensure pool event `full` is emitted only once.
601 - Ensure worker node cannot be instantiated without proper arguments.
603 ## [2.6.29] - 2023-08-18
607 - Fix race condition between readiness and task functions worker message handling at startup.
608 - Fix duplicate task function worker usage statistics computation per task function.
609 - Update task function worker usage statistics if and only if there's at least two different task functions.
610 - Fix race condition at task function worker usage executing task computation leading to negative value.
614 - 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).
615 - Use back pressure detection in worker choice strategies.
616 - Add worker choice strategies retries mechanism if no worker is eligible.
618 ## [2.6.28] - 2023-08-16
622 - Ensure pool workers are properly initialized.
626 - HTTP server pool examples: express-cluster, express-hybrid.
630 - Remove now useless branching in worker hot code path.
632 ## [2.6.27] - 2023-08-15
636 - Add `KillHandler` type definition to exported types.
640 - Add `destroy` event to pool API.
642 ## [2.6.26] - 2023-08-15
646 - Add kill handler to worker options allowing to execute custom code when worker is killed.
647 - Add `listTaskFunctions()` method to pool API.
648 - SMTP client pool example: nodemailer.
650 ## [2.6.25] - 2023-08-13
654 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
655 - WebSocket server pool examples: ws-cluster, ws-hybrid.
657 ## [2.6.24] - 2023-08-12
661 - Add array of transferable objects to the `execute()` method arguments.
662 - WebSocket server pool examples: ws-worker_threads.
664 ## [2.6.23] - 2023-08-11
668 - 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.
672 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
673 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
675 ## [2.6.22] - 2023-08-10
679 - Add missing `types` field to package.json `exports`.
683 - Structure markdown documentation (PR #811).
685 ## [2.6.21] - 2023-08-03
689 - Improve code documentation.
690 - Code refactoring and cleanup for better maintainability and readability.
692 ## [2.6.20] - 2023-07-21
696 - Fix queued tasks redistribution on error task execution starvation.
697 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
701 - Drastically reduce lookups by worker in the worker nodes.
703 ## [2.6.19] - 2023-07-20
707 - Dedicated internal communication channel for worker_threads pools.
709 ## [2.6.18] - 2023-07-19
713 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
715 ## [2.6.17] - 2023-07-16
719 - Add `listTaskFunctions()` method to worker API.
721 ## [2.6.16] - 2023-07-12
725 - Fix pool startup detection.
726 - Fix worker task functions handling.
728 ## [2.6.15] - 2023-07-11
732 - Take into account worker node readiness in worker choice strategies.
734 ## [2.6.14] - 2023-07-10
738 - Fix task function statistics tracking.
740 ## [2.6.13] - 2023-07-10
744 - Add per task function statistics tracking.
745 - Add public methods to manipulate the worker task functions at runtime.
747 ## [2.6.12] - 2023-07-09
751 - Workaround import issue with `node:os` module in node 16.x.x.
753 ## [2.6.11] - 2023-07-09
757 - Fix pool readiness semantic.
759 ## [2.6.10] - 2023-07-08
763 - Ensure workers are not recreated on error at pool startup.
767 - Add `ready` and `strategy` fields to pool information.
768 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
769 - Add dynamic pool sizing checks.
771 ## [2.6.9] - 2023-07-07
775 - Recreate the right worker type on uncaught exception.
779 - Add minimum and maximum to internal measurement statistics.
780 - Add `runTime` and `waitTime` to pool information.
781 - Check worker inactive time only on dynamic worker.
783 ## [2.6.8] - 2023-07-03
787 - Brown paper bag release to fix version handling in pool information.
789 ## [2.6.7] - 2023-07-03
793 - Ensure worker queued tasks at error are reassigned to other pool workers.
797 - Add pool `utilization` ratio to pool information.
798 - Add `version` to pool information.
799 - Add worker information to worker nodes.
801 ## [2.6.6] - 2023-07-01
805 - Add safe helper `availableParallelism()` to help sizing the pool.
809 - Ensure message handler is only registered in worker.
811 ## [2.6.5] - 2023-06-27
815 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
819 - Artificial version bump to 2.6.5 to workaround publication issue.
820 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
821 - Ensure pool event is emitted before task error promise rejection.
822 - Fix queued tasks count computation.
826 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
828 ## [2.6.4] - 2023-06-27
832 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
836 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
837 - Ensure pool event is emitted before task error promise rejection.
838 - Fix queued tasks count computation.
842 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
844 ## [2.6.3] - 2023-06-19
848 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
849 - Update strategies internals after statistics computation.
853 - Optimize O(1) queue implementation.
855 ## [2.6.2] - 2023-06-12
859 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
861 ## [2.6.1] - 2023-06-10
865 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
869 - Fix average statistics computation: ensure failed tasks are not accounted.
871 ## [2.6.0] - 2023-06-09
875 - Add `LEAST_ELU` worker choice strategy (experimental).
876 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
880 - Refactor pool worker node usage internals.
881 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
882 - Breaking change: pool information `info` property object fields have been renamed.
886 - Fix wait time accounting.
887 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
888 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
890 ## [2.5.4] - 2023-06-07
894 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
898 - Compute statistics at the worker level only if needed.
899 - Add `worker_threads` options to thread pool options.
903 - Make the `LEAST_BUSY` strategy only relies on task runtime.
905 ## [2.5.3] - 2023-06-04
909 - Refine pool information content.
910 - Limit pool internals public exposure.
912 ## [2.5.2] - 2023-06-02
916 - Add `taskError` pool event for task execution error.
917 - Add pool information `info` property to pool.
918 - Emit pool information on `busy` and `full` pool events.
920 ## [2.5.1] - 2023-06-01
924 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
925 - Add `error` pool event for uncaught worker error.
927 ## [2.5.0] - 2023-05-31
931 - Switch pool event emitter to `EventEmitterAsyncResource`.
932 - Add tasks wait time accounting in per worker tasks usage.
933 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
937 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
939 ## [2.4.14] - 2023-05-09
943 - Ensure no undefined task runtime can land in the tasks history.
944 - Fix median computation implementation once again.
948 - Unit tests for median and queue implementations.
950 ## [2.4.13] - 2023-05-08
954 - Fix worker choice strategy options validation.
955 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
957 ## [2.4.12] - 2023-05-06
961 - Support multiple task functions per worker.
962 - Add custom worker weights support to worker choice strategies options.
966 - Use O(1) queue implementation for tasks queueing.
970 - Fix median computation implementation.
971 - Fix fair share worker choice strategy internals update.
973 ## [2.4.11] - 2023-04-23
977 - Optimize free worker finding in worker choice strategies.
979 ## [2.4.10] - 2023-04-15
983 - Fix typescript type definition for task function: ensure the input data is optional.
984 - Fix typescript type definition for pool execute(): ensure the input data is optional.
986 ## [2.4.9] - 2023-04-15
990 - Add tasks queue enablement runtime setter to pool.
991 - Add tasks queue options runtime setter to pool.
992 - Add worker choice strategy options runtime setter to pool.
996 - Remove the tasks queuing experimental status.
1000 - Fix task function type definition and validation.
1001 - Fix worker choice strategy options handling.
1003 ## [2.4.8] - 2023-04-12
1007 - Fix message between main worker and worker type definition for tasks.
1008 - Fix code documentation.
1010 ## [2.4.7] - 2023-04-11
1014 - Add worker tasks queue options to pool options.
1018 - Fix missing documentation.
1020 ## [2.4.6] - 2023-04-10
1024 - Ensure one task at a time is executed per worker with tasks queueing enabled.
1025 - Properly count worker executing tasks with tasks queueing enabled.
1027 ## [2.4.5] - 2023-04-09
1031 - Use monotonic high resolution timer for worker tasks runtime.
1032 - Add worker tasks median runtime to statistics.
1033 - Add worker tasks queue (experimental).
1035 ## [2.4.4] - 2023-04-07
1039 - Add `PoolEvents` enumeration and `PoolEvent` type.
1043 - Destroy worker only on alive check.
1045 ## [2.4.3] - 2023-04-07
1049 - Fix typedoc generation with inheritance.
1051 ## [2.4.2] - 2023-04-06
1055 - Add `full` event to dynamic pool.
1056 - Keep worker choice strategy in memory for conditional reuse.
1060 - Fix possible negative worker key at worker removal in worker choice strategies.
1062 ## [2.4.1] - 2023-04-05
1066 - Optimize worker choice strategy for dynamic pool.
1070 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
1072 ## [2.4.0] - 2023-04-04
1076 - Add `LESS_BUSY` worker choice strategy.
1080 - Optimize worker storage in pool.
1081 - Optimize worker alive status check.
1082 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1083 - Optimize `LESS_USED` worker choice strategy.
1084 - Update benchmark versus external threads pools.
1085 - Optimize tasks usage statistics requirements for worker choice strategy.
1089 - Ensure trimmable characters are checked at pool initialization.
1090 - Fix message id integer overflow.
1091 - Fix pool worker removal in worker choice strategy internals.
1092 - Fix package publication with pnpm.
1094 ## [2.4.0-3] - 2023-04-04
1098 - Add `LESS_BUSY` worker choice strategy.
1102 - Optimize worker storage in pool.
1103 - Optimize worker alive status check.
1104 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1105 - Optimize `LESS_USED` worker choice strategy.
1106 - Update benchmark versus external threads pools.
1110 - Ensure trimmable characters are checked at pool initialization.
1111 - Fix message id integer overflow.
1112 - Fix pool worker removal in worker choice strategy internals.
1113 - Fix package publication with pnpm.
1115 ## [2.4.0-2] - 2023-04-03
1119 - Add `LESS_BUSY` worker choice strategy.
1123 - Optimize worker storage in pool.
1124 - Optimize worker alive status check.
1125 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1126 - Optimize `LESS_USED` worker choice strategy.
1130 - Ensure trimmable characters are checked at pool initialization.
1131 - Fix message id integer overflow.
1132 - Fix pool worker removal in worker choice strategy internals.
1133 - Fix package publication with pnpm.
1135 ## [2.4.0-1] - 2023-04-03
1139 - Add `LESS_BUSY` worker choice strategy.
1143 - Optimize worker storage in pool.
1144 - Optimize worker alive status check.
1145 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1146 - Optimize `LESS_USED` worker choice strategy.
1150 - Ensure trimmable characters are checked at pool initialization.
1151 - Fix message id integer overflow.
1152 - Fix pool worker removal in worker choice strategy internals.
1154 ## [2.4.0-0] - 2023-04-03
1158 - Add `LESS_BUSY` worker choice strategy.
1162 - Optimize worker storage in pool.
1163 - Optimize worker alive status check.
1164 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1165 - Optimize `LESS_USED` worker choice strategy.
1169 - Ensure trimmable characters are checked at pool initialization.
1170 - Fix message id integer overflow.
1171 - Fix pool worker removal in worker choice strategy internals.
1173 ## [2.3.10] - 2023-03-18
1177 - Fix package.json `exports` syntax for ESM and CommonJS.
1181 - Permit SemVer pre-release publication.
1183 ## [2.3.10-2] - 2023-03-18
1187 - Fix package.json `exports` syntax for ESM and CommonJS.
1189 ## [2.3.10-1] - 2023-03-18
1193 - Permit SemVer pre-release publication.
1195 ## [2.3.10-0] - 2023-03-18
1199 - Fix package.json `exports` syntax for ESM and CommonJS.
1201 ## [2.3.9] - 2023-03-18
1205 - Introduce ESM module support along with CommonJS one.
1209 - Fix brown paper bag bug referencing the same object literal.
1211 ## [2.3.8] - 2023-03-18
1215 - Switch internal benchmarking code to benny.
1216 - Switch to TypeScript 5.x.x.
1217 - Switch rollup bundler plugins to core ones.
1218 - Switch to TSDoc syntax.
1219 - Enforce conventional commits.
1223 - Fix random integer generator.
1224 - Fix worker choice strategy pool type identification at initialization.
1226 ## [2.3.7] - 2022-10-23
1230 - Switch to open collective FOSS project funding platform.
1231 - Switch to ts-standard linter configuration on TypeScript code.
1235 - Fixed missing async on pool execute method.
1236 - Fixed typing in TypeScript example.
1237 - Fixed types in unit tests.
1239 ## [2.3.6] - 2022-10-22
1243 - Cleanup pool attributes and methods.
1244 - Refine error types thrown.
1248 - Fix continuous integration build on windows.
1249 - Fix code coverage reporting by using c8 instead of nyc.
1251 ## [2.3.5] - 2022-10-21
1255 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1256 - Optimize tasks usage lookup implementation.
1260 - Fix missed pool event emitter type export.
1261 - Fix typedoc documentation generation.
1263 ## [2.3.4] - 2022-10-17
1267 - Fully automate release process with release-it.
1271 - Optimize fair share task scheduling algorithm implementation.
1272 - Update benchmark versus external pools results with latest version.
1274 ## [2.3.3] - 2022-10-15
1278 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1280 ## [2.3.2] - 2022-10-14
1284 - Optimize fair share worker selection strategy implementation.
1288 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1290 ## [2.3.1] - 2022-10-13
1294 - Pool worker choice strategies:
1295 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1296 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1298 ## [2.2.2] - 2022-10-09
1302 - Fixed `README.md` file.
1304 ## [2.2.1] - 2022-10-08
1308 - Dynamic worker choice strategy change at runtime.
1310 ## [2.2.0] - 2022-01-05
1312 ### Breaking Changes
1314 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1316 ## [2.1.0] - 2021-08-29
1320 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1322 ### Breaking Changes
1324 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1325 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1326 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1327 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1329 ## [2.0.2] - 2021-05-12
1333 - Fix `busy` event emission on fixed pool type
1335 ## [2.0.1] - 2021-03-16
1339 - Check if pool options are properly set.
1340 - `busy` event is emitted on all pool types.
1342 ## [2.0.0] - 2021-03-01
1346 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1348 ### Breaking Changes
1350 - `FullPool` event is now renamed to `busy`.
1351 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1352 _Find more details on our JSDoc._
1354 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1356 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1358 ### Pool options types declaration merge
1360 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1362 #### New `export` strategy
1366 const DynamicThreadPool = require('poolifier/lib/dynamic')
1368 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1371 But you should always prefer just using
1374 const { DynamicThreadPool } = require('poolifier')
1377 #### New type definitions for input data and response
1379 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1380 _This is not a limitation by poolifier but Node.js._
1382 #### Public property replacements
1384 `numWorkers` property is now `numberOfWorkers`
1386 #### Internal (protected) properties and methods renaming
1388 These properties are not intended for end users
1390 - `id` => `nextMessageId`
1392 These methods are not intended for end users
1394 - `_chooseWorker` => `chooseWorker`
1395 - `_newWorker` => `createWorker`
1396 - `_execute` => `internalExecute`
1397 - `_chooseWorker` => `chooseWorker`
1398 - `_checkAlive` => `checkAlive`
1400 - `_runAsync` => `runAsync`
1402 ## [1.1.0] - 2020-05-21
1406 - ThreadWorker support async functions as option
1407 - Various external library patches
1409 ## [1.0.0] - 2020-01-24
1413 - FixedThreadPool implementation
1414 - DynamicThreadPool implementation
1415 - WorkerThread implementation to improve developer experience