3 All notable changes to this project will be documented in this file.
5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
12 - Fix pool event emitter registered callbacks removal at `destroy()`.
14 ## [3.1.21] - 2024-02-22
18 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
20 ## [3.1.20] - 2024-02-11
24 - Ensure `worker_threads` workers are unreferenced at termination.
26 ## [3.1.19] - 2024-01-16
30 - Fix possible null exception at task finishing handling.
34 - Optimize Deque implementation to improve tasks queueing performance.
36 ## [3.1.18] - 2024-01-06
40 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
42 ## [3.1.17] - 2024-01-05
46 - Improve performance by clean up unneeded condition checks on hot code paths.
48 ## [3.1.16] - 2024-01-03
52 - Add missing type to TS type definitions.
54 ## [3.1.15] - 2024-01-02
58 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
60 ## [3.1.15-0] - 2024-01-02
64 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
66 ## [3.1.14] - 2024-01-01
70 - Properly handle dynamic pool with zero minimum size.
72 ## [3.1.13] - 2023-12-30
76 - Reduce branching in several hot code paths.
77 - Use faster object cloning implementation.
79 ## [3.1.12] - 2023-12-27
83 - Fix tasks redistribution triggers at pool destroying.
87 - Switch TypeScript module resolution to Node16.
89 ## [3.1.12-0] - 2023-12-27
93 - Fix tasks redistribution triggers at pool destroying.
95 ## [3.1.11] - 2023-12-24
99 - Avoid worker node cross tasks stealing.
100 - Ensure only half the pool worker nodes can steal tasks.
102 ## [3.1.10] - 2023-12-23
106 - Avoid useless branching on pool type.
108 ## [3.1.9] - 2023-12-22
112 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
114 ## [3.1.8] - 2023-12-21
118 - Fix default worker weight computation.
119 - Fix possible null exception at pool destroying.
121 ## [3.1.7] - 2023-12-20
125 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
127 ## [3.1.6] - 2023-12-18
131 - Fix pool destroying with tasks queuing enabled.
133 ## [3.1.5] - 2023-12-18
137 - Add queued tasks end timeout support to worker node termination.
139 ## [3.1.4] - 2023-12-18
143 - Make more robust the fix for possible null exception at handling task execution response.
145 ## [3.1.3] - 2023-12-17
149 - Fix possible null exception at handling task execution response.
151 ## [3.1.2] - 2023-12-17
155 - Wait for queued tasks to end at worker node termination.
157 ## [3.1.1] - 2023-12-16
161 - Fix pool options TS type definition.
163 ## [3.1.0] - 2023-12-16
167 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
169 ## [3.0.14] - 2023-12-13
173 - Fix possible null exception with worker_threads pools.
175 ## [3.0.13] - 2023-12-12
179 - Ensure worker choice strategy wait for worker nodes readiness.
183 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
185 ## [3.0.12] - 2023-12-12
189 - Add infinite retries support in worker choice strategy.
191 ## [3.0.11] - 2023-12-11
195 - Ensure pool asynchronous resource properly track tasks execution.
197 ## [3.0.10] - 2023-12-08
201 - Add a fastpath when tasks stealing or redistribution is impossible.
203 ## [3.0.9] - 2023-11-26
207 - Remove all pool events listener at pool destroying.
208 - Remove all worker node events listener at worker node destroying.
209 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
211 ## [3.0.8] - 2023-11-25
215 - Ensure continuous tasks stealing on idle start at worker node idling.
217 ## [3.0.7] - 2023-11-24
221 - Make continuous tasks stealing start at worker node idling.
223 ## [3.0.6] - 2023-11-24
227 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
228 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
230 ## [3.0.5] - 2023-10-27
234 - Ensure pool `ready` event can be emitted only once.
236 ## [3.0.4] - 2023-10-20
240 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
241 - Use builtin retry mechanism in worker choice strategies instead of custom one.
243 ## [3.0.3] - 2023-10-19
247 - Avoid null exception at sending message to worker.
248 - Avoid null exception at checking worker node readiness.
250 ## [3.0.2] - 2023-10-17
254 - 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).
256 ## [3.0.1] - 2023-10-16
260 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
264 - Switch the worker node eventing code to `EventTarget` API.
266 ## [3.0.0] - 2023-10-08
270 - Remove Node.js 16.x.x (EOL) support.
272 ## [2.7.5] - 2023-10-03
276 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
278 ## [2.7.4] - 2023-09-25
282 - Fix source maps (bundler issue).
284 ## [2.7.3] - 2023-09-24
288 - Convert pool event emitter to event emitter async resource.
290 ## [2.7.2] - 2023-09-23
294 - Add source maps to npm package to ease debugging.
298 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
300 ## [2.7.1] - 2023-09-20
304 - Ensure worker message listener used one time are removed after usage.
306 ## [2.7.0] - 2023-09-19
310 - Fix task stealing related tasks queue options handling at runtime.
314 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
318 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
319 - Stricter worker constructor arguments validation.
321 ## [2.6.45] - 2023-09-17
325 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
329 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
330 - Add `start()` method to pool API to start the minimum number of workers.
331 - 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.
332 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
334 ## [2.6.44] - 2023-09-08
338 - Use a dedicated PAT to publish on GitHub packages registry.
342 - Publish on GitHub packages registry on release.
346 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
348 ## [2.6.43] - 2023-09-08
352 - Publish on GitHub packages registry on release.
356 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
358 ## [2.6.42] - 2023-09-06
362 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
364 ## [2.6.41] - 2023-09-03
368 - Optimize worker choice strategies implementation.
370 ## [2.6.40] - 2023-09-01
374 - Do not pre-choose in WRR worker choice strategy to avoid bias.
375 - Avoid array out of bound in worker choice strategies after worker node removal.
377 ## [2.6.39] - 2023-08-30
381 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
383 ## [2.6.38] - 2023-08-30
387 - Bundle typescript types declaration into one file.
391 - Improve interleaved weighted round robin worker choice strategy implementation.
393 ## [2.6.37] - 2023-08-28
397 - Ensure unused worker usage statistics are deleted at runtime.
401 - Rename worker choice strategy options `choiceRetries` to `retries`.
402 - Avoid unnecessary branching in worker choice strategies.
404 ## [2.6.36] - 2023-08-27
408 - Fix pool `execute()` arguments check.
412 - Make continuous tasks stealing algorithm less aggressive.
413 - Fine tune tasks stealing algorithm under back pressure.
415 ## [2.6.35] - 2023-08-25
419 - Don't account worker usage statistics for tasks that have failed.
420 - Fix pool information runtime and wait time median computation.
424 - Update simple moving average implementation to use a circular buffer.
425 - Update simple moving median implementation to use a circular buffer.
426 - Account for stolen tasks in worker usage statistics and pool information.
430 - Continuous tasks stealing algorithm.
432 ## [2.6.34] - 2023-08-24
436 - Avoid cascading tasks stealing under back pressure.
440 - Add fastpath to queued tasks rescheduling.
442 ## [2.6.33] - 2023-08-24
446 - Fix queued tasks rescheduling.
450 - Rename tasks queue options `queueMaxSize` to `size`.
454 - Task stealing scheduling algorithm if tasks queueing is enabled.
456 ## [2.6.32] - 2023-08-23
460 - Ensure no task can be executed when the pool is destroyed.
464 - Add `queueMaxSize` option to tasks queue options.
465 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
466 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
468 ## [2.6.31] - 2023-08-20
472 - Fix worker choice strategy retries mechanism in some edge cases.
476 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
477 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
479 ## [2.6.30] - 2023-08-19
483 - Ensure pool event `backPressure` is emitted.
484 - Ensure pool event `full` is emitted only once.
485 - Ensure worker node cannot be instantiated without proper arguments.
487 ## [2.6.29] - 2023-08-18
491 - Fix race condition between readiness and task functions worker message handling at startup.
492 - Fix duplicate task function worker usage statistics computation per task function.
493 - Update task function worker usage statistics if and only if there's at least two different task functions.
494 - Fix race condition at task function worker usage executing task computation leading to negative value.
498 - 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).
499 - Use back pressure detection in worker choice strategies.
500 - Add worker choice strategies retries mechanism if no worker is eligible.
502 ## [2.6.28] - 2023-08-16
506 - Ensure pool workers are properly initialized.
510 - HTTP server pool examples: express-cluster, express-hybrid.
514 - Remove now useless branching in worker hot code path.
516 ## [2.6.27] - 2023-08-15
520 - Add `KillHandler` type definition to exported types.
524 - Add `destroy` event to pool API.
526 ## [2.6.26] - 2023-08-15
530 - Add kill handler to worker options allowing to execute custom code when worker is killed.
531 - Add `listTaskFunctions()` method to pool API.
532 - SMTP client pool example: nodemailer.
534 ## [2.6.25] - 2023-08-13
538 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
539 - WebSocket server pool examples: ws-cluster, ws-hybrid.
541 ## [2.6.24] - 2023-08-12
545 - Add array of transferable objects to the `execute()` method arguments.
546 - WebSocket server pool examples: ws-worker_threads.
548 ## [2.6.23] - 2023-08-11
552 - 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.
556 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
557 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
559 ## [2.6.22] - 2023-08-10
563 - Add missing `types` field to package.json `exports`.
567 - Structure markdown documentation (PR #811).
569 ## [2.6.21] - 2023-08-03
573 - Improve code documentation.
574 - Code refactoring and cleanup for better maintainability and readability.
576 ## [2.6.20] - 2023-07-21
580 - Fix queued tasks redistribution on error task execution starvation.
581 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
585 - Drastically reduce lookups by worker in the worker nodes.
587 ## [2.6.19] - 2023-07-20
591 - Dedicated internal communication channel for worker_threads pools.
593 ## [2.6.18] - 2023-07-19
597 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
599 ## [2.6.17] - 2023-07-16
603 - Add `listTaskFunctions()` method to worker API.
605 ## [2.6.16] - 2023-07-12
609 - Fix pool startup detection.
610 - Fix worker task functions handling.
612 ## [2.6.15] - 2023-07-11
616 - Take into account worker node readiness in worker choice strategies.
618 ## [2.6.14] - 2023-07-10
622 - Fix task function statistics tracking.
624 ## [2.6.13] - 2023-07-10
628 - Add per task function statistics tracking.
629 - Add public methods to manipulate the worker task functions at runtime.
631 ## [2.6.12] - 2023-07-09
635 - Workaround import issue with `node:os` module in node 16.x.x.
637 ## [2.6.11] - 2023-07-09
641 - Fix pool readiness semantic.
643 ## [2.6.10] - 2023-07-08
647 - Ensure workers are not recreated on error at pool startup.
651 - Add `ready` and `strategy` fields to pool information.
652 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
653 - Add dynamic pool sizing checks.
655 ## [2.6.9] - 2023-07-07
659 - Recreate the right worker type on uncaught exception.
663 - Add minimum and maximum to internal measurement statistics.
664 - Add `runTime` and `waitTime` to pool information.
665 - Check worker inactive time only on dynamic worker.
667 ## [2.6.8] - 2023-07-03
671 - Brown paper bag release to fix version handling in pool information.
673 ## [2.6.7] - 2023-07-03
677 - Ensure worker queued tasks at error are reassigned to other pool workers.
681 - Add pool `utilization` ratio to pool information.
682 - Add `version` to pool information.
683 - Add worker information to worker nodes.
685 ## [2.6.6] - 2023-07-01
689 - Add safe helper `availableParallelism()` to help sizing the pool.
693 - Ensure message handler is only registered in worker.
695 ## [2.6.5] - 2023-06-27
699 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
703 - Artificial version bump to 2.6.5 to workaround publication issue.
704 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
705 - Ensure pool event is emitted before task error promise rejection.
706 - Fix queued tasks count computation.
710 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
712 ## [2.6.4] - 2023-06-27
716 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
720 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
721 - Ensure pool event is emitted before task error promise rejection.
722 - Fix queued tasks count computation.
726 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
728 ## [2.6.3] - 2023-06-19
732 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
733 - Update strategies internals after statistics computation.
737 - Optimize O(1) queue implementation.
739 ## [2.6.2] - 2023-06-12
743 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
745 ## [2.6.1] - 2023-06-10
749 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
753 - Fix average statistics computation: ensure failed tasks are not accounted.
755 ## [2.6.0] - 2023-06-09
759 - Add `LEAST_ELU` worker choice strategy (experimental).
760 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
764 - Refactor pool worker node usage internals.
765 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
766 - Breaking change: pool information `info` property object fields have been renamed.
770 - Fix wait time accounting.
771 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
772 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
774 ## [2.5.4] - 2023-06-07
778 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
782 - Compute statistics at the worker level only if needed.
783 - Add `worker_threads` options to thread pool options.
787 - Make the `LEAST_BUSY` strategy only relies on task runtime.
789 ## [2.5.3] - 2023-06-04
793 - Refine pool information content.
794 - Limit pool internals public exposure.
796 ## [2.5.2] - 2023-06-02
800 - Add `taskError` pool event for task execution error.
801 - Add pool information `info` property to pool.
802 - Emit pool information on `busy` and `full` pool events.
804 ## [2.5.1] - 2023-06-01
808 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
809 - Add `error` pool event for uncaught worker error.
811 ## [2.5.0] - 2023-05-31
815 - Switch pool event emitter to `EventEmitterAsyncResource`.
816 - Add tasks wait time accounting in per worker tasks usage.
817 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
821 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
823 ## [2.4.14] - 2023-05-09
827 - Ensure no undefined task runtime can land in the tasks history.
828 - Fix median computation implementation once again.
832 - Unit tests for median and queue implementations.
834 ## [2.4.13] - 2023-05-08
838 - Fix worker choice strategy options validation.
839 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
841 ## [2.4.12] - 2023-05-06
845 - Support multiple task functions per worker.
846 - Add custom worker weights support to worker choice strategies options.
850 - Use O(1) queue implementation for tasks queueing.
854 - Fix median computation implementation.
855 - Fix fair share worker choice strategy internals update.
857 ## [2.4.11] - 2023-04-23
861 - Optimize free worker finding in worker choice strategies.
863 ## [2.4.10] - 2023-04-15
867 - Fix typescript type definition for task function: ensure the input data is optional.
868 - Fix typescript type definition for pool execute(): ensure the input data is optional.
870 ## [2.4.9] - 2023-04-15
874 - Add tasks queue enablement runtime setter to pool.
875 - Add tasks queue options runtime setter to pool.
876 - Add worker choice strategy options runtime setter to pool.
880 - Remove the tasks queuing experimental status.
884 - Fix task function type definition and validation.
885 - Fix worker choice strategy options handling.
887 ## [2.4.8] - 2023-04-12
891 - Fix message between main worker and worker type definition for tasks.
892 - Fix code documentation.
894 ## [2.4.7] - 2023-04-11
898 - Add worker tasks queue options to pool options.
902 - Fix missing documentation.
904 ## [2.4.6] - 2023-04-10
908 - Ensure one task at a time is executed per worker with tasks queueing enabled.
909 - Properly count worker executing tasks with tasks queueing enabled.
911 ## [2.4.5] - 2023-04-09
915 - Use monotonic high resolution timer for worker tasks runtime.
916 - Add worker tasks median runtime to statistics.
917 - Add worker tasks queue (experimental).
919 ## [2.4.4] - 2023-04-07
923 - Add `PoolEvents` enumeration and `PoolEvent` type.
927 - Destroy worker only on alive check.
929 ## [2.4.3] - 2023-04-07
933 - Fix typedoc generation with inheritance.
935 ## [2.4.2] - 2023-04-06
939 - Add `full` event to dynamic pool.
940 - Keep worker choice strategy in memory for conditional reuse.
944 - Fix possible negative worker key at worker removal in worker choice strategies.
946 ## [2.4.1] - 2023-04-05
950 - Optimize worker choice strategy for dynamic pool.
954 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
956 ## [2.4.0] - 2023-04-04
960 - Add `LESS_BUSY` worker choice strategy.
964 - Optimize worker storage in pool.
965 - Optimize worker alive status check.
966 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
967 - Optimize `LESS_USED` worker choice strategy.
968 - Update benchmark versus external threads pools.
969 - Optimize tasks usage statistics requirements for worker choice strategy.
973 - Ensure trimmable characters are checked at pool initialization.
974 - Fix message id integer overflow.
975 - Fix pool worker removal in worker choice strategy internals.
976 - Fix package publication with pnpm.
978 ## [2.4.0-3] - 2023-04-04
982 - Add `LESS_BUSY` worker choice strategy.
986 - Optimize worker storage in pool.
987 - Optimize worker alive status check.
988 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
989 - Optimize `LESS_USED` worker choice strategy.
990 - Update benchmark versus external threads pools.
994 - Ensure trimmable characters are checked at pool initialization.
995 - Fix message id integer overflow.
996 - Fix pool worker removal in worker choice strategy internals.
997 - Fix package publication with pnpm.
999 ## [2.4.0-2] - 2023-04-03
1003 - Add `LESS_BUSY` worker choice strategy.
1007 - Optimize worker storage in pool.
1008 - Optimize worker alive status check.
1009 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1010 - Optimize `LESS_USED` worker choice strategy.
1014 - Ensure trimmable characters are checked at pool initialization.
1015 - Fix message id integer overflow.
1016 - Fix pool worker removal in worker choice strategy internals.
1017 - Fix package publication with pnpm.
1019 ## [2.4.0-1] - 2023-04-03
1023 - Add `LESS_BUSY` worker choice strategy.
1027 - Optimize worker storage in pool.
1028 - Optimize worker alive status check.
1029 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1030 - Optimize `LESS_USED` worker choice strategy.
1034 - Ensure trimmable characters are checked at pool initialization.
1035 - Fix message id integer overflow.
1036 - Fix pool worker removal in worker choice strategy internals.
1038 ## [2.4.0-0] - 2023-04-03
1042 - Add `LESS_BUSY` worker choice strategy.
1046 - Optimize worker storage in pool.
1047 - Optimize worker alive status check.
1048 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1049 - Optimize `LESS_USED` worker choice strategy.
1053 - Ensure trimmable characters are checked at pool initialization.
1054 - Fix message id integer overflow.
1055 - Fix pool worker removal in worker choice strategy internals.
1057 ## [2.3.10] - 2023-03-18
1061 - Fix package.json `exports` syntax for ESM and CommonJS.
1065 - Permit SemVer pre-release publication.
1067 ## [2.3.10-2] - 2023-03-18
1071 - Fix package.json `exports` syntax for ESM and CommonJS.
1073 ## [2.3.10-1] - 2023-03-18
1077 - Permit SemVer pre-release publication.
1079 ## [2.3.10-0] - 2023-03-18
1083 - Fix package.json `exports` syntax for ESM and CommonJS.
1085 ## [2.3.9] - 2023-03-18
1089 - Introduce ESM module support along with CommonJS one.
1093 - Fix brown paper bag bug referencing the same object literal.
1095 ## [2.3.8] - 2023-03-18
1099 - Switch internal benchmarking code to benny.
1100 - Switch to TypeScript 5.x.x.
1101 - Switch rollup bundler plugins to core ones.
1102 - Switch to TSDoc syntax.
1103 - Enforce conventional commits.
1107 - Fix random integer generator.
1108 - Fix worker choice strategy pool type identification at initialization.
1110 ## [2.3.7] - 2022-10-23
1114 - Switch to open collective FOSS project funding platform.
1115 - Switch to ts-standard linter configuration on TypeScript code.
1119 - Fixed missing async on pool execute method.
1120 - Fixed typing in TypeScript example.
1121 - Fixed types in unit tests.
1123 ## [2.3.6] - 2022-10-22
1127 - Cleanup pool attributes and methods.
1128 - Refine error types thrown.
1132 - Fix continuous integration build on windows.
1133 - Fix code coverage reporting by using c8 instead of nyc.
1135 ## [2.3.5] - 2022-10-21
1139 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1140 - Optimize tasks usage lookup implementation.
1144 - Fix missed pool event emitter type export.
1145 - Fix typedoc documentation generation.
1147 ## [2.3.4] - 2022-10-17
1151 - Fully automate release process with release-it.
1155 - Optimize fair share task scheduling algorithm implementation.
1156 - Update benchmark versus external pools results with latest version.
1158 ## [2.3.3] - 2022-10-15
1162 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1164 ## [2.3.2] - 2022-10-14
1168 - Optimize fair share worker selection strategy implementation.
1172 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1174 ## [2.3.1] - 2022-10-13
1178 - Pool worker choice strategies:
1179 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1180 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1182 ## [2.2.2] - 2022-10-09
1186 - Fixed `README.md` file.
1188 ## [2.2.1] - 2022-10-08
1192 - Dynamic worker choice strategy change at runtime.
1194 ## [2.2.0] - 2022-01-05
1196 ### Breaking Changes
1198 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1200 ## [2.1.0] - 2021-08-29
1204 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1206 ### Breaking Changes
1208 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1209 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1210 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1211 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1213 ## [2.0.2] - 2021-05-12
1217 - Fix `busy` event emission on fixed pool type
1219 ## [2.0.1] - 2021-03-16
1223 - Check if pool options are properly set.
1224 - `busy` event is emitted on all pool types.
1226 ## [2.0.0] - 2021-03-01
1230 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1232 ### Breaking Changes
1234 - `FullPool` event is now renamed to `busy`.
1235 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1236 _Find more details on our JSDoc._
1238 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1240 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1242 ### Pool options types declaration merge
1244 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1246 #### New `export` strategy
1250 const DynamicThreadPool = require('poolifier/lib/dynamic')
1252 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1255 But you should always prefer just using
1258 const { DynamicThreadPool } = require('poolifier')
1261 #### New type definitions for input data and response
1263 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1264 _This is not a limitation by poolifier but Node.js._
1266 #### Public property replacements
1268 `numWorkers` property is now `numberOfWorkers`
1270 #### Internal (protected) properties and methods renaming
1272 These properties are not intended for end users
1274 - `id` => `nextMessageId`
1276 These methods are not intended for end users
1278 - `_chooseWorker` => `chooseWorker`
1279 - `_newWorker` => `createWorker`
1280 - `_execute` => `internalExecute`
1281 - `_chooseWorker` => `chooseWorker`
1282 - `_checkAlive` => `checkAlive`
1284 - `_runAsync` => `runAsync`
1286 ## [1.1.0] - 2020-05-21
1290 - ThreadWorker support async functions as option
1291 - Various external library patches
1293 ## [1.0.0] - 2020-01-24
1297 - FixedThreadPool implementation
1298 - DynamicThreadPool implementation
1299 - WorkerThread implementation to improve developer experience