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 ## [2.6.43] - 2023-09-08
14 - Publish on GitHub packages registry on release
18 - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128)
20 ## [2.6.42] - 2023-09-06
24 - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ...
26 ## [2.6.41] - 2023-09-03
30 - Optimize worker choice strategies implementation.
32 ## [2.6.40] - 2023-09-01
36 - Do not pre-choose in WRR worker choice strategy to avoid bias.
37 - Avoid array out of bound in worker choice strategies after worker node removal.
39 ## [2.6.39] - 2023-08-30
43 - Fix race condition in worker choice strategies at worker node info querying while not yet initialized .
45 ## [2.6.38] - 2023-08-30
49 - Bundle typescript types declaration into one file.
53 - Improve interleaved weighted round robin worker choice strategy implementation.
55 ## [2.6.37] - 2023-08-28
59 - Ensure unused worker usage statistics are deleted at runtime.
63 - Rename worker choice strategy options `choiceRetries` to `retries`.
64 - Avoid unnecessary branching in worker choice strategies.
66 ## [2.6.36] - 2023-08-27
70 - Fix pool `execute()` arguments check.
74 - Make continuous tasks stealing algorithm less aggressive.
75 - Fine tune tasks stealing algorithm under back pressure.
77 ## [2.6.35] - 2023-08-25
81 - Don't account worker usage statistics for tasks that have failed.
82 - Fix pool information runtime and wait time median computation.
86 - Update simple moving average implementation to use a circular buffer.
87 - Update simple moving median implementation to use a circular buffer.
88 - Account for stolen tasks in worker usage statistics and pool information.
92 - Continuous tasks stealing algorithm.
94 ## [2.6.34] - 2023-08-24
98 - Avoid cascading tasks stealing under back pressure.
102 - Add fastpath to queued tasks rescheduling.
104 ## [2.6.33] - 2023-08-24
108 - Fix queued tasks rescheduling.
112 - Rename tasks queue options `queueMaxSize` to `size`.
116 - Task stealing scheduling algorithm if tasks queueing is enabled.
118 ## [2.6.32] - 2023-08-23
122 - Ensure no task can be executed when the pool is destroyed.
126 - Add `queueMaxSize` option to tasks queue options.
127 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
128 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
130 ## [2.6.31] - 2023-08-20
134 - Fix worker choice strategy retries mechanism in some edge cases.
138 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
139 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
141 ## [2.6.30] - 2023-08-19
145 - Ensure pool event `backPressure` is emitted.
146 - Ensure pool event `full` is emitted only once.
147 - Ensure worker node cannot be instantiated without proper arguments.
149 ## [2.6.29] - 2023-08-18
153 - Fix race condition between ready and task functions worker message handling at startup.
154 - Fix duplicate task function worker usage statistics computation per task function.
155 - Update task function worker usage statistics if and only if there's at least two different task functions.
156 - Fix race condition at task function worker usage executing task computation leading to negative value.
160 - 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).
161 - Use back pressure detection in worker choice strategies.
162 - Add worker choice strategies retries mechanism if no worker is eligible.
164 ## [2.6.28] - 2023-08-16
168 - Ensure pool workers are properly initialized.
172 - HTTP server pool examples: express-cluster, express-hybrid.
176 - Remove now useless branching in worker hot code path.
178 ## [2.6.27] - 2023-08-15
182 - Add `KillHandler` type definition to exported types.
186 - Add `destroy` event to pool API.
188 ## [2.6.26] - 2023-08-15
192 - Add kill handler to worker options allowing to execute custom code when worker is killed.
193 - Add `listTaskFunctions()` method to pool API.
194 - SMTP server pool example: nodemailer.
196 ## [2.6.25] - 2023-08-13
200 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
201 - WebSocket server pool examples: ws-cluster, ws-hybrid.
203 ## [2.6.24] - 2023-08-12
207 - Add array of transferable objects to the `execute()` method arguments.
208 - WebSocket server pool examples: ws-worker_threads.
210 ## [2.6.23] - 2023-08-11
214 - 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.
218 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
219 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
221 ## [2.6.22] - 2023-08-10
225 - Add missing `types` field to package.json `exports`.
229 - Structure markdown documentation (PR #811).
231 ## [2.6.21] - 2023-08-03
235 - Improve code documentation.
236 - Code refactoring and cleanup for better maintainability and readability.
238 ## [2.6.20] - 2023-07-21
242 - Fix queued tasks redistribution on error task execution starvation.
243 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
247 - Drastically reduce lookups by worker in the worker nodes.
249 ## [2.6.19] - 2023-07-20
253 - Dedicated internal communication channel for worker_threads pools.
255 ## [2.6.18] - 2023-07-19
259 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
261 ## [2.6.17] - 2023-07-16
265 - Add `listTaskFunctions()` method to worker API.
267 ## [2.6.16] - 2023-07-12
271 - Fix pool startup detection.
272 - Fix worker task functions handling.
274 ## [2.6.15] - 2023-07-11
278 - Take into account worker node readiness in worker choice strategies.
280 ## [2.6.14] - 2023-07-10
284 - Fix task function statistics tracking.
286 ## [2.6.13] - 2023-07-10
290 - Add per task function statistics tracking.
291 - Add public methods to manipulate the worker task functions at runtime.
293 ## [2.6.12] - 2023-07-09
297 - Workaround import issue with `node:os` module in node 16.x.x.
299 ## [2.6.11] - 2023-07-09
303 - Fix pool readiness semantic.
305 ## [2.6.10] - 2023-07-08
309 - Ensure workers are not recreated on error at pool startup.
313 - Add `ready` and `strategy` fields to pool information.
314 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
315 - Add dynamic pool sizing checks.
317 ## [2.6.9] - 2023-07-07
321 - Recreate the right worker type on uncaught exception.
325 - Add minimum and maximum to internal measurement statistics.
326 - Add `runTime` and `waitTime` to pool information.
327 - Check worker inactive time only on dynamic worker.
329 ## [2.6.8] - 2023-07-03
333 - Brown paper bag release to fix version handling in pool information.
335 ## [2.6.7] - 2023-07-03
339 - Ensure worker queued tasks at error are reassigned to other pool workers.
343 - Add pool `utilization` ratio to pool information.
344 - Add `version` to pool information.
345 - Add worker information to worker nodes.
347 ## [2.6.6] - 2023-07-01
351 - Add safe helper `availableParallelism()` to help sizing the pool.
355 - Ensure message handler is only registered in worker.
357 ## [2.6.5] - 2023-06-27
361 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
365 - Artificial version bump to 2.6.5 to workaround publication issue.
366 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
367 - Ensure pool event is emitted before task error promise rejection.
368 - Fix queued tasks count computation.
372 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
374 ## [2.6.4] - 2023-06-27
378 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
382 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
383 - Ensure pool event is emitted before task error promise rejection.
384 - Fix queued tasks count computation.
388 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
390 ## [2.6.3] - 2023-06-19
394 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
395 - Update strategies internals after statistics computation.
399 - Optimize O(1) queue implementation.
401 ## [2.6.2] - 2023-06-12
405 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
407 ## [2.6.1] - 2023-06-10
411 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
415 - Fix average statistics computation: ensure failed tasks are not accounted.
417 ## [2.6.0] - 2023-06-09
421 - Add `LEAST_ELU` worker choice strategy (experimental).
422 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
426 - Refactor pool worker node usage internals.
427 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
428 - Breaking change: pool information `info` property object fields have been renamed.
432 - Fix wait time accounting.
433 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
434 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
436 ## [2.5.4] - 2023-06-07
440 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
444 - Compute statistics at the worker level only if needed.
445 - Add `worker_threads` options to thread pool options.
449 - Make the `LEAST_BUSY` strategy only relies on task runtime.
451 ## [2.5.3] - 2023-06-04
455 - Refine pool information content.
456 - Limit pool internals public exposure.
458 ## [2.5.2] - 2023-06-02
462 - Add `taskError` pool event for task execution error.
463 - Add pool information `info` property to pool.
464 - Emit pool information on `busy` and `full` pool events.
466 ## [2.5.1] - 2023-06-01
470 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
471 - Add `error` pool event for uncaught worker error.
473 ## [2.5.0] - 2023-05-31
477 - Switch pool event emitter to `EventEmitterAsyncResource`.
478 - Add tasks wait time accounting in per worker tasks usage.
479 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
483 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
485 ## [2.4.14] - 2023-05-09
489 - Ensure no undefined task runtime can land in the tasks history.
490 - Fix median computation implementation once again.
494 - Unit tests for median and queue implementations.
496 ## [2.4.13] - 2023-05-08
500 - Fix worker choice strategy options validation.
501 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
503 ## [2.4.12] - 2023-05-06
507 - Support multiple task functions per worker.
508 - Add custom worker weights support to worker choice strategies options.
512 - Use O(1) queue implementation for tasks queueing.
516 - Fix median computation implementation.
517 - Fix fair share worker choice strategy internals update.
519 ## [2.4.11] - 2023-04-23
523 - Optimize free worker finding in worker choice strategies.
525 ## [2.4.10] - 2023-04-15
529 - Fix typescript type definition for task function: ensure the input data is optional.
530 - Fix typescript type definition for pool execute(): ensure the input data is optional.
532 ## [2.4.9] - 2023-04-15
536 - Add tasks queue enablement runtime setter to pool.
537 - Add tasks queue options runtime setter to pool.
538 - Add worker choice strategy options runtime setter to pool.
542 - Remove the tasks queuing experimental status.
546 - Fix task function type definition and validation.
547 - Fix worker choice strategy options handling.
549 ## [2.4.8] - 2023-04-12
553 - Fix message between main worker and worker type definition for tasks.
554 - Fix code documentation.
556 ## [2.4.7] - 2023-04-11
560 - Add worker tasks queue options to pool options.
564 - Fix missing documentation.
566 ## [2.4.6] - 2023-04-10
570 - Ensure one task at a time is executed per worker with tasks queueing enabled.
571 - Properly count worker executing tasks with tasks queueing enabled.
573 ## [2.4.5] - 2023-04-09
577 - Use monotonic high resolution timer for worker tasks runtime.
578 - Add worker tasks median runtime to statistics.
579 - Add worker tasks queue (experimental).
581 ## [2.4.4] - 2023-04-07
585 - Add `PoolEvents` enumeration and `PoolEvent` type.
589 - Destroy worker only on alive check.
591 ## [2.4.3] - 2023-04-07
595 - Fix typedoc generation with inheritance.
597 ## [2.4.2] - 2023-04-06
601 - Add `full` event to dynamic pool.
602 - Keep worker choice strategy in memory for conditional reuse.
606 - Fix possible negative worker key at worker removal in worker choice strategies.
608 ## [2.4.1] - 2023-04-05
612 - Optimize worker choice strategy for dynamic pool.
616 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
618 ## [2.4.0] - 2023-04-04
622 - Add `LESS_BUSY` worker choice strategy.
626 - Optimize worker storage in pool.
627 - Optimize worker alive status check.
628 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
629 - Optimize `LESS_USED` worker choice strategy.
630 - Update benchmarks versus external threads pools.
631 - Optimize tasks usage statistics requirements for worker choice strategy.
635 - Ensure trimmable characters are checked at pool initialization.
636 - Fix message id integer overflow.
637 - Fix pool worker removal in worker choice strategy internals.
638 - Fix package publication with pnpm.
640 ## [2.4.0-3] - 2023-04-04
644 - Add `LESS_BUSY` worker choice strategy.
648 - Optimize worker storage in pool.
649 - Optimize worker alive status check.
650 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
651 - Optimize `LESS_USED` worker choice strategy.
652 - Update benchmarks versus external threads pools.
656 - Ensure trimmable characters are checked at pool initialization.
657 - Fix message id integer overflow.
658 - Fix pool worker removal in worker choice strategy internals.
659 - Fix package publication with pnpm.
661 ## [2.4.0-2] - 2023-04-03
665 - Add `LESS_BUSY` worker choice strategy.
669 - Optimize worker storage in pool.
670 - Optimize worker alive status check.
671 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
672 - Optimize `LESS_USED` worker choice strategy.
676 - Ensure trimmable characters are checked at pool initialization.
677 - Fix message id integer overflow.
678 - Fix pool worker removal in worker choice strategy internals.
679 - Fix package publication with pnpm.
681 ## [2.4.0-1] - 2023-04-03
685 - Add `LESS_BUSY` worker choice strategy.
689 - Optimize worker storage in pool.
690 - Optimize worker alive status check.
691 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
692 - Optimize `LESS_USED` worker choice strategy.
696 - Ensure trimmable characters are checked at pool initialization.
697 - Fix message id integer overflow.
698 - Fix pool worker removal in worker choice strategy internals.
700 ## [2.4.0-0] - 2023-04-03
704 - Add `LESS_BUSY` worker choice strategy.
708 - Optimize worker storage in pool.
709 - Optimize worker alive status check.
710 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
711 - Optimize `LESS_USED` worker choice strategy.
715 - Ensure trimmable characters are checked at pool initialization.
716 - Fix message id integer overflow.
717 - Fix pool worker removal in worker choice strategy internals.
719 ## [2.3.10] - 2023-03-18
723 - Fix package.json `exports` syntax for ESM and CommonJS.
727 - Permit SemVer pre-release publication.
729 ## [2.3.10-2] - 2023-03-18
733 - Fix package.json `exports` syntax for ESM and CommonJS.
735 ## [2.3.10-1] - 2023-03-18
739 - Permit SemVer pre-release publication.
741 ## [2.3.10-0] - 2023-03-18
745 - Fix package.json `exports` syntax for ESM and CommonJS.
747 ## [2.3.9] - 2023-03-18
751 - Introduce ESM module support along with CommonJS one.
755 - Fix brown paper bag bug referencing the same object literal.
757 ## [2.3.8] - 2023-03-18
761 - Switch internal benchmarking code to benny.
762 - Switch to TypeScript 5.x.x.
763 - Switch rollup bundler plugins to core ones.
764 - Switch to TSDoc syntax.
765 - Enforce conventional commits.
769 - Fix random integer generator.
770 - Fix worker choice strategy pool type identification at initialization.
772 ## [2.3.7] - 2022-10-23
776 - Switch to open collective FOSS project funding platform.
777 - Switch to ts-standard linter configuration on TypeScript code.
781 - Fixed missing async on pool execute method.
782 - Fixed typing in TypeScript example.
783 - Fixed types in unit tests.
785 ## [2.3.6] - 2022-10-22
789 - Cleanup pool attributes and methods.
790 - Refine error types thrown.
794 - Fix continuous integration build on windows.
795 - Fix code coverage reporting by using c8 instead of nyc.
797 ## [2.3.5] - 2022-10-21
801 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
802 - Optimize tasks usage lookup implementation.
806 - Fix missed pool event emitter type export.
807 - Fix typedoc documentation generation.
809 ## [2.3.4] - 2022-10-17
813 - Fully automate release process with release-it.
817 - Optimize fair share task scheduling algorithm implementation.
818 - Update benchmarks versus external pools results with latest version.
820 ## [2.3.3] - 2022-10-15
824 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
826 ## [2.3.2] - 2022-10-14
830 - Optimize fair share worker selection strategy implementation.
834 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
836 ## [2.3.1] - 2022-10-13
840 - Pool worker choice strategies:
841 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
842 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
844 ## [2.2.2] - 2022-10-09
848 - Fixed `README.md` file.
850 ## [2.2.1] - 2022-10-08
854 - Dynamic worker choice strategy change at runtime.
856 ## [2.2.0] - 2022-01-05
860 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
862 ## [2.1.0] - 2021-08-29
866 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
870 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
871 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
872 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
873 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
875 ## [2.0.2] - 2021-05-12
879 - Fix `busy` event emission on fixed pool type
881 ## [2.0.1] - 2021-03-16
885 - Check if pool options are properly set.
886 - `busy` event is emitted on all pool types.
888 ## [2.0.0] - 2021-03-01
892 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
896 - `FullPool` event is now renamed to `busy`.
897 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
898 _Find more details on our JSDoc._
900 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
902 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
904 ### Pool options types declaration merge
906 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
908 #### New `export` strategy
912 const DynamicThreadPool = require('poolifier/lib/dynamic')
914 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
917 But you should always prefer just using
920 const { DynamicThreadPool } = require('poolifier')
923 #### New type definitions for input data and response
925 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
926 _This is not a limitation by poolifier but Node.js._
928 #### Public property replacements
930 `numWorkers` property is now `numberOfWorkers`
932 #### Internal (protected) properties and methods renaming
934 These properties are not intended for end users
936 - `id` => `nextMessageId`
938 These methods are not intended for end users
940 - `_chooseWorker` => `chooseWorker`
941 - `_newWorker` => `createWorker`
942 - `_execute` => `internalExecute`
943 - `_chooseWorker` => `chooseWorker`
944 - `_checkAlive` => `checkAlive`
946 - `_runAsync` => `runAsync`
948 ## [1.1.0] - 2020-05-21
952 - ThreadWorker support async functions as option
953 - Various external library patches
955 ## [1.0.0] - 2020-01-24
959 - FixedThreadPool implementation
960 - DynamicThreadPool implementation
961 - WorkerThread implementation to improve developer experience