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.
14 ## [2.6.44] - 2023-09-08
18 - Use a dedicated PAT to publish on GitHub packages registry.
22 - Publish on GitHub packages registry on release.
26 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
28 ## [2.6.43] - 2023-09-08
32 - Publish on GitHub packages registry on release.
36 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128).
38 ## [2.6.42] - 2023-09-06
42 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
44 ## [2.6.41] - 2023-09-03
48 - Optimize worker choice strategies implementation.
50 ## [2.6.40] - 2023-09-01
54 - Do not pre-choose in WRR worker choice strategy to avoid bias.
55 - Avoid array out of bound in worker choice strategies after worker node removal.
57 ## [2.6.39] - 2023-08-30
61 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized.
63 ## [2.6.38] - 2023-08-30
67 - Bundle typescript types declaration into one file.
71 - Improve interleaved weighted round robin worker choice strategy implementation.
73 ## [2.6.37] - 2023-08-28
77 - Ensure unused worker usage statistics are deleted at runtime.
81 - Rename worker choice strategy options `choiceRetries` to `retries`.
82 - Avoid unnecessary branching in worker choice strategies.
84 ## [2.6.36] - 2023-08-27
88 - Fix pool `execute()` arguments check.
92 - Make continuous tasks stealing algorithm less aggressive.
93 - Fine tune tasks stealing algorithm under back pressure.
95 ## [2.6.35] - 2023-08-25
99 - Don't account worker usage statistics for tasks that have failed.
100 - Fix pool information runtime and wait time median computation.
104 - Update simple moving average implementation to use a circular buffer.
105 - Update simple moving median implementation to use a circular buffer.
106 - Account for stolen tasks in worker usage statistics and pool information.
110 - Continuous tasks stealing algorithm.
112 ## [2.6.34] - 2023-08-24
116 - Avoid cascading tasks stealing under back pressure.
120 - Add fastpath to queued tasks rescheduling.
122 ## [2.6.33] - 2023-08-24
126 - Fix queued tasks rescheduling.
130 - Rename tasks queue options `queueMaxSize` to `size`.
134 - Task stealing scheduling algorithm if tasks queueing is enabled.
136 ## [2.6.32] - 2023-08-23
140 - Ensure no task can be executed when the pool is destroyed.
144 - Add `queueMaxSize` option to tasks queue options.
145 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
146 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
148 ## [2.6.31] - 2023-08-20
152 - Fix worker choice strategy retries mechanism in some edge cases.
156 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
157 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
159 ## [2.6.30] - 2023-08-19
163 - Ensure pool event `backPressure` is emitted.
164 - Ensure pool event `full` is emitted only once.
165 - Ensure worker node cannot be instantiated without proper arguments.
167 ## [2.6.29] - 2023-08-18
171 - Fix race condition between ready and task functions worker message handling at startup.
172 - Fix duplicate task function worker usage statistics computation per task function.
173 - Update task function worker usage statistics if and only if there's at least two different task functions.
174 - Fix race condition at task function worker usage executing task computation leading to negative value.
178 - 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).
179 - Use back pressure detection in worker choice strategies.
180 - Add worker choice strategies retries mechanism if no worker is eligible.
182 ## [2.6.28] - 2023-08-16
186 - Ensure pool workers are properly initialized.
190 - HTTP server pool examples: express-cluster, express-hybrid.
194 - Remove now useless branching in worker hot code path.
196 ## [2.6.27] - 2023-08-15
200 - Add `KillHandler` type definition to exported types.
204 - Add `destroy` event to pool API.
206 ## [2.6.26] - 2023-08-15
210 - Add kill handler to worker options allowing to execute custom code when worker is killed.
211 - Add `listTaskFunctions()` method to pool API.
212 - SMTP client pool example: nodemailer.
214 ## [2.6.25] - 2023-08-13
218 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
219 - WebSocket server pool examples: ws-cluster, ws-hybrid.
221 ## [2.6.24] - 2023-08-12
225 - Add array of transferable objects to the `execute()` method arguments.
226 - WebSocket server pool examples: ws-worker_threads.
228 ## [2.6.23] - 2023-08-11
232 - 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.
236 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
237 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
239 ## [2.6.22] - 2023-08-10
243 - Add missing `types` field to package.json `exports`.
247 - Structure markdown documentation (PR #811).
249 ## [2.6.21] - 2023-08-03
253 - Improve code documentation.
254 - Code refactoring and cleanup for better maintainability and readability.
256 ## [2.6.20] - 2023-07-21
260 - Fix queued tasks redistribution on error task execution starvation.
261 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
265 - Drastically reduce lookups by worker in the worker nodes.
267 ## [2.6.19] - 2023-07-20
271 - Dedicated internal communication channel for worker_threads pools.
273 ## [2.6.18] - 2023-07-19
277 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
279 ## [2.6.17] - 2023-07-16
283 - Add `listTaskFunctions()` method to worker API.
285 ## [2.6.16] - 2023-07-12
289 - Fix pool startup detection.
290 - Fix worker task functions handling.
292 ## [2.6.15] - 2023-07-11
296 - Take into account worker node readiness in worker choice strategies.
298 ## [2.6.14] - 2023-07-10
302 - Fix task function statistics tracking.
304 ## [2.6.13] - 2023-07-10
308 - Add per task function statistics tracking.
309 - Add public methods to manipulate the worker task functions at runtime.
311 ## [2.6.12] - 2023-07-09
315 - Workaround import issue with `node:os` module in node 16.x.x.
317 ## [2.6.11] - 2023-07-09
321 - Fix pool readiness semantic.
323 ## [2.6.10] - 2023-07-08
327 - Ensure workers are not recreated on error at pool startup.
331 - Add `ready` and `strategy` fields to pool information.
332 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
333 - Add dynamic pool sizing checks.
335 ## [2.6.9] - 2023-07-07
339 - Recreate the right worker type on uncaught exception.
343 - Add minimum and maximum to internal measurement statistics.
344 - Add `runTime` and `waitTime` to pool information.
345 - Check worker inactive time only on dynamic worker.
347 ## [2.6.8] - 2023-07-03
351 - Brown paper bag release to fix version handling in pool information.
353 ## [2.6.7] - 2023-07-03
357 - Ensure worker queued tasks at error are reassigned to other pool workers.
361 - Add pool `utilization` ratio to pool information.
362 - Add `version` to pool information.
363 - Add worker information to worker nodes.
365 ## [2.6.6] - 2023-07-01
369 - Add safe helper `availableParallelism()` to help sizing the pool.
373 - Ensure message handler is only registered in worker.
375 ## [2.6.5] - 2023-06-27
379 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
383 - Artificial version bump to 2.6.5 to workaround publication issue.
384 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
385 - Ensure pool event is emitted before task error promise rejection.
386 - Fix queued tasks count computation.
390 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
392 ## [2.6.4] - 2023-06-27
396 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
400 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
401 - Ensure pool event is emitted before task error promise rejection.
402 - Fix queued tasks count computation.
406 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
408 ## [2.6.3] - 2023-06-19
412 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
413 - Update strategies internals after statistics computation.
417 - Optimize O(1) queue implementation.
419 ## [2.6.2] - 2023-06-12
423 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
425 ## [2.6.1] - 2023-06-10
429 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
433 - Fix average statistics computation: ensure failed tasks are not accounted.
435 ## [2.6.0] - 2023-06-09
439 - Add `LEAST_ELU` worker choice strategy (experimental).
440 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
444 - Refactor pool worker node usage internals.
445 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
446 - Breaking change: pool information `info` property object fields have been renamed.
450 - Fix wait time accounting.
451 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
452 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
454 ## [2.5.4] - 2023-06-07
458 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
462 - Compute statistics at the worker level only if needed.
463 - Add `worker_threads` options to thread pool options.
467 - Make the `LEAST_BUSY` strategy only relies on task runtime.
469 ## [2.5.3] - 2023-06-04
473 - Refine pool information content.
474 - Limit pool internals public exposure.
476 ## [2.5.2] - 2023-06-02
480 - Add `taskError` pool event for task execution error.
481 - Add pool information `info` property to pool.
482 - Emit pool information on `busy` and `full` pool events.
484 ## [2.5.1] - 2023-06-01
488 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
489 - Add `error` pool event for uncaught worker error.
491 ## [2.5.0] - 2023-05-31
495 - Switch pool event emitter to `EventEmitterAsyncResource`.
496 - Add tasks wait time accounting in per worker tasks usage.
497 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
501 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
503 ## [2.4.14] - 2023-05-09
507 - Ensure no undefined task runtime can land in the tasks history.
508 - Fix median computation implementation once again.
512 - Unit tests for median and queue implementations.
514 ## [2.4.13] - 2023-05-08
518 - Fix worker choice strategy options validation.
519 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
521 ## [2.4.12] - 2023-05-06
525 - Support multiple task functions per worker.
526 - Add custom worker weights support to worker choice strategies options.
530 - Use O(1) queue implementation for tasks queueing.
534 - Fix median computation implementation.
535 - Fix fair share worker choice strategy internals update.
537 ## [2.4.11] - 2023-04-23
541 - Optimize free worker finding in worker choice strategies.
543 ## [2.4.10] - 2023-04-15
547 - Fix typescript type definition for task function: ensure the input data is optional.
548 - Fix typescript type definition for pool execute(): ensure the input data is optional.
550 ## [2.4.9] - 2023-04-15
554 - Add tasks queue enablement runtime setter to pool.
555 - Add tasks queue options runtime setter to pool.
556 - Add worker choice strategy options runtime setter to pool.
560 - Remove the tasks queuing experimental status.
564 - Fix task function type definition and validation.
565 - Fix worker choice strategy options handling.
567 ## [2.4.8] - 2023-04-12
571 - Fix message between main worker and worker type definition for tasks.
572 - Fix code documentation.
574 ## [2.4.7] - 2023-04-11
578 - Add worker tasks queue options to pool options.
582 - Fix missing documentation.
584 ## [2.4.6] - 2023-04-10
588 - Ensure one task at a time is executed per worker with tasks queueing enabled.
589 - Properly count worker executing tasks with tasks queueing enabled.
591 ## [2.4.5] - 2023-04-09
595 - Use monotonic high resolution timer for worker tasks runtime.
596 - Add worker tasks median runtime to statistics.
597 - Add worker tasks queue (experimental).
599 ## [2.4.4] - 2023-04-07
603 - Add `PoolEvents` enumeration and `PoolEvent` type.
607 - Destroy worker only on alive check.
609 ## [2.4.3] - 2023-04-07
613 - Fix typedoc generation with inheritance.
615 ## [2.4.2] - 2023-04-06
619 - Add `full` event to dynamic pool.
620 - Keep worker choice strategy in memory for conditional reuse.
624 - Fix possible negative worker key at worker removal in worker choice strategies.
626 ## [2.4.1] - 2023-04-05
630 - Optimize worker choice strategy for dynamic pool.
634 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
636 ## [2.4.0] - 2023-04-04
640 - Add `LESS_BUSY` worker choice strategy.
644 - Optimize worker storage in pool.
645 - Optimize worker alive status check.
646 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
647 - Optimize `LESS_USED` worker choice strategy.
648 - Update benchmarks versus external threads pools.
649 - Optimize tasks usage statistics requirements for worker choice strategy.
653 - Ensure trimmable characters are checked at pool initialization.
654 - Fix message id integer overflow.
655 - Fix pool worker removal in worker choice strategy internals.
656 - Fix package publication with pnpm.
658 ## [2.4.0-3] - 2023-04-04
662 - Add `LESS_BUSY` worker choice strategy.
666 - Optimize worker storage in pool.
667 - Optimize worker alive status check.
668 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
669 - Optimize `LESS_USED` worker choice strategy.
670 - Update benchmarks versus external threads pools.
674 - Ensure trimmable characters are checked at pool initialization.
675 - Fix message id integer overflow.
676 - Fix pool worker removal in worker choice strategy internals.
677 - Fix package publication with pnpm.
679 ## [2.4.0-2] - 2023-04-03
683 - Add `LESS_BUSY` worker choice strategy.
687 - Optimize worker storage in pool.
688 - Optimize worker alive status check.
689 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
690 - Optimize `LESS_USED` worker choice strategy.
694 - Ensure trimmable characters are checked at pool initialization.
695 - Fix message id integer overflow.
696 - Fix pool worker removal in worker choice strategy internals.
697 - Fix package publication with pnpm.
699 ## [2.4.0-1] - 2023-04-03
703 - Add `LESS_BUSY` worker choice strategy.
707 - Optimize worker storage in pool.
708 - Optimize worker alive status check.
709 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
710 - Optimize `LESS_USED` worker choice strategy.
714 - Ensure trimmable characters are checked at pool initialization.
715 - Fix message id integer overflow.
716 - Fix pool worker removal in worker choice strategy internals.
718 ## [2.4.0-0] - 2023-04-03
722 - Add `LESS_BUSY` worker choice strategy.
726 - Optimize worker storage in pool.
727 - Optimize worker alive status check.
728 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
729 - Optimize `LESS_USED` worker choice strategy.
733 - Ensure trimmable characters are checked at pool initialization.
734 - Fix message id integer overflow.
735 - Fix pool worker removal in worker choice strategy internals.
737 ## [2.3.10] - 2023-03-18
741 - Fix package.json `exports` syntax for ESM and CommonJS.
745 - Permit SemVer pre-release publication.
747 ## [2.3.10-2] - 2023-03-18
751 - Fix package.json `exports` syntax for ESM and CommonJS.
753 ## [2.3.10-1] - 2023-03-18
757 - Permit SemVer pre-release publication.
759 ## [2.3.10-0] - 2023-03-18
763 - Fix package.json `exports` syntax for ESM and CommonJS.
765 ## [2.3.9] - 2023-03-18
769 - Introduce ESM module support along with CommonJS one.
773 - Fix brown paper bag bug referencing the same object literal.
775 ## [2.3.8] - 2023-03-18
779 - Switch internal benchmarking code to benny.
780 - Switch to TypeScript 5.x.x.
781 - Switch rollup bundler plugins to core ones.
782 - Switch to TSDoc syntax.
783 - Enforce conventional commits.
787 - Fix random integer generator.
788 - Fix worker choice strategy pool type identification at initialization.
790 ## [2.3.7] - 2022-10-23
794 - Switch to open collective FOSS project funding platform.
795 - Switch to ts-standard linter configuration on TypeScript code.
799 - Fixed missing async on pool execute method.
800 - Fixed typing in TypeScript example.
801 - Fixed types in unit tests.
803 ## [2.3.6] - 2022-10-22
807 - Cleanup pool attributes and methods.
808 - Refine error types thrown.
812 - Fix continuous integration build on windows.
813 - Fix code coverage reporting by using c8 instead of nyc.
815 ## [2.3.5] - 2022-10-21
819 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
820 - Optimize tasks usage lookup implementation.
824 - Fix missed pool event emitter type export.
825 - Fix typedoc documentation generation.
827 ## [2.3.4] - 2022-10-17
831 - Fully automate release process with release-it.
835 - Optimize fair share task scheduling algorithm implementation.
836 - Update benchmarks versus external pools results with latest version.
838 ## [2.3.3] - 2022-10-15
842 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
844 ## [2.3.2] - 2022-10-14
848 - Optimize fair share worker selection strategy implementation.
852 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
854 ## [2.3.1] - 2022-10-13
858 - Pool worker choice strategies:
859 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
860 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
862 ## [2.2.2] - 2022-10-09
866 - Fixed `README.md` file.
868 ## [2.2.1] - 2022-10-08
872 - Dynamic worker choice strategy change at runtime.
874 ## [2.2.0] - 2022-01-05
878 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
880 ## [2.1.0] - 2021-08-29
884 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
888 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
889 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
890 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
891 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
893 ## [2.0.2] - 2021-05-12
897 - Fix `busy` event emission on fixed pool type
899 ## [2.0.1] - 2021-03-16
903 - Check if pool options are properly set.
904 - `busy` event is emitted on all pool types.
906 ## [2.0.0] - 2021-03-01
910 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
914 - `FullPool` event is now renamed to `busy`.
915 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
916 _Find more details on our JSDoc._
918 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
920 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
922 ### Pool options types declaration merge
924 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
926 #### New `export` strategy
930 const DynamicThreadPool = require('poolifier/lib/dynamic')
932 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
935 But you should always prefer just using
938 const { DynamicThreadPool } = require('poolifier')
941 #### New type definitions for input data and response
943 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
944 _This is not a limitation by poolifier but Node.js._
946 #### Public property replacements
948 `numWorkers` property is now `numberOfWorkers`
950 #### Internal (protected) properties and methods renaming
952 These properties are not intended for end users
954 - `id` => `nextMessageId`
956 These methods are not intended for end users
958 - `_chooseWorker` => `chooseWorker`
959 - `_newWorker` => `createWorker`
960 - `_execute` => `internalExecute`
961 - `_chooseWorker` => `chooseWorker`
962 - `_checkAlive` => `checkAlive`
964 - `_runAsync` => `runAsync`
966 ## [1.1.0] - 2020-05-21
970 - ThreadWorker support async functions as option
971 - Various external library patches
973 ## [1.0.0] - 2020-01-24
977 - FixedThreadPool implementation
978 - DynamicThreadPool implementation
979 - WorkerThread implementation to improve developer experience