3 All notable changes to this project will be documented in this file.
5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
12 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
14 ## [3.1.17] - 2024-01-05
18 - Improve performance by clean up unneeded condition checks on hot code paths.
20 ## [3.1.16] - 2024-01-03
24 - Add missing type to TS type definitions.
26 ## [3.1.15] - 2024-01-02
30 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
32 ## [3.1.15-0] - 2024-01-02
36 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
38 ## [3.1.14] - 2024-01-01
42 - Properly handle dynamic pool with zero minimum size.
44 ## [3.1.13] - 2023-12-30
48 - Reduce branching in several hot code paths.
49 - Use faster object cloning implementation.
51 ## [3.1.12] - 2023-12-27
55 - Fix tasks redistribution triggers at pool destroying.
59 - Switch TypeScript module resolution to Node16.
61 ## [3.1.12-0] - 2023-12-27
65 - Fix tasks redistribution triggers at pool destroying.
67 ## [3.1.11] - 2023-12-24
71 - Avoid worker node cross tasks stealing.
72 - Ensure only half the pool worker nodes can steal tasks.
74 ## [3.1.10] - 2023-12-23
78 - Avoid useless branching on pool type.
80 ## [3.1.9] - 2023-12-22
84 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
86 ## [3.1.8] - 2023-12-21
90 - Fix default worker weight computation.
91 - Fix possible null exception at pool destroying.
93 ## [3.1.7] - 2023-12-20
97 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
99 ## [3.1.6] - 2023-12-18
103 - Fix pool destroying with tasks queuing enabled.
105 ## [3.1.5] - 2023-12-18
109 - Add queued tasks end timeout support to worker node termination.
111 ## [3.1.4] - 2023-12-18
115 - Make more robust the fix for possible null exception at handling task execution response.
117 ## [3.1.3] - 2023-12-17
121 - Fix possible null exception at handling task execution response.
123 ## [3.1.2] - 2023-12-17
127 - Wait for queued tasks to end at worker node termination.
129 ## [3.1.1] - 2023-12-16
133 - Fix pool options TS type definition.
135 ## [3.1.0] - 2023-12-16
139 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
141 ## [3.0.14] - 2023-12-13
145 - Fix possible null exception with worker_threads pools.
147 ## [3.0.13] - 2023-12-12
151 - Ensure worker choice strategy wait for worker nodes readiness.
155 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
157 ## [3.0.12] - 2023-12-12
161 - Add infinite retries support in worker choice strategy.
163 ## [3.0.11] - 2023-12-11
167 - Ensure pool asynchronous resource properly track tasks execution.
169 ## [3.0.10] - 2023-12-08
173 - Add a fastpath when tasks stealing or redistribution is impossible.
175 ## [3.0.9] - 2023-11-26
179 - Remove all pool events listener at pool destroying.
180 - Remove all worker node events listener at worker node destroying.
181 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
183 ## [3.0.8] - 2023-11-25
187 - Ensure continuous tasks stealing on idle start at worker node idling.
189 ## [3.0.7] - 2023-11-24
193 - Make continuous tasks stealing start at worker node idling.
195 ## [3.0.6] - 2023-11-24
199 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
200 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
202 ## [3.0.5] - 2023-10-27
206 - Ensure pool `ready` event can be emitted only once.
208 ## [3.0.4] - 2023-10-20
212 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
213 - Use builtin retry mechanism in worker choice strategies instead of custom one.
215 ## [3.0.3] - 2023-10-19
219 - Avoid null exception at sending message to worker.
220 - Avoid null exception at checking worker node readiness.
222 ## [3.0.2] - 2023-10-17
226 - 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).
228 ## [3.0.1] - 2023-10-16
232 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
236 - Switch the worker node eventing code to `EventTarget` API.
238 ## [3.0.0] - 2023-10-08
242 - Remove Node.js 16.x.x (EOL) support.
244 ## [2.7.5] - 2023-10-03
248 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
250 ## [2.7.4] - 2023-09-25
254 - Fix source maps (bundler issue).
256 ## [2.7.3] - 2023-09-24
260 - Convert pool event emitter to event emitter async resource.
262 ## [2.7.2] - 2023-09-23
266 - Add source maps to npm package to ease debugging.
270 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
272 ## [2.7.1] - 2023-09-20
276 - Ensure worker message listener used one time are removed after usage.
278 ## [2.7.0] - 2023-09-19
282 - Fix task stealing related tasks queue options handling at runtime.
286 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
290 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
291 - Stricter worker constructor arguments validation.
293 ## [2.6.45] - 2023-09-17
297 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
301 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
302 - Add `start()` method to pool API to start the minimum number of workers.
303 - Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not.
304 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
306 ## [2.6.44] - 2023-09-08
310 - Use a dedicated PAT to publish on GitHub packages registry.
314 - Publish on GitHub packages registry on release.
318 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
320 ## [2.6.43] - 2023-09-08
324 - Publish on GitHub packages registry on release.
328 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
330 ## [2.6.42] - 2023-09-06
334 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
336 ## [2.6.41] - 2023-09-03
340 - Optimize worker choice strategies implementation.
342 ## [2.6.40] - 2023-09-01
346 - Do not pre-choose in WRR worker choice strategy to avoid bias.
347 - Avoid array out of bound in worker choice strategies after worker node removal.
349 ## [2.6.39] - 2023-08-30
353 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
355 ## [2.6.38] - 2023-08-30
359 - Bundle typescript types declaration into one file.
363 - Improve interleaved weighted round robin worker choice strategy implementation.
365 ## [2.6.37] - 2023-08-28
369 - Ensure unused worker usage statistics are deleted at runtime.
373 - Rename worker choice strategy options `choiceRetries` to `retries`.
374 - Avoid unnecessary branching in worker choice strategies.
376 ## [2.6.36] - 2023-08-27
380 - Fix pool `execute()` arguments check.
384 - Make continuous tasks stealing algorithm less aggressive.
385 - Fine tune tasks stealing algorithm under back pressure.
387 ## [2.6.35] - 2023-08-25
391 - Don't account worker usage statistics for tasks that have failed.
392 - Fix pool information runtime and wait time median computation.
396 - Update simple moving average implementation to use a circular buffer.
397 - Update simple moving median implementation to use a circular buffer.
398 - Account for stolen tasks in worker usage statistics and pool information.
402 - Continuous tasks stealing algorithm.
404 ## [2.6.34] - 2023-08-24
408 - Avoid cascading tasks stealing under back pressure.
412 - Add fastpath to queued tasks rescheduling.
414 ## [2.6.33] - 2023-08-24
418 - Fix queued tasks rescheduling.
422 - Rename tasks queue options `queueMaxSize` to `size`.
426 - Task stealing scheduling algorithm if tasks queueing is enabled.
428 ## [2.6.32] - 2023-08-23
432 - Ensure no task can be executed when the pool is destroyed.
436 - Add `queueMaxSize` option to tasks queue options.
437 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
438 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
440 ## [2.6.31] - 2023-08-20
444 - Fix worker choice strategy retries mechanism in some edge cases.
448 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
449 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
451 ## [2.6.30] - 2023-08-19
455 - Ensure pool event `backPressure` is emitted.
456 - Ensure pool event `full` is emitted only once.
457 - Ensure worker node cannot be instantiated without proper arguments.
459 ## [2.6.29] - 2023-08-18
463 - Fix race condition between readiness and task functions worker message handling at startup.
464 - Fix duplicate task function worker usage statistics computation per task function.
465 - Update task function worker usage statistics if and only if there's at least two different task functions.
466 - Fix race condition at task function worker usage executing task computation leading to negative value.
470 - 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).
471 - Use back pressure detection in worker choice strategies.
472 - Add worker choice strategies retries mechanism if no worker is eligible.
474 ## [2.6.28] - 2023-08-16
478 - Ensure pool workers are properly initialized.
482 - HTTP server pool examples: express-cluster, express-hybrid.
486 - Remove now useless branching in worker hot code path.
488 ## [2.6.27] - 2023-08-15
492 - Add `KillHandler` type definition to exported types.
496 - Add `destroy` event to pool API.
498 ## [2.6.26] - 2023-08-15
502 - Add kill handler to worker options allowing to execute custom code when worker is killed.
503 - Add `listTaskFunctions()` method to pool API.
504 - SMTP client pool example: nodemailer.
506 ## [2.6.25] - 2023-08-13
510 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
511 - WebSocket server pool examples: ws-cluster, ws-hybrid.
513 ## [2.6.24] - 2023-08-12
517 - Add array of transferable objects to the `execute()` method arguments.
518 - WebSocket server pool examples: ws-worker_threads.
520 ## [2.6.23] - 2023-08-11
524 - 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.
528 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
529 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
531 ## [2.6.22] - 2023-08-10
535 - Add missing `types` field to package.json `exports`.
539 - Structure markdown documentation (PR #811).
541 ## [2.6.21] - 2023-08-03
545 - Improve code documentation.
546 - Code refactoring and cleanup for better maintainability and readability.
548 ## [2.6.20] - 2023-07-21
552 - Fix queued tasks redistribution on error task execution starvation.
553 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
557 - Drastically reduce lookups by worker in the worker nodes.
559 ## [2.6.19] - 2023-07-20
563 - Dedicated internal communication channel for worker_threads pools.
565 ## [2.6.18] - 2023-07-19
569 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
571 ## [2.6.17] - 2023-07-16
575 - Add `listTaskFunctions()` method to worker API.
577 ## [2.6.16] - 2023-07-12
581 - Fix pool startup detection.
582 - Fix worker task functions handling.
584 ## [2.6.15] - 2023-07-11
588 - Take into account worker node readiness in worker choice strategies.
590 ## [2.6.14] - 2023-07-10
594 - Fix task function statistics tracking.
596 ## [2.6.13] - 2023-07-10
600 - Add per task function statistics tracking.
601 - Add public methods to manipulate the worker task functions at runtime.
603 ## [2.6.12] - 2023-07-09
607 - Workaround import issue with `node:os` module in node 16.x.x.
609 ## [2.6.11] - 2023-07-09
613 - Fix pool readiness semantic.
615 ## [2.6.10] - 2023-07-08
619 - Ensure workers are not recreated on error at pool startup.
623 - Add `ready` and `strategy` fields to pool information.
624 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
625 - Add dynamic pool sizing checks.
627 ## [2.6.9] - 2023-07-07
631 - Recreate the right worker type on uncaught exception.
635 - Add minimum and maximum to internal measurement statistics.
636 - Add `runTime` and `waitTime` to pool information.
637 - Check worker inactive time only on dynamic worker.
639 ## [2.6.8] - 2023-07-03
643 - Brown paper bag release to fix version handling in pool information.
645 ## [2.6.7] - 2023-07-03
649 - Ensure worker queued tasks at error are reassigned to other pool workers.
653 - Add pool `utilization` ratio to pool information.
654 - Add `version` to pool information.
655 - Add worker information to worker nodes.
657 ## [2.6.6] - 2023-07-01
661 - Add safe helper `availableParallelism()` to help sizing the pool.
665 - Ensure message handler is only registered in worker.
667 ## [2.6.5] - 2023-06-27
671 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
675 - Artificial version bump to 2.6.5 to workaround publication issue.
676 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
677 - Ensure pool event is emitted before task error promise rejection.
678 - Fix queued tasks count computation.
682 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
684 ## [2.6.4] - 2023-06-27
688 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
692 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
693 - Ensure pool event is emitted before task error promise rejection.
694 - Fix queued tasks count computation.
698 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
700 ## [2.6.3] - 2023-06-19
704 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
705 - Update strategies internals after statistics computation.
709 - Optimize O(1) queue implementation.
711 ## [2.6.2] - 2023-06-12
715 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
717 ## [2.6.1] - 2023-06-10
721 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
725 - Fix average statistics computation: ensure failed tasks are not accounted.
727 ## [2.6.0] - 2023-06-09
731 - Add `LEAST_ELU` worker choice strategy (experimental).
732 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
736 - Refactor pool worker node usage internals.
737 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
738 - Breaking change: pool information `info` property object fields have been renamed.
742 - Fix wait time accounting.
743 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
744 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
746 ## [2.5.4] - 2023-06-07
750 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
754 - Compute statistics at the worker level only if needed.
755 - Add `worker_threads` options to thread pool options.
759 - Make the `LEAST_BUSY` strategy only relies on task runtime.
761 ## [2.5.3] - 2023-06-04
765 - Refine pool information content.
766 - Limit pool internals public exposure.
768 ## [2.5.2] - 2023-06-02
772 - Add `taskError` pool event for task execution error.
773 - Add pool information `info` property to pool.
774 - Emit pool information on `busy` and `full` pool events.
776 ## [2.5.1] - 2023-06-01
780 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
781 - Add `error` pool event for uncaught worker error.
783 ## [2.5.0] - 2023-05-31
787 - Switch pool event emitter to `EventEmitterAsyncResource`.
788 - Add tasks wait time accounting in per worker tasks usage.
789 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
793 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
795 ## [2.4.14] - 2023-05-09
799 - Ensure no undefined task runtime can land in the tasks history.
800 - Fix median computation implementation once again.
804 - Unit tests for median and queue implementations.
806 ## [2.4.13] - 2023-05-08
810 - Fix worker choice strategy options validation.
811 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
813 ## [2.4.12] - 2023-05-06
817 - Support multiple task functions per worker.
818 - Add custom worker weights support to worker choice strategies options.
822 - Use O(1) queue implementation for tasks queueing.
826 - Fix median computation implementation.
827 - Fix fair share worker choice strategy internals update.
829 ## [2.4.11] - 2023-04-23
833 - Optimize free worker finding in worker choice strategies.
835 ## [2.4.10] - 2023-04-15
839 - Fix typescript type definition for task function: ensure the input data is optional.
840 - Fix typescript type definition for pool execute(): ensure the input data is optional.
842 ## [2.4.9] - 2023-04-15
846 - Add tasks queue enablement runtime setter to pool.
847 - Add tasks queue options runtime setter to pool.
848 - Add worker choice strategy options runtime setter to pool.
852 - Remove the tasks queuing experimental status.
856 - Fix task function type definition and validation.
857 - Fix worker choice strategy options handling.
859 ## [2.4.8] - 2023-04-12
863 - Fix message between main worker and worker type definition for tasks.
864 - Fix code documentation.
866 ## [2.4.7] - 2023-04-11
870 - Add worker tasks queue options to pool options.
874 - Fix missing documentation.
876 ## [2.4.6] - 2023-04-10
880 - Ensure one task at a time is executed per worker with tasks queueing enabled.
881 - Properly count worker executing tasks with tasks queueing enabled.
883 ## [2.4.5] - 2023-04-09
887 - Use monotonic high resolution timer for worker tasks runtime.
888 - Add worker tasks median runtime to statistics.
889 - Add worker tasks queue (experimental).
891 ## [2.4.4] - 2023-04-07
895 - Add `PoolEvents` enumeration and `PoolEvent` type.
899 - Destroy worker only on alive check.
901 ## [2.4.3] - 2023-04-07
905 - Fix typedoc generation with inheritance.
907 ## [2.4.2] - 2023-04-06
911 - Add `full` event to dynamic pool.
912 - Keep worker choice strategy in memory for conditional reuse.
916 - Fix possible negative worker key at worker removal in worker choice strategies.
918 ## [2.4.1] - 2023-04-05
922 - Optimize worker choice strategy for dynamic pool.
926 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
928 ## [2.4.0] - 2023-04-04
932 - Add `LESS_BUSY` worker choice strategy.
936 - Optimize worker storage in pool.
937 - Optimize worker alive status check.
938 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
939 - Optimize `LESS_USED` worker choice strategy.
940 - Update benchmark versus external threads pools.
941 - Optimize tasks usage statistics requirements for worker choice strategy.
945 - Ensure trimmable characters are checked at pool initialization.
946 - Fix message id integer overflow.
947 - Fix pool worker removal in worker choice strategy internals.
948 - Fix package publication with pnpm.
950 ## [2.4.0-3] - 2023-04-04
954 - Add `LESS_BUSY` worker choice strategy.
958 - Optimize worker storage in pool.
959 - Optimize worker alive status check.
960 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
961 - Optimize `LESS_USED` worker choice strategy.
962 - Update benchmark versus external threads pools.
966 - Ensure trimmable characters are checked at pool initialization.
967 - Fix message id integer overflow.
968 - Fix pool worker removal in worker choice strategy internals.
969 - Fix package publication with pnpm.
971 ## [2.4.0-2] - 2023-04-03
975 - Add `LESS_BUSY` worker choice strategy.
979 - Optimize worker storage in pool.
980 - Optimize worker alive status check.
981 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
982 - Optimize `LESS_USED` worker choice strategy.
986 - Ensure trimmable characters are checked at pool initialization.
987 - Fix message id integer overflow.
988 - Fix pool worker removal in worker choice strategy internals.
989 - Fix package publication with pnpm.
991 ## [2.4.0-1] - 2023-04-03
995 - Add `LESS_BUSY` worker choice strategy.
999 - Optimize worker storage in pool.
1000 - Optimize worker alive status check.
1001 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1002 - Optimize `LESS_USED` worker choice strategy.
1006 - Ensure trimmable characters are checked at pool initialization.
1007 - Fix message id integer overflow.
1008 - Fix pool worker removal in worker choice strategy internals.
1010 ## [2.4.0-0] - 2023-04-03
1014 - Add `LESS_BUSY` worker choice strategy.
1018 - Optimize worker storage in pool.
1019 - Optimize worker alive status check.
1020 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1021 - Optimize `LESS_USED` worker choice strategy.
1025 - Ensure trimmable characters are checked at pool initialization.
1026 - Fix message id integer overflow.
1027 - Fix pool worker removal in worker choice strategy internals.
1029 ## [2.3.10] - 2023-03-18
1033 - Fix package.json `exports` syntax for ESM and CommonJS.
1037 - Permit SemVer pre-release publication.
1039 ## [2.3.10-2] - 2023-03-18
1043 - Fix package.json `exports` syntax for ESM and CommonJS.
1045 ## [2.3.10-1] - 2023-03-18
1049 - Permit SemVer pre-release publication.
1051 ## [2.3.10-0] - 2023-03-18
1055 - Fix package.json `exports` syntax for ESM and CommonJS.
1057 ## [2.3.9] - 2023-03-18
1061 - Introduce ESM module support along with CommonJS one.
1065 - Fix brown paper bag bug referencing the same object literal.
1067 ## [2.3.8] - 2023-03-18
1071 - Switch internal benchmarking code to benny.
1072 - Switch to TypeScript 5.x.x.
1073 - Switch rollup bundler plugins to core ones.
1074 - Switch to TSDoc syntax.
1075 - Enforce conventional commits.
1079 - Fix random integer generator.
1080 - Fix worker choice strategy pool type identification at initialization.
1082 ## [2.3.7] - 2022-10-23
1086 - Switch to open collective FOSS project funding platform.
1087 - Switch to ts-standard linter configuration on TypeScript code.
1091 - Fixed missing async on pool execute method.
1092 - Fixed typing in TypeScript example.
1093 - Fixed types in unit tests.
1095 ## [2.3.6] - 2022-10-22
1099 - Cleanup pool attributes and methods.
1100 - Refine error types thrown.
1104 - Fix continuous integration build on windows.
1105 - Fix code coverage reporting by using c8 instead of nyc.
1107 ## [2.3.5] - 2022-10-21
1111 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1112 - Optimize tasks usage lookup implementation.
1116 - Fix missed pool event emitter type export.
1117 - Fix typedoc documentation generation.
1119 ## [2.3.4] - 2022-10-17
1123 - Fully automate release process with release-it.
1127 - Optimize fair share task scheduling algorithm implementation.
1128 - Update benchmark versus external pools results with latest version.
1130 ## [2.3.3] - 2022-10-15
1134 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1136 ## [2.3.2] - 2022-10-14
1140 - Optimize fair share worker selection strategy implementation.
1144 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1146 ## [2.3.1] - 2022-10-13
1150 - Pool worker choice strategies:
1151 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1152 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1154 ## [2.2.2] - 2022-10-09
1158 - Fixed `README.md` file.
1160 ## [2.2.1] - 2022-10-08
1164 - Dynamic worker choice strategy change at runtime.
1166 ## [2.2.0] - 2022-01-05
1168 ### Breaking Changes
1170 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1172 ## [2.1.0] - 2021-08-29
1176 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1178 ### Breaking Changes
1180 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1181 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1182 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1183 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1185 ## [2.0.2] - 2021-05-12
1189 - Fix `busy` event emission on fixed pool type
1191 ## [2.0.1] - 2021-03-16
1195 - Check if pool options are properly set.
1196 - `busy` event is emitted on all pool types.
1198 ## [2.0.0] - 2021-03-01
1202 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1204 ### Breaking Changes
1206 - `FullPool` event is now renamed to `busy`.
1207 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1208 _Find more details on our JSDoc._
1210 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1212 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1214 ### Pool options types declaration merge
1216 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1218 #### New `export` strategy
1222 const DynamicThreadPool = require('poolifier/lib/dynamic')
1224 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1227 But you should always prefer just using
1230 const { DynamicThreadPool } = require('poolifier')
1233 #### New type definitions for input data and response
1235 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1236 _This is not a limitation by poolifier but Node.js._
1238 #### Public property replacements
1240 `numWorkers` property is now `numberOfWorkers`
1242 #### Internal (protected) properties and methods renaming
1244 These properties are not intended for end users
1246 - `id` => `nextMessageId`
1248 These methods are not intended for end users
1250 - `_chooseWorker` => `chooseWorker`
1251 - `_newWorker` => `createWorker`
1252 - `_execute` => `internalExecute`
1253 - `_chooseWorker` => `chooseWorker`
1254 - `_checkAlive` => `checkAlive`
1256 - `_runAsync` => `runAsync`
1258 ## [1.1.0] - 2020-05-21
1262 - ThreadWorker support async functions as option
1263 - Various external library patches
1265 ## [1.0.0] - 2020-01-24
1269 - FixedThreadPool implementation
1270 - DynamicThreadPool implementation
1271 - WorkerThread implementation to improve developer experience