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.13] - 2023-12-30
14 - Reduce branching in several hot code paths.
15 - Use faster object cloning implementation.
17 ## [3.1.12] - 2023-12-27
21 - Fix tasks redistribution triggers at pool destroying.
25 - Switch TypeScript module resolution to Node16.
27 ## [3.1.12-0] - 2023-12-27
31 - Fix tasks redistribution triggers at pool destroying.
33 ## [3.1.11] - 2023-12-24
37 - Avoid worker node cross tasks stealing.
38 - Ensure only half the pool worker nodes can steal tasks.
40 ## [3.1.10] - 2023-12-23
44 - Avoid useless branching on pool type.
46 ## [3.1.9] - 2023-12-22
50 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
52 ## [3.1.8] - 2023-12-21
56 - Fix default worker weight computation.
57 - Fix possible null exception at pool destroying.
59 ## [3.1.7] - 2023-12-20
63 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
65 ## [3.1.6] - 2023-12-18
69 - Fix pool destroying with tasks queuing enabled.
71 ## [3.1.5] - 2023-12-18
75 - Add queued tasks end timeout support to worker node termination.
77 ## [3.1.4] - 2023-12-18
81 - Make more robust the fix for possible null exception at handling task execution response.
83 ## [3.1.3] - 2023-12-17
87 - Fix possible null exception at handling task execution response.
89 ## [3.1.2] - 2023-12-17
93 - Wait for queued tasks to end at worker node termination.
95 ## [3.1.1] - 2023-12-16
99 - Fix pool options TS type definition.
101 ## [3.1.0] - 2023-12-16
105 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
107 ## [3.0.14] - 2023-12-13
111 - Fix possible null exception with worker_threads pools.
113 ## [3.0.13] - 2023-12-12
117 - Ensure worker choice strategy wait for worker nodes readiness.
121 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
123 ## [3.0.12] - 2023-12-12
127 - Add infinite retries support in worker choice strategy.
129 ## [3.0.11] - 2023-12-11
133 - Ensure pool asynchronous resource properly track tasks execution.
135 ## [3.0.10] - 2023-12-08
139 - Add a fastpath when tasks stealing or redistribution is impossible.
141 ## [3.0.9] - 2023-11-26
145 - Remove all pool events listener at pool destroying.
146 - Remove all worker node events listener at worker node destroying.
147 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
149 ## [3.0.8] - 2023-11-25
153 - Ensure continuous tasks stealing on idle start at worker node idling.
155 ## [3.0.7] - 2023-11-24
159 - Make continuous tasks stealing start at worker node idling.
161 ## [3.0.6] - 2023-11-24
165 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
166 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
168 ## [3.0.5] - 2023-10-27
172 - Ensure pool `ready` event can be emitted only once.
174 ## [3.0.4] - 2023-10-20
178 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
179 - Use builtin retry mechanism in worker choice strategies instead of custom one.
181 ## [3.0.3] - 2023-10-19
185 - Avoid null exception at sending message to worker.
186 - Avoid null exception at checking worker node readiness.
188 ## [3.0.2] - 2023-10-17
192 - 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).
194 ## [3.0.1] - 2023-10-16
198 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
202 - Switch the worker node eventing code to `EventTarget` API.
204 ## [3.0.0] - 2023-10-08
208 - Remove Node.js 16.x.x (EOL) support.
210 ## [2.7.5] - 2023-10-03
214 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
216 ## [2.7.4] - 2023-09-25
220 - Fix source maps (bundler issue).
222 ## [2.7.3] - 2023-09-24
226 - Convert pool event emitter to event emitter async resource.
228 ## [2.7.2] - 2023-09-23
232 - Add source maps to npm package to ease debugging.
236 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
238 ## [2.7.1] - 2023-09-20
242 - Ensure worker message listener used one time are removed after usage.
244 ## [2.7.0] - 2023-09-19
248 - Fix task stealing related tasks queue options handling at runtime.
252 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
256 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
257 - Stricter worker constructor arguments validation.
259 ## [2.6.45] - 2023-09-17
263 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
267 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
268 - Add `start()` method to pool API to start the minimum number of workers.
269 - 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.
270 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
272 ## [2.6.44] - 2023-09-08
276 - Use a dedicated PAT to publish on GitHub packages registry.
280 - Publish on GitHub packages registry on release.
284 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
286 ## [2.6.43] - 2023-09-08
290 - Publish on GitHub packages registry on release.
294 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
296 ## [2.6.42] - 2023-09-06
300 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
302 ## [2.6.41] - 2023-09-03
306 - Optimize worker choice strategies implementation.
308 ## [2.6.40] - 2023-09-01
312 - Do not pre-choose in WRR worker choice strategy to avoid bias.
313 - Avoid array out of bound in worker choice strategies after worker node removal.
315 ## [2.6.39] - 2023-08-30
319 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
321 ## [2.6.38] - 2023-08-30
325 - Bundle typescript types declaration into one file.
329 - Improve interleaved weighted round robin worker choice strategy implementation.
331 ## [2.6.37] - 2023-08-28
335 - Ensure unused worker usage statistics are deleted at runtime.
339 - Rename worker choice strategy options `choiceRetries` to `retries`.
340 - Avoid unnecessary branching in worker choice strategies.
342 ## [2.6.36] - 2023-08-27
346 - Fix pool `execute()` arguments check.
350 - Make continuous tasks stealing algorithm less aggressive.
351 - Fine tune tasks stealing algorithm under back pressure.
353 ## [2.6.35] - 2023-08-25
357 - Don't account worker usage statistics for tasks that have failed.
358 - Fix pool information runtime and wait time median computation.
362 - Update simple moving average implementation to use a circular buffer.
363 - Update simple moving median implementation to use a circular buffer.
364 - Account for stolen tasks in worker usage statistics and pool information.
368 - Continuous tasks stealing algorithm.
370 ## [2.6.34] - 2023-08-24
374 - Avoid cascading tasks stealing under back pressure.
378 - Add fastpath to queued tasks rescheduling.
380 ## [2.6.33] - 2023-08-24
384 - Fix queued tasks rescheduling.
388 - Rename tasks queue options `queueMaxSize` to `size`.
392 - Task stealing scheduling algorithm if tasks queueing is enabled.
394 ## [2.6.32] - 2023-08-23
398 - Ensure no task can be executed when the pool is destroyed.
402 - Add `queueMaxSize` option to tasks queue options.
403 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
404 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
406 ## [2.6.31] - 2023-08-20
410 - Fix worker choice strategy retries mechanism in some edge cases.
414 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
415 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
417 ## [2.6.30] - 2023-08-19
421 - Ensure pool event `backPressure` is emitted.
422 - Ensure pool event `full` is emitted only once.
423 - Ensure worker node cannot be instantiated without proper arguments.
425 ## [2.6.29] - 2023-08-18
429 - Fix race condition between readiness and task functions worker message handling at startup.
430 - Fix duplicate task function worker usage statistics computation per task function.
431 - Update task function worker usage statistics if and only if there's at least two different task functions.
432 - Fix race condition at task function worker usage executing task computation leading to negative value.
436 - 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).
437 - Use back pressure detection in worker choice strategies.
438 - Add worker choice strategies retries mechanism if no worker is eligible.
440 ## [2.6.28] - 2023-08-16
444 - Ensure pool workers are properly initialized.
448 - HTTP server pool examples: express-cluster, express-hybrid.
452 - Remove now useless branching in worker hot code path.
454 ## [2.6.27] - 2023-08-15
458 - Add `KillHandler` type definition to exported types.
462 - Add `destroy` event to pool API.
464 ## [2.6.26] - 2023-08-15
468 - Add kill handler to worker options allowing to execute custom code when worker is killed.
469 - Add `listTaskFunctions()` method to pool API.
470 - SMTP client pool example: nodemailer.
472 ## [2.6.25] - 2023-08-13
476 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
477 - WebSocket server pool examples: ws-cluster, ws-hybrid.
479 ## [2.6.24] - 2023-08-12
483 - Add array of transferable objects to the `execute()` method arguments.
484 - WebSocket server pool examples: ws-worker_threads.
486 ## [2.6.23] - 2023-08-11
490 - 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.
494 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
495 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
497 ## [2.6.22] - 2023-08-10
501 - Add missing `types` field to package.json `exports`.
505 - Structure markdown documentation (PR #811).
507 ## [2.6.21] - 2023-08-03
511 - Improve code documentation.
512 - Code refactoring and cleanup for better maintainability and readability.
514 ## [2.6.20] - 2023-07-21
518 - Fix queued tasks redistribution on error task execution starvation.
519 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
523 - Drastically reduce lookups by worker in the worker nodes.
525 ## [2.6.19] - 2023-07-20
529 - Dedicated internal communication channel for worker_threads pools.
531 ## [2.6.18] - 2023-07-19
535 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
537 ## [2.6.17] - 2023-07-16
541 - Add `listTaskFunctions()` method to worker API.
543 ## [2.6.16] - 2023-07-12
547 - Fix pool startup detection.
548 - Fix worker task functions handling.
550 ## [2.6.15] - 2023-07-11
554 - Take into account worker node readiness in worker choice strategies.
556 ## [2.6.14] - 2023-07-10
560 - Fix task function statistics tracking.
562 ## [2.6.13] - 2023-07-10
566 - Add per task function statistics tracking.
567 - Add public methods to manipulate the worker task functions at runtime.
569 ## [2.6.12] - 2023-07-09
573 - Workaround import issue with `node:os` module in node 16.x.x.
575 ## [2.6.11] - 2023-07-09
579 - Fix pool readiness semantic.
581 ## [2.6.10] - 2023-07-08
585 - Ensure workers are not recreated on error at pool startup.
589 - Add `ready` and `strategy` fields to pool information.
590 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
591 - Add dynamic pool sizing checks.
593 ## [2.6.9] - 2023-07-07
597 - Recreate the right worker type on uncaught exception.
601 - Add minimum and maximum to internal measurement statistics.
602 - Add `runTime` and `waitTime` to pool information.
603 - Check worker inactive time only on dynamic worker.
605 ## [2.6.8] - 2023-07-03
609 - Brown paper bag release to fix version handling in pool information.
611 ## [2.6.7] - 2023-07-03
615 - Ensure worker queued tasks at error are reassigned to other pool workers.
619 - Add pool `utilization` ratio to pool information.
620 - Add `version` to pool information.
621 - Add worker information to worker nodes.
623 ## [2.6.6] - 2023-07-01
627 - Add safe helper `availableParallelism()` to help sizing the pool.
631 - Ensure message handler is only registered in worker.
633 ## [2.6.5] - 2023-06-27
637 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
641 - Artificial version bump to 2.6.5 to workaround publication issue.
642 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
643 - Ensure pool event is emitted before task error promise rejection.
644 - Fix queued tasks count computation.
648 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
650 ## [2.6.4] - 2023-06-27
654 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
658 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
659 - Ensure pool event is emitted before task error promise rejection.
660 - Fix queued tasks count computation.
664 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
666 ## [2.6.3] - 2023-06-19
670 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
671 - Update strategies internals after statistics computation.
675 - Optimize O(1) queue implementation.
677 ## [2.6.2] - 2023-06-12
681 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
683 ## [2.6.1] - 2023-06-10
687 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
691 - Fix average statistics computation: ensure failed tasks are not accounted.
693 ## [2.6.0] - 2023-06-09
697 - Add `LEAST_ELU` worker choice strategy (experimental).
698 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
702 - Refactor pool worker node usage internals.
703 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
704 - Breaking change: pool information `info` property object fields have been renamed.
708 - Fix wait time accounting.
709 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
710 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
712 ## [2.5.4] - 2023-06-07
716 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
720 - Compute statistics at the worker level only if needed.
721 - Add `worker_threads` options to thread pool options.
725 - Make the `LEAST_BUSY` strategy only relies on task runtime.
727 ## [2.5.3] - 2023-06-04
731 - Refine pool information content.
732 - Limit pool internals public exposure.
734 ## [2.5.2] - 2023-06-02
738 - Add `taskError` pool event for task execution error.
739 - Add pool information `info` property to pool.
740 - Emit pool information on `busy` and `full` pool events.
742 ## [2.5.1] - 2023-06-01
746 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
747 - Add `error` pool event for uncaught worker error.
749 ## [2.5.0] - 2023-05-31
753 - Switch pool event emitter to `EventEmitterAsyncResource`.
754 - Add tasks wait time accounting in per worker tasks usage.
755 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
759 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
761 ## [2.4.14] - 2023-05-09
765 - Ensure no undefined task runtime can land in the tasks history.
766 - Fix median computation implementation once again.
770 - Unit tests for median and queue implementations.
772 ## [2.4.13] - 2023-05-08
776 - Fix worker choice strategy options validation.
777 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
779 ## [2.4.12] - 2023-05-06
783 - Support multiple task functions per worker.
784 - Add custom worker weights support to worker choice strategies options.
788 - Use O(1) queue implementation for tasks queueing.
792 - Fix median computation implementation.
793 - Fix fair share worker choice strategy internals update.
795 ## [2.4.11] - 2023-04-23
799 - Optimize free worker finding in worker choice strategies.
801 ## [2.4.10] - 2023-04-15
805 - Fix typescript type definition for task function: ensure the input data is optional.
806 - Fix typescript type definition for pool execute(): ensure the input data is optional.
808 ## [2.4.9] - 2023-04-15
812 - Add tasks queue enablement runtime setter to pool.
813 - Add tasks queue options runtime setter to pool.
814 - Add worker choice strategy options runtime setter to pool.
818 - Remove the tasks queuing experimental status.
822 - Fix task function type definition and validation.
823 - Fix worker choice strategy options handling.
825 ## [2.4.8] - 2023-04-12
829 - Fix message between main worker and worker type definition for tasks.
830 - Fix code documentation.
832 ## [2.4.7] - 2023-04-11
836 - Add worker tasks queue options to pool options.
840 - Fix missing documentation.
842 ## [2.4.6] - 2023-04-10
846 - Ensure one task at a time is executed per worker with tasks queueing enabled.
847 - Properly count worker executing tasks with tasks queueing enabled.
849 ## [2.4.5] - 2023-04-09
853 - Use monotonic high resolution timer for worker tasks runtime.
854 - Add worker tasks median runtime to statistics.
855 - Add worker tasks queue (experimental).
857 ## [2.4.4] - 2023-04-07
861 - Add `PoolEvents` enumeration and `PoolEvent` type.
865 - Destroy worker only on alive check.
867 ## [2.4.3] - 2023-04-07
871 - Fix typedoc generation with inheritance.
873 ## [2.4.2] - 2023-04-06
877 - Add `full` event to dynamic pool.
878 - Keep worker choice strategy in memory for conditional reuse.
882 - Fix possible negative worker key at worker removal in worker choice strategies.
884 ## [2.4.1] - 2023-04-05
888 - Optimize worker choice strategy for dynamic pool.
892 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
894 ## [2.4.0] - 2023-04-04
898 - Add `LESS_BUSY` worker choice strategy.
902 - Optimize worker storage in pool.
903 - Optimize worker alive status check.
904 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
905 - Optimize `LESS_USED` worker choice strategy.
906 - Update benchmark versus external threads pools.
907 - Optimize tasks usage statistics requirements for worker choice strategy.
911 - Ensure trimmable characters are checked at pool initialization.
912 - Fix message id integer overflow.
913 - Fix pool worker removal in worker choice strategy internals.
914 - Fix package publication with pnpm.
916 ## [2.4.0-3] - 2023-04-04
920 - Add `LESS_BUSY` worker choice strategy.
924 - Optimize worker storage in pool.
925 - Optimize worker alive status check.
926 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
927 - Optimize `LESS_USED` worker choice strategy.
928 - Update benchmark versus external threads pools.
932 - Ensure trimmable characters are checked at pool initialization.
933 - Fix message id integer overflow.
934 - Fix pool worker removal in worker choice strategy internals.
935 - Fix package publication with pnpm.
937 ## [2.4.0-2] - 2023-04-03
941 - Add `LESS_BUSY` worker choice strategy.
945 - Optimize worker storage in pool.
946 - Optimize worker alive status check.
947 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
948 - Optimize `LESS_USED` worker choice strategy.
952 - Ensure trimmable characters are checked at pool initialization.
953 - Fix message id integer overflow.
954 - Fix pool worker removal in worker choice strategy internals.
955 - Fix package publication with pnpm.
957 ## [2.4.0-1] - 2023-04-03
961 - Add `LESS_BUSY` worker choice strategy.
965 - Optimize worker storage in pool.
966 - Optimize worker alive status check.
967 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
968 - Optimize `LESS_USED` worker choice strategy.
972 - Ensure trimmable characters are checked at pool initialization.
973 - Fix message id integer overflow.
974 - Fix pool worker removal in worker choice strategy internals.
976 ## [2.4.0-0] - 2023-04-03
980 - Add `LESS_BUSY` worker choice strategy.
984 - Optimize worker storage in pool.
985 - Optimize worker alive status check.
986 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
987 - Optimize `LESS_USED` worker choice strategy.
991 - Ensure trimmable characters are checked at pool initialization.
992 - Fix message id integer overflow.
993 - Fix pool worker removal in worker choice strategy internals.
995 ## [2.3.10] - 2023-03-18
999 - Fix package.json `exports` syntax for ESM and CommonJS.
1003 - Permit SemVer pre-release publication.
1005 ## [2.3.10-2] - 2023-03-18
1009 - Fix package.json `exports` syntax for ESM and CommonJS.
1011 ## [2.3.10-1] - 2023-03-18
1015 - Permit SemVer pre-release publication.
1017 ## [2.3.10-0] - 2023-03-18
1021 - Fix package.json `exports` syntax for ESM and CommonJS.
1023 ## [2.3.9] - 2023-03-18
1027 - Introduce ESM module support along with CommonJS one.
1031 - Fix brown paper bag bug referencing the same object literal.
1033 ## [2.3.8] - 2023-03-18
1037 - Switch internal benchmarking code to benny.
1038 - Switch to TypeScript 5.x.x.
1039 - Switch rollup bundler plugins to core ones.
1040 - Switch to TSDoc syntax.
1041 - Enforce conventional commits.
1045 - Fix random integer generator.
1046 - Fix worker choice strategy pool type identification at initialization.
1048 ## [2.3.7] - 2022-10-23
1052 - Switch to open collective FOSS project funding platform.
1053 - Switch to ts-standard linter configuration on TypeScript code.
1057 - Fixed missing async on pool execute method.
1058 - Fixed typing in TypeScript example.
1059 - Fixed types in unit tests.
1061 ## [2.3.6] - 2022-10-22
1065 - Cleanup pool attributes and methods.
1066 - Refine error types thrown.
1070 - Fix continuous integration build on windows.
1071 - Fix code coverage reporting by using c8 instead of nyc.
1073 ## [2.3.5] - 2022-10-21
1077 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1078 - Optimize tasks usage lookup implementation.
1082 - Fix missed pool event emitter type export.
1083 - Fix typedoc documentation generation.
1085 ## [2.3.4] - 2022-10-17
1089 - Fully automate release process with release-it.
1093 - Optimize fair share task scheduling algorithm implementation.
1094 - Update benchmark versus external pools results with latest version.
1096 ## [2.3.3] - 2022-10-15
1100 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1102 ## [2.3.2] - 2022-10-14
1106 - Optimize fair share worker selection strategy implementation.
1110 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1112 ## [2.3.1] - 2022-10-13
1116 - Pool worker choice strategies:
1117 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1118 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1120 ## [2.2.2] - 2022-10-09
1124 - Fixed `README.md` file.
1126 ## [2.2.1] - 2022-10-08
1130 - Dynamic worker choice strategy change at runtime.
1132 ## [2.2.0] - 2022-01-05
1134 ### Breaking Changes
1136 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1138 ## [2.1.0] - 2021-08-29
1142 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1144 ### Breaking Changes
1146 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1147 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1148 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1149 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1151 ## [2.0.2] - 2021-05-12
1155 - Fix `busy` event emission on fixed pool type
1157 ## [2.0.1] - 2021-03-16
1161 - Check if pool options are properly set.
1162 - `busy` event is emitted on all pool types.
1164 ## [2.0.0] - 2021-03-01
1168 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1170 ### Breaking Changes
1172 - `FullPool` event is now renamed to `busy`.
1173 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1174 _Find more details on our JSDoc._
1176 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1178 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1180 ### Pool options types declaration merge
1182 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1184 #### New `export` strategy
1188 const DynamicThreadPool = require('poolifier/lib/dynamic')
1190 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1193 But you should always prefer just using
1196 const { DynamicThreadPool } = require('poolifier')
1199 #### New type definitions for input data and response
1201 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1202 _This is not a limitation by poolifier but Node.js._
1204 #### Public property replacements
1206 `numWorkers` property is now `numberOfWorkers`
1208 #### Internal (protected) properties and methods renaming
1210 These properties are not intended for end users
1212 - `id` => `nextMessageId`
1214 These methods are not intended for end users
1216 - `_chooseWorker` => `chooseWorker`
1217 - `_newWorker` => `createWorker`
1218 - `_execute` => `internalExecute`
1219 - `_chooseWorker` => `chooseWorker`
1220 - `_checkAlive` => `checkAlive`
1222 - `_runAsync` => `runAsync`
1224 ## [1.1.0] - 2020-05-21
1228 - ThreadWorker support async functions as option
1229 - Various external library patches
1231 ## [1.0.0] - 2020-01-24
1235 - FixedThreadPool implementation
1236 - DynamicThreadPool implementation
1237 - WorkerThread implementation to improve developer experience