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.21] - 2024-02-22
14 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
16 ## [3.1.20] - 2024-02-11
20 - Ensure `worker_threads` workers are unreferenced at termination.
22 ## [3.1.19] - 2024-01-16
26 - Fix possible null exception at task finishing handling.
30 - Optimize Deque implementation to improve tasks queueing performance.
32 ## [3.1.18] - 2024-01-06
36 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
38 ## [3.1.17] - 2024-01-05
42 - Improve performance by clean up unneeded condition checks on hot code paths.
44 ## [3.1.16] - 2024-01-03
48 - Add missing type to TS type definitions.
50 ## [3.1.15] - 2024-01-02
54 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
56 ## [3.1.15-0] - 2024-01-02
60 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
62 ## [3.1.14] - 2024-01-01
66 - Properly handle dynamic pool with zero minimum size.
68 ## [3.1.13] - 2023-12-30
72 - Reduce branching in several hot code paths.
73 - Use faster object cloning implementation.
75 ## [3.1.12] - 2023-12-27
79 - Fix tasks redistribution triggers at pool destroying.
83 - Switch TypeScript module resolution to Node16.
85 ## [3.1.12-0] - 2023-12-27
89 - Fix tasks redistribution triggers at pool destroying.
91 ## [3.1.11] - 2023-12-24
95 - Avoid worker node cross tasks stealing.
96 - Ensure only half the pool worker nodes can steal tasks.
98 ## [3.1.10] - 2023-12-23
102 - Avoid useless branching on pool type.
104 ## [3.1.9] - 2023-12-22
108 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
110 ## [3.1.8] - 2023-12-21
114 - Fix default worker weight computation.
115 - Fix possible null exception at pool destroying.
117 ## [3.1.7] - 2023-12-20
121 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
123 ## [3.1.6] - 2023-12-18
127 - Fix pool destroying with tasks queuing enabled.
129 ## [3.1.5] - 2023-12-18
133 - Add queued tasks end timeout support to worker node termination.
135 ## [3.1.4] - 2023-12-18
139 - Make more robust the fix for possible null exception at handling task execution response.
141 ## [3.1.3] - 2023-12-17
145 - Fix possible null exception at handling task execution response.
147 ## [3.1.2] - 2023-12-17
151 - Wait for queued tasks to end at worker node termination.
153 ## [3.1.1] - 2023-12-16
157 - Fix pool options TS type definition.
159 ## [3.1.0] - 2023-12-16
163 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
165 ## [3.0.14] - 2023-12-13
169 - Fix possible null exception with worker_threads pools.
171 ## [3.0.13] - 2023-12-12
175 - Ensure worker choice strategy wait for worker nodes readiness.
179 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
181 ## [3.0.12] - 2023-12-12
185 - Add infinite retries support in worker choice strategy.
187 ## [3.0.11] - 2023-12-11
191 - Ensure pool asynchronous resource properly track tasks execution.
193 ## [3.0.10] - 2023-12-08
197 - Add a fastpath when tasks stealing or redistribution is impossible.
199 ## [3.0.9] - 2023-11-26
203 - Remove all pool events listener at pool destroying.
204 - Remove all worker node events listener at worker node destroying.
205 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
207 ## [3.0.8] - 2023-11-25
211 - Ensure continuous tasks stealing on idle start at worker node idling.
213 ## [3.0.7] - 2023-11-24
217 - Make continuous tasks stealing start at worker node idling.
219 ## [3.0.6] - 2023-11-24
223 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
224 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
226 ## [3.0.5] - 2023-10-27
230 - Ensure pool `ready` event can be emitted only once.
232 ## [3.0.4] - 2023-10-20
236 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
237 - Use builtin retry mechanism in worker choice strategies instead of custom one.
239 ## [3.0.3] - 2023-10-19
243 - Avoid null exception at sending message to worker.
244 - Avoid null exception at checking worker node readiness.
246 ## [3.0.2] - 2023-10-17
250 - 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).
252 ## [3.0.1] - 2023-10-16
256 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
260 - Switch the worker node eventing code to `EventTarget` API.
262 ## [3.0.0] - 2023-10-08
266 - Remove Node.js 16.x.x (EOL) support.
268 ## [2.7.5] - 2023-10-03
272 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
274 ## [2.7.4] - 2023-09-25
278 - Fix source maps (bundler issue).
280 ## [2.7.3] - 2023-09-24
284 - Convert pool event emitter to event emitter async resource.
286 ## [2.7.2] - 2023-09-23
290 - Add source maps to npm package to ease debugging.
294 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
296 ## [2.7.1] - 2023-09-20
300 - Ensure worker message listener used one time are removed after usage.
302 ## [2.7.0] - 2023-09-19
306 - Fix task stealing related tasks queue options handling at runtime.
310 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
314 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
315 - Stricter worker constructor arguments validation.
317 ## [2.6.45] - 2023-09-17
321 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
325 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
326 - Add `start()` method to pool API to start the minimum number of workers.
327 - 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.
328 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
330 ## [2.6.44] - 2023-09-08
334 - Use a dedicated PAT to publish on GitHub packages registry.
338 - Publish on GitHub packages registry on release.
342 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
344 ## [2.6.43] - 2023-09-08
348 - Publish on GitHub packages registry on release.
352 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
354 ## [2.6.42] - 2023-09-06
358 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
360 ## [2.6.41] - 2023-09-03
364 - Optimize worker choice strategies implementation.
366 ## [2.6.40] - 2023-09-01
370 - Do not pre-choose in WRR worker choice strategy to avoid bias.
371 - Avoid array out of bound in worker choice strategies after worker node removal.
373 ## [2.6.39] - 2023-08-30
377 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
379 ## [2.6.38] - 2023-08-30
383 - Bundle typescript types declaration into one file.
387 - Improve interleaved weighted round robin worker choice strategy implementation.
389 ## [2.6.37] - 2023-08-28
393 - Ensure unused worker usage statistics are deleted at runtime.
397 - Rename worker choice strategy options `choiceRetries` to `retries`.
398 - Avoid unnecessary branching in worker choice strategies.
400 ## [2.6.36] - 2023-08-27
404 - Fix pool `execute()` arguments check.
408 - Make continuous tasks stealing algorithm less aggressive.
409 - Fine tune tasks stealing algorithm under back pressure.
411 ## [2.6.35] - 2023-08-25
415 - Don't account worker usage statistics for tasks that have failed.
416 - Fix pool information runtime and wait time median computation.
420 - Update simple moving average implementation to use a circular buffer.
421 - Update simple moving median implementation to use a circular buffer.
422 - Account for stolen tasks in worker usage statistics and pool information.
426 - Continuous tasks stealing algorithm.
428 ## [2.6.34] - 2023-08-24
432 - Avoid cascading tasks stealing under back pressure.
436 - Add fastpath to queued tasks rescheduling.
438 ## [2.6.33] - 2023-08-24
442 - Fix queued tasks rescheduling.
446 - Rename tasks queue options `queueMaxSize` to `size`.
450 - Task stealing scheduling algorithm if tasks queueing is enabled.
452 ## [2.6.32] - 2023-08-23
456 - Ensure no task can be executed when the pool is destroyed.
460 - Add `queueMaxSize` option to tasks queue options.
461 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
462 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
464 ## [2.6.31] - 2023-08-20
468 - Fix worker choice strategy retries mechanism in some edge cases.
472 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
473 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
475 ## [2.6.30] - 2023-08-19
479 - Ensure pool event `backPressure` is emitted.
480 - Ensure pool event `full` is emitted only once.
481 - Ensure worker node cannot be instantiated without proper arguments.
483 ## [2.6.29] - 2023-08-18
487 - Fix race condition between readiness and task functions worker message handling at startup.
488 - Fix duplicate task function worker usage statistics computation per task function.
489 - Update task function worker usage statistics if and only if there's at least two different task functions.
490 - Fix race condition at task function worker usage executing task computation leading to negative value.
494 - 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).
495 - Use back pressure detection in worker choice strategies.
496 - Add worker choice strategies retries mechanism if no worker is eligible.
498 ## [2.6.28] - 2023-08-16
502 - Ensure pool workers are properly initialized.
506 - HTTP server pool examples: express-cluster, express-hybrid.
510 - Remove now useless branching in worker hot code path.
512 ## [2.6.27] - 2023-08-15
516 - Add `KillHandler` type definition to exported types.
520 - Add `destroy` event to pool API.
522 ## [2.6.26] - 2023-08-15
526 - Add kill handler to worker options allowing to execute custom code when worker is killed.
527 - Add `listTaskFunctions()` method to pool API.
528 - SMTP client pool example: nodemailer.
530 ## [2.6.25] - 2023-08-13
534 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
535 - WebSocket server pool examples: ws-cluster, ws-hybrid.
537 ## [2.6.24] - 2023-08-12
541 - Add array of transferable objects to the `execute()` method arguments.
542 - WebSocket server pool examples: ws-worker_threads.
544 ## [2.6.23] - 2023-08-11
548 - 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.
552 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
553 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
555 ## [2.6.22] - 2023-08-10
559 - Add missing `types` field to package.json `exports`.
563 - Structure markdown documentation (PR #811).
565 ## [2.6.21] - 2023-08-03
569 - Improve code documentation.
570 - Code refactoring and cleanup for better maintainability and readability.
572 ## [2.6.20] - 2023-07-21
576 - Fix queued tasks redistribution on error task execution starvation.
577 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
581 - Drastically reduce lookups by worker in the worker nodes.
583 ## [2.6.19] - 2023-07-20
587 - Dedicated internal communication channel for worker_threads pools.
589 ## [2.6.18] - 2023-07-19
593 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
595 ## [2.6.17] - 2023-07-16
599 - Add `listTaskFunctions()` method to worker API.
601 ## [2.6.16] - 2023-07-12
605 - Fix pool startup detection.
606 - Fix worker task functions handling.
608 ## [2.6.15] - 2023-07-11
612 - Take into account worker node readiness in worker choice strategies.
614 ## [2.6.14] - 2023-07-10
618 - Fix task function statistics tracking.
620 ## [2.6.13] - 2023-07-10
624 - Add per task function statistics tracking.
625 - Add public methods to manipulate the worker task functions at runtime.
627 ## [2.6.12] - 2023-07-09
631 - Workaround import issue with `node:os` module in node 16.x.x.
633 ## [2.6.11] - 2023-07-09
637 - Fix pool readiness semantic.
639 ## [2.6.10] - 2023-07-08
643 - Ensure workers are not recreated on error at pool startup.
647 - Add `ready` and `strategy` fields to pool information.
648 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
649 - Add dynamic pool sizing checks.
651 ## [2.6.9] - 2023-07-07
655 - Recreate the right worker type on uncaught exception.
659 - Add minimum and maximum to internal measurement statistics.
660 - Add `runTime` and `waitTime` to pool information.
661 - Check worker inactive time only on dynamic worker.
663 ## [2.6.8] - 2023-07-03
667 - Brown paper bag release to fix version handling in pool information.
669 ## [2.6.7] - 2023-07-03
673 - Ensure worker queued tasks at error are reassigned to other pool workers.
677 - Add pool `utilization` ratio to pool information.
678 - Add `version` to pool information.
679 - Add worker information to worker nodes.
681 ## [2.6.6] - 2023-07-01
685 - Add safe helper `availableParallelism()` to help sizing the pool.
689 - Ensure message handler is only registered in worker.
691 ## [2.6.5] - 2023-06-27
695 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
699 - Artificial version bump to 2.6.5 to workaround publication issue.
700 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
701 - Ensure pool event is emitted before task error promise rejection.
702 - Fix queued tasks count computation.
706 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
708 ## [2.6.4] - 2023-06-27
712 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
716 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
717 - Ensure pool event is emitted before task error promise rejection.
718 - Fix queued tasks count computation.
722 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
724 ## [2.6.3] - 2023-06-19
728 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
729 - Update strategies internals after statistics computation.
733 - Optimize O(1) queue implementation.
735 ## [2.6.2] - 2023-06-12
739 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
741 ## [2.6.1] - 2023-06-10
745 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
749 - Fix average statistics computation: ensure failed tasks are not accounted.
751 ## [2.6.0] - 2023-06-09
755 - Add `LEAST_ELU` worker choice strategy (experimental).
756 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
760 - Refactor pool worker node usage internals.
761 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
762 - Breaking change: pool information `info` property object fields have been renamed.
766 - Fix wait time accounting.
767 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
768 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
770 ## [2.5.4] - 2023-06-07
774 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
778 - Compute statistics at the worker level only if needed.
779 - Add `worker_threads` options to thread pool options.
783 - Make the `LEAST_BUSY` strategy only relies on task runtime.
785 ## [2.5.3] - 2023-06-04
789 - Refine pool information content.
790 - Limit pool internals public exposure.
792 ## [2.5.2] - 2023-06-02
796 - Add `taskError` pool event for task execution error.
797 - Add pool information `info` property to pool.
798 - Emit pool information on `busy` and `full` pool events.
800 ## [2.5.1] - 2023-06-01
804 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
805 - Add `error` pool event for uncaught worker error.
807 ## [2.5.0] - 2023-05-31
811 - Switch pool event emitter to `EventEmitterAsyncResource`.
812 - Add tasks wait time accounting in per worker tasks usage.
813 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
817 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
819 ## [2.4.14] - 2023-05-09
823 - Ensure no undefined task runtime can land in the tasks history.
824 - Fix median computation implementation once again.
828 - Unit tests for median and queue implementations.
830 ## [2.4.13] - 2023-05-08
834 - Fix worker choice strategy options validation.
835 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
837 ## [2.4.12] - 2023-05-06
841 - Support multiple task functions per worker.
842 - Add custom worker weights support to worker choice strategies options.
846 - Use O(1) queue implementation for tasks queueing.
850 - Fix median computation implementation.
851 - Fix fair share worker choice strategy internals update.
853 ## [2.4.11] - 2023-04-23
857 - Optimize free worker finding in worker choice strategies.
859 ## [2.4.10] - 2023-04-15
863 - Fix typescript type definition for task function: ensure the input data is optional.
864 - Fix typescript type definition for pool execute(): ensure the input data is optional.
866 ## [2.4.9] - 2023-04-15
870 - Add tasks queue enablement runtime setter to pool.
871 - Add tasks queue options runtime setter to pool.
872 - Add worker choice strategy options runtime setter to pool.
876 - Remove the tasks queuing experimental status.
880 - Fix task function type definition and validation.
881 - Fix worker choice strategy options handling.
883 ## [2.4.8] - 2023-04-12
887 - Fix message between main worker and worker type definition for tasks.
888 - Fix code documentation.
890 ## [2.4.7] - 2023-04-11
894 - Add worker tasks queue options to pool options.
898 - Fix missing documentation.
900 ## [2.4.6] - 2023-04-10
904 - Ensure one task at a time is executed per worker with tasks queueing enabled.
905 - Properly count worker executing tasks with tasks queueing enabled.
907 ## [2.4.5] - 2023-04-09
911 - Use monotonic high resolution timer for worker tasks runtime.
912 - Add worker tasks median runtime to statistics.
913 - Add worker tasks queue (experimental).
915 ## [2.4.4] - 2023-04-07
919 - Add `PoolEvents` enumeration and `PoolEvent` type.
923 - Destroy worker only on alive check.
925 ## [2.4.3] - 2023-04-07
929 - Fix typedoc generation with inheritance.
931 ## [2.4.2] - 2023-04-06
935 - Add `full` event to dynamic pool.
936 - Keep worker choice strategy in memory for conditional reuse.
940 - Fix possible negative worker key at worker removal in worker choice strategies.
942 ## [2.4.1] - 2023-04-05
946 - Optimize worker choice strategy for dynamic pool.
950 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
952 ## [2.4.0] - 2023-04-04
956 - Add `LESS_BUSY` worker choice strategy.
960 - Optimize worker storage in pool.
961 - Optimize worker alive status check.
962 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
963 - Optimize `LESS_USED` worker choice strategy.
964 - Update benchmark versus external threads pools.
965 - Optimize tasks usage statistics requirements for worker choice strategy.
969 - Ensure trimmable characters are checked at pool initialization.
970 - Fix message id integer overflow.
971 - Fix pool worker removal in worker choice strategy internals.
972 - Fix package publication with pnpm.
974 ## [2.4.0-3] - 2023-04-04
978 - Add `LESS_BUSY` worker choice strategy.
982 - Optimize worker storage in pool.
983 - Optimize worker alive status check.
984 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
985 - Optimize `LESS_USED` worker choice strategy.
986 - Update benchmark versus external threads pools.
990 - Ensure trimmable characters are checked at pool initialization.
991 - Fix message id integer overflow.
992 - Fix pool worker removal in worker choice strategy internals.
993 - Fix package publication with pnpm.
995 ## [2.4.0-2] - 2023-04-03
999 - Add `LESS_BUSY` worker choice strategy.
1003 - Optimize worker storage in pool.
1004 - Optimize worker alive status check.
1005 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1006 - Optimize `LESS_USED` worker choice strategy.
1010 - Ensure trimmable characters are checked at pool initialization.
1011 - Fix message id integer overflow.
1012 - Fix pool worker removal in worker choice strategy internals.
1013 - Fix package publication with pnpm.
1015 ## [2.4.0-1] - 2023-04-03
1019 - Add `LESS_BUSY` worker choice strategy.
1023 - Optimize worker storage in pool.
1024 - Optimize worker alive status check.
1025 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1026 - Optimize `LESS_USED` worker choice strategy.
1030 - Ensure trimmable characters are checked at pool initialization.
1031 - Fix message id integer overflow.
1032 - Fix pool worker removal in worker choice strategy internals.
1034 ## [2.4.0-0] - 2023-04-03
1038 - Add `LESS_BUSY` worker choice strategy.
1042 - Optimize worker storage in pool.
1043 - Optimize worker alive status check.
1044 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1045 - Optimize `LESS_USED` worker choice strategy.
1049 - Ensure trimmable characters are checked at pool initialization.
1050 - Fix message id integer overflow.
1051 - Fix pool worker removal in worker choice strategy internals.
1053 ## [2.3.10] - 2023-03-18
1057 - Fix package.json `exports` syntax for ESM and CommonJS.
1061 - Permit SemVer pre-release publication.
1063 ## [2.3.10-2] - 2023-03-18
1067 - Fix package.json `exports` syntax for ESM and CommonJS.
1069 ## [2.3.10-1] - 2023-03-18
1073 - Permit SemVer pre-release publication.
1075 ## [2.3.10-0] - 2023-03-18
1079 - Fix package.json `exports` syntax for ESM and CommonJS.
1081 ## [2.3.9] - 2023-03-18
1085 - Introduce ESM module support along with CommonJS one.
1089 - Fix brown paper bag bug referencing the same object literal.
1091 ## [2.3.8] - 2023-03-18
1095 - Switch internal benchmarking code to benny.
1096 - Switch to TypeScript 5.x.x.
1097 - Switch rollup bundler plugins to core ones.
1098 - Switch to TSDoc syntax.
1099 - Enforce conventional commits.
1103 - Fix random integer generator.
1104 - Fix worker choice strategy pool type identification at initialization.
1106 ## [2.3.7] - 2022-10-23
1110 - Switch to open collective FOSS project funding platform.
1111 - Switch to ts-standard linter configuration on TypeScript code.
1115 - Fixed missing async on pool execute method.
1116 - Fixed typing in TypeScript example.
1117 - Fixed types in unit tests.
1119 ## [2.3.6] - 2022-10-22
1123 - Cleanup pool attributes and methods.
1124 - Refine error types thrown.
1128 - Fix continuous integration build on windows.
1129 - Fix code coverage reporting by using c8 instead of nyc.
1131 ## [2.3.5] - 2022-10-21
1135 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1136 - Optimize tasks usage lookup implementation.
1140 - Fix missed pool event emitter type export.
1141 - Fix typedoc documentation generation.
1143 ## [2.3.4] - 2022-10-17
1147 - Fully automate release process with release-it.
1151 - Optimize fair share task scheduling algorithm implementation.
1152 - Update benchmark versus external pools results with latest version.
1154 ## [2.3.3] - 2022-10-15
1158 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1160 ## [2.3.2] - 2022-10-14
1164 - Optimize fair share worker selection strategy implementation.
1168 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1170 ## [2.3.1] - 2022-10-13
1174 - Pool worker choice strategies:
1175 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1176 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1178 ## [2.2.2] - 2022-10-09
1182 - Fixed `README.md` file.
1184 ## [2.2.1] - 2022-10-08
1188 - Dynamic worker choice strategy change at runtime.
1190 ## [2.2.0] - 2022-01-05
1192 ### Breaking Changes
1194 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1196 ## [2.1.0] - 2021-08-29
1200 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1202 ### Breaking Changes
1204 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1205 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1206 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1207 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1209 ## [2.0.2] - 2021-05-12
1213 - Fix `busy` event emission on fixed pool type
1215 ## [2.0.1] - 2021-03-16
1219 - Check if pool options are properly set.
1220 - `busy` event is emitted on all pool types.
1222 ## [2.0.0] - 2021-03-01
1226 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1228 ### Breaking Changes
1230 - `FullPool` event is now renamed to `busy`.
1231 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1232 _Find more details on our JSDoc._
1234 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1236 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1238 ### Pool options types declaration merge
1240 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1242 #### New `export` strategy
1246 const DynamicThreadPool = require('poolifier/lib/dynamic')
1248 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1251 But you should always prefer just using
1254 const { DynamicThreadPool } = require('poolifier')
1257 #### New type definitions for input data and response
1259 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1260 _This is not a limitation by poolifier but Node.js._
1262 #### Public property replacements
1264 `numWorkers` property is now `numberOfWorkers`
1266 #### Internal (protected) properties and methods renaming
1268 These properties are not intended for end users
1270 - `id` => `nextMessageId`
1272 These methods are not intended for end users
1274 - `_chooseWorker` => `chooseWorker`
1275 - `_newWorker` => `createWorker`
1276 - `_execute` => `internalExecute`
1277 - `_chooseWorker` => `chooseWorker`
1278 - `_checkAlive` => `checkAlive`
1280 - `_runAsync` => `runAsync`
1282 ## [1.1.0] - 2020-05-21
1286 - ThreadWorker support async functions as option
1287 - Various external library patches
1289 ## [1.0.0] - 2020-01-24
1293 - FixedThreadPool implementation
1294 - DynamicThreadPool implementation
1295 - WorkerThread implementation to improve developer experience