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 mapExecute() helper to execute a task function on an iterable data's input
13 and return an array of responses.
15 ## [4.0.13] - 2024-05-29
19 - Optimize tasks queue implementation.
20 - Enable prioritized tasks queueing only when necessary.
22 ## [4.0.12] - 2024-05-25
26 - Optimize circular buffer implementation to store task execution measurements.
28 ## [4.0.11] - 2024-05-21
32 - Switch to optimized circular buffer implementation to store task execution measurements.
34 ## [4.0.10] - 2024-05-20
38 - Ensure tasks stealing dynamic worker node is not destroyed on inactivity.
40 ## [4.0.9] - 2024-05-19
44 - Add ELU `utilization` statistics to pool information.
46 ## [4.0.8] - 2024-05-15
50 - Fix default task function worker choice strategy and priority handling.
52 ## [4.0.7] - 2024-05-13
56 - Add ELU statistics to pool information.
58 ## [4.0.6] - 2024-05-10
62 - Fix pools' `addTaskFunction()` type definition.
64 ## [4.0.5] - 2024-05-09
68 - Avoid queued tasks redistribution on the errored worker node.
70 ## [4.0.4] - 2024-05-08
74 - Disable `tasksStealingOnBackPressure` by default until performance issues under heavy load are sorted out.
76 ## [4.0.3] - 2024-05-08
80 - Optimize task(s) stealing by dequeuing task(s) from the last prioritized bucket.
82 ## [4.0.2] - 2024-05-06
86 - Ensure poolifier worker task performance measurement requirements are synchronized with task function objects' worker choice strategies.
88 ## [4.0.1] - 2024-05-02
92 - Ensure dynamic worker node are initialized with sensible worker node usage default values to avoid worker choice strategies biased decisions.
93 - 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.
95 ## [4.0.0] - 2024-04-30
99 - 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 }`.
100 - Add priority queue based tasks queueing. One priority queue is divided into prioritized buckets to avoid queued tasks starvation under load.
101 - BREAKING CHANGE: `listTaskFunctionNames()` to `listTaskFunctionsProperties()` in pool and worker API returning registered task functions properties.
102 - BREAKING CHANGE: `strategy` field in pool information renamed to `defaultStrategy`.
106 - Ensure worker choice strategy options changes at runtime are propagated to poolifier workers.
108 ## [3.1.30] - 2024-04-22
112 - Fix `transferList` argument type definition.
114 ## [3.1.29] - 2024-04-02
118 - Fix possible race condition at worker node recreation on worker `error` and `exit` events.
120 ## [3.1.28] - 2024-04-01
124 - Ensure the minimum number of workers on a started pool is guaranteed.
126 ## [3.1.27] - 2024-03-27
130 - Fix publishing on JSR, take 4.
132 ## [3.1.26] - 2024-03-27
136 - Fix publishing on JSR, take 3.
138 ## [3.1.25] - 2024-03-27
142 - Fix publishing on JSR, take 2.
144 ## [3.1.24] - 2024-03-27
148 - Fix publishing on JSR.
150 ## [3.1.23] - 2024-03-27
156 ## [3.1.22] - 2024-03-15
160 - Fix pool event emitter registered callbacks removal at `destroy()`.
162 ## [3.1.21] - 2024-02-22
166 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
168 ## [3.1.20] - 2024-02-11
172 - Ensure `worker_threads` workers are unreferenced at termination.
174 ## [3.1.19] - 2024-01-16
178 - Fix possible null exception at task finishing handling.
182 - Optimize Deque implementation to improve tasks queueing performance.
184 ## [3.1.18] - 2024-01-06
188 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
190 ## [3.1.17] - 2024-01-05
194 - Improve performance by clean up unneeded condition checks on hot code paths.
196 ## [3.1.16] - 2024-01-03
200 - Add missing type to TS type definitions.
202 ## [3.1.15] - 2024-01-02
206 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
208 ## [3.1.15-0] - 2024-01-02
212 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
214 ## [3.1.14] - 2024-01-01
218 - Properly handle dynamic pool with zero minimum size.
220 ## [3.1.13] - 2023-12-30
224 - Reduce branching in several hot code paths.
225 - Use faster object cloning implementation.
227 ## [3.1.12] - 2023-12-27
231 - Fix tasks redistribution triggers at pool destroying.
235 - Switch TypeScript module resolution to Node16.
237 ## [3.1.12-0] - 2023-12-27
241 - Fix tasks redistribution triggers at pool destroying.
243 ## [3.1.11] - 2023-12-24
247 - Avoid worker node cross tasks stealing.
248 - Ensure only half the pool worker nodes can steal tasks.
250 ## [3.1.10] - 2023-12-23
254 - Avoid useless branching on pool type.
256 ## [3.1.9] - 2023-12-22
260 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
262 ## [3.1.8] - 2023-12-21
266 - Fix default worker weight computation.
267 - Fix possible null exception at pool destroying.
269 ## [3.1.7] - 2023-12-20
273 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
275 ## [3.1.6] - 2023-12-18
279 - Fix pool destroying with tasks queuing enabled.
281 ## [3.1.5] - 2023-12-18
285 - Add queued tasks end timeout support to worker node termination.
287 ## [3.1.4] - 2023-12-18
291 - Make more robust the fix for possible null exception at handling task execution response.
293 ## [3.1.3] - 2023-12-17
297 - Fix possible null exception at handling task execution response.
299 ## [3.1.2] - 2023-12-17
303 - Wait for queued tasks to end at worker node termination.
305 ## [3.1.1] - 2023-12-16
309 - Fix pool options TS type definition.
311 ## [3.1.0] - 2023-12-16
315 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
317 ## [3.0.14] - 2023-12-13
321 - Fix possible null exception with worker_threads pools.
323 ## [3.0.13] - 2023-12-12
327 - Ensure worker choice strategy wait for worker nodes readiness.
331 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
333 ## [3.0.12] - 2023-12-12
337 - Add infinite retries support in worker choice strategy.
339 ## [3.0.11] - 2023-12-11
343 - Ensure pool asynchronous resource properly track tasks execution.
345 ## [3.0.10] - 2023-12-08
349 - Add a fastpath when tasks stealing or redistribution is impossible.
351 ## [3.0.9] - 2023-11-26
355 - Remove all pool events listener at pool destroying.
356 - Remove all worker node events listener at worker node destroying.
357 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
359 ## [3.0.8] - 2023-11-25
363 - Ensure continuous tasks stealing on idle start at worker node idling.
365 ## [3.0.7] - 2023-11-24
369 - Make continuous tasks stealing start at worker node idling.
371 ## [3.0.6] - 2023-11-24
375 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
376 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
378 ## [3.0.5] - 2023-10-27
382 - Ensure pool `ready` event can be emitted only once.
384 ## [3.0.4] - 2023-10-20
388 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
389 - Use builtin retry mechanism in worker choice strategies instead of custom one.
391 ## [3.0.3] - 2023-10-19
395 - Avoid null exception at sending message to worker.
396 - Avoid null exception at checking worker node readiness.
398 ## [3.0.2] - 2023-10-17
402 - 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).
404 ## [3.0.1] - 2023-10-16
408 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
412 - Switch the worker node eventing code to `EventTarget` API.
414 ## [3.0.0] - 2023-10-08
418 - Remove Node.js 16.x.x (EOL) support.
420 ## [2.7.5] - 2023-10-03
424 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
426 ## [2.7.4] - 2023-09-25
430 - Fix source maps (bundler issue).
432 ## [2.7.3] - 2023-09-24
436 - Convert pool event emitter to event emitter async resource.
438 ## [2.7.2] - 2023-09-23
442 - Add source maps to npm package to ease debugging.
446 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
448 ## [2.7.1] - 2023-09-20
452 - Ensure worker message listener used one time are removed after usage.
454 ## [2.7.0] - 2023-09-19
458 - Fix task stealing related tasks queue options handling at runtime.
462 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
466 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
467 - Stricter worker constructor arguments validation.
469 ## [2.6.45] - 2023-09-17
473 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
477 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
478 - Add `start()` method to pool API to start the minimum number of workers.
479 - 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.
480 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
482 ## [2.6.44] - 2023-09-08
486 - Use a dedicated PAT to publish on GitHub packages registry.
490 - Publish on GitHub packages registry on release.
494 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
496 ## [2.6.43] - 2023-09-08
500 - Publish on GitHub packages registry on release.
504 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
506 ## [2.6.42] - 2023-09-06
510 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
512 ## [2.6.41] - 2023-09-03
516 - Optimize worker choice strategies implementation.
518 ## [2.6.40] - 2023-09-01
522 - Do not pre-choose in WRR worker choice strategy to avoid bias.
523 - Avoid array out of bound in worker choice strategies after worker node removal.
525 ## [2.6.39] - 2023-08-30
529 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
531 ## [2.6.38] - 2023-08-30
535 - Bundle typescript types declaration into one file.
539 - Improve interleaved weighted round robin worker choice strategy implementation.
541 ## [2.6.37] - 2023-08-28
545 - Ensure unused worker usage statistics are deleted at runtime.
549 - Rename worker choice strategy options `choiceRetries` to `retries`.
550 - Avoid unnecessary branching in worker choice strategies.
552 ## [2.6.36] - 2023-08-27
556 - Fix pool `execute()` arguments check.
560 - Make continuous tasks stealing algorithm less aggressive.
561 - Fine tune tasks stealing algorithm under back pressure.
563 ## [2.6.35] - 2023-08-25
567 - Don't account worker usage statistics for tasks that have failed.
568 - Fix pool information runtime and wait time median computation.
572 - Update simple moving average implementation to use a circular buffer.
573 - Update simple moving median implementation to use a circular buffer.
574 - Account for stolen tasks in worker usage statistics and pool information.
578 - Continuous tasks stealing algorithm.
580 ## [2.6.34] - 2023-08-24
584 - Avoid cascading tasks stealing under back pressure.
588 - Add fastpath to queued tasks rescheduling.
590 ## [2.6.33] - 2023-08-24
594 - Fix queued tasks rescheduling.
598 - Rename tasks queue options `queueMaxSize` to `size`.
602 - Task stealing scheduling algorithm if tasks queueing is enabled.
604 ## [2.6.32] - 2023-08-23
608 - Ensure no task can be executed when the pool is destroyed.
612 - Add `queueMaxSize` option to tasks queue options.
613 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
614 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
616 ## [2.6.31] - 2023-08-20
620 - Fix worker choice strategy retries mechanism in some edge cases.
624 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
625 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
627 ## [2.6.30] - 2023-08-19
631 - Ensure pool event `backPressure` is emitted.
632 - Ensure pool event `full` is emitted only once.
633 - Ensure worker node cannot be instantiated without proper arguments.
635 ## [2.6.29] - 2023-08-18
639 - Fix race condition between readiness and task functions worker message handling at startup.
640 - Fix duplicate task function worker usage statistics computation per task function.
641 - Update task function worker usage statistics if and only if there's at least two different task functions.
642 - Fix race condition at task function worker usage executing task computation leading to negative value.
646 - 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).
647 - Use back pressure detection in worker choice strategies.
648 - Add worker choice strategies retries mechanism if no worker is eligible.
650 ## [2.6.28] - 2023-08-16
654 - Ensure pool workers are properly initialized.
658 - HTTP server pool examples: express-cluster, express-hybrid.
662 - Remove now useless branching in worker hot code path.
664 ## [2.6.27] - 2023-08-15
668 - Add `KillHandler` type definition to exported types.
672 - Add `destroy` event to pool API.
674 ## [2.6.26] - 2023-08-15
678 - Add kill handler to worker options allowing to execute custom code when worker is killed.
679 - Add `listTaskFunctions()` method to pool API.
680 - SMTP client pool example: nodemailer.
682 ## [2.6.25] - 2023-08-13
686 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
687 - WebSocket server pool examples: ws-cluster, ws-hybrid.
689 ## [2.6.24] - 2023-08-12
693 - Add array of transferable objects to the `execute()` method arguments.
694 - WebSocket server pool examples: ws-worker_threads.
696 ## [2.6.23] - 2023-08-11
700 - 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.
704 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
705 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
707 ## [2.6.22] - 2023-08-10
711 - Add missing `types` field to package.json `exports`.
715 - Structure markdown documentation (PR #811).
717 ## [2.6.21] - 2023-08-03
721 - Improve code documentation.
722 - Code refactoring and cleanup for better maintainability and readability.
724 ## [2.6.20] - 2023-07-21
728 - Fix queued tasks redistribution on error task execution starvation.
729 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
733 - Drastically reduce lookups by worker in the worker nodes.
735 ## [2.6.19] - 2023-07-20
739 - Dedicated internal communication channel for worker_threads pools.
741 ## [2.6.18] - 2023-07-19
745 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
747 ## [2.6.17] - 2023-07-16
751 - Add `listTaskFunctions()` method to worker API.
753 ## [2.6.16] - 2023-07-12
757 - Fix pool startup detection.
758 - Fix worker task functions handling.
760 ## [2.6.15] - 2023-07-11
764 - Take into account worker node readiness in worker choice strategies.
766 ## [2.6.14] - 2023-07-10
770 - Fix task function statistics tracking.
772 ## [2.6.13] - 2023-07-10
776 - Add per task function statistics tracking.
777 - Add public methods to manipulate the worker task functions at runtime.
779 ## [2.6.12] - 2023-07-09
783 - Workaround import issue with `node:os` module in node 16.x.x.
785 ## [2.6.11] - 2023-07-09
789 - Fix pool readiness semantic.
791 ## [2.6.10] - 2023-07-08
795 - Ensure workers are not recreated on error at pool startup.
799 - Add `ready` and `strategy` fields to pool information.
800 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
801 - Add dynamic pool sizing checks.
803 ## [2.6.9] - 2023-07-07
807 - Recreate the right worker type on uncaught exception.
811 - Add minimum and maximum to internal measurement statistics.
812 - Add `runTime` and `waitTime` to pool information.
813 - Check worker inactive time only on dynamic worker.
815 ## [2.6.8] - 2023-07-03
819 - Brown paper bag release to fix version handling in pool information.
821 ## [2.6.7] - 2023-07-03
825 - Ensure worker queued tasks at error are reassigned to other pool workers.
829 - Add pool `utilization` ratio to pool information.
830 - Add `version` to pool information.
831 - Add worker information to worker nodes.
833 ## [2.6.6] - 2023-07-01
837 - Add safe helper `availableParallelism()` to help sizing the pool.
841 - Ensure message handler is only registered in worker.
843 ## [2.6.5] - 2023-06-27
847 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
851 - Artificial version bump to 2.6.5 to workaround publication issue.
852 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
853 - Ensure pool event is emitted before task error promise rejection.
854 - Fix queued tasks count computation.
858 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
860 ## [2.6.4] - 2023-06-27
864 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
868 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
869 - Ensure pool event is emitted before task error promise rejection.
870 - Fix queued tasks count computation.
874 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
876 ## [2.6.3] - 2023-06-19
880 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
881 - Update strategies internals after statistics computation.
885 - Optimize O(1) queue implementation.
887 ## [2.6.2] - 2023-06-12
891 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
893 ## [2.6.1] - 2023-06-10
897 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
901 - Fix average statistics computation: ensure failed tasks are not accounted.
903 ## [2.6.0] - 2023-06-09
907 - Add `LEAST_ELU` worker choice strategy (experimental).
908 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
912 - Refactor pool worker node usage internals.
913 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
914 - Breaking change: pool information `info` property object fields have been renamed.
918 - Fix wait time accounting.
919 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
920 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
922 ## [2.5.4] - 2023-06-07
926 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
930 - Compute statistics at the worker level only if needed.
931 - Add `worker_threads` options to thread pool options.
935 - Make the `LEAST_BUSY` strategy only relies on task runtime.
937 ## [2.5.3] - 2023-06-04
941 - Refine pool information content.
942 - Limit pool internals public exposure.
944 ## [2.5.2] - 2023-06-02
948 - Add `taskError` pool event for task execution error.
949 - Add pool information `info` property to pool.
950 - Emit pool information on `busy` and `full` pool events.
952 ## [2.5.1] - 2023-06-01
956 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
957 - Add `error` pool event for uncaught worker error.
959 ## [2.5.0] - 2023-05-31
963 - Switch pool event emitter to `EventEmitterAsyncResource`.
964 - Add tasks wait time accounting in per worker tasks usage.
965 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
969 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
971 ## [2.4.14] - 2023-05-09
975 - Ensure no undefined task runtime can land in the tasks history.
976 - Fix median computation implementation once again.
980 - Unit tests for median and queue implementations.
982 ## [2.4.13] - 2023-05-08
986 - Fix worker choice strategy options validation.
987 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
989 ## [2.4.12] - 2023-05-06
993 - Support multiple task functions per worker.
994 - Add custom worker weights support to worker choice strategies options.
998 - Use O(1) queue implementation for tasks queueing.
1002 - Fix median computation implementation.
1003 - Fix fair share worker choice strategy internals update.
1005 ## [2.4.11] - 2023-04-23
1009 - Optimize free worker finding in worker choice strategies.
1011 ## [2.4.10] - 2023-04-15
1015 - Fix typescript type definition for task function: ensure the input data is optional.
1016 - Fix typescript type definition for pool execute(): ensure the input data is optional.
1018 ## [2.4.9] - 2023-04-15
1022 - Add tasks queue enablement runtime setter to pool.
1023 - Add tasks queue options runtime setter to pool.
1024 - Add worker choice strategy options runtime setter to pool.
1028 - Remove the tasks queuing experimental status.
1032 - Fix task function type definition and validation.
1033 - Fix worker choice strategy options handling.
1035 ## [2.4.8] - 2023-04-12
1039 - Fix message between main worker and worker type definition for tasks.
1040 - Fix code documentation.
1042 ## [2.4.7] - 2023-04-11
1046 - Add worker tasks queue options to pool options.
1050 - Fix missing documentation.
1052 ## [2.4.6] - 2023-04-10
1056 - Ensure one task at a time is executed per worker with tasks queueing enabled.
1057 - Properly count worker executing tasks with tasks queueing enabled.
1059 ## [2.4.5] - 2023-04-09
1063 - Use monotonic high resolution timer for worker tasks runtime.
1064 - Add worker tasks median runtime to statistics.
1065 - Add worker tasks queue (experimental).
1067 ## [2.4.4] - 2023-04-07
1071 - Add `PoolEvents` enumeration and `PoolEvent` type.
1075 - Destroy worker only on alive check.
1077 ## [2.4.3] - 2023-04-07
1081 - Fix typedoc generation with inheritance.
1083 ## [2.4.2] - 2023-04-06
1087 - Add `full` event to dynamic pool.
1088 - Keep worker choice strategy in memory for conditional reuse.
1092 - Fix possible negative worker key at worker removal in worker choice strategies.
1094 ## [2.4.1] - 2023-04-05
1098 - Optimize worker choice strategy for dynamic pool.
1102 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
1104 ## [2.4.0] - 2023-04-04
1108 - Add `LESS_BUSY` worker choice strategy.
1112 - Optimize worker storage in pool.
1113 - Optimize worker alive status check.
1114 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1115 - Optimize `LESS_USED` worker choice strategy.
1116 - Update benchmark versus external threads pools.
1117 - Optimize tasks usage statistics requirements for worker choice strategy.
1121 - Ensure trimmable characters are checked at pool initialization.
1122 - Fix message id integer overflow.
1123 - Fix pool worker removal in worker choice strategy internals.
1124 - Fix package publication with pnpm.
1126 ## [2.4.0-3] - 2023-04-04
1130 - Add `LESS_BUSY` worker choice strategy.
1134 - Optimize worker storage in pool.
1135 - Optimize worker alive status check.
1136 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1137 - Optimize `LESS_USED` worker choice strategy.
1138 - Update benchmark versus external threads pools.
1142 - Ensure trimmable characters are checked at pool initialization.
1143 - Fix message id integer overflow.
1144 - Fix pool worker removal in worker choice strategy internals.
1145 - Fix package publication with pnpm.
1147 ## [2.4.0-2] - 2023-04-03
1151 - Add `LESS_BUSY` worker choice strategy.
1155 - Optimize worker storage in pool.
1156 - Optimize worker alive status check.
1157 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1158 - Optimize `LESS_USED` worker choice strategy.
1162 - Ensure trimmable characters are checked at pool initialization.
1163 - Fix message id integer overflow.
1164 - Fix pool worker removal in worker choice strategy internals.
1165 - Fix package publication with pnpm.
1167 ## [2.4.0-1] - 2023-04-03
1171 - Add `LESS_BUSY` worker choice strategy.
1175 - Optimize worker storage in pool.
1176 - Optimize worker alive status check.
1177 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1178 - Optimize `LESS_USED` worker choice strategy.
1182 - Ensure trimmable characters are checked at pool initialization.
1183 - Fix message id integer overflow.
1184 - Fix pool worker removal in worker choice strategy internals.
1186 ## [2.4.0-0] - 2023-04-03
1190 - Add `LESS_BUSY` worker choice strategy.
1194 - Optimize worker storage in pool.
1195 - Optimize worker alive status check.
1196 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1197 - Optimize `LESS_USED` worker choice strategy.
1201 - Ensure trimmable characters are checked at pool initialization.
1202 - Fix message id integer overflow.
1203 - Fix pool worker removal in worker choice strategy internals.
1205 ## [2.3.10] - 2023-03-18
1209 - Fix package.json `exports` syntax for ESM and CommonJS.
1213 - Permit SemVer pre-release publication.
1215 ## [2.3.10-2] - 2023-03-18
1219 - Fix package.json `exports` syntax for ESM and CommonJS.
1221 ## [2.3.10-1] - 2023-03-18
1225 - Permit SemVer pre-release publication.
1227 ## [2.3.10-0] - 2023-03-18
1231 - Fix package.json `exports` syntax for ESM and CommonJS.
1233 ## [2.3.9] - 2023-03-18
1237 - Introduce ESM module support along with CommonJS one.
1241 - Fix brown paper bag bug referencing the same object literal.
1243 ## [2.3.8] - 2023-03-18
1247 - Switch internal benchmarking code to benny.
1248 - Switch to TypeScript 5.x.x.
1249 - Switch rollup bundler plugins to core ones.
1250 - Switch to TSDoc syntax.
1251 - Enforce conventional commits.
1255 - Fix random integer generator.
1256 - Fix worker choice strategy pool type identification at initialization.
1258 ## [2.3.7] - 2022-10-23
1262 - Switch to open collective FOSS project funding platform.
1263 - Switch to ts-standard linter configuration on TypeScript code.
1267 - Fixed missing async on pool execute method.
1268 - Fixed typing in TypeScript example.
1269 - Fixed types in unit tests.
1271 ## [2.3.6] - 2022-10-22
1275 - Cleanup pool attributes and methods.
1276 - Refine error types thrown.
1280 - Fix continuous integration build on windows.
1281 - Fix code coverage reporting by using c8 instead of nyc.
1283 ## [2.3.5] - 2022-10-21
1287 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1288 - Optimize tasks usage lookup implementation.
1292 - Fix missed pool event emitter type export.
1293 - Fix typedoc documentation generation.
1295 ## [2.3.4] - 2022-10-17
1299 - Fully automate release process with release-it.
1303 - Optimize fair share task scheduling algorithm implementation.
1304 - Update benchmark versus external pools results with latest version.
1306 ## [2.3.3] - 2022-10-15
1310 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1312 ## [2.3.2] - 2022-10-14
1316 - Optimize fair share worker selection strategy implementation.
1320 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1322 ## [2.3.1] - 2022-10-13
1326 - Pool worker choice strategies:
1327 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1328 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1330 ## [2.2.2] - 2022-10-09
1334 - Fixed `README.md` file.
1336 ## [2.2.1] - 2022-10-08
1340 - Dynamic worker choice strategy change at runtime.
1342 ## [2.2.0] - 2022-01-05
1344 ### Breaking Changes
1346 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1348 ## [2.1.0] - 2021-08-29
1352 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1354 ### Breaking Changes
1356 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1357 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1358 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1359 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1361 ## [2.0.2] - 2021-05-12
1365 - Fix `busy` event emission on fixed pool type
1367 ## [2.0.1] - 2021-03-16
1371 - Check if pool options are properly set.
1372 - `busy` event is emitted on all pool types.
1374 ## [2.0.0] - 2021-03-01
1378 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1380 ### Breaking Changes
1382 - `FullPool` event is now renamed to `busy`.
1383 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1384 _Find more details on our JSDoc._
1386 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1388 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1390 ### Pool options types declaration merge
1392 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1394 #### New `export` strategy
1398 const DynamicThreadPool = require('poolifier/lib/dynamic')
1400 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1403 But you should always prefer just using
1406 const { DynamicThreadPool } = require('poolifier')
1409 #### New type definitions for input data and response
1411 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1412 _This is not a limitation by poolifier but Node.js._
1414 #### Public property replacements
1416 `numWorkers` property is now `numberOfWorkers`
1418 #### Internal (protected) properties and methods renaming
1420 These properties are not intended for end users
1422 - `id` => `nextMessageId`
1424 These methods are not intended for end users
1426 - `_chooseWorker` => `chooseWorker`
1427 - `_newWorker` => `createWorker`
1428 - `_execute` => `internalExecute`
1429 - `_chooseWorker` => `chooseWorker`
1430 - `_checkAlive` => `checkAlive`
1432 - `_runAsync` => `runAsync`
1434 ## [1.1.0] - 2020-05-21
1438 - ThreadWorker support async functions as option
1439 - Various external library patches
1441 ## [1.0.0] - 2020-01-24
1445 - FixedThreadPool implementation
1446 - DynamicThreadPool implementation
1447 - WorkerThread implementation to improve developer experience