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).
10 ## [3.1.10] - 2023-12-23
14 - Avoid useless branching on pool type.
16 ## [3.1.9] - 2023-12-22
20 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
22 ## [3.1.8] - 2023-12-21
26 - Fix default worker weight computation.
27 - Fix possible null exception at pool destroying.
29 ## [3.1.7] - 2023-12-20
33 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
35 ## [3.1.6] - 2023-12-18
39 - Fix pool destroying with tasks queuing enabled.
41 ## [3.1.5] - 2023-12-18
45 - Add queued tasks end timeout support to worker node termination.
47 ## [3.1.4] - 2023-12-18
51 - Make more robust the fix for possible null exception at handling task execution response.
53 ## [3.1.3] - 2023-12-17
57 - Fix possible null exception at handling task execution response.
59 ## [3.1.2] - 2023-12-17
63 - Wait for queued tasks to end at worker node termination.
65 ## [3.1.1] - 2023-12-16
69 - Fix pool options TS type definition.
71 ## [3.1.0] - 2023-12-16
75 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
77 ## [3.0.14] - 2023-12-13
81 - Fix possible null exception with worker_threads pools.
83 ## [3.0.13] - 2023-12-12
87 - Ensure worker choice strategy wait for worker nodes readiness.
91 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
93 ## [3.0.12] - 2023-12-12
97 - Add infinite retries support in worker choice strategy.
99 ## [3.0.11] - 2023-12-11
103 - Ensure pool asynchronous resource properly track tasks execution.
105 ## [3.0.10] - 2023-12-08
109 - Add a fastpath when tasks stealing or redistribution is impossible.
111 ## [3.0.9] - 2023-11-26
115 - Remove all pool events listener at pool destroying.
116 - Remove all worker node events listener at worker node destroying.
117 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
119 ## [3.0.8] - 2023-11-25
123 - Ensure continuous tasks stealing on idle start at worker node idling.
125 ## [3.0.7] - 2023-11-24
129 - Make continuous tasks stealing start at worker node idling.
131 ## [3.0.6] - 2023-11-24
135 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
136 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
138 ## [3.0.5] - 2023-10-27
142 - Ensure pool `ready` event can be emitted only once.
144 ## [3.0.4] - 2023-10-20
148 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
149 - Use builtin retry mechanism in worker choice strategies instead of custom one.
151 ## [3.0.3] - 2023-10-19
155 - Avoid null exception at sending message to worker.
156 - Avoid null exception at checking worker node readiness.
158 ## [3.0.2] - 2023-10-17
162 - 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).
164 ## [3.0.1] - 2023-10-16
168 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
172 - Switch the worker node eventing code to `EventTarget` API.
174 ## [3.0.0] - 2023-10-08
178 - Remove Node.js 16.x.x (EOL) support.
180 ## [2.7.5] - 2023-10-03
184 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
186 ## [2.7.4] - 2023-09-25
190 - Fix source maps (bundler issue).
192 ## [2.7.3] - 2023-09-24
196 - Convert pool event emitter to event emitter async resource.
198 ## [2.7.2] - 2023-09-23
202 - Add source maps to npm package to ease debugging.
206 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
208 ## [2.7.1] - 2023-09-20
212 - Ensure worker message listener used one time are removed after usage.
214 ## [2.7.0] - 2023-09-19
218 - Fix task stealing related tasks queue options handling at runtime.
222 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
226 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
227 - Stricter worker constructor arguments validation.
229 ## [2.6.45] - 2023-09-17
233 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
237 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
238 - Add `start()` method to pool API to start the minimum number of workers.
239 - 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.
240 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
242 ## [2.6.44] - 2023-09-08
246 - Use a dedicated PAT to publish on GitHub packages registry.
250 - Publish on GitHub packages registry on release.
254 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
256 ## [2.6.43] - 2023-09-08
260 - Publish on GitHub packages registry on release.
264 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
266 ## [2.6.42] - 2023-09-06
270 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
272 ## [2.6.41] - 2023-09-03
276 - Optimize worker choice strategies implementation.
278 ## [2.6.40] - 2023-09-01
282 - Do not pre-choose in WRR worker choice strategy to avoid bias.
283 - Avoid array out of bound in worker choice strategies after worker node removal.
285 ## [2.6.39] - 2023-08-30
289 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
291 ## [2.6.38] - 2023-08-30
295 - Bundle typescript types declaration into one file.
299 - Improve interleaved weighted round robin worker choice strategy implementation.
301 ## [2.6.37] - 2023-08-28
305 - Ensure unused worker usage statistics are deleted at runtime.
309 - Rename worker choice strategy options `choiceRetries` to `retries`.
310 - Avoid unnecessary branching in worker choice strategies.
312 ## [2.6.36] - 2023-08-27
316 - Fix pool `execute()` arguments check.
320 - Make continuous tasks stealing algorithm less aggressive.
321 - Fine tune tasks stealing algorithm under back pressure.
323 ## [2.6.35] - 2023-08-25
327 - Don't account worker usage statistics for tasks that have failed.
328 - Fix pool information runtime and wait time median computation.
332 - Update simple moving average implementation to use a circular buffer.
333 - Update simple moving median implementation to use a circular buffer.
334 - Account for stolen tasks in worker usage statistics and pool information.
338 - Continuous tasks stealing algorithm.
340 ## [2.6.34] - 2023-08-24
344 - Avoid cascading tasks stealing under back pressure.
348 - Add fastpath to queued tasks rescheduling.
350 ## [2.6.33] - 2023-08-24
354 - Fix queued tasks rescheduling.
358 - Rename tasks queue options `queueMaxSize` to `size`.
362 - Task stealing scheduling algorithm if tasks queueing is enabled.
364 ## [2.6.32] - 2023-08-23
368 - Ensure no task can be executed when the pool is destroyed.
372 - Add `queueMaxSize` option to tasks queue options.
373 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
374 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
376 ## [2.6.31] - 2023-08-20
380 - Fix worker choice strategy retries mechanism in some edge cases.
384 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
385 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
387 ## [2.6.30] - 2023-08-19
391 - Ensure pool event `backPressure` is emitted.
392 - Ensure pool event `full` is emitted only once.
393 - Ensure worker node cannot be instantiated without proper arguments.
395 ## [2.6.29] - 2023-08-18
399 - Fix race condition between readiness and task functions worker message handling at startup.
400 - Fix duplicate task function worker usage statistics computation per task function.
401 - Update task function worker usage statistics if and only if there's at least two different task functions.
402 - Fix race condition at task function worker usage executing task computation leading to negative value.
406 - 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).
407 - Use back pressure detection in worker choice strategies.
408 - Add worker choice strategies retries mechanism if no worker is eligible.
410 ## [2.6.28] - 2023-08-16
414 - Ensure pool workers are properly initialized.
418 - HTTP server pool examples: express-cluster, express-hybrid.
422 - Remove now useless branching in worker hot code path.
424 ## [2.6.27] - 2023-08-15
428 - Add `KillHandler` type definition to exported types.
432 - Add `destroy` event to pool API.
434 ## [2.6.26] - 2023-08-15
438 - Add kill handler to worker options allowing to execute custom code when worker is killed.
439 - Add `listTaskFunctions()` method to pool API.
440 - SMTP client pool example: nodemailer.
442 ## [2.6.25] - 2023-08-13
446 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
447 - WebSocket server pool examples: ws-cluster, ws-hybrid.
449 ## [2.6.24] - 2023-08-12
453 - Add array of transferable objects to the `execute()` method arguments.
454 - WebSocket server pool examples: ws-worker_threads.
456 ## [2.6.23] - 2023-08-11
460 - 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.
464 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
465 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
467 ## [2.6.22] - 2023-08-10
471 - Add missing `types` field to package.json `exports`.
475 - Structure markdown documentation (PR #811).
477 ## [2.6.21] - 2023-08-03
481 - Improve code documentation.
482 - Code refactoring and cleanup for better maintainability and readability.
484 ## [2.6.20] - 2023-07-21
488 - Fix queued tasks redistribution on error task execution starvation.
489 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
493 - Drastically reduce lookups by worker in the worker nodes.
495 ## [2.6.19] - 2023-07-20
499 - Dedicated internal communication channel for worker_threads pools.
501 ## [2.6.18] - 2023-07-19
505 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
507 ## [2.6.17] - 2023-07-16
511 - Add `listTaskFunctions()` method to worker API.
513 ## [2.6.16] - 2023-07-12
517 - Fix pool startup detection.
518 - Fix worker task functions handling.
520 ## [2.6.15] - 2023-07-11
524 - Take into account worker node readiness in worker choice strategies.
526 ## [2.6.14] - 2023-07-10
530 - Fix task function statistics tracking.
532 ## [2.6.13] - 2023-07-10
536 - Add per task function statistics tracking.
537 - Add public methods to manipulate the worker task functions at runtime.
539 ## [2.6.12] - 2023-07-09
543 - Workaround import issue with `node:os` module in node 16.x.x.
545 ## [2.6.11] - 2023-07-09
549 - Fix pool readiness semantic.
551 ## [2.6.10] - 2023-07-08
555 - Ensure workers are not recreated on error at pool startup.
559 - Add `ready` and `strategy` fields to pool information.
560 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
561 - Add dynamic pool sizing checks.
563 ## [2.6.9] - 2023-07-07
567 - Recreate the right worker type on uncaught exception.
571 - Add minimum and maximum to internal measurement statistics.
572 - Add `runTime` and `waitTime` to pool information.
573 - Check worker inactive time only on dynamic worker.
575 ## [2.6.8] - 2023-07-03
579 - Brown paper bag release to fix version handling in pool information.
581 ## [2.6.7] - 2023-07-03
585 - Ensure worker queued tasks at error are reassigned to other pool workers.
589 - Add pool `utilization` ratio to pool information.
590 - Add `version` to pool information.
591 - Add worker information to worker nodes.
593 ## [2.6.6] - 2023-07-01
597 - Add safe helper `availableParallelism()` to help sizing the pool.
601 - Ensure message handler is only registered in worker.
603 ## [2.6.5] - 2023-06-27
607 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
611 - Artificial version bump to 2.6.5 to workaround publication issue.
612 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
613 - Ensure pool event is emitted before task error promise rejection.
614 - Fix queued tasks count computation.
618 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
620 ## [2.6.4] - 2023-06-27
624 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
628 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
629 - Ensure pool event is emitted before task error promise rejection.
630 - Fix queued tasks count computation.
634 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
636 ## [2.6.3] - 2023-06-19
640 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
641 - Update strategies internals after statistics computation.
645 - Optimize O(1) queue implementation.
647 ## [2.6.2] - 2023-06-12
651 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
653 ## [2.6.1] - 2023-06-10
657 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
661 - Fix average statistics computation: ensure failed tasks are not accounted.
663 ## [2.6.0] - 2023-06-09
667 - Add `LEAST_ELU` worker choice strategy (experimental).
668 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
672 - Refactor pool worker node usage internals.
673 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
674 - Breaking change: pool information `info` property object fields have been renamed.
678 - Fix wait time accounting.
679 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
680 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
682 ## [2.5.4] - 2023-06-07
686 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
690 - Compute statistics at the worker level only if needed.
691 - Add `worker_threads` options to thread pool options.
695 - Make the `LEAST_BUSY` strategy only relies on task runtime.
697 ## [2.5.3] - 2023-06-04
701 - Refine pool information content.
702 - Limit pool internals public exposure.
704 ## [2.5.2] - 2023-06-02
708 - Add `taskError` pool event for task execution error.
709 - Add pool information `info` property to pool.
710 - Emit pool information on `busy` and `full` pool events.
712 ## [2.5.1] - 2023-06-01
716 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
717 - Add `error` pool event for uncaught worker error.
719 ## [2.5.0] - 2023-05-31
723 - Switch pool event emitter to `EventEmitterAsyncResource`.
724 - Add tasks wait time accounting in per worker tasks usage.
725 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
729 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
731 ## [2.4.14] - 2023-05-09
735 - Ensure no undefined task runtime can land in the tasks history.
736 - Fix median computation implementation once again.
740 - Unit tests for median and queue implementations.
742 ## [2.4.13] - 2023-05-08
746 - Fix worker choice strategy options validation.
747 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
749 ## [2.4.12] - 2023-05-06
753 - Support multiple task functions per worker.
754 - Add custom worker weights support to worker choice strategies options.
758 - Use O(1) queue implementation for tasks queueing.
762 - Fix median computation implementation.
763 - Fix fair share worker choice strategy internals update.
765 ## [2.4.11] - 2023-04-23
769 - Optimize free worker finding in worker choice strategies.
771 ## [2.4.10] - 2023-04-15
775 - Fix typescript type definition for task function: ensure the input data is optional.
776 - Fix typescript type definition for pool execute(): ensure the input data is optional.
778 ## [2.4.9] - 2023-04-15
782 - Add tasks queue enablement runtime setter to pool.
783 - Add tasks queue options runtime setter to pool.
784 - Add worker choice strategy options runtime setter to pool.
788 - Remove the tasks queuing experimental status.
792 - Fix task function type definition and validation.
793 - Fix worker choice strategy options handling.
795 ## [2.4.8] - 2023-04-12
799 - Fix message between main worker and worker type definition for tasks.
800 - Fix code documentation.
802 ## [2.4.7] - 2023-04-11
806 - Add worker tasks queue options to pool options.
810 - Fix missing documentation.
812 ## [2.4.6] - 2023-04-10
816 - Ensure one task at a time is executed per worker with tasks queueing enabled.
817 - Properly count worker executing tasks with tasks queueing enabled.
819 ## [2.4.5] - 2023-04-09
823 - Use monotonic high resolution timer for worker tasks runtime.
824 - Add worker tasks median runtime to statistics.
825 - Add worker tasks queue (experimental).
827 ## [2.4.4] - 2023-04-07
831 - Add `PoolEvents` enumeration and `PoolEvent` type.
835 - Destroy worker only on alive check.
837 ## [2.4.3] - 2023-04-07
841 - Fix typedoc generation with inheritance.
843 ## [2.4.2] - 2023-04-06
847 - Add `full` event to dynamic pool.
848 - Keep worker choice strategy in memory for conditional reuse.
852 - Fix possible negative worker key at worker removal in worker choice strategies.
854 ## [2.4.1] - 2023-04-05
858 - Optimize worker choice strategy for dynamic pool.
862 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
864 ## [2.4.0] - 2023-04-04
868 - Add `LESS_BUSY` worker choice strategy.
872 - Optimize worker storage in pool.
873 - Optimize worker alive status check.
874 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
875 - Optimize `LESS_USED` worker choice strategy.
876 - Update benchmark versus external threads pools.
877 - Optimize tasks usage statistics requirements for worker choice strategy.
881 - Ensure trimmable characters are checked at pool initialization.
882 - Fix message id integer overflow.
883 - Fix pool worker removal in worker choice strategy internals.
884 - Fix package publication with pnpm.
886 ## [2.4.0-3] - 2023-04-04
890 - Add `LESS_BUSY` worker choice strategy.
894 - Optimize worker storage in pool.
895 - Optimize worker alive status check.
896 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
897 - Optimize `LESS_USED` worker choice strategy.
898 - Update benchmark versus external threads pools.
902 - Ensure trimmable characters are checked at pool initialization.
903 - Fix message id integer overflow.
904 - Fix pool worker removal in worker choice strategy internals.
905 - Fix package publication with pnpm.
907 ## [2.4.0-2] - 2023-04-03
911 - Add `LESS_BUSY` worker choice strategy.
915 - Optimize worker storage in pool.
916 - Optimize worker alive status check.
917 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
918 - Optimize `LESS_USED` worker choice strategy.
922 - Ensure trimmable characters are checked at pool initialization.
923 - Fix message id integer overflow.
924 - Fix pool worker removal in worker choice strategy internals.
925 - Fix package publication with pnpm.
927 ## [2.4.0-1] - 2023-04-03
931 - Add `LESS_BUSY` worker choice strategy.
935 - Optimize worker storage in pool.
936 - Optimize worker alive status check.
937 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
938 - Optimize `LESS_USED` worker choice strategy.
942 - Ensure trimmable characters are checked at pool initialization.
943 - Fix message id integer overflow.
944 - Fix pool worker removal in worker choice strategy internals.
946 ## [2.4.0-0] - 2023-04-03
950 - Add `LESS_BUSY` worker choice strategy.
954 - Optimize worker storage in pool.
955 - Optimize worker alive status check.
956 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
957 - Optimize `LESS_USED` worker choice strategy.
961 - Ensure trimmable characters are checked at pool initialization.
962 - Fix message id integer overflow.
963 - Fix pool worker removal in worker choice strategy internals.
965 ## [2.3.10] - 2023-03-18
969 - Fix package.json `exports` syntax for ESM and CommonJS.
973 - Permit SemVer pre-release publication.
975 ## [2.3.10-2] - 2023-03-18
979 - Fix package.json `exports` syntax for ESM and CommonJS.
981 ## [2.3.10-1] - 2023-03-18
985 - Permit SemVer pre-release publication.
987 ## [2.3.10-0] - 2023-03-18
991 - Fix package.json `exports` syntax for ESM and CommonJS.
993 ## [2.3.9] - 2023-03-18
997 - Introduce ESM module support along with CommonJS one.
1001 - Fix brown paper bag bug referencing the same object literal.
1003 ## [2.3.8] - 2023-03-18
1007 - Switch internal benchmarking code to benny.
1008 - Switch to TypeScript 5.x.x.
1009 - Switch rollup bundler plugins to core ones.
1010 - Switch to TSDoc syntax.
1011 - Enforce conventional commits.
1015 - Fix random integer generator.
1016 - Fix worker choice strategy pool type identification at initialization.
1018 ## [2.3.7] - 2022-10-23
1022 - Switch to open collective FOSS project funding platform.
1023 - Switch to ts-standard linter configuration on TypeScript code.
1027 - Fixed missing async on pool execute method.
1028 - Fixed typing in TypeScript example.
1029 - Fixed types in unit tests.
1031 ## [2.3.6] - 2022-10-22
1035 - Cleanup pool attributes and methods.
1036 - Refine error types thrown.
1040 - Fix continuous integration build on windows.
1041 - Fix code coverage reporting by using c8 instead of nyc.
1043 ## [2.3.5] - 2022-10-21
1047 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1048 - Optimize tasks usage lookup implementation.
1052 - Fix missed pool event emitter type export.
1053 - Fix typedoc documentation generation.
1055 ## [2.3.4] - 2022-10-17
1059 - Fully automate release process with release-it.
1063 - Optimize fair share task scheduling algorithm implementation.
1064 - Update benchmark versus external pools results with latest version.
1066 ## [2.3.3] - 2022-10-15
1070 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1072 ## [2.3.2] - 2022-10-14
1076 - Optimize fair share worker selection strategy implementation.
1080 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1082 ## [2.3.1] - 2022-10-13
1086 - Pool worker choice strategies:
1087 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1088 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1090 ## [2.2.2] - 2022-10-09
1094 - Fixed `README.md` file.
1096 ## [2.2.1] - 2022-10-08
1100 - Dynamic worker choice strategy change at runtime.
1102 ## [2.2.0] - 2022-01-05
1104 ### Breaking Changes
1106 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1108 ## [2.1.0] - 2021-08-29
1112 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1114 ### Breaking Changes
1116 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1117 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1118 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1119 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1121 ## [2.0.2] - 2021-05-12
1125 - Fix `busy` event emission on fixed pool type
1127 ## [2.0.1] - 2021-03-16
1131 - Check if pool options are properly set.
1132 - `busy` event is emitted on all pool types.
1134 ## [2.0.0] - 2021-03-01
1138 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1140 ### Breaking Changes
1142 - `FullPool` event is now renamed to `busy`.
1143 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1144 _Find more details on our JSDoc._
1146 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1148 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1150 ### Pool options types declaration merge
1152 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1154 #### New `export` strategy
1158 const DynamicThreadPool = require('poolifier/lib/dynamic')
1160 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1163 But you should always prefer just using
1166 const { DynamicThreadPool } = require('poolifier')
1169 #### New type definitions for input data and response
1171 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1172 _This is not a limitation by poolifier but Node.js._
1174 #### Public property replacements
1176 `numWorkers` property is now `numberOfWorkers`
1178 #### Internal (protected) properties and methods renaming
1180 These properties are not intended for end users
1182 - `id` => `nextMessageId`
1184 These methods are not intended for end users
1186 - `_chooseWorker` => `chooseWorker`
1187 - `_newWorker` => `createWorker`
1188 - `_execute` => `internalExecute`
1189 - `_chooseWorker` => `chooseWorker`
1190 - `_checkAlive` => `checkAlive`
1192 - `_runAsync` => `runAsync`
1194 ## [1.1.0] - 2020-05-21
1198 - ThreadWorker support async functions as option
1199 - Various external library patches
1201 ## [1.0.0] - 2020-01-24
1205 - FixedThreadPool implementation
1206 - DynamicThreadPool implementation
1207 - WorkerThread implementation to improve developer experience