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.7] - 2023-12-20
14 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
16 ## [3.1.6] - 2023-12-18
20 - Fix pool destroying with tasks queuing enabled.
22 ## [3.1.5] - 2023-12-18
26 - Add queued tasks end timeout support to worker node termination.
28 ## [3.1.4] - 2023-12-18
32 - Make more robust the fix for possible null exception at handling task execution response.
34 ## [3.1.3] - 2023-12-17
38 - Fix possible null exception at handling task execution response.
40 ## [3.1.2] - 2023-12-17
44 - Wait for queued tasks to end at worker node termination.
46 ## [3.1.1] - 2023-12-16
50 - Fix pool options TS type definition.
52 ## [3.1.0] - 2023-12-16
56 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
58 ## [3.0.14] - 2023-12-13
62 - Fix possible null exception with worker_threads pools.
64 ## [3.0.13] - 2023-12-12
68 - Ensure worker choice strategy wait for worker nodes readiness.
72 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
74 ## [3.0.12] - 2023-12-12
78 - Add infinite retries support in worker choice strategy.
80 ## [3.0.11] - 2023-12-11
84 - Ensure pool asynchronous resource properly track tasks execution.
86 ## [3.0.10] - 2023-12-08
90 - Add a fastpath when tasks stealing or redistribution is impossible.
92 ## [3.0.9] - 2023-11-26
96 - Remove all pool events listener at pool destroying.
97 - Remove all worker node events listener at worker node destroying.
98 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
100 ## [3.0.8] - 2023-11-25
104 - Ensure continuous tasks stealing on idle start at worker node idling.
106 ## [3.0.7] - 2023-11-24
110 - Make continuous tasks stealing start at worker node idling.
112 ## [3.0.6] - 2023-11-24
116 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
117 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
119 ## [3.0.5] - 2023-10-27
123 - Ensure pool `ready` event can be emitted only once.
125 ## [3.0.4] - 2023-10-20
129 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
130 - Use builtin retry mechanism in worker choice strategies instead of custom one.
132 ## [3.0.3] - 2023-10-19
136 - Avoid null exception at sending message to worker.
137 - Avoid null exception at checking worker node readiness.
139 ## [3.0.2] - 2023-10-17
143 - 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).
145 ## [3.0.1] - 2023-10-16
149 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
153 - Switch the worker node eventing code to `EventTarget` API.
155 ## [3.0.0] - 2023-10-08
159 - Remove Node.js 16.x.x (EOL) support.
161 ## [2.7.5] - 2023-10-03
165 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
167 ## [2.7.4] - 2023-09-25
171 - Fix source maps (bundler issue).
173 ## [2.7.3] - 2023-09-24
177 - Convert pool event emitter to event emitter async resource.
179 ## [2.7.2] - 2023-09-23
183 - Add source maps to npm package to ease debugging.
187 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
189 ## [2.7.1] - 2023-09-20
193 - Ensure worker message listener used one time are removed after usage.
195 ## [2.7.0] - 2023-09-19
199 - Fix task stealing related tasks queue options handling at runtime.
203 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
207 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
208 - Stricter worker constructor arguments validation.
210 ## [2.6.45] - 2023-09-17
214 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
218 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
219 - Add `start()` method to pool API to start the minimum number of workers.
220 - 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.
221 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
223 ## [2.6.44] - 2023-09-08
227 - Use a dedicated PAT to publish on GitHub packages registry.
231 - Publish on GitHub packages registry on release.
235 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
237 ## [2.6.43] - 2023-09-08
241 - Publish on GitHub packages registry on release.
245 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
247 ## [2.6.42] - 2023-09-06
251 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
253 ## [2.6.41] - 2023-09-03
257 - Optimize worker choice strategies implementation.
259 ## [2.6.40] - 2023-09-01
263 - Do not pre-choose in WRR worker choice strategy to avoid bias.
264 - Avoid array out of bound in worker choice strategies after worker node removal.
266 ## [2.6.39] - 2023-08-30
270 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
272 ## [2.6.38] - 2023-08-30
276 - Bundle typescript types declaration into one file.
280 - Improve interleaved weighted round robin worker choice strategy implementation.
282 ## [2.6.37] - 2023-08-28
286 - Ensure unused worker usage statistics are deleted at runtime.
290 - Rename worker choice strategy options `choiceRetries` to `retries`.
291 - Avoid unnecessary branching in worker choice strategies.
293 ## [2.6.36] - 2023-08-27
297 - Fix pool `execute()` arguments check.
301 - Make continuous tasks stealing algorithm less aggressive.
302 - Fine tune tasks stealing algorithm under back pressure.
304 ## [2.6.35] - 2023-08-25
308 - Don't account worker usage statistics for tasks that have failed.
309 - Fix pool information runtime and wait time median computation.
313 - Update simple moving average implementation to use a circular buffer.
314 - Update simple moving median implementation to use a circular buffer.
315 - Account for stolen tasks in worker usage statistics and pool information.
319 - Continuous tasks stealing algorithm.
321 ## [2.6.34] - 2023-08-24
325 - Avoid cascading tasks stealing under back pressure.
329 - Add fastpath to queued tasks rescheduling.
331 ## [2.6.33] - 2023-08-24
335 - Fix queued tasks rescheduling.
339 - Rename tasks queue options `queueMaxSize` to `size`.
343 - Task stealing scheduling algorithm if tasks queueing is enabled.
345 ## [2.6.32] - 2023-08-23
349 - Ensure no task can be executed when the pool is destroyed.
353 - Add `queueMaxSize` option to tasks queue options.
354 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
355 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
357 ## [2.6.31] - 2023-08-20
361 - Fix worker choice strategy retries mechanism in some edge cases.
365 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
366 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
368 ## [2.6.30] - 2023-08-19
372 - Ensure pool event `backPressure` is emitted.
373 - Ensure pool event `full` is emitted only once.
374 - Ensure worker node cannot be instantiated without proper arguments.
376 ## [2.6.29] - 2023-08-18
380 - Fix race condition between readiness and task functions worker message handling at startup.
381 - Fix duplicate task function worker usage statistics computation per task function.
382 - Update task function worker usage statistics if and only if there's at least two different task functions.
383 - Fix race condition at task function worker usage executing task computation leading to negative value.
387 - 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).
388 - Use back pressure detection in worker choice strategies.
389 - Add worker choice strategies retries mechanism if no worker is eligible.
391 ## [2.6.28] - 2023-08-16
395 - Ensure pool workers are properly initialized.
399 - HTTP server pool examples: express-cluster, express-hybrid.
403 - Remove now useless branching in worker hot code path.
405 ## [2.6.27] - 2023-08-15
409 - Add `KillHandler` type definition to exported types.
413 - Add `destroy` event to pool API.
415 ## [2.6.26] - 2023-08-15
419 - Add kill handler to worker options allowing to execute custom code when worker is killed.
420 - Add `listTaskFunctions()` method to pool API.
421 - SMTP client pool example: nodemailer.
423 ## [2.6.25] - 2023-08-13
427 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
428 - WebSocket server pool examples: ws-cluster, ws-hybrid.
430 ## [2.6.24] - 2023-08-12
434 - Add array of transferable objects to the `execute()` method arguments.
435 - WebSocket server pool examples: ws-worker_threads.
437 ## [2.6.23] - 2023-08-11
441 - 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.
445 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
446 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
448 ## [2.6.22] - 2023-08-10
452 - Add missing `types` field to package.json `exports`.
456 - Structure markdown documentation (PR #811).
458 ## [2.6.21] - 2023-08-03
462 - Improve code documentation.
463 - Code refactoring and cleanup for better maintainability and readability.
465 ## [2.6.20] - 2023-07-21
469 - Fix queued tasks redistribution on error task execution starvation.
470 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
474 - Drastically reduce lookups by worker in the worker nodes.
476 ## [2.6.19] - 2023-07-20
480 - Dedicated internal communication channel for worker_threads pools.
482 ## [2.6.18] - 2023-07-19
486 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
488 ## [2.6.17] - 2023-07-16
492 - Add `listTaskFunctions()` method to worker API.
494 ## [2.6.16] - 2023-07-12
498 - Fix pool startup detection.
499 - Fix worker task functions handling.
501 ## [2.6.15] - 2023-07-11
505 - Take into account worker node readiness in worker choice strategies.
507 ## [2.6.14] - 2023-07-10
511 - Fix task function statistics tracking.
513 ## [2.6.13] - 2023-07-10
517 - Add per task function statistics tracking.
518 - Add public methods to manipulate the worker task functions at runtime.
520 ## [2.6.12] - 2023-07-09
524 - Workaround import issue with `node:os` module in node 16.x.x.
526 ## [2.6.11] - 2023-07-09
530 - Fix pool readiness semantic.
532 ## [2.6.10] - 2023-07-08
536 - Ensure workers are not recreated on error at pool startup.
540 - Add `ready` and `strategy` fields to pool information.
541 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
542 - Add dynamic pool sizing checks.
544 ## [2.6.9] - 2023-07-07
548 - Recreate the right worker type on uncaught exception.
552 - Add minimum and maximum to internal measurement statistics.
553 - Add `runTime` and `waitTime` to pool information.
554 - Check worker inactive time only on dynamic worker.
556 ## [2.6.8] - 2023-07-03
560 - Brown paper bag release to fix version handling in pool information.
562 ## [2.6.7] - 2023-07-03
566 - Ensure worker queued tasks at error are reassigned to other pool workers.
570 - Add pool `utilization` ratio to pool information.
571 - Add `version` to pool information.
572 - Add worker information to worker nodes.
574 ## [2.6.6] - 2023-07-01
578 - Add safe helper `availableParallelism()` to help sizing the pool.
582 - Ensure message handler is only registered in worker.
584 ## [2.6.5] - 2023-06-27
588 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
592 - Artificial version bump to 2.6.5 to workaround publication issue.
593 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
594 - Ensure pool event is emitted before task error promise rejection.
595 - Fix queued tasks count computation.
599 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
601 ## [2.6.4] - 2023-06-27
605 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
609 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
610 - Ensure pool event is emitted before task error promise rejection.
611 - Fix queued tasks count computation.
615 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
617 ## [2.6.3] - 2023-06-19
621 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
622 - Update strategies internals after statistics computation.
626 - Optimize O(1) queue implementation.
628 ## [2.6.2] - 2023-06-12
632 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
634 ## [2.6.1] - 2023-06-10
638 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
642 - Fix average statistics computation: ensure failed tasks are not accounted.
644 ## [2.6.0] - 2023-06-09
648 - Add `LEAST_ELU` worker choice strategy (experimental).
649 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
653 - Refactor pool worker node usage internals.
654 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
655 - Breaking change: pool information `info` property object fields have been renamed.
659 - Fix wait time accounting.
660 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
661 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
663 ## [2.5.4] - 2023-06-07
667 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
671 - Compute statistics at the worker level only if needed.
672 - Add `worker_threads` options to thread pool options.
676 - Make the `LEAST_BUSY` strategy only relies on task runtime.
678 ## [2.5.3] - 2023-06-04
682 - Refine pool information content.
683 - Limit pool internals public exposure.
685 ## [2.5.2] - 2023-06-02
689 - Add `taskError` pool event for task execution error.
690 - Add pool information `info` property to pool.
691 - Emit pool information on `busy` and `full` pool events.
693 ## [2.5.1] - 2023-06-01
697 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
698 - Add `error` pool event for uncaught worker error.
700 ## [2.5.0] - 2023-05-31
704 - Switch pool event emitter to `EventEmitterAsyncResource`.
705 - Add tasks wait time accounting in per worker tasks usage.
706 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
710 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
712 ## [2.4.14] - 2023-05-09
716 - Ensure no undefined task runtime can land in the tasks history.
717 - Fix median computation implementation once again.
721 - Unit tests for median and queue implementations.
723 ## [2.4.13] - 2023-05-08
727 - Fix worker choice strategy options validation.
728 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
730 ## [2.4.12] - 2023-05-06
734 - Support multiple task functions per worker.
735 - Add custom worker weights support to worker choice strategies options.
739 - Use O(1) queue implementation for tasks queueing.
743 - Fix median computation implementation.
744 - Fix fair share worker choice strategy internals update.
746 ## [2.4.11] - 2023-04-23
750 - Optimize free worker finding in worker choice strategies.
752 ## [2.4.10] - 2023-04-15
756 - Fix typescript type definition for task function: ensure the input data is optional.
757 - Fix typescript type definition for pool execute(): ensure the input data is optional.
759 ## [2.4.9] - 2023-04-15
763 - Add tasks queue enablement runtime setter to pool.
764 - Add tasks queue options runtime setter to pool.
765 - Add worker choice strategy options runtime setter to pool.
769 - Remove the tasks queuing experimental status.
773 - Fix task function type definition and validation.
774 - Fix worker choice strategy options handling.
776 ## [2.4.8] - 2023-04-12
780 - Fix message between main worker and worker type definition for tasks.
781 - Fix code documentation.
783 ## [2.4.7] - 2023-04-11
787 - Add worker tasks queue options to pool options.
791 - Fix missing documentation.
793 ## [2.4.6] - 2023-04-10
797 - Ensure one task at a time is executed per worker with tasks queueing enabled.
798 - Properly count worker executing tasks with tasks queueing enabled.
800 ## [2.4.5] - 2023-04-09
804 - Use monotonic high resolution timer for worker tasks runtime.
805 - Add worker tasks median runtime to statistics.
806 - Add worker tasks queue (experimental).
808 ## [2.4.4] - 2023-04-07
812 - Add `PoolEvents` enumeration and `PoolEvent` type.
816 - Destroy worker only on alive check.
818 ## [2.4.3] - 2023-04-07
822 - Fix typedoc generation with inheritance.
824 ## [2.4.2] - 2023-04-06
828 - Add `full` event to dynamic pool.
829 - Keep worker choice strategy in memory for conditional reuse.
833 - Fix possible negative worker key at worker removal in worker choice strategies.
835 ## [2.4.1] - 2023-04-05
839 - Optimize worker choice strategy for dynamic pool.
843 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
845 ## [2.4.0] - 2023-04-04
849 - Add `LESS_BUSY` worker choice strategy.
853 - Optimize worker storage in pool.
854 - Optimize worker alive status check.
855 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
856 - Optimize `LESS_USED` worker choice strategy.
857 - Update benchmark versus external threads pools.
858 - Optimize tasks usage statistics requirements for worker choice strategy.
862 - Ensure trimmable characters are checked at pool initialization.
863 - Fix message id integer overflow.
864 - Fix pool worker removal in worker choice strategy internals.
865 - Fix package publication with pnpm.
867 ## [2.4.0-3] - 2023-04-04
871 - Add `LESS_BUSY` worker choice strategy.
875 - Optimize worker storage in pool.
876 - Optimize worker alive status check.
877 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
878 - Optimize `LESS_USED` worker choice strategy.
879 - Update benchmark versus external threads pools.
883 - Ensure trimmable characters are checked at pool initialization.
884 - Fix message id integer overflow.
885 - Fix pool worker removal in worker choice strategy internals.
886 - Fix package publication with pnpm.
888 ## [2.4.0-2] - 2023-04-03
892 - Add `LESS_BUSY` worker choice strategy.
896 - Optimize worker storage in pool.
897 - Optimize worker alive status check.
898 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
899 - Optimize `LESS_USED` worker choice strategy.
903 - Ensure trimmable characters are checked at pool initialization.
904 - Fix message id integer overflow.
905 - Fix pool worker removal in worker choice strategy internals.
906 - Fix package publication with pnpm.
908 ## [2.4.0-1] - 2023-04-03
912 - Add `LESS_BUSY` worker choice strategy.
916 - Optimize worker storage in pool.
917 - Optimize worker alive status check.
918 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
919 - Optimize `LESS_USED` worker choice strategy.
923 - Ensure trimmable characters are checked at pool initialization.
924 - Fix message id integer overflow.
925 - Fix pool worker removal in worker choice strategy internals.
927 ## [2.4.0-0] - 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.3.10] - 2023-03-18
950 - Fix package.json `exports` syntax for ESM and CommonJS.
954 - Permit SemVer pre-release publication.
956 ## [2.3.10-2] - 2023-03-18
960 - Fix package.json `exports` syntax for ESM and CommonJS.
962 ## [2.3.10-1] - 2023-03-18
966 - Permit SemVer pre-release publication.
968 ## [2.3.10-0] - 2023-03-18
972 - Fix package.json `exports` syntax for ESM and CommonJS.
974 ## [2.3.9] - 2023-03-18
978 - Introduce ESM module support along with CommonJS one.
982 - Fix brown paper bag bug referencing the same object literal.
984 ## [2.3.8] - 2023-03-18
988 - Switch internal benchmarking code to benny.
989 - Switch to TypeScript 5.x.x.
990 - Switch rollup bundler plugins to core ones.
991 - Switch to TSDoc syntax.
992 - Enforce conventional commits.
996 - Fix random integer generator.
997 - Fix worker choice strategy pool type identification at initialization.
999 ## [2.3.7] - 2022-10-23
1003 - Switch to open collective FOSS project funding platform.
1004 - Switch to ts-standard linter configuration on TypeScript code.
1008 - Fixed missing async on pool execute method.
1009 - Fixed typing in TypeScript example.
1010 - Fixed types in unit tests.
1012 ## [2.3.6] - 2022-10-22
1016 - Cleanup pool attributes and methods.
1017 - Refine error types thrown.
1021 - Fix continuous integration build on windows.
1022 - Fix code coverage reporting by using c8 instead of nyc.
1024 ## [2.3.5] - 2022-10-21
1028 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1029 - Optimize tasks usage lookup implementation.
1033 - Fix missed pool event emitter type export.
1034 - Fix typedoc documentation generation.
1036 ## [2.3.4] - 2022-10-17
1040 - Fully automate release process with release-it.
1044 - Optimize fair share task scheduling algorithm implementation.
1045 - Update benchmark versus external pools results with latest version.
1047 ## [2.3.3] - 2022-10-15
1051 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1053 ## [2.3.2] - 2022-10-14
1057 - Optimize fair share worker selection strategy implementation.
1061 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1063 ## [2.3.1] - 2022-10-13
1067 - Pool worker choice strategies:
1068 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1069 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1071 ## [2.2.2] - 2022-10-09
1075 - Fixed `README.md` file.
1077 ## [2.2.1] - 2022-10-08
1081 - Dynamic worker choice strategy change at runtime.
1083 ## [2.2.0] - 2022-01-05
1085 ### Breaking Changes
1087 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1089 ## [2.1.0] - 2021-08-29
1093 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1095 ### Breaking Changes
1097 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1098 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1099 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1100 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1102 ## [2.0.2] - 2021-05-12
1106 - Fix `busy` event emission on fixed pool type
1108 ## [2.0.1] - 2021-03-16
1112 - Check if pool options are properly set.
1113 - `busy` event is emitted on all pool types.
1115 ## [2.0.0] - 2021-03-01
1119 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1121 ### Breaking Changes
1123 - `FullPool` event is now renamed to `busy`.
1124 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1125 _Find more details on our JSDoc._
1127 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1129 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1131 ### Pool options types declaration merge
1133 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1135 #### New `export` strategy
1139 const DynamicThreadPool = require('poolifier/lib/dynamic')
1141 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1144 But you should always prefer just using
1147 const { DynamicThreadPool } = require('poolifier')
1150 #### New type definitions for input data and response
1152 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1153 _This is not a limitation by poolifier but Node.js._
1155 #### Public property replacements
1157 `numWorkers` property is now `numberOfWorkers`
1159 #### Internal (protected) properties and methods renaming
1161 These properties are not intended for end users
1163 - `id` => `nextMessageId`
1165 These methods are not intended for end users
1167 - `_chooseWorker` => `chooseWorker`
1168 - `_newWorker` => `createWorker`
1169 - `_execute` => `internalExecute`
1170 - `_chooseWorker` => `chooseWorker`
1171 - `_checkAlive` => `checkAlive`
1173 - `_runAsync` => `runAsync`
1175 ## [1.1.0] - 2020-05-21
1179 - ThreadWorker support async functions as option
1180 - Various external library patches
1182 ## [1.0.0] - 2020-01-24
1186 - FixedThreadPool implementation
1187 - DynamicThreadPool implementation
1188 - WorkerThread implementation to improve developer experience