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 - Ensure tasks stealing dynamic worker node is not destroyed on inactivity.
14 ## [4.0.9] - 2024-05-19
18 - Add ELU `utilization` statistics to pool information.
20 ## [4.0.8] - 2024-05-15
24 - Fix default task function worker choice strategy and priority handling.
26 ## [4.0.7] - 2024-05-13
30 - Add ELU statistics to pool information.
32 ## [4.0.6] - 2024-05-10
36 - Fix pools' `addTaskFunction()` type definition.
38 ## [4.0.5] - 2024-05-09
42 - Avoid queued tasks redistribution on the errored worker node.
44 ## [4.0.4] - 2024-05-08
48 - Disable `tasksStealingOnBackPressure` by default until performance issues under heavy load are sorted out.
50 ## [4.0.3] - 2024-05-08
54 - Optimize task(s) stealing by dequeuing task(s) from the last prioritized bucket.
56 ## [4.0.2] - 2024-05-06
60 - Ensure poolifier worker task performance measurement requirements are synchronized with task function objects' worker choice strategies.
62 ## [4.0.1] - 2024-05-02
66 - Ensure dynamic worker node are initialized with sensible worker node usage default values to avoid worker choice strategies biased decisions.
67 - 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.
69 ## [4.0.0] - 2024-04-30
73 - 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 }`.
74 - Add priority queue based tasks queueing. One priority queue is divided into prioritized buckets to avoid queued tasks starvation under load.
75 - BREAKING CHANGE: `listTaskFunctionNames()` to `listTaskFunctionsProperties()` in pool and worker API returning registered task functions properties.
76 - BREAKING CHANGE: `strategy` field in pool information renamed to `defaultStrategy`.
80 - Ensure worker choice strategy options changes at runtime are propagated to poolifier workers.
82 ## [3.1.30] - 2024-04-22
86 - Fix `transferList` argument type definition.
88 ## [3.1.29] - 2024-04-02
92 - Fix possible race condition at worker node recreation on worker `error` and `exit` events.
94 ## [3.1.28] - 2024-04-01
98 - Ensure the minimum number of workers on a started pool is guaranteed.
100 ## [3.1.27] - 2024-03-27
104 - Fix publishing on JSR, take 4.
106 ## [3.1.26] - 2024-03-27
110 - Fix publishing on JSR, take 3.
112 ## [3.1.25] - 2024-03-27
116 - Fix publishing on JSR, take 2.
118 ## [3.1.24] - 2024-03-27
122 - Fix publishing on JSR.
124 ## [3.1.23] - 2024-03-27
130 ## [3.1.22] - 2024-03-15
134 - Fix pool event emitter registered callbacks removal at `destroy()`.
136 ## [3.1.21] - 2024-02-22
140 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
142 ## [3.1.20] - 2024-02-11
146 - Ensure `worker_threads` workers are unreferenced at termination.
148 ## [3.1.19] - 2024-01-16
152 - Fix possible null exception at task finishing handling.
156 - Optimize Deque implementation to improve tasks queueing performance.
158 ## [3.1.18] - 2024-01-06
162 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
164 ## [3.1.17] - 2024-01-05
168 - Improve performance by clean up unneeded condition checks on hot code paths.
170 ## [3.1.16] - 2024-01-03
174 - Add missing type to TS type definitions.
176 ## [3.1.15] - 2024-01-02
180 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
182 ## [3.1.15-0] - 2024-01-02
186 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
188 ## [3.1.14] - 2024-01-01
192 - Properly handle dynamic pool with zero minimum size.
194 ## [3.1.13] - 2023-12-30
198 - Reduce branching in several hot code paths.
199 - Use faster object cloning implementation.
201 ## [3.1.12] - 2023-12-27
205 - Fix tasks redistribution triggers at pool destroying.
209 - Switch TypeScript module resolution to Node16.
211 ## [3.1.12-0] - 2023-12-27
215 - Fix tasks redistribution triggers at pool destroying.
217 ## [3.1.11] - 2023-12-24
221 - Avoid worker node cross tasks stealing.
222 - Ensure only half the pool worker nodes can steal tasks.
224 ## [3.1.10] - 2023-12-23
228 - Avoid useless branching on pool type.
230 ## [3.1.9] - 2023-12-22
234 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
236 ## [3.1.8] - 2023-12-21
240 - Fix default worker weight computation.
241 - Fix possible null exception at pool destroying.
243 ## [3.1.7] - 2023-12-20
247 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
249 ## [3.1.6] - 2023-12-18
253 - Fix pool destroying with tasks queuing enabled.
255 ## [3.1.5] - 2023-12-18
259 - Add queued tasks end timeout support to worker node termination.
261 ## [3.1.4] - 2023-12-18
265 - Make more robust the fix for possible null exception at handling task execution response.
267 ## [3.1.3] - 2023-12-17
271 - Fix possible null exception at handling task execution response.
273 ## [3.1.2] - 2023-12-17
277 - Wait for queued tasks to end at worker node termination.
279 ## [3.1.1] - 2023-12-16
283 - Fix pool options TS type definition.
285 ## [3.1.0] - 2023-12-16
289 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
291 ## [3.0.14] - 2023-12-13
295 - Fix possible null exception with worker_threads pools.
297 ## [3.0.13] - 2023-12-12
301 - Ensure worker choice strategy wait for worker nodes readiness.
305 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
307 ## [3.0.12] - 2023-12-12
311 - Add infinite retries support in worker choice strategy.
313 ## [3.0.11] - 2023-12-11
317 - Ensure pool asynchronous resource properly track tasks execution.
319 ## [3.0.10] - 2023-12-08
323 - Add a fastpath when tasks stealing or redistribution is impossible.
325 ## [3.0.9] - 2023-11-26
329 - Remove all pool events listener at pool destroying.
330 - Remove all worker node events listener at worker node destroying.
331 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
333 ## [3.0.8] - 2023-11-25
337 - Ensure continuous tasks stealing on idle start at worker node idling.
339 ## [3.0.7] - 2023-11-24
343 - Make continuous tasks stealing start at worker node idling.
345 ## [3.0.6] - 2023-11-24
349 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
350 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
352 ## [3.0.5] - 2023-10-27
356 - Ensure pool `ready` event can be emitted only once.
358 ## [3.0.4] - 2023-10-20
362 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
363 - Use builtin retry mechanism in worker choice strategies instead of custom one.
365 ## [3.0.3] - 2023-10-19
369 - Avoid null exception at sending message to worker.
370 - Avoid null exception at checking worker node readiness.
372 ## [3.0.2] - 2023-10-17
376 - 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).
378 ## [3.0.1] - 2023-10-16
382 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
386 - Switch the worker node eventing code to `EventTarget` API.
388 ## [3.0.0] - 2023-10-08
392 - Remove Node.js 16.x.x (EOL) support.
394 ## [2.7.5] - 2023-10-03
398 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
400 ## [2.7.4] - 2023-09-25
404 - Fix source maps (bundler issue).
406 ## [2.7.3] - 2023-09-24
410 - Convert pool event emitter to event emitter async resource.
412 ## [2.7.2] - 2023-09-23
416 - Add source maps to npm package to ease debugging.
420 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
422 ## [2.7.1] - 2023-09-20
426 - Ensure worker message listener used one time are removed after usage.
428 ## [2.7.0] - 2023-09-19
432 - Fix task stealing related tasks queue options handling at runtime.
436 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
440 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
441 - Stricter worker constructor arguments validation.
443 ## [2.6.45] - 2023-09-17
447 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
451 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
452 - Add `start()` method to pool API to start the minimum number of workers.
453 - 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.
454 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
456 ## [2.6.44] - 2023-09-08
460 - Use a dedicated PAT to publish on GitHub packages registry.
464 - Publish on GitHub packages registry on release.
468 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
470 ## [2.6.43] - 2023-09-08
474 - Publish on GitHub packages registry on release.
478 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
480 ## [2.6.42] - 2023-09-06
484 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
486 ## [2.6.41] - 2023-09-03
490 - Optimize worker choice strategies implementation.
492 ## [2.6.40] - 2023-09-01
496 - Do not pre-choose in WRR worker choice strategy to avoid bias.
497 - Avoid array out of bound in worker choice strategies after worker node removal.
499 ## [2.6.39] - 2023-08-30
503 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
505 ## [2.6.38] - 2023-08-30
509 - Bundle typescript types declaration into one file.
513 - Improve interleaved weighted round robin worker choice strategy implementation.
515 ## [2.6.37] - 2023-08-28
519 - Ensure unused worker usage statistics are deleted at runtime.
523 - Rename worker choice strategy options `choiceRetries` to `retries`.
524 - Avoid unnecessary branching in worker choice strategies.
526 ## [2.6.36] - 2023-08-27
530 - Fix pool `execute()` arguments check.
534 - Make continuous tasks stealing algorithm less aggressive.
535 - Fine tune tasks stealing algorithm under back pressure.
537 ## [2.6.35] - 2023-08-25
541 - Don't account worker usage statistics for tasks that have failed.
542 - Fix pool information runtime and wait time median computation.
546 - Update simple moving average implementation to use a circular buffer.
547 - Update simple moving median implementation to use a circular buffer.
548 - Account for stolen tasks in worker usage statistics and pool information.
552 - Continuous tasks stealing algorithm.
554 ## [2.6.34] - 2023-08-24
558 - Avoid cascading tasks stealing under back pressure.
562 - Add fastpath to queued tasks rescheduling.
564 ## [2.6.33] - 2023-08-24
568 - Fix queued tasks rescheduling.
572 - Rename tasks queue options `queueMaxSize` to `size`.
576 - Task stealing scheduling algorithm if tasks queueing is enabled.
578 ## [2.6.32] - 2023-08-23
582 - Ensure no task can be executed when the pool is destroyed.
586 - Add `queueMaxSize` option to tasks queue options.
587 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
588 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
590 ## [2.6.31] - 2023-08-20
594 - Fix worker choice strategy retries mechanism in some edge cases.
598 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
599 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
601 ## [2.6.30] - 2023-08-19
605 - Ensure pool event `backPressure` is emitted.
606 - Ensure pool event `full` is emitted only once.
607 - Ensure worker node cannot be instantiated without proper arguments.
609 ## [2.6.29] - 2023-08-18
613 - Fix race condition between readiness and task functions worker message handling at startup.
614 - Fix duplicate task function worker usage statistics computation per task function.
615 - Update task function worker usage statistics if and only if there's at least two different task functions.
616 - Fix race condition at task function worker usage executing task computation leading to negative value.
620 - 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).
621 - Use back pressure detection in worker choice strategies.
622 - Add worker choice strategies retries mechanism if no worker is eligible.
624 ## [2.6.28] - 2023-08-16
628 - Ensure pool workers are properly initialized.
632 - HTTP server pool examples: express-cluster, express-hybrid.
636 - Remove now useless branching in worker hot code path.
638 ## [2.6.27] - 2023-08-15
642 - Add `KillHandler` type definition to exported types.
646 - Add `destroy` event to pool API.
648 ## [2.6.26] - 2023-08-15
652 - Add kill handler to worker options allowing to execute custom code when worker is killed.
653 - Add `listTaskFunctions()` method to pool API.
654 - SMTP client pool example: nodemailer.
656 ## [2.6.25] - 2023-08-13
660 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
661 - WebSocket server pool examples: ws-cluster, ws-hybrid.
663 ## [2.6.24] - 2023-08-12
667 - Add array of transferable objects to the `execute()` method arguments.
668 - WebSocket server pool examples: ws-worker_threads.
670 ## [2.6.23] - 2023-08-11
674 - 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.
678 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
679 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
681 ## [2.6.22] - 2023-08-10
685 - Add missing `types` field to package.json `exports`.
689 - Structure markdown documentation (PR #811).
691 ## [2.6.21] - 2023-08-03
695 - Improve code documentation.
696 - Code refactoring and cleanup for better maintainability and readability.
698 ## [2.6.20] - 2023-07-21
702 - Fix queued tasks redistribution on error task execution starvation.
703 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
707 - Drastically reduce lookups by worker in the worker nodes.
709 ## [2.6.19] - 2023-07-20
713 - Dedicated internal communication channel for worker_threads pools.
715 ## [2.6.18] - 2023-07-19
719 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
721 ## [2.6.17] - 2023-07-16
725 - Add `listTaskFunctions()` method to worker API.
727 ## [2.6.16] - 2023-07-12
731 - Fix pool startup detection.
732 - Fix worker task functions handling.
734 ## [2.6.15] - 2023-07-11
738 - Take into account worker node readiness in worker choice strategies.
740 ## [2.6.14] - 2023-07-10
744 - Fix task function statistics tracking.
746 ## [2.6.13] - 2023-07-10
750 - Add per task function statistics tracking.
751 - Add public methods to manipulate the worker task functions at runtime.
753 ## [2.6.12] - 2023-07-09
757 - Workaround import issue with `node:os` module in node 16.x.x.
759 ## [2.6.11] - 2023-07-09
763 - Fix pool readiness semantic.
765 ## [2.6.10] - 2023-07-08
769 - Ensure workers are not recreated on error at pool startup.
773 - Add `ready` and `strategy` fields to pool information.
774 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
775 - Add dynamic pool sizing checks.
777 ## [2.6.9] - 2023-07-07
781 - Recreate the right worker type on uncaught exception.
785 - Add minimum and maximum to internal measurement statistics.
786 - Add `runTime` and `waitTime` to pool information.
787 - Check worker inactive time only on dynamic worker.
789 ## [2.6.8] - 2023-07-03
793 - Brown paper bag release to fix version handling in pool information.
795 ## [2.6.7] - 2023-07-03
799 - Ensure worker queued tasks at error are reassigned to other pool workers.
803 - Add pool `utilization` ratio to pool information.
804 - Add `version` to pool information.
805 - Add worker information to worker nodes.
807 ## [2.6.6] - 2023-07-01
811 - Add safe helper `availableParallelism()` to help sizing the pool.
815 - Ensure message handler is only registered in worker.
817 ## [2.6.5] - 2023-06-27
821 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
825 - Artificial version bump to 2.6.5 to workaround publication issue.
826 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
827 - Ensure pool event is emitted before task error promise rejection.
828 - Fix queued tasks count computation.
832 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
834 ## [2.6.4] - 2023-06-27
838 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
842 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
843 - Ensure pool event is emitted before task error promise rejection.
844 - Fix queued tasks count computation.
848 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
850 ## [2.6.3] - 2023-06-19
854 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
855 - Update strategies internals after statistics computation.
859 - Optimize O(1) queue implementation.
861 ## [2.6.2] - 2023-06-12
865 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
867 ## [2.6.1] - 2023-06-10
871 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
875 - Fix average statistics computation: ensure failed tasks are not accounted.
877 ## [2.6.0] - 2023-06-09
881 - Add `LEAST_ELU` worker choice strategy (experimental).
882 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
886 - Refactor pool worker node usage internals.
887 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
888 - Breaking change: pool information `info` property object fields have been renamed.
892 - Fix wait time accounting.
893 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
894 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
896 ## [2.5.4] - 2023-06-07
900 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
904 - Compute statistics at the worker level only if needed.
905 - Add `worker_threads` options to thread pool options.
909 - Make the `LEAST_BUSY` strategy only relies on task runtime.
911 ## [2.5.3] - 2023-06-04
915 - Refine pool information content.
916 - Limit pool internals public exposure.
918 ## [2.5.2] - 2023-06-02
922 - Add `taskError` pool event for task execution error.
923 - Add pool information `info` property to pool.
924 - Emit pool information on `busy` and `full` pool events.
926 ## [2.5.1] - 2023-06-01
930 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
931 - Add `error` pool event for uncaught worker error.
933 ## [2.5.0] - 2023-05-31
937 - Switch pool event emitter to `EventEmitterAsyncResource`.
938 - Add tasks wait time accounting in per worker tasks usage.
939 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
943 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
945 ## [2.4.14] - 2023-05-09
949 - Ensure no undefined task runtime can land in the tasks history.
950 - Fix median computation implementation once again.
954 - Unit tests for median and queue implementations.
956 ## [2.4.13] - 2023-05-08
960 - Fix worker choice strategy options validation.
961 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
963 ## [2.4.12] - 2023-05-06
967 - Support multiple task functions per worker.
968 - Add custom worker weights support to worker choice strategies options.
972 - Use O(1) queue implementation for tasks queueing.
976 - Fix median computation implementation.
977 - Fix fair share worker choice strategy internals update.
979 ## [2.4.11] - 2023-04-23
983 - Optimize free worker finding in worker choice strategies.
985 ## [2.4.10] - 2023-04-15
989 - Fix typescript type definition for task function: ensure the input data is optional.
990 - Fix typescript type definition for pool execute(): ensure the input data is optional.
992 ## [2.4.9] - 2023-04-15
996 - Add tasks queue enablement runtime setter to pool.
997 - Add tasks queue options runtime setter to pool.
998 - Add worker choice strategy options runtime setter to pool.
1002 - Remove the tasks queuing experimental status.
1006 - Fix task function type definition and validation.
1007 - Fix worker choice strategy options handling.
1009 ## [2.4.8] - 2023-04-12
1013 - Fix message between main worker and worker type definition for tasks.
1014 - Fix code documentation.
1016 ## [2.4.7] - 2023-04-11
1020 - Add worker tasks queue options to pool options.
1024 - Fix missing documentation.
1026 ## [2.4.6] - 2023-04-10
1030 - Ensure one task at a time is executed per worker with tasks queueing enabled.
1031 - Properly count worker executing tasks with tasks queueing enabled.
1033 ## [2.4.5] - 2023-04-09
1037 - Use monotonic high resolution timer for worker tasks runtime.
1038 - Add worker tasks median runtime to statistics.
1039 - Add worker tasks queue (experimental).
1041 ## [2.4.4] - 2023-04-07
1045 - Add `PoolEvents` enumeration and `PoolEvent` type.
1049 - Destroy worker only on alive check.
1051 ## [2.4.3] - 2023-04-07
1055 - Fix typedoc generation with inheritance.
1057 ## [2.4.2] - 2023-04-06
1061 - Add `full` event to dynamic pool.
1062 - Keep worker choice strategy in memory for conditional reuse.
1066 - Fix possible negative worker key at worker removal in worker choice strategies.
1068 ## [2.4.1] - 2023-04-05
1072 - Optimize worker choice strategy for dynamic pool.
1076 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
1078 ## [2.4.0] - 2023-04-04
1082 - Add `LESS_BUSY` worker choice strategy.
1086 - Optimize worker storage in pool.
1087 - Optimize worker alive status check.
1088 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1089 - Optimize `LESS_USED` worker choice strategy.
1090 - Update benchmark versus external threads pools.
1091 - Optimize tasks usage statistics requirements for worker choice strategy.
1095 - Ensure trimmable characters are checked at pool initialization.
1096 - Fix message id integer overflow.
1097 - Fix pool worker removal in worker choice strategy internals.
1098 - Fix package publication with pnpm.
1100 ## [2.4.0-3] - 2023-04-04
1104 - Add `LESS_BUSY` worker choice strategy.
1108 - Optimize worker storage in pool.
1109 - Optimize worker alive status check.
1110 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1111 - Optimize `LESS_USED` worker choice strategy.
1112 - Update benchmark versus external threads pools.
1116 - Ensure trimmable characters are checked at pool initialization.
1117 - Fix message id integer overflow.
1118 - Fix pool worker removal in worker choice strategy internals.
1119 - Fix package publication with pnpm.
1121 ## [2.4.0-2] - 2023-04-03
1125 - Add `LESS_BUSY` worker choice strategy.
1129 - Optimize worker storage in pool.
1130 - Optimize worker alive status check.
1131 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1132 - Optimize `LESS_USED` worker choice strategy.
1136 - Ensure trimmable characters are checked at pool initialization.
1137 - Fix message id integer overflow.
1138 - Fix pool worker removal in worker choice strategy internals.
1139 - Fix package publication with pnpm.
1141 ## [2.4.0-1] - 2023-04-03
1145 - Add `LESS_BUSY` worker choice strategy.
1149 - Optimize worker storage in pool.
1150 - Optimize worker alive status check.
1151 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1152 - Optimize `LESS_USED` worker choice strategy.
1156 - Ensure trimmable characters are checked at pool initialization.
1157 - Fix message id integer overflow.
1158 - Fix pool worker removal in worker choice strategy internals.
1160 ## [2.4.0-0] - 2023-04-03
1164 - Add `LESS_BUSY` worker choice strategy.
1168 - Optimize worker storage in pool.
1169 - Optimize worker alive status check.
1170 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1171 - Optimize `LESS_USED` worker choice strategy.
1175 - Ensure trimmable characters are checked at pool initialization.
1176 - Fix message id integer overflow.
1177 - Fix pool worker removal in worker choice strategy internals.
1179 ## [2.3.10] - 2023-03-18
1183 - Fix package.json `exports` syntax for ESM and CommonJS.
1187 - Permit SemVer pre-release publication.
1189 ## [2.3.10-2] - 2023-03-18
1193 - Fix package.json `exports` syntax for ESM and CommonJS.
1195 ## [2.3.10-1] - 2023-03-18
1199 - Permit SemVer pre-release publication.
1201 ## [2.3.10-0] - 2023-03-18
1205 - Fix package.json `exports` syntax for ESM and CommonJS.
1207 ## [2.3.9] - 2023-03-18
1211 - Introduce ESM module support along with CommonJS one.
1215 - Fix brown paper bag bug referencing the same object literal.
1217 ## [2.3.8] - 2023-03-18
1221 - Switch internal benchmarking code to benny.
1222 - Switch to TypeScript 5.x.x.
1223 - Switch rollup bundler plugins to core ones.
1224 - Switch to TSDoc syntax.
1225 - Enforce conventional commits.
1229 - Fix random integer generator.
1230 - Fix worker choice strategy pool type identification at initialization.
1232 ## [2.3.7] - 2022-10-23
1236 - Switch to open collective FOSS project funding platform.
1237 - Switch to ts-standard linter configuration on TypeScript code.
1241 - Fixed missing async on pool execute method.
1242 - Fixed typing in TypeScript example.
1243 - Fixed types in unit tests.
1245 ## [2.3.6] - 2022-10-22
1249 - Cleanup pool attributes and methods.
1250 - Refine error types thrown.
1254 - Fix continuous integration build on windows.
1255 - Fix code coverage reporting by using c8 instead of nyc.
1257 ## [2.3.5] - 2022-10-21
1261 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1262 - Optimize tasks usage lookup implementation.
1266 - Fix missed pool event emitter type export.
1267 - Fix typedoc documentation generation.
1269 ## [2.3.4] - 2022-10-17
1273 - Fully automate release process with release-it.
1277 - Optimize fair share task scheduling algorithm implementation.
1278 - Update benchmark versus external pools results with latest version.
1280 ## [2.3.3] - 2022-10-15
1284 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1286 ## [2.3.2] - 2022-10-14
1290 - Optimize fair share worker selection strategy implementation.
1294 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1296 ## [2.3.1] - 2022-10-13
1300 - Pool worker choice strategies:
1301 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1302 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1304 ## [2.2.2] - 2022-10-09
1308 - Fixed `README.md` file.
1310 ## [2.2.1] - 2022-10-08
1314 - Dynamic worker choice strategy change at runtime.
1316 ## [2.2.0] - 2022-01-05
1318 ### Breaking Changes
1320 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1322 ## [2.1.0] - 2021-08-29
1326 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1328 ### Breaking Changes
1330 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1331 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1332 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1333 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1335 ## [2.0.2] - 2021-05-12
1339 - Fix `busy` event emission on fixed pool type
1341 ## [2.0.1] - 2021-03-16
1345 - Check if pool options are properly set.
1346 - `busy` event is emitted on all pool types.
1348 ## [2.0.0] - 2021-03-01
1352 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1354 ### Breaking Changes
1356 - `FullPool` event is now renamed to `busy`.
1357 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1358 _Find more details on our JSDoc._
1360 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1362 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1364 ### Pool options types declaration merge
1366 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1368 #### New `export` strategy
1372 const DynamicThreadPool = require('poolifier/lib/dynamic')
1374 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1377 But you should always prefer just using
1380 const { DynamicThreadPool } = require('poolifier')
1383 #### New type definitions for input data and response
1385 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1386 _This is not a limitation by poolifier but Node.js._
1388 #### Public property replacements
1390 `numWorkers` property is now `numberOfWorkers`
1392 #### Internal (protected) properties and methods renaming
1394 These properties are not intended for end users
1396 - `id` => `nextMessageId`
1398 These methods are not intended for end users
1400 - `_chooseWorker` => `chooseWorker`
1401 - `_newWorker` => `createWorker`
1402 - `_execute` => `internalExecute`
1403 - `_chooseWorker` => `chooseWorker`
1404 - `_checkAlive` => `checkAlive`
1406 - `_runAsync` => `runAsync`
1408 ## [1.1.0] - 2020-05-21
1412 - ThreadWorker support async functions as option
1413 - Various external library patches
1415 ## [1.0.0] - 2020-01-24
1419 - FixedThreadPool implementation
1420 - DynamicThreadPool implementation
1421 - WorkerThread implementation to improve developer experience