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 ## [4.0.3] - 2024-05-08
14 - Optimize task(s) stealing by dequeuing task(s) from the last prioritized bucket.
16 ## [4.0.2] - 2024-05-06
20 - Ensure poolifier worker task performance measurement requirements are synchronized with task function objects' worker choice strategies.
22 ## [4.0.1] - 2024-05-02
26 - Ensure dynamic worker node are initialized with sensible worker node usage default values to avoid worker choice strategies biased decisions.
27 - Account for tasks wait time in task execution time computation in worker choice strategies to avoid biased decisions under load with several prioritized task functions and tasks queue enabled.
29 ## [4.0.0] - 2024-04-30
33 - Support per task function(s) priority and worker choice strategy definition via a task function object: `{ taskFunction: (data?: Data) => Response | Promise<Response>, priority?: number, strategy?: WorkerChoiceStrategy }`.
34 - Add priority queue based tasks queueing. One priority queue is divided into prioritized buckets to avoid queued tasks starvation under load.
35 - BREAKING CHANGE: `listTaskFunctionNames()` to `listTaskFunctionsProperties()` in pool and worker API returning registered task functions properties.
36 - BREAKING CHANGE: `strategy` field in pool information renamed to `defaultStrategy`.
40 - Ensure worker choice strategy options changes at runtime are propagated to poolifier workers.
42 ## [3.1.30] - 2024-04-22
46 - Fix `transferList` argument type definition.
48 ## [3.1.29] - 2024-04-02
52 - Fix possible race condition at worker node recreation on worker `error` and `exit` events.
54 ## [3.1.28] - 2024-04-01
58 - Ensure the minimum number of workers on a started pool is guaranteed.
60 ## [3.1.27] - 2024-03-27
64 - Fix publishing on JSR, take 4.
66 ## [3.1.26] - 2024-03-27
70 - Fix publishing on JSR, take 3.
72 ## [3.1.25] - 2024-03-27
76 - Fix publishing on JSR, take 2.
78 ## [3.1.24] - 2024-03-27
82 - Fix publishing on JSR.
84 ## [3.1.23] - 2024-03-27
90 ## [3.1.22] - 2024-03-15
94 - Fix pool event emitter registered callbacks removal at `destroy()`.
96 ## [3.1.21] - 2024-02-22
100 - Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
102 ## [3.1.20] - 2024-02-11
106 - Ensure `worker_threads` workers are unreferenced at termination.
108 ## [3.1.19] - 2024-01-16
112 - Fix possible null exception at task finishing handling.
116 - Optimize Deque implementation to improve tasks queueing performance.
118 ## [3.1.18] - 2024-01-06
122 - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
124 ## [3.1.17] - 2024-01-05
128 - Improve performance by clean up unneeded condition checks on hot code paths.
130 ## [3.1.16] - 2024-01-03
134 - Add missing type to TS type definitions.
136 ## [3.1.15] - 2024-01-02
140 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
142 ## [3.1.15-0] - 2024-01-02
146 - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
148 ## [3.1.14] - 2024-01-01
152 - Properly handle dynamic pool with zero minimum size.
154 ## [3.1.13] - 2023-12-30
158 - Reduce branching in several hot code paths.
159 - Use faster object cloning implementation.
161 ## [3.1.12] - 2023-12-27
165 - Fix tasks redistribution triggers at pool destroying.
169 - Switch TypeScript module resolution to Node16.
171 ## [3.1.12-0] - 2023-12-27
175 - Fix tasks redistribution triggers at pool destroying.
177 ## [3.1.11] - 2023-12-24
181 - Avoid worker node cross tasks stealing.
182 - Ensure only half the pool worker nodes can steal tasks.
184 ## [3.1.10] - 2023-12-23
188 - Avoid useless branching on pool type.
190 ## [3.1.9] - 2023-12-22
194 - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
196 ## [3.1.8] - 2023-12-21
200 - Fix default worker weight computation.
201 - Fix possible null exception at pool destroying.
203 ## [3.1.7] - 2023-12-20
207 - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
209 ## [3.1.6] - 2023-12-18
213 - Fix pool destroying with tasks queuing enabled.
215 ## [3.1.5] - 2023-12-18
219 - Add queued tasks end timeout support to worker node termination.
221 ## [3.1.4] - 2023-12-18
225 - Make more robust the fix for possible null exception at handling task execution response.
227 ## [3.1.3] - 2023-12-17
231 - Fix possible null exception at handling task execution response.
233 ## [3.1.2] - 2023-12-17
237 - Wait for queued tasks to end at worker node termination.
239 ## [3.1.1] - 2023-12-16
243 - Fix pool options TS type definition.
245 ## [3.1.0] - 2023-12-16
249 - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
251 ## [3.0.14] - 2023-12-13
255 - Fix possible null exception with worker_threads pools.
257 ## [3.0.13] - 2023-12-12
261 - Ensure worker choice strategy wait for worker nodes readiness.
265 - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
267 ## [3.0.12] - 2023-12-12
271 - Add infinite retries support in worker choice strategy.
273 ## [3.0.11] - 2023-12-11
277 - Ensure pool asynchronous resource properly track tasks execution.
279 ## [3.0.10] - 2023-12-08
283 - Add a fastpath when tasks stealing or redistribution is impossible.
285 ## [3.0.9] - 2023-11-26
289 - Remove all pool events listener at pool destroying.
290 - Remove all worker node events listener at worker node destroying.
291 - Fix worker node event emitter listeners handling memory leak at pool options runtime change.
293 ## [3.0.8] - 2023-11-25
297 - Ensure continuous tasks stealing on idle start at worker node idling.
299 ## [3.0.7] - 2023-11-24
303 - Make continuous tasks stealing start at worker node idling.
305 ## [3.0.6] - 2023-11-24
309 - Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
310 - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
312 ## [3.0.5] - 2023-10-27
316 - Ensure pool `ready` event can be emitted only once.
318 ## [3.0.4] - 2023-10-20
322 - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
323 - Use builtin retry mechanism in worker choice strategies instead of custom one.
325 ## [3.0.3] - 2023-10-19
329 - Avoid null exception at sending message to worker.
330 - Avoid null exception at checking worker node readiness.
332 ## [3.0.2] - 2023-10-17
336 - 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).
338 ## [3.0.1] - 2023-10-16
342 - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
346 - Switch the worker node eventing code to `EventTarget` API.
348 ## [3.0.0] - 2023-10-08
352 - Remove Node.js 16.x.x (EOL) support.
354 ## [2.7.5] - 2023-10-03
358 - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
360 ## [2.7.4] - 2023-09-25
364 - Fix source maps (bundler issue).
366 ## [2.7.3] - 2023-09-24
370 - Convert pool event emitter to event emitter async resource.
372 ## [2.7.2] - 2023-09-23
376 - Add source maps to npm package to ease debugging.
380 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
382 ## [2.7.1] - 2023-09-20
386 - Ensure worker message listener used one time are removed after usage.
388 ## [2.7.0] - 2023-09-19
392 - Fix task stealing related tasks queue options handling at runtime.
396 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
400 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
401 - Stricter worker constructor arguments validation.
403 ## [2.6.45] - 2023-09-17
407 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
411 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
412 - Add `start()` method to pool API to start the minimum number of workers.
413 - 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.
414 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
416 ## [2.6.44] - 2023-09-08
420 - Use a dedicated PAT to publish on GitHub packages registry.
424 - Publish on GitHub packages registry on release.
428 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
430 ## [2.6.43] - 2023-09-08
434 - Publish on GitHub packages registry on release.
438 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
440 ## [2.6.42] - 2023-09-06
444 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
446 ## [2.6.41] - 2023-09-03
450 - Optimize worker choice strategies implementation.
452 ## [2.6.40] - 2023-09-01
456 - Do not pre-choose in WRR worker choice strategy to avoid bias.
457 - Avoid array out of bound in worker choice strategies after worker node removal.
459 ## [2.6.39] - 2023-08-30
463 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
465 ## [2.6.38] - 2023-08-30
469 - Bundle typescript types declaration into one file.
473 - Improve interleaved weighted round robin worker choice strategy implementation.
475 ## [2.6.37] - 2023-08-28
479 - Ensure unused worker usage statistics are deleted at runtime.
483 - Rename worker choice strategy options `choiceRetries` to `retries`.
484 - Avoid unnecessary branching in worker choice strategies.
486 ## [2.6.36] - 2023-08-27
490 - Fix pool `execute()` arguments check.
494 - Make continuous tasks stealing algorithm less aggressive.
495 - Fine tune tasks stealing algorithm under back pressure.
497 ## [2.6.35] - 2023-08-25
501 - Don't account worker usage statistics for tasks that have failed.
502 - Fix pool information runtime and wait time median computation.
506 - Update simple moving average implementation to use a circular buffer.
507 - Update simple moving median implementation to use a circular buffer.
508 - Account for stolen tasks in worker usage statistics and pool information.
512 - Continuous tasks stealing algorithm.
514 ## [2.6.34] - 2023-08-24
518 - Avoid cascading tasks stealing under back pressure.
522 - Add fastpath to queued tasks rescheduling.
524 ## [2.6.33] - 2023-08-24
528 - Fix queued tasks rescheduling.
532 - Rename tasks queue options `queueMaxSize` to `size`.
536 - Task stealing scheduling algorithm if tasks queueing is enabled.
538 ## [2.6.32] - 2023-08-23
542 - Ensure no task can be executed when the pool is destroyed.
546 - Add `queueMaxSize` option to tasks queue options.
547 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
548 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
550 ## [2.6.31] - 2023-08-20
554 - Fix worker choice strategy retries mechanism in some edge cases.
558 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
559 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
561 ## [2.6.30] - 2023-08-19
565 - Ensure pool event `backPressure` is emitted.
566 - Ensure pool event `full` is emitted only once.
567 - Ensure worker node cannot be instantiated without proper arguments.
569 ## [2.6.29] - 2023-08-18
573 - Fix race condition between readiness and task functions worker message handling at startup.
574 - Fix duplicate task function worker usage statistics computation per task function.
575 - Update task function worker usage statistics if and only if there's at least two different task functions.
576 - Fix race condition at task function worker usage executing task computation leading to negative value.
580 - 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).
581 - Use back pressure detection in worker choice strategies.
582 - Add worker choice strategies retries mechanism if no worker is eligible.
584 ## [2.6.28] - 2023-08-16
588 - Ensure pool workers are properly initialized.
592 - HTTP server pool examples: express-cluster, express-hybrid.
596 - Remove now useless branching in worker hot code path.
598 ## [2.6.27] - 2023-08-15
602 - Add `KillHandler` type definition to exported types.
606 - Add `destroy` event to pool API.
608 ## [2.6.26] - 2023-08-15
612 - Add kill handler to worker options allowing to execute custom code when worker is killed.
613 - Add `listTaskFunctions()` method to pool API.
614 - SMTP client pool example: nodemailer.
616 ## [2.6.25] - 2023-08-13
620 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
621 - WebSocket server pool examples: ws-cluster, ws-hybrid.
623 ## [2.6.24] - 2023-08-12
627 - Add array of transferable objects to the `execute()` method arguments.
628 - WebSocket server pool examples: ws-worker_threads.
630 ## [2.6.23] - 2023-08-11
634 - 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.
638 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
639 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
641 ## [2.6.22] - 2023-08-10
645 - Add missing `types` field to package.json `exports`.
649 - Structure markdown documentation (PR #811).
651 ## [2.6.21] - 2023-08-03
655 - Improve code documentation.
656 - Code refactoring and cleanup for better maintainability and readability.
658 ## [2.6.20] - 2023-07-21
662 - Fix queued tasks redistribution on error task execution starvation.
663 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
667 - Drastically reduce lookups by worker in the worker nodes.
669 ## [2.6.19] - 2023-07-20
673 - Dedicated internal communication channel for worker_threads pools.
675 ## [2.6.18] - 2023-07-19
679 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
681 ## [2.6.17] - 2023-07-16
685 - Add `listTaskFunctions()` method to worker API.
687 ## [2.6.16] - 2023-07-12
691 - Fix pool startup detection.
692 - Fix worker task functions handling.
694 ## [2.6.15] - 2023-07-11
698 - Take into account worker node readiness in worker choice strategies.
700 ## [2.6.14] - 2023-07-10
704 - Fix task function statistics tracking.
706 ## [2.6.13] - 2023-07-10
710 - Add per task function statistics tracking.
711 - Add public methods to manipulate the worker task functions at runtime.
713 ## [2.6.12] - 2023-07-09
717 - Workaround import issue with `node:os` module in node 16.x.x.
719 ## [2.6.11] - 2023-07-09
723 - Fix pool readiness semantic.
725 ## [2.6.10] - 2023-07-08
729 - Ensure workers are not recreated on error at pool startup.
733 - Add `ready` and `strategy` fields to pool information.
734 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
735 - Add dynamic pool sizing checks.
737 ## [2.6.9] - 2023-07-07
741 - Recreate the right worker type on uncaught exception.
745 - Add minimum and maximum to internal measurement statistics.
746 - Add `runTime` and `waitTime` to pool information.
747 - Check worker inactive time only on dynamic worker.
749 ## [2.6.8] - 2023-07-03
753 - Brown paper bag release to fix version handling in pool information.
755 ## [2.6.7] - 2023-07-03
759 - Ensure worker queued tasks at error are reassigned to other pool workers.
763 - Add pool `utilization` ratio to pool information.
764 - Add `version` to pool information.
765 - Add worker information to worker nodes.
767 ## [2.6.6] - 2023-07-01
771 - Add safe helper `availableParallelism()` to help sizing the pool.
775 - Ensure message handler is only registered in worker.
777 ## [2.6.5] - 2023-06-27
781 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
785 - Artificial version bump to 2.6.5 to workaround publication issue.
786 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
787 - Ensure pool event is emitted before task error promise rejection.
788 - Fix queued tasks count computation.
792 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
794 ## [2.6.4] - 2023-06-27
798 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
802 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
803 - Ensure pool event is emitted before task error promise rejection.
804 - Fix queued tasks count computation.
808 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
810 ## [2.6.3] - 2023-06-19
814 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
815 - Update strategies internals after statistics computation.
819 - Optimize O(1) queue implementation.
821 ## [2.6.2] - 2023-06-12
825 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
827 ## [2.6.1] - 2023-06-10
831 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
835 - Fix average statistics computation: ensure failed tasks are not accounted.
837 ## [2.6.0] - 2023-06-09
841 - Add `LEAST_ELU` worker choice strategy (experimental).
842 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
846 - Refactor pool worker node usage internals.
847 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
848 - Breaking change: pool information `info` property object fields have been renamed.
852 - Fix wait time accounting.
853 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
854 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
856 ## [2.5.4] - 2023-06-07
860 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
864 - Compute statistics at the worker level only if needed.
865 - Add `worker_threads` options to thread pool options.
869 - Make the `LEAST_BUSY` strategy only relies on task runtime.
871 ## [2.5.3] - 2023-06-04
875 - Refine pool information content.
876 - Limit pool internals public exposure.
878 ## [2.5.2] - 2023-06-02
882 - Add `taskError` pool event for task execution error.
883 - Add pool information `info` property to pool.
884 - Emit pool information on `busy` and `full` pool events.
886 ## [2.5.1] - 2023-06-01
890 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
891 - Add `error` pool event for uncaught worker error.
893 ## [2.5.0] - 2023-05-31
897 - Switch pool event emitter to `EventEmitterAsyncResource`.
898 - Add tasks wait time accounting in per worker tasks usage.
899 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
903 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
905 ## [2.4.14] - 2023-05-09
909 - Ensure no undefined task runtime can land in the tasks history.
910 - Fix median computation implementation once again.
914 - Unit tests for median and queue implementations.
916 ## [2.4.13] - 2023-05-08
920 - Fix worker choice strategy options validation.
921 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
923 ## [2.4.12] - 2023-05-06
927 - Support multiple task functions per worker.
928 - Add custom worker weights support to worker choice strategies options.
932 - Use O(1) queue implementation for tasks queueing.
936 - Fix median computation implementation.
937 - Fix fair share worker choice strategy internals update.
939 ## [2.4.11] - 2023-04-23
943 - Optimize free worker finding in worker choice strategies.
945 ## [2.4.10] - 2023-04-15
949 - Fix typescript type definition for task function: ensure the input data is optional.
950 - Fix typescript type definition for pool execute(): ensure the input data is optional.
952 ## [2.4.9] - 2023-04-15
956 - Add tasks queue enablement runtime setter to pool.
957 - Add tasks queue options runtime setter to pool.
958 - Add worker choice strategy options runtime setter to pool.
962 - Remove the tasks queuing experimental status.
966 - Fix task function type definition and validation.
967 - Fix worker choice strategy options handling.
969 ## [2.4.8] - 2023-04-12
973 - Fix message between main worker and worker type definition for tasks.
974 - Fix code documentation.
976 ## [2.4.7] - 2023-04-11
980 - Add worker tasks queue options to pool options.
984 - Fix missing documentation.
986 ## [2.4.6] - 2023-04-10
990 - Ensure one task at a time is executed per worker with tasks queueing enabled.
991 - Properly count worker executing tasks with tasks queueing enabled.
993 ## [2.4.5] - 2023-04-09
997 - Use monotonic high resolution timer for worker tasks runtime.
998 - Add worker tasks median runtime to statistics.
999 - Add worker tasks queue (experimental).
1001 ## [2.4.4] - 2023-04-07
1005 - Add `PoolEvents` enumeration and `PoolEvent` type.
1009 - Destroy worker only on alive check.
1011 ## [2.4.3] - 2023-04-07
1015 - Fix typedoc generation with inheritance.
1017 ## [2.4.2] - 2023-04-06
1021 - Add `full` event to dynamic pool.
1022 - Keep worker choice strategy in memory for conditional reuse.
1026 - Fix possible negative worker key at worker removal in worker choice strategies.
1028 ## [2.4.1] - 2023-04-05
1032 - Optimize worker choice strategy for dynamic pool.
1036 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
1038 ## [2.4.0] - 2023-04-04
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.
1050 - Update benchmark versus external threads pools.
1051 - Optimize tasks usage statistics requirements for worker choice strategy.
1055 - Ensure trimmable characters are checked at pool initialization.
1056 - Fix message id integer overflow.
1057 - Fix pool worker removal in worker choice strategy internals.
1058 - Fix package publication with pnpm.
1060 ## [2.4.0-3] - 2023-04-04
1064 - Add `LESS_BUSY` worker choice strategy.
1068 - Optimize worker storage in pool.
1069 - Optimize worker alive status check.
1070 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1071 - Optimize `LESS_USED` worker choice strategy.
1072 - Update benchmark versus external threads pools.
1076 - Ensure trimmable characters are checked at pool initialization.
1077 - Fix message id integer overflow.
1078 - Fix pool worker removal in worker choice strategy internals.
1079 - Fix package publication with pnpm.
1081 ## [2.4.0-2] - 2023-04-03
1085 - Add `LESS_BUSY` worker choice strategy.
1089 - Optimize worker storage in pool.
1090 - Optimize worker alive status check.
1091 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1092 - Optimize `LESS_USED` worker choice strategy.
1096 - Ensure trimmable characters are checked at pool initialization.
1097 - Fix message id integer overflow.
1098 - Fix pool worker removal in worker choice strategy internals.
1099 - Fix package publication with pnpm.
1101 ## [2.4.0-1] - 2023-04-03
1105 - Add `LESS_BUSY` worker choice strategy.
1109 - Optimize worker storage in pool.
1110 - Optimize worker alive status check.
1111 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1112 - Optimize `LESS_USED` worker choice strategy.
1116 - Ensure trimmable characters are checked at pool initialization.
1117 - Fix message id integer overflow.
1118 - Fix pool worker removal in worker choice strategy internals.
1120 ## [2.4.0-0] - 2023-04-03
1124 - Add `LESS_BUSY` worker choice strategy.
1128 - Optimize worker storage in pool.
1129 - Optimize worker alive status check.
1130 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
1131 - Optimize `LESS_USED` worker choice strategy.
1135 - Ensure trimmable characters are checked at pool initialization.
1136 - Fix message id integer overflow.
1137 - Fix pool worker removal in worker choice strategy internals.
1139 ## [2.3.10] - 2023-03-18
1143 - Fix package.json `exports` syntax for ESM and CommonJS.
1147 - Permit SemVer pre-release publication.
1149 ## [2.3.10-2] - 2023-03-18
1153 - Fix package.json `exports` syntax for ESM and CommonJS.
1155 ## [2.3.10-1] - 2023-03-18
1159 - Permit SemVer pre-release publication.
1161 ## [2.3.10-0] - 2023-03-18
1165 - Fix package.json `exports` syntax for ESM and CommonJS.
1167 ## [2.3.9] - 2023-03-18
1171 - Introduce ESM module support along with CommonJS one.
1175 - Fix brown paper bag bug referencing the same object literal.
1177 ## [2.3.8] - 2023-03-18
1181 - Switch internal benchmarking code to benny.
1182 - Switch to TypeScript 5.x.x.
1183 - Switch rollup bundler plugins to core ones.
1184 - Switch to TSDoc syntax.
1185 - Enforce conventional commits.
1189 - Fix random integer generator.
1190 - Fix worker choice strategy pool type identification at initialization.
1192 ## [2.3.7] - 2022-10-23
1196 - Switch to open collective FOSS project funding platform.
1197 - Switch to ts-standard linter configuration on TypeScript code.
1201 - Fixed missing async on pool execute method.
1202 - Fixed typing in TypeScript example.
1203 - Fixed types in unit tests.
1205 ## [2.3.6] - 2022-10-22
1209 - Cleanup pool attributes and methods.
1210 - Refine error types thrown.
1214 - Fix continuous integration build on windows.
1215 - Fix code coverage reporting by using c8 instead of nyc.
1217 ## [2.3.5] - 2022-10-21
1221 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
1222 - Optimize tasks usage lookup implementation.
1226 - Fix missed pool event emitter type export.
1227 - Fix typedoc documentation generation.
1229 ## [2.3.4] - 2022-10-17
1233 - Fully automate release process with release-it.
1237 - Optimize fair share task scheduling algorithm implementation.
1238 - Update benchmark versus external pools results with latest version.
1240 ## [2.3.3] - 2022-10-15
1244 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
1246 ## [2.3.2] - 2022-10-14
1250 - Optimize fair share worker selection strategy implementation.
1254 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
1256 ## [2.3.1] - 2022-10-13
1260 - Pool worker choice strategies:
1261 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
1262 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
1264 ## [2.2.2] - 2022-10-09
1268 - Fixed `README.md` file.
1270 ## [2.2.1] - 2022-10-08
1274 - Dynamic worker choice strategy change at runtime.
1276 ## [2.2.0] - 2022-01-05
1278 ### Breaking Changes
1280 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
1282 ## [2.1.0] - 2021-08-29
1286 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
1288 ### Breaking Changes
1290 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
1291 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
1292 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
1293 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
1295 ## [2.0.2] - 2021-05-12
1299 - Fix `busy` event emission on fixed pool type
1301 ## [2.0.1] - 2021-03-16
1305 - Check if pool options are properly set.
1306 - `busy` event is emitted on all pool types.
1308 ## [2.0.0] - 2021-03-01
1312 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
1314 ### Breaking Changes
1316 - `FullPool` event is now renamed to `busy`.
1317 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
1318 _Find more details on our JSDoc._
1320 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
1322 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
1324 ### Pool options types declaration merge
1326 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
1328 #### New `export` strategy
1332 const DynamicThreadPool = require('poolifier/lib/dynamic')
1334 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
1337 But you should always prefer just using
1340 const { DynamicThreadPool } = require('poolifier')
1343 #### New type definitions for input data and response
1345 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
1346 _This is not a limitation by poolifier but Node.js._
1348 #### Public property replacements
1350 `numWorkers` property is now `numberOfWorkers`
1352 #### Internal (protected) properties and methods renaming
1354 These properties are not intended for end users
1356 - `id` => `nextMessageId`
1358 These methods are not intended for end users
1360 - `_chooseWorker` => `chooseWorker`
1361 - `_newWorker` => `createWorker`
1362 - `_execute` => `internalExecute`
1363 - `_chooseWorker` => `chooseWorker`
1364 - `_checkAlive` => `checkAlive`
1366 - `_runAsync` => `runAsync`
1368 ## [1.1.0] - 2020-05-21
1372 - ThreadWorker support async functions as option
1373 - Various external library patches
1375 ## [1.0.0] - 2020-01-24
1379 - FixedThreadPool implementation
1380 - DynamicThreadPool implementation
1381 - WorkerThread implementation to improve developer experience