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 source maps (bundler issue).
14 ## [2.7.3] - 2023-09-24
18 - Convert pool event emitter to event emitter async resource.
20 ## [2.7.2] - 2023-09-23
24 - Add source maps to npm package to ease debugging.
28 - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
30 ## [2.7.1] - 2023-09-20
34 - Ensure worker message listener used one time are removed after usage.
36 ## [2.7.0] - 2023-09-19
40 - Fix task stealing related tasks queue options handling at runtime.
44 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
48 - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
49 - Stricter worker constructor arguments validation.
51 ## [2.6.45] - 2023-09-17
55 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
59 - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
60 - Add `start()` method to pool API to start the minimum number of workers.
61 - Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing on back pressure or not.
62 - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
64 ## [2.6.44] - 2023-09-08
68 - Use a dedicated PAT to publish on GitHub packages registry.
72 - Publish on GitHub packages registry on release.
76 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
78 ## [2.6.43] - 2023-09-08
82 - Publish on GitHub packages registry on release.
86 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
88 ## [2.6.42] - 2023-09-06
92 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
94 ## [2.6.41] - 2023-09-03
98 - Optimize worker choice strategies implementation.
100 ## [2.6.40] - 2023-09-01
104 - Do not pre-choose in WRR worker choice strategy to avoid bias.
105 - Avoid array out of bound in worker choice strategies after worker node removal.
107 ## [2.6.39] - 2023-08-30
111 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
113 ## [2.6.38] - 2023-08-30
117 - Bundle typescript types declaration into one file.
121 - Improve interleaved weighted round robin worker choice strategy implementation.
123 ## [2.6.37] - 2023-08-28
127 - Ensure unused worker usage statistics are deleted at runtime.
131 - Rename worker choice strategy options `choiceRetries` to `retries`.
132 - Avoid unnecessary branching in worker choice strategies.
134 ## [2.6.36] - 2023-08-27
138 - Fix pool `execute()` arguments check.
142 - Make continuous tasks stealing algorithm less aggressive.
143 - Fine tune tasks stealing algorithm under back pressure.
145 ## [2.6.35] - 2023-08-25
149 - Don't account worker usage statistics for tasks that have failed.
150 - Fix pool information runtime and wait time median computation.
154 - Update simple moving average implementation to use a circular buffer.
155 - Update simple moving median implementation to use a circular buffer.
156 - Account for stolen tasks in worker usage statistics and pool information.
160 - Continuous tasks stealing algorithm.
162 ## [2.6.34] - 2023-08-24
166 - Avoid cascading tasks stealing under back pressure.
170 - Add fastpath to queued tasks rescheduling.
172 ## [2.6.33] - 2023-08-24
176 - Fix queued tasks rescheduling.
180 - Rename tasks queue options `queueMaxSize` to `size`.
184 - Task stealing scheduling algorithm if tasks queueing is enabled.
186 ## [2.6.32] - 2023-08-23
190 - Ensure no task can be executed when the pool is destroyed.
194 - Add `queueMaxSize` option to tasks queue options.
195 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
196 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
198 ## [2.6.31] - 2023-08-20
202 - Fix worker choice strategy retries mechanism in some edge cases.
206 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
207 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
209 ## [2.6.30] - 2023-08-19
213 - Ensure pool event `backPressure` is emitted.
214 - Ensure pool event `full` is emitted only once.
215 - Ensure worker node cannot be instantiated without proper arguments.
217 ## [2.6.29] - 2023-08-18
221 - Fix race condition between ready and task functions worker message handling at startup.
222 - Fix duplicate task function worker usage statistics computation per task function.
223 - Update task function worker usage statistics if and only if there's at least two different task functions.
224 - Fix race condition at task function worker usage executing task computation leading to negative value.
228 - 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).
229 - Use back pressure detection in worker choice strategies.
230 - Add worker choice strategies retries mechanism if no worker is eligible.
232 ## [2.6.28] - 2023-08-16
236 - Ensure pool workers are properly initialized.
240 - HTTP server pool examples: express-cluster, express-hybrid.
244 - Remove now useless branching in worker hot code path.
246 ## [2.6.27] - 2023-08-15
250 - Add `KillHandler` type definition to exported types.
254 - Add `destroy` event to pool API.
256 ## [2.6.26] - 2023-08-15
260 - Add kill handler to worker options allowing to execute custom code when worker is killed.
261 - Add `listTaskFunctions()` method to pool API.
262 - SMTP client pool example: nodemailer.
264 ## [2.6.25] - 2023-08-13
268 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
269 - WebSocket server pool examples: ws-cluster, ws-hybrid.
271 ## [2.6.24] - 2023-08-12
275 - Add array of transferable objects to the `execute()` method arguments.
276 - WebSocket server pool examples: ws-worker_threads.
278 ## [2.6.23] - 2023-08-11
282 - 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.
286 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
287 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
289 ## [2.6.22] - 2023-08-10
293 - Add missing `types` field to package.json `exports`.
297 - Structure markdown documentation (PR #811).
299 ## [2.6.21] - 2023-08-03
303 - Improve code documentation.
304 - Code refactoring and cleanup for better maintainability and readability.
306 ## [2.6.20] - 2023-07-21
310 - Fix queued tasks redistribution on error task execution starvation.
311 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
315 - Drastically reduce lookups by worker in the worker nodes.
317 ## [2.6.19] - 2023-07-20
321 - Dedicated internal communication channel for worker_threads pools.
323 ## [2.6.18] - 2023-07-19
327 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
329 ## [2.6.17] - 2023-07-16
333 - Add `listTaskFunctions()` method to worker API.
335 ## [2.6.16] - 2023-07-12
339 - Fix pool startup detection.
340 - Fix worker task functions handling.
342 ## [2.6.15] - 2023-07-11
346 - Take into account worker node readiness in worker choice strategies.
348 ## [2.6.14] - 2023-07-10
352 - Fix task function statistics tracking.
354 ## [2.6.13] - 2023-07-10
358 - Add per task function statistics tracking.
359 - Add public methods to manipulate the worker task functions at runtime.
361 ## [2.6.12] - 2023-07-09
365 - Workaround import issue with `node:os` module in node 16.x.x.
367 ## [2.6.11] - 2023-07-09
371 - Fix pool readiness semantic.
373 ## [2.6.10] - 2023-07-08
377 - Ensure workers are not recreated on error at pool startup.
381 - Add `ready` and `strategy` fields to pool information.
382 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
383 - Add dynamic pool sizing checks.
385 ## [2.6.9] - 2023-07-07
389 - Recreate the right worker type on uncaught exception.
393 - Add minimum and maximum to internal measurement statistics.
394 - Add `runTime` and `waitTime` to pool information.
395 - Check worker inactive time only on dynamic worker.
397 ## [2.6.8] - 2023-07-03
401 - Brown paper bag release to fix version handling in pool information.
403 ## [2.6.7] - 2023-07-03
407 - Ensure worker queued tasks at error are reassigned to other pool workers.
411 - Add pool `utilization` ratio to pool information.
412 - Add `version` to pool information.
413 - Add worker information to worker nodes.
415 ## [2.6.6] - 2023-07-01
419 - Add safe helper `availableParallelism()` to help sizing the pool.
423 - Ensure message handler is only registered in worker.
425 ## [2.6.5] - 2023-06-27
429 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
433 - Artificial version bump to 2.6.5 to workaround publication issue.
434 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
435 - Ensure pool event is emitted before task error promise rejection.
436 - Fix queued tasks count computation.
440 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
442 ## [2.6.4] - 2023-06-27
446 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
450 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
451 - Ensure pool event is emitted before task error promise rejection.
452 - Fix queued tasks count computation.
456 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
458 ## [2.6.3] - 2023-06-19
462 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
463 - Update strategies internals after statistics computation.
467 - Optimize O(1) queue implementation.
469 ## [2.6.2] - 2023-06-12
473 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
475 ## [2.6.1] - 2023-06-10
479 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
483 - Fix average statistics computation: ensure failed tasks are not accounted.
485 ## [2.6.0] - 2023-06-09
489 - Add `LEAST_ELU` worker choice strategy (experimental).
490 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
494 - Refactor pool worker node usage internals.
495 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
496 - Breaking change: pool information `info` property object fields have been renamed.
500 - Fix wait time accounting.
501 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
502 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
504 ## [2.5.4] - 2023-06-07
508 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
512 - Compute statistics at the worker level only if needed.
513 - Add `worker_threads` options to thread pool options.
517 - Make the `LEAST_BUSY` strategy only relies on task runtime.
519 ## [2.5.3] - 2023-06-04
523 - Refine pool information content.
524 - Limit pool internals public exposure.
526 ## [2.5.2] - 2023-06-02
530 - Add `taskError` pool event for task execution error.
531 - Add pool information `info` property to pool.
532 - Emit pool information on `busy` and `full` pool events.
534 ## [2.5.1] - 2023-06-01
538 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
539 - Add `error` pool event for uncaught worker error.
541 ## [2.5.0] - 2023-05-31
545 - Switch pool event emitter to `EventEmitterAsyncResource`.
546 - Add tasks wait time accounting in per worker tasks usage.
547 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
551 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
553 ## [2.4.14] - 2023-05-09
557 - Ensure no undefined task runtime can land in the tasks history.
558 - Fix median computation implementation once again.
562 - Unit tests for median and queue implementations.
564 ## [2.4.13] - 2023-05-08
568 - Fix worker choice strategy options validation.
569 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
571 ## [2.4.12] - 2023-05-06
575 - Support multiple task functions per worker.
576 - Add custom worker weights support to worker choice strategies options.
580 - Use O(1) queue implementation for tasks queueing.
584 - Fix median computation implementation.
585 - Fix fair share worker choice strategy internals update.
587 ## [2.4.11] - 2023-04-23
591 - Optimize free worker finding in worker choice strategies.
593 ## [2.4.10] - 2023-04-15
597 - Fix typescript type definition for task function: ensure the input data is optional.
598 - Fix typescript type definition for pool execute(): ensure the input data is optional.
600 ## [2.4.9] - 2023-04-15
604 - Add tasks queue enablement runtime setter to pool.
605 - Add tasks queue options runtime setter to pool.
606 - Add worker choice strategy options runtime setter to pool.
610 - Remove the tasks queuing experimental status.
614 - Fix task function type definition and validation.
615 - Fix worker choice strategy options handling.
617 ## [2.4.8] - 2023-04-12
621 - Fix message between main worker and worker type definition for tasks.
622 - Fix code documentation.
624 ## [2.4.7] - 2023-04-11
628 - Add worker tasks queue options to pool options.
632 - Fix missing documentation.
634 ## [2.4.6] - 2023-04-10
638 - Ensure one task at a time is executed per worker with tasks queueing enabled.
639 - Properly count worker executing tasks with tasks queueing enabled.
641 ## [2.4.5] - 2023-04-09
645 - Use monotonic high resolution timer for worker tasks runtime.
646 - Add worker tasks median runtime to statistics.
647 - Add worker tasks queue (experimental).
649 ## [2.4.4] - 2023-04-07
653 - Add `PoolEvents` enumeration and `PoolEvent` type.
657 - Destroy worker only on alive check.
659 ## [2.4.3] - 2023-04-07
663 - Fix typedoc generation with inheritance.
665 ## [2.4.2] - 2023-04-06
669 - Add `full` event to dynamic pool.
670 - Keep worker choice strategy in memory for conditional reuse.
674 - Fix possible negative worker key at worker removal in worker choice strategies.
676 ## [2.4.1] - 2023-04-05
680 - Optimize worker choice strategy for dynamic pool.
684 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
686 ## [2.4.0] - 2023-04-04
690 - Add `LESS_BUSY` worker choice strategy.
694 - Optimize worker storage in pool.
695 - Optimize worker alive status check.
696 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
697 - Optimize `LESS_USED` worker choice strategy.
698 - Update benchmark versus external threads pools.
699 - Optimize tasks usage statistics requirements for worker choice strategy.
703 - Ensure trimmable characters are checked at pool initialization.
704 - Fix message id integer overflow.
705 - Fix pool worker removal in worker choice strategy internals.
706 - Fix package publication with pnpm.
708 ## [2.4.0-3] - 2023-04-04
712 - Add `LESS_BUSY` worker choice strategy.
716 - Optimize worker storage in pool.
717 - Optimize worker alive status check.
718 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
719 - Optimize `LESS_USED` worker choice strategy.
720 - Update benchmark versus external threads pools.
724 - Ensure trimmable characters are checked at pool initialization.
725 - Fix message id integer overflow.
726 - Fix pool worker removal in worker choice strategy internals.
727 - Fix package publication with pnpm.
729 ## [2.4.0-2] - 2023-04-03
733 - Add `LESS_BUSY` worker choice strategy.
737 - Optimize worker storage in pool.
738 - Optimize worker alive status check.
739 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
740 - Optimize `LESS_USED` worker choice strategy.
744 - Ensure trimmable characters are checked at pool initialization.
745 - Fix message id integer overflow.
746 - Fix pool worker removal in worker choice strategy internals.
747 - Fix package publication with pnpm.
749 ## [2.4.0-1] - 2023-04-03
753 - Add `LESS_BUSY` worker choice strategy.
757 - Optimize worker storage in pool.
758 - Optimize worker alive status check.
759 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
760 - Optimize `LESS_USED` worker choice strategy.
764 - Ensure trimmable characters are checked at pool initialization.
765 - Fix message id integer overflow.
766 - Fix pool worker removal in worker choice strategy internals.
768 ## [2.4.0-0] - 2023-04-03
772 - Add `LESS_BUSY` worker choice strategy.
776 - Optimize worker storage in pool.
777 - Optimize worker alive status check.
778 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
779 - Optimize `LESS_USED` worker choice strategy.
783 - Ensure trimmable characters are checked at pool initialization.
784 - Fix message id integer overflow.
785 - Fix pool worker removal in worker choice strategy internals.
787 ## [2.3.10] - 2023-03-18
791 - Fix package.json `exports` syntax for ESM and CommonJS.
795 - Permit SemVer pre-release publication.
797 ## [2.3.10-2] - 2023-03-18
801 - Fix package.json `exports` syntax for ESM and CommonJS.
803 ## [2.3.10-1] - 2023-03-18
807 - Permit SemVer pre-release publication.
809 ## [2.3.10-0] - 2023-03-18
813 - Fix package.json `exports` syntax for ESM and CommonJS.
815 ## [2.3.9] - 2023-03-18
819 - Introduce ESM module support along with CommonJS one.
823 - Fix brown paper bag bug referencing the same object literal.
825 ## [2.3.8] - 2023-03-18
829 - Switch internal benchmarking code to benny.
830 - Switch to TypeScript 5.x.x.
831 - Switch rollup bundler plugins to core ones.
832 - Switch to TSDoc syntax.
833 - Enforce conventional commits.
837 - Fix random integer generator.
838 - Fix worker choice strategy pool type identification at initialization.
840 ## [2.3.7] - 2022-10-23
844 - Switch to open collective FOSS project funding platform.
845 - Switch to ts-standard linter configuration on TypeScript code.
849 - Fixed missing async on pool execute method.
850 - Fixed typing in TypeScript example.
851 - Fixed types in unit tests.
853 ## [2.3.6] - 2022-10-22
857 - Cleanup pool attributes and methods.
858 - Refine error types thrown.
862 - Fix continuous integration build on windows.
863 - Fix code coverage reporting by using c8 instead of nyc.
865 ## [2.3.5] - 2022-10-21
869 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
870 - Optimize tasks usage lookup implementation.
874 - Fix missed pool event emitter type export.
875 - Fix typedoc documentation generation.
877 ## [2.3.4] - 2022-10-17
881 - Fully automate release process with release-it.
885 - Optimize fair share task scheduling algorithm implementation.
886 - Update benchmark versus external pools results with latest version.
888 ## [2.3.3] - 2022-10-15
892 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
894 ## [2.3.2] - 2022-10-14
898 - Optimize fair share worker selection strategy implementation.
902 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
904 ## [2.3.1] - 2022-10-13
908 - Pool worker choice strategies:
909 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
910 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
912 ## [2.2.2] - 2022-10-09
916 - Fixed `README.md` file.
918 ## [2.2.1] - 2022-10-08
922 - Dynamic worker choice strategy change at runtime.
924 ## [2.2.0] - 2022-01-05
928 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
930 ## [2.1.0] - 2021-08-29
934 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
938 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
939 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
940 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
941 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
943 ## [2.0.2] - 2021-05-12
947 - Fix `busy` event emission on fixed pool type
949 ## [2.0.1] - 2021-03-16
953 - Check if pool options are properly set.
954 - `busy` event is emitted on all pool types.
956 ## [2.0.0] - 2021-03-01
960 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
964 - `FullPool` event is now renamed to `busy`.
965 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
966 _Find more details on our JSDoc._
968 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
970 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
972 ### Pool options types declaration merge
974 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
976 #### New `export` strategy
980 const DynamicThreadPool = require('poolifier/lib/dynamic')
982 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
985 But you should always prefer just using
988 const { DynamicThreadPool } = require('poolifier')
991 #### New type definitions for input data and response
993 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
994 _This is not a limitation by poolifier but Node.js._
996 #### Public property replacements
998 `numWorkers` property is now `numberOfWorkers`
1000 #### Internal (protected) properties and methods renaming
1002 These properties are not intended for end users
1004 - `id` => `nextMessageId`
1006 These methods are not intended for end users
1008 - `_chooseWorker` => `chooseWorker`
1009 - `_newWorker` => `createWorker`
1010 - `_execute` => `internalExecute`
1011 - `_chooseWorker` => `chooseWorker`
1012 - `_checkAlive` => `checkAlive`
1014 - `_runAsync` => `runAsync`
1016 ## [1.1.0] - 2020-05-21
1020 - ThreadWorker support async functions as option
1021 - Various external library patches
1023 ## [1.0.0] - 2020-01-24
1027 - FixedThreadPool implementation
1028 - DynamicThreadPool implementation
1029 - WorkerThread implementation to improve developer experience