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 - Publish on GitHub packages registry on release
16 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128)
18 ## [2.6.42] - 2023-09-06
22 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
24 ## [2.6.41] - 2023-09-03
28 - Optimize worker choice strategies implementation.
30 ## [2.6.40] - 2023-09-01
34 - Do not pre-choose in WRR worker choice strategy to avoid bias.
35 - Avoid array out of bound in worker choice strategies after worker node removal.
37 ## [2.6.39] - 2023-08-30
41 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized .
43 ## [2.6.38] - 2023-08-30
47 - Bundle typescript types declaration into one file.
51 - Improve interleaved weighted round robin worker choice strategy implementation.
53 ## [2.6.37] - 2023-08-28
57 - Ensure unused worker usage statistics are deleted at runtime.
61 - Rename worker choice strategy options `choiceRetries` to `retries`.
62 - Avoid unnecessary branching in worker choice strategies.
64 ## [2.6.36] - 2023-08-27
68 - Fix pool `execute()` arguments check.
72 - Make continuous tasks stealing algorithm less aggressive.
73 - Fine tune tasks stealing algorithm under back pressure.
75 ## [2.6.35] - 2023-08-25
79 - Don't account worker usage statistics for tasks that have failed.
80 - Fix pool information runtime and wait time median computation.
84 - Update simple moving average implementation to use a circular buffer.
85 - Update simple moving median implementation to use a circular buffer.
86 - Account for stolen tasks in worker usage statistics and pool information.
90 - Continuous tasks stealing algorithm.
92 ## [2.6.34] - 2023-08-24
96 - Avoid cascading tasks stealing under back pressure.
100 - Add fastpath to queued tasks rescheduling.
102 ## [2.6.33] - 2023-08-24
106 - Fix queued tasks rescheduling.
110 - Rename tasks queue options `queueMaxSize` to `size`.
114 - Task stealing scheduling algorithm if tasks queueing is enabled.
116 ## [2.6.32] - 2023-08-23
120 - Ensure no task can be executed when the pool is destroyed.
124 - Add `queueMaxSize` option to tasks queue options.
125 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
126 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
128 ## [2.6.31] - 2023-08-20
132 - Fix worker choice strategy retries mechanism in some edge cases.
136 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
137 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
139 ## [2.6.30] - 2023-08-19
143 - Ensure pool event `backPressure` is emitted.
144 - Ensure pool event `full` is emitted only once.
145 - Ensure worker node cannot be instantiated without proper arguments.
147 ## [2.6.29] - 2023-08-18
151 - Fix race condition between ready and task functions worker message handling at startup.
152 - Fix duplicate task function worker usage statistics computation per task function.
153 - Update task function worker usage statistics if and only if there's at least two different task functions.
154 - Fix race condition at task function worker usage executing task computation leading to negative value.
158 - 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).
159 - Use back pressure detection in worker choice strategies.
160 - Add worker choice strategies retries mechanism if no worker is eligible.
162 ## [2.6.28] - 2023-08-16
166 - Ensure pool workers are properly initialized.
170 - HTTP server pool examples: express-cluster, express-hybrid.
174 - Remove now useless branching in worker hot code path.
176 ## [2.6.27] - 2023-08-15
180 - Add `KillHandler` type definition to exported types.
184 - Add `destroy` event to pool API.
186 ## [2.6.26] - 2023-08-15
190 - Add kill handler to worker options allowing to execute custom code when worker is killed.
191 - Add `listTaskFunctions()` method to pool API.
192 - SMTP server pool example: nodemailer.
194 ## [2.6.25] - 2023-08-13
198 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
199 - WebSocket server pool examples: ws-cluster, ws-hybrid.
201 ## [2.6.24] - 2023-08-12
205 - Add array of transferable objects to the `execute()` method arguments.
206 - WebSocket server pool examples: ws-worker_threads.
208 ## [2.6.23] - 2023-08-11
212 - 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.
216 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
217 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
219 ## [2.6.22] - 2023-08-10
223 - Add missing `types` field to package.json `exports`.
227 - Structure markdown documentation (PR #811).
229 ## [2.6.21] - 2023-08-03
233 - Improve code documentation.
234 - Code refactoring and cleanup for better maintainability and readability.
236 ## [2.6.20] - 2023-07-21
240 - Fix queued tasks redistribution on error task execution starvation.
241 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
245 - Drastically reduce lookups by worker in the worker nodes.
247 ## [2.6.19] - 2023-07-20
251 - Dedicated internal communication channel for worker_threads pools.
253 ## [2.6.18] - 2023-07-19
257 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
259 ## [2.6.17] - 2023-07-16
263 - Add `listTaskFunctions()` method to worker API.
265 ## [2.6.16] - 2023-07-12
269 - Fix pool startup detection.
270 - Fix worker task functions handling.
272 ## [2.6.15] - 2023-07-11
276 - Take into account worker node readiness in worker choice strategies.
278 ## [2.6.14] - 2023-07-10
282 - Fix task function statistics tracking.
284 ## [2.6.13] - 2023-07-10
288 - Add per task function statistics tracking.
289 - Add public methods to manipulate the worker task functions at runtime.
291 ## [2.6.12] - 2023-07-09
295 - Workaround import issue with `node:os` module in node 16.x.x.
297 ## [2.6.11] - 2023-07-09
301 - Fix pool readiness semantic.
303 ## [2.6.10] - 2023-07-08
307 - Ensure workers are not recreated on error at pool startup.
311 - Add `ready` and `strategy` fields to pool information.
312 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
313 - Add dynamic pool sizing checks.
315 ## [2.6.9] - 2023-07-07
319 - Recreate the right worker type on uncaught exception.
323 - Add minimum and maximum to internal measurement statistics.
324 - Add `runTime` and `waitTime` to pool information.
325 - Check worker inactive time only on dynamic worker.
327 ## [2.6.8] - 2023-07-03
331 - Brown paper bag release to fix version handling in pool information.
333 ## [2.6.7] - 2023-07-03
337 - Ensure worker queued tasks at error are reassigned to other pool workers.
341 - Add pool `utilization` ratio to pool information.
342 - Add `version` to pool information.
343 - Add worker information to worker nodes.
345 ## [2.6.6] - 2023-07-01
349 - Add safe helper `availableParallelism()` to help sizing the pool.
353 - Ensure message handler is only registered in worker.
355 ## [2.6.5] - 2023-06-27
359 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
363 - Artificial version bump to 2.6.5 to workaround publication issue.
364 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
365 - Ensure pool event is emitted before task error promise rejection.
366 - Fix queued tasks count computation.
370 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
372 ## [2.6.4] - 2023-06-27
376 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
380 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
381 - Ensure pool event is emitted before task error promise rejection.
382 - Fix queued tasks count computation.
386 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
388 ## [2.6.3] - 2023-06-19
392 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
393 - Update strategies internals after statistics computation.
397 - Optimize O(1) queue implementation.
399 ## [2.6.2] - 2023-06-12
403 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
405 ## [2.6.1] - 2023-06-10
409 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
413 - Fix average statistics computation: ensure failed tasks are not accounted.
415 ## [2.6.0] - 2023-06-09
419 - Add `LEAST_ELU` worker choice strategy (experimental).
420 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
424 - Refactor pool worker node usage internals.
425 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
426 - Breaking change: pool information `info` property object fields have been renamed.
430 - Fix wait time accounting.
431 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
432 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
434 ## [2.5.4] - 2023-06-07
438 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
442 - Compute statistics at the worker level only if needed.
443 - Add `worker_threads` options to thread pool options.
447 - Make the `LEAST_BUSY` strategy only relies on task runtime.
449 ## [2.5.3] - 2023-06-04
453 - Refine pool information content.
454 - Limit pool internals public exposure.
456 ## [2.5.2] - 2023-06-02
460 - Add `taskError` pool event for task execution error.
461 - Add pool information `info` property to pool.
462 - Emit pool information on `busy` and `full` pool events.
464 ## [2.5.1] - 2023-06-01
468 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
469 - Add `error` pool event for uncaught worker error.
471 ## [2.5.0] - 2023-05-31
475 - Switch pool event emitter to `EventEmitterAsyncResource`.
476 - Add tasks wait time accounting in per worker tasks usage.
477 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
481 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
483 ## [2.4.14] - 2023-05-09
487 - Ensure no undefined task runtime can land in the tasks history.
488 - Fix median computation implementation once again.
492 - Unit tests for median and queue implementations.
494 ## [2.4.13] - 2023-05-08
498 - Fix worker choice strategy options validation.
499 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
501 ## [2.4.12] - 2023-05-06
505 - Support multiple task functions per worker.
506 - Add custom worker weights support to worker choice strategies options.
510 - Use O(1) queue implementation for tasks queueing.
514 - Fix median computation implementation.
515 - Fix fair share worker choice strategy internals update.
517 ## [2.4.11] - 2023-04-23
521 - Optimize free worker finding in worker choice strategies.
523 ## [2.4.10] - 2023-04-15
527 - Fix typescript type definition for task function: ensure the input data is optional.
528 - Fix typescript type definition for pool execute(): ensure the input data is optional.
530 ## [2.4.9] - 2023-04-15
534 - Add tasks queue enablement runtime setter to pool.
535 - Add tasks queue options runtime setter to pool.
536 - Add worker choice strategy options runtime setter to pool.
540 - Remove the tasks queuing experimental status.
544 - Fix task function type definition and validation.
545 - Fix worker choice strategy options handling.
547 ## [2.4.8] - 2023-04-12
551 - Fix message between main worker and worker type definition for tasks.
552 - Fix code documentation.
554 ## [2.4.7] - 2023-04-11
558 - Add worker tasks queue options to pool options.
562 - Fix missing documentation.
564 ## [2.4.6] - 2023-04-10
568 - Ensure one task at a time is executed per worker with tasks queueing enabled.
569 - Properly count worker executing tasks with tasks queueing enabled.
571 ## [2.4.5] - 2023-04-09
575 - Use monotonic high resolution timer for worker tasks runtime.
576 - Add worker tasks median runtime to statistics.
577 - Add worker tasks queue (experimental).
579 ## [2.4.4] - 2023-04-07
583 - Add `PoolEvents` enumeration and `PoolEvent` type.
587 - Destroy worker only on alive check.
589 ## [2.4.3] - 2023-04-07
593 - Fix typedoc generation with inheritance.
595 ## [2.4.2] - 2023-04-06
599 - Add `full` event to dynamic pool.
600 - Keep worker choice strategy in memory for conditional reuse.
604 - Fix possible negative worker key at worker removal in worker choice strategies.
606 ## [2.4.1] - 2023-04-05
610 - Optimize worker choice strategy for dynamic pool.
614 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
616 ## [2.4.0] - 2023-04-04
620 - Add `LESS_BUSY` worker choice strategy.
624 - Optimize worker storage in pool.
625 - Optimize worker alive status check.
626 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
627 - Optimize `LESS_USED` worker choice strategy.
628 - Update benchmarks versus external threads pools.
629 - Optimize tasks usage statistics requirements for worker choice strategy.
633 - Ensure trimmable characters are checked at pool initialization.
634 - Fix message id integer overflow.
635 - Fix pool worker removal in worker choice strategy internals.
636 - Fix package publication with pnpm.
638 ## [2.4.0-3] - 2023-04-04
642 - Add `LESS_BUSY` worker choice strategy.
646 - Optimize worker storage in pool.
647 - Optimize worker alive status check.
648 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
649 - Optimize `LESS_USED` worker choice strategy.
650 - Update benchmarks versus external threads pools.
654 - Ensure trimmable characters are checked at pool initialization.
655 - Fix message id integer overflow.
656 - Fix pool worker removal in worker choice strategy internals.
657 - Fix package publication with pnpm.
659 ## [2.4.0-2] - 2023-04-03
663 - Add `LESS_BUSY` worker choice strategy.
667 - Optimize worker storage in pool.
668 - Optimize worker alive status check.
669 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
670 - Optimize `LESS_USED` worker choice strategy.
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-1] - 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.
698 ## [2.4.0-0] - 2023-04-03
702 - Add `LESS_BUSY` worker choice strategy.
706 - Optimize worker storage in pool.
707 - Optimize worker alive status check.
708 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
709 - Optimize `LESS_USED` worker choice strategy.
713 - Ensure trimmable characters are checked at pool initialization.
714 - Fix message id integer overflow.
715 - Fix pool worker removal in worker choice strategy internals.
717 ## [2.3.10] - 2023-03-18
721 - Fix package.json `exports` syntax for ESM and CommonJS.
725 - Permit SemVer pre-release publication.
727 ## [2.3.10-2] - 2023-03-18
731 - Fix package.json `exports` syntax for ESM and CommonJS.
733 ## [2.3.10-1] - 2023-03-18
737 - Permit SemVer pre-release publication.
739 ## [2.3.10-0] - 2023-03-18
743 - Fix package.json `exports` syntax for ESM and CommonJS.
745 ## [2.3.9] - 2023-03-18
749 - Introduce ESM module support along with CommonJS one.
753 - Fix brown paper bag bug referencing the same object literal.
755 ## [2.3.8] - 2023-03-18
759 - Switch internal benchmarking code to benny.
760 - Switch to TypeScript 5.x.x.
761 - Switch rollup bundler plugins to core ones.
762 - Switch to TSDoc syntax.
763 - Enforce conventional commits.
767 - Fix random integer generator.
768 - Fix worker choice strategy pool type identification at initialization.
770 ## [2.3.7] - 2022-10-23
774 - Switch to open collective FOSS project funding platform.
775 - Switch to ts-standard linter configuration on TypeScript code.
779 - Fixed missing async on pool execute method.
780 - Fixed typing in TypeScript example.
781 - Fixed types in unit tests.
783 ## [2.3.6] - 2022-10-22
787 - Cleanup pool attributes and methods.
788 - Refine error types thrown.
792 - Fix continuous integration build on windows.
793 - Fix code coverage reporting by using c8 instead of nyc.
795 ## [2.3.5] - 2022-10-21
799 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
800 - Optimize tasks usage lookup implementation.
804 - Fix missed pool event emitter type export.
805 - Fix typedoc documentation generation.
807 ## [2.3.4] - 2022-10-17
811 - Fully automate release process with release-it.
815 - Optimize fair share task scheduling algorithm implementation.
816 - Update benchmarks versus external pools results with latest version.
818 ## [2.3.3] - 2022-10-15
822 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
824 ## [2.3.2] - 2022-10-14
828 - Optimize fair share worker selection strategy implementation.
832 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
834 ## [2.3.1] - 2022-10-13
838 - Pool worker choice strategies:
839 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
840 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
842 ## [2.2.2] - 2022-10-09
846 - Fixed `README.md` file.
848 ## [2.2.1] - 2022-10-08
852 - Dynamic worker choice strategy change at runtime.
854 ## [2.2.0] - 2022-01-05
858 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
860 ## [2.1.0] - 2021-08-29
864 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
868 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
869 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
870 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
871 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
873 ## [2.0.2] - 2021-05-12
877 - Fix `busy` event emission on fixed pool type
879 ## [2.0.1] - 2021-03-16
883 - Check if pool options are properly set.
884 - `busy` event is emitted on all pool types.
886 ## [2.0.0] - 2021-03-01
890 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
894 - `FullPool` event is now renamed to `busy`.
895 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
896 _Find more details on our JSDoc._
898 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
900 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
902 ### Pool options types declaration merge
904 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
906 #### New `export` strategy
910 const DynamicThreadPool = require('poolifier/lib/dynamic')
912 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
915 But you should always prefer just using
918 const { DynamicThreadPool } = require('poolifier')
921 #### New type definitions for input data and response
923 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
924 _This is not a limitation by poolifier but Node.js._
926 #### Public property replacements
928 `numWorkers` property is now `numberOfWorkers`
930 #### Internal (protected) properties and methods renaming
932 These properties are not intended for end users
934 - `id` => `nextMessageId`
936 These methods are not intended for end users
938 - `_chooseWorker` => `chooseWorker`
939 - `_newWorker` => `createWorker`
940 - `_execute` => `internalExecute`
941 - `_chooseWorker` => `chooseWorker`
942 - `_checkAlive` => `checkAlive`
944 - `_runAsync` => `runAsync`
946 ## [1.1.0] - 2020-05-21
950 - ThreadWorker support async functions as option
951 - Various external library patches
953 ## [1.0.0] - 2020-01-24
957 - FixedThreadPool implementation
958 - DynamicThreadPool implementation
959 - WorkerThread implementation to improve developer experience