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 - Disable publication on GitHub packages registry on release until authentication issue is fixed.
13 - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API.
17 - Add `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API.
19 ## [2.6.44] - 2023-09-08
23 - Use a dedicated PAT to publish on GitHub packages registry.
27 - Publish on GitHub packages registry on release.
31 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
33 ## [2.6.43] - 2023-09-08
37 - Publish on GitHub packages registry on release.
41 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
43 ## [2.6.42] - 2023-09-06
47 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
49 ## [2.6.41] - 2023-09-03
53 - Optimize worker choice strategies implementation.
55 ## [2.6.40] - 2023-09-01
59 - Do not pre-choose in WRR worker choice strategy to avoid bias.
60 - Avoid array out of bound in worker choice strategies after worker node removal.
62 ## [2.6.39] - 2023-08-30
66 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
68 ## [2.6.38] - 2023-08-30
72 - Bundle typescript types declaration into one file.
76 - Improve interleaved weighted round robin worker choice strategy implementation.
78 ## [2.6.37] - 2023-08-28
82 - Ensure unused worker usage statistics are deleted at runtime.
86 - Rename worker choice strategy options `choiceRetries` to `retries`.
87 - Avoid unnecessary branching in worker choice strategies.
89 ## [2.6.36] - 2023-08-27
93 - Fix pool `execute()` arguments check.
97 - Make continuous tasks stealing algorithm less aggressive.
98 - Fine tune tasks stealing algorithm under back pressure.
100 ## [2.6.35] - 2023-08-25
104 - Don't account worker usage statistics for tasks that have failed.
105 - Fix pool information runtime and wait time median computation.
109 - Update simple moving average implementation to use a circular buffer.
110 - Update simple moving median implementation to use a circular buffer.
111 - Account for stolen tasks in worker usage statistics and pool information.
115 - Continuous tasks stealing algorithm.
117 ## [2.6.34] - 2023-08-24
121 - Avoid cascading tasks stealing under back pressure.
125 - Add fastpath to queued tasks rescheduling.
127 ## [2.6.33] - 2023-08-24
131 - Fix queued tasks rescheduling.
135 - Rename tasks queue options `queueMaxSize` to `size`.
139 - Task stealing scheduling algorithm if tasks queueing is enabled.
141 ## [2.6.32] - 2023-08-23
145 - Ensure no task can be executed when the pool is destroyed.
149 - Add `queueMaxSize` option to tasks queue options.
150 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
151 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
153 ## [2.6.31] - 2023-08-20
157 - Fix worker choice strategy retries mechanism in some edge cases.
161 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
162 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
164 ## [2.6.30] - 2023-08-19
168 - Ensure pool event `backPressure` is emitted.
169 - Ensure pool event `full` is emitted only once.
170 - Ensure worker node cannot be instantiated without proper arguments.
172 ## [2.6.29] - 2023-08-18
176 - Fix race condition between ready and task functions worker message handling at startup.
177 - Fix duplicate task function worker usage statistics computation per task function.
178 - Update task function worker usage statistics if and only if there's at least two different task functions.
179 - Fix race condition at task function worker usage executing task computation leading to negative value.
183 - 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).
184 - Use back pressure detection in worker choice strategies.
185 - Add worker choice strategies retries mechanism if no worker is eligible.
187 ## [2.6.28] - 2023-08-16
191 - Ensure pool workers are properly initialized.
195 - HTTP server pool examples: express-cluster, express-hybrid.
199 - Remove now useless branching in worker hot code path.
201 ## [2.6.27] - 2023-08-15
205 - Add `KillHandler` type definition to exported types.
209 - Add `destroy` event to pool API.
211 ## [2.6.26] - 2023-08-15
215 - Add kill handler to worker options allowing to execute custom code when worker is killed.
216 - Add `listTaskFunctions()` method to pool API.
217 - SMTP client pool example: nodemailer.
219 ## [2.6.25] - 2023-08-13
223 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
224 - WebSocket server pool examples: ws-cluster, ws-hybrid.
226 ## [2.6.24] - 2023-08-12
230 - Add array of transferable objects to the `execute()` method arguments.
231 - WebSocket server pool examples: ws-worker_threads.
233 ## [2.6.23] - 2023-08-11
237 - 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.
241 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
242 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
244 ## [2.6.22] - 2023-08-10
248 - Add missing `types` field to package.json `exports`.
252 - Structure markdown documentation (PR #811).
254 ## [2.6.21] - 2023-08-03
258 - Improve code documentation.
259 - Code refactoring and cleanup for better maintainability and readability.
261 ## [2.6.20] - 2023-07-21
265 - Fix queued tasks redistribution on error task execution starvation.
266 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
270 - Drastically reduce lookups by worker in the worker nodes.
272 ## [2.6.19] - 2023-07-20
276 - Dedicated internal communication channel for worker_threads pools.
278 ## [2.6.18] - 2023-07-19
282 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
284 ## [2.6.17] - 2023-07-16
288 - Add `listTaskFunctions()` method to worker API.
290 ## [2.6.16] - 2023-07-12
294 - Fix pool startup detection.
295 - Fix worker task functions handling.
297 ## [2.6.15] - 2023-07-11
301 - Take into account worker node readiness in worker choice strategies.
303 ## [2.6.14] - 2023-07-10
307 - Fix task function statistics tracking.
309 ## [2.6.13] - 2023-07-10
313 - Add per task function statistics tracking.
314 - Add public methods to manipulate the worker task functions at runtime.
316 ## [2.6.12] - 2023-07-09
320 - Workaround import issue with `node:os` module in node 16.x.x.
322 ## [2.6.11] - 2023-07-09
326 - Fix pool readiness semantic.
328 ## [2.6.10] - 2023-07-08
332 - Ensure workers are not recreated on error at pool startup.
336 - Add `ready` and `strategy` fields to pool information.
337 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
338 - Add dynamic pool sizing checks.
340 ## [2.6.9] - 2023-07-07
344 - Recreate the right worker type on uncaught exception.
348 - Add minimum and maximum to internal measurement statistics.
349 - Add `runTime` and `waitTime` to pool information.
350 - Check worker inactive time only on dynamic worker.
352 ## [2.6.8] - 2023-07-03
356 - Brown paper bag release to fix version handling in pool information.
358 ## [2.6.7] - 2023-07-03
362 - Ensure worker queued tasks at error are reassigned to other pool workers.
366 - Add pool `utilization` ratio to pool information.
367 - Add `version` to pool information.
368 - Add worker information to worker nodes.
370 ## [2.6.6] - 2023-07-01
374 - Add safe helper `availableParallelism()` to help sizing the pool.
378 - Ensure message handler is only registered in worker.
380 ## [2.6.5] - 2023-06-27
384 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
388 - Artificial version bump to 2.6.5 to workaround publication issue.
389 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
390 - Ensure pool event is emitted before task error promise rejection.
391 - Fix queued tasks count computation.
395 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
397 ## [2.6.4] - 2023-06-27
401 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
405 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
406 - Ensure pool event is emitted before task error promise rejection.
407 - Fix queued tasks count computation.
411 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
413 ## [2.6.3] - 2023-06-19
417 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
418 - Update strategies internals after statistics computation.
422 - Optimize O(1) queue implementation.
424 ## [2.6.2] - 2023-06-12
428 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
430 ## [2.6.1] - 2023-06-10
434 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
438 - Fix average statistics computation: ensure failed tasks are not accounted.
440 ## [2.6.0] - 2023-06-09
444 - Add `LEAST_ELU` worker choice strategy (experimental).
445 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
449 - Refactor pool worker node usage internals.
450 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
451 - Breaking change: pool information `info` property object fields have been renamed.
455 - Fix wait time accounting.
456 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
457 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
459 ## [2.5.4] - 2023-06-07
463 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
467 - Compute statistics at the worker level only if needed.
468 - Add `worker_threads` options to thread pool options.
472 - Make the `LEAST_BUSY` strategy only relies on task runtime.
474 ## [2.5.3] - 2023-06-04
478 - Refine pool information content.
479 - Limit pool internals public exposure.
481 ## [2.5.2] - 2023-06-02
485 - Add `taskError` pool event for task execution error.
486 - Add pool information `info` property to pool.
487 - Emit pool information on `busy` and `full` pool events.
489 ## [2.5.1] - 2023-06-01
493 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
494 - Add `error` pool event for uncaught worker error.
496 ## [2.5.0] - 2023-05-31
500 - Switch pool event emitter to `EventEmitterAsyncResource`.
501 - Add tasks wait time accounting in per worker tasks usage.
502 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
506 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
508 ## [2.4.14] - 2023-05-09
512 - Ensure no undefined task runtime can land in the tasks history.
513 - Fix median computation implementation once again.
517 - Unit tests for median and queue implementations.
519 ## [2.4.13] - 2023-05-08
523 - Fix worker choice strategy options validation.
524 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
526 ## [2.4.12] - 2023-05-06
530 - Support multiple task functions per worker.
531 - Add custom worker weights support to worker choice strategies options.
535 - Use O(1) queue implementation for tasks queueing.
539 - Fix median computation implementation.
540 - Fix fair share worker choice strategy internals update.
542 ## [2.4.11] - 2023-04-23
546 - Optimize free worker finding in worker choice strategies.
548 ## [2.4.10] - 2023-04-15
552 - Fix typescript type definition for task function: ensure the input data is optional.
553 - Fix typescript type definition for pool execute(): ensure the input data is optional.
555 ## [2.4.9] - 2023-04-15
559 - Add tasks queue enablement runtime setter to pool.
560 - Add tasks queue options runtime setter to pool.
561 - Add worker choice strategy options runtime setter to pool.
565 - Remove the tasks queuing experimental status.
569 - Fix task function type definition and validation.
570 - Fix worker choice strategy options handling.
572 ## [2.4.8] - 2023-04-12
576 - Fix message between main worker and worker type definition for tasks.
577 - Fix code documentation.
579 ## [2.4.7] - 2023-04-11
583 - Add worker tasks queue options to pool options.
587 - Fix missing documentation.
589 ## [2.4.6] - 2023-04-10
593 - Ensure one task at a time is executed per worker with tasks queueing enabled.
594 - Properly count worker executing tasks with tasks queueing enabled.
596 ## [2.4.5] - 2023-04-09
600 - Use monotonic high resolution timer for worker tasks runtime.
601 - Add worker tasks median runtime to statistics.
602 - Add worker tasks queue (experimental).
604 ## [2.4.4] - 2023-04-07
608 - Add `PoolEvents` enumeration and `PoolEvent` type.
612 - Destroy worker only on alive check.
614 ## [2.4.3] - 2023-04-07
618 - Fix typedoc generation with inheritance.
620 ## [2.4.2] - 2023-04-06
624 - Add `full` event to dynamic pool.
625 - Keep worker choice strategy in memory for conditional reuse.
629 - Fix possible negative worker key at worker removal in worker choice strategies.
631 ## [2.4.1] - 2023-04-05
635 - Optimize worker choice strategy for dynamic pool.
639 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
641 ## [2.4.0] - 2023-04-04
645 - Add `LESS_BUSY` worker choice strategy.
649 - Optimize worker storage in pool.
650 - Optimize worker alive status check.
651 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
652 - Optimize `LESS_USED` worker choice strategy.
653 - Update benchmarks versus external threads pools.
654 - Optimize tasks usage statistics requirements for worker choice strategy.
658 - Ensure trimmable characters are checked at pool initialization.
659 - Fix message id integer overflow.
660 - Fix pool worker removal in worker choice strategy internals.
661 - Fix package publication with pnpm.
663 ## [2.4.0-3] - 2023-04-04
667 - Add `LESS_BUSY` worker choice strategy.
671 - Optimize worker storage in pool.
672 - Optimize worker alive status check.
673 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
674 - Optimize `LESS_USED` worker choice strategy.
675 - Update benchmarks versus external threads pools.
679 - Ensure trimmable characters are checked at pool initialization.
680 - Fix message id integer overflow.
681 - Fix pool worker removal in worker choice strategy internals.
682 - Fix package publication with pnpm.
684 ## [2.4.0-2] - 2023-04-03
688 - Add `LESS_BUSY` worker choice strategy.
692 - Optimize worker storage in pool.
693 - Optimize worker alive status check.
694 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
695 - Optimize `LESS_USED` worker choice strategy.
699 - Ensure trimmable characters are checked at pool initialization.
700 - Fix message id integer overflow.
701 - Fix pool worker removal in worker choice strategy internals.
702 - Fix package publication with pnpm.
704 ## [2.4.0-1] - 2023-04-03
708 - Add `LESS_BUSY` worker choice strategy.
712 - Optimize worker storage in pool.
713 - Optimize worker alive status check.
714 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
715 - Optimize `LESS_USED` worker choice strategy.
719 - Ensure trimmable characters are checked at pool initialization.
720 - Fix message id integer overflow.
721 - Fix pool worker removal in worker choice strategy internals.
723 ## [2.4.0-0] - 2023-04-03
727 - Add `LESS_BUSY` worker choice strategy.
731 - Optimize worker storage in pool.
732 - Optimize worker alive status check.
733 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
734 - Optimize `LESS_USED` worker choice strategy.
738 - Ensure trimmable characters are checked at pool initialization.
739 - Fix message id integer overflow.
740 - Fix pool worker removal in worker choice strategy internals.
742 ## [2.3.10] - 2023-03-18
746 - Fix package.json `exports` syntax for ESM and CommonJS.
750 - Permit SemVer pre-release publication.
752 ## [2.3.10-2] - 2023-03-18
756 - Fix package.json `exports` syntax for ESM and CommonJS.
758 ## [2.3.10-1] - 2023-03-18
762 - Permit SemVer pre-release publication.
764 ## [2.3.10-0] - 2023-03-18
768 - Fix package.json `exports` syntax for ESM and CommonJS.
770 ## [2.3.9] - 2023-03-18
774 - Introduce ESM module support along with CommonJS one.
778 - Fix brown paper bag bug referencing the same object literal.
780 ## [2.3.8] - 2023-03-18
784 - Switch internal benchmarking code to benny.
785 - Switch to TypeScript 5.x.x.
786 - Switch rollup bundler plugins to core ones.
787 - Switch to TSDoc syntax.
788 - Enforce conventional commits.
792 - Fix random integer generator.
793 - Fix worker choice strategy pool type identification at initialization.
795 ## [2.3.7] - 2022-10-23
799 - Switch to open collective FOSS project funding platform.
800 - Switch to ts-standard linter configuration on TypeScript code.
804 - Fixed missing async on pool execute method.
805 - Fixed typing in TypeScript example.
806 - Fixed types in unit tests.
808 ## [2.3.6] - 2022-10-22
812 - Cleanup pool attributes and methods.
813 - Refine error types thrown.
817 - Fix continuous integration build on windows.
818 - Fix code coverage reporting by using c8 instead of nyc.
820 ## [2.3.5] - 2022-10-21
824 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
825 - Optimize tasks usage lookup implementation.
829 - Fix missed pool event emitter type export.
830 - Fix typedoc documentation generation.
832 ## [2.3.4] - 2022-10-17
836 - Fully automate release process with release-it.
840 - Optimize fair share task scheduling algorithm implementation.
841 - Update benchmarks versus external pools results with latest version.
843 ## [2.3.3] - 2022-10-15
847 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
849 ## [2.3.2] - 2022-10-14
853 - Optimize fair share worker selection strategy implementation.
857 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
859 ## [2.3.1] - 2022-10-13
863 - Pool worker choice strategies:
864 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
865 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
867 ## [2.2.2] - 2022-10-09
871 - Fixed `README.md` file.
873 ## [2.2.1] - 2022-10-08
877 - Dynamic worker choice strategy change at runtime.
879 ## [2.2.0] - 2022-01-05
883 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
885 ## [2.1.0] - 2021-08-29
889 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
893 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
894 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
895 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
896 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
898 ## [2.0.2] - 2021-05-12
902 - Fix `busy` event emission on fixed pool type
904 ## [2.0.1] - 2021-03-16
908 - Check if pool options are properly set.
909 - `busy` event is emitted on all pool types.
911 ## [2.0.0] - 2021-03-01
915 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
919 - `FullPool` event is now renamed to `busy`.
920 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
921 _Find more details on our JSDoc._
923 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
925 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
927 ### Pool options types declaration merge
929 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
931 #### New `export` strategy
935 const DynamicThreadPool = require('poolifier/lib/dynamic')
937 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
940 But you should always prefer just using
943 const { DynamicThreadPool } = require('poolifier')
946 #### New type definitions for input data and response
948 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
949 _This is not a limitation by poolifier but Node.js._
951 #### Public property replacements
953 `numWorkers` property is now `numberOfWorkers`
955 #### Internal (protected) properties and methods renaming
957 These properties are not intended for end users
959 - `id` => `nextMessageId`
961 These methods are not intended for end users
963 - `_chooseWorker` => `chooseWorker`
964 - `_newWorker` => `createWorker`
965 - `_execute` => `internalExecute`
966 - `_chooseWorker` => `chooseWorker`
967 - `_checkAlive` => `checkAlive`
969 - `_runAsync` => `runAsync`
971 ## [1.1.0] - 2020-05-21
975 - ThreadWorker support async functions as option
976 - Various external library patches
978 ## [1.0.0] - 2020-01-24
982 - FixedThreadPool implementation
983 - DynamicThreadPool implementation
984 - WorkerThread implementation to improve developer experience