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 - Don't account worker usage statistics for tasks that have failed.
16 - Update simple moving average implementation to use a circular buffer.
17 - Update simple moving median implementation to use a circular buffer.
19 ## [2.6.34] - 2023-08-24
23 - Avoid cascading tasks stealing under back pressure.
27 - Add fastpath to queued tasks rescheduling.
29 ## [2.6.33] - 2023-08-24
33 - Fix queued tasks rescheduling.
37 - Rename tasks queue options `queueMaxSize` to `size`.
41 - Task stealing scheduling algorithm if tasks queueing is enabled.
43 ## [2.6.32] - 2023-08-23
47 - Ensure no task can be executed when the pool is destroyed.
51 - Add `queueMaxSize` option to tasks queue options.
52 - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing.
53 - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled.
55 ## [2.6.31] - 2023-08-20
59 - Fix worker choice strategy retries mechanism in some edge cases.
63 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
64 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
66 ## [2.6.30] - 2023-08-19
70 - Ensure pool event `backPressure` is emitted.
71 - Ensure pool event `full` is emitted only once.
72 - Ensure worker node cannot be instantiated without proper arguments.
74 ## [2.6.29] - 2023-08-18
78 - Fix race condition between ready and task functions worker message handling at startup.
79 - Fix duplicate task function worker usage statistics computation per task function.
80 - Update task function worker usage statistics if and only if there's at least two different task functions.
81 - Fix race condition at task function worker usage executing task computation leading to negative value.
85 - 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).
86 - Use back pressure detection in worker choice strategies.
87 - Add worker choice strategies retries mechanism if no worker is eligible.
89 ## [2.6.28] - 2023-08-16
93 - Ensure pool workers are properly initialized.
97 - HTTP server pool examples: express-cluster, express-hybrid.
101 - Remove now useless branching in worker hot code path.
103 ## [2.6.27] - 2023-08-15
107 - Add `KillHandler` type definition to exported types.
111 - Add `destroy` event to pool API.
113 ## [2.6.26] - 2023-08-15
117 - Add kill handler to worker options allowing to execute custom code when worker is killed.
118 - Add `listTaskFunctions()` method to pool API.
119 - SMTP server pool example: nodemailer.
121 ## [2.6.25] - 2023-08-13
125 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
126 - WebSocket server pool examples: ws-cluster, ws-hybrid.
128 ## [2.6.24] - 2023-08-12
132 - Add array of transferable objects to the `execute()` method arguments.
133 - WebSocket server pool examples: ws-worker_threads.
135 ## [2.6.23] - 2023-08-11
139 - 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.
143 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
144 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
146 ## [2.6.22] - 2023-08-10
150 - Add missing `types` field to package.json `exports`.
154 - Structure markdown documentation (PR #811).
156 ## [2.6.21] - 2023-08-03
160 - Improve code documentation.
161 - Code refactoring and cleanup for better maintainability and readability.
163 ## [2.6.20] - 2023-07-21
167 - Fix queued tasks redistribution on error task execution starvation.
168 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
172 - Drastically reduce lookups by worker in the worker nodes.
174 ## [2.6.19] - 2023-07-20
178 - Dedicated internal communication channel for worker_threads pools.
180 ## [2.6.18] - 2023-07-19
184 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
186 ## [2.6.17] - 2023-07-16
190 - Add `listTaskFunctions()` method to worker API.
192 ## [2.6.16] - 2023-07-12
196 - Fix pool startup detection.
197 - Fix worker task functions handling.
199 ## [2.6.15] - 2023-07-11
203 - Take into account worker node readiness in worker choice strategies.
205 ## [2.6.14] - 2023-07-10
209 - Fix task function statistics tracking.
211 ## [2.6.13] - 2023-07-10
215 - Add per task function statistics tracking.
216 - Add public methods to manipulate the worker task functions at runtime.
218 ## [2.6.12] - 2023-07-09
222 - Workaround import issue with `node:os` module in node 16.x.x.
224 ## [2.6.11] - 2023-07-09
228 - Fix pool readiness semantic.
230 ## [2.6.10] - 2023-07-08
234 - Ensure workers are not recreated on error at pool startup.
238 - Add `ready` and `strategy` fields to pool information.
239 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
240 - Add dynamic pool sizing checks.
242 ## [2.6.9] - 2023-07-07
246 - Recreate the right worker type on uncaught exception.
250 - Add minimum and maximum to internal measurement statistics.
251 - Add `runTime` and `waitTime` to pool information.
252 - Check worker inactive time only on dynamic worker.
254 ## [2.6.8] - 2023-07-03
258 - Brown paper bag release to fix version handling in pool information.
260 ## [2.6.7] - 2023-07-03
264 - Ensure worker queued tasks at error are reassigned to other pool workers.
268 - Add pool `utilization` ratio to pool information.
269 - Add `version` to pool information.
270 - Add worker information to worker nodes.
272 ## [2.6.6] - 2023-07-01
276 - Add safe helper `availableParallelism()` to help sizing the pool.
280 - Ensure message handler is only registered in worker.
282 ## [2.6.5] - 2023-06-27
286 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
290 - Artificial version bump to 2.6.5 to workaround publication issue.
291 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
292 - Ensure pool event is emitted before task error promise rejection.
293 - Fix queued tasks count computation.
297 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
299 ## [2.6.4] - 2023-06-27
303 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
307 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
308 - Ensure pool event is emitted before task error promise rejection.
309 - Fix queued tasks count computation.
313 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
315 ## [2.6.3] - 2023-06-19
319 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
320 - Update strategies internals after statistics computation.
324 - Optimize O(1) queue implementation.
326 ## [2.6.2] - 2023-06-12
330 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
332 ## [2.6.1] - 2023-06-10
336 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
340 - Fix average statistics computation: ensure failed tasks are not accounted.
342 ## [2.6.0] - 2023-06-09
346 - Add `LEAST_ELU` worker choice strategy (experimental).
347 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
351 - Refactor pool worker node usage internals.
352 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
353 - Breaking change: pool information `info` property object fields have been renamed.
357 - Fix wait time accounting.
358 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
359 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
361 ## [2.5.4] - 2023-06-07
365 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
369 - Compute statistics at the worker level only if needed.
370 - Add `worker_threads` options to thread pool options.
374 - Make the `LEAST_BUSY` strategy only relies on task runtime.
376 ## [2.5.3] - 2023-06-04
380 - Refine pool information content.
381 - Limit pool internals public exposure.
383 ## [2.5.2] - 2023-06-02
387 - Add `taskError` pool event for task execution error.
388 - Add pool information `info` property to pool.
389 - Emit pool information on `busy` and `full` pool events.
391 ## [2.5.1] - 2023-06-01
395 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
396 - Add `error` pool event for uncaught worker error.
398 ## [2.5.0] - 2023-05-31
402 - Switch pool event emitter to `EventEmitterAsyncResource`.
403 - Add tasks wait time accounting in per worker tasks usage.
404 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
408 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
410 ## [2.4.14] - 2023-05-09
414 - Ensure no undefined task runtime can land in the tasks history.
415 - Fix median computation implementation once again.
419 - Unit tests for median and queue implementations.
421 ## [2.4.13] - 2023-05-08
425 - Fix worker choice strategy options validation.
426 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
428 ## [2.4.12] - 2023-05-06
432 - Support multiple task functions per worker.
433 - Add custom worker weights support to worker choice strategies options.
437 - Use O(1) queue implementation for tasks queueing.
441 - Fix median computation implementation.
442 - Fix fair share worker choice strategy internals update.
444 ## [2.4.11] - 2023-04-23
448 - Optimize free worker finding in worker choice strategies.
450 ## [2.4.10] - 2023-04-15
454 - Fix typescript type definition for task function: ensure the input data is optional.
455 - Fix typescript type definition for pool execute(): ensure the input data is optional.
457 ## [2.4.9] - 2023-04-15
461 - Add tasks queue enablement runtime setter to pool.
462 - Add tasks queue options runtime setter to pool.
463 - Add worker choice strategy options runtime setter to pool.
467 - Remove the tasks queuing experimental status.
471 - Fix task function type definition and validation.
472 - Fix worker choice strategy options handling.
474 ## [2.4.8] - 2023-04-12
478 - Fix message between main worker and worker type definition for tasks.
479 - Fix code documentation.
481 ## [2.4.7] - 2023-04-11
485 - Add worker tasks queue options to pool options.
489 - Fix missing documentation.
491 ## [2.4.6] - 2023-04-10
495 - Ensure one task at a time is executed per worker with tasks queueing enabled.
496 - Properly count worker executing tasks with tasks queueing enabled.
498 ## [2.4.5] - 2023-04-09
502 - Use monotonic high resolution timer for worker tasks runtime.
503 - Add worker tasks median runtime to statistics.
504 - Add worker tasks queue (experimental).
506 ## [2.4.4] - 2023-04-07
510 - Add `PoolEvents` enumeration and `PoolEvent` type.
514 - Destroy worker only on alive check.
516 ## [2.4.3] - 2023-04-07
520 - Fix typedoc generation with inheritance.
522 ## [2.4.2] - 2023-04-06
526 - Add `full` event to dynamic pool.
527 - Keep worker choice strategy in memory for conditional reuse.
531 - Fix possible negative worker key at worker removal in worker choice strategies.
533 ## [2.4.1] - 2023-04-05
537 - Optimize worker choice strategy for dynamic pool.
541 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
543 ## [2.4.0] - 2023-04-04
547 - Add `LESS_BUSY` worker choice strategy.
551 - Optimize worker storage in pool.
552 - Optimize worker alive status check.
553 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
554 - Optimize `LESS_USED` worker choice strategy.
555 - Update benchmarks versus external threads pools.
556 - Optimize tasks usage statistics requirements for worker choice strategy.
560 - Ensure trimmable characters are checked at pool initialization.
561 - Fix message id integer overflow.
562 - Fix pool worker removal in worker choice strategy internals.
563 - Fix package publication with pnpm.
565 ## [2.4.0-3] - 2023-04-04
569 - Add `LESS_BUSY` worker choice strategy.
573 - Optimize worker storage in pool.
574 - Optimize worker alive status check.
575 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
576 - Optimize `LESS_USED` worker choice strategy.
577 - Update benchmarks versus external threads pools.
581 - Ensure trimmable characters are checked at pool initialization.
582 - Fix message id integer overflow.
583 - Fix pool worker removal in worker choice strategy internals.
584 - Fix package publication with pnpm.
586 ## [2.4.0-2] - 2023-04-03
590 - Add `LESS_BUSY` worker choice strategy.
594 - Optimize worker storage in pool.
595 - Optimize worker alive status check.
596 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
597 - Optimize `LESS_USED` worker choice strategy.
601 - Ensure trimmable characters are checked at pool initialization.
602 - Fix message id integer overflow.
603 - Fix pool worker removal in worker choice strategy internals.
604 - Fix package publication with pnpm.
606 ## [2.4.0-1] - 2023-04-03
610 - Add `LESS_BUSY` worker choice strategy.
614 - Optimize worker storage in pool.
615 - Optimize worker alive status check.
616 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
617 - Optimize `LESS_USED` worker choice strategy.
621 - Ensure trimmable characters are checked at pool initialization.
622 - Fix message id integer overflow.
623 - Fix pool worker removal in worker choice strategy internals.
625 ## [2.4.0-0] - 2023-04-03
629 - Add `LESS_BUSY` worker choice strategy.
633 - Optimize worker storage in pool.
634 - Optimize worker alive status check.
635 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
636 - Optimize `LESS_USED` worker choice strategy.
640 - Ensure trimmable characters are checked at pool initialization.
641 - Fix message id integer overflow.
642 - Fix pool worker removal in worker choice strategy internals.
644 ## [2.3.10] - 2023-03-18
648 - Fix package.json `exports` syntax for ESM and CommonJS.
652 - Permit SemVer pre-release publication.
654 ## [2.3.10-2] - 2023-03-18
658 - Fix package.json `exports` syntax for ESM and CommonJS.
660 ## [2.3.10-1] - 2023-03-18
664 - Permit SemVer pre-release publication.
666 ## [2.3.10-0] - 2023-03-18
670 - Fix package.json `exports` syntax for ESM and CommonJS.
672 ## [2.3.9] - 2023-03-18
676 - Introduce ESM module support along with CommonJS one.
680 - Fix brown paper bag bug referencing the same object literal.
682 ## [2.3.8] - 2023-03-18
686 - Switch internal benchmarking code to benny.
687 - Switch to TypeScript 5.x.x.
688 - Switch rollup bundler plugins to core ones.
689 - Switch to TSDoc syntax.
690 - Enforce conventional commits.
694 - Fix random integer generator.
695 - Fix worker choice strategy pool type identification at initialization.
697 ## [2.3.7] - 2022-10-23
701 - Switch to open collective FOSS project funding platform.
702 - Switch to ts-standard linter configuration on TypeScript code.
706 - Fixed missing async on pool execute method.
707 - Fixed typing in TypeScript example.
708 - Fixed types in unit tests.
710 ## [2.3.6] - 2022-10-22
714 - Cleanup pool attributes and methods.
715 - Refine error types thrown.
719 - Fix continuous integration build on windows.
720 - Fix code coverage reporting by using c8 instead of nyc.
722 ## [2.3.5] - 2022-10-21
726 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
727 - Optimize tasks usage lookup implementation.
731 - Fix missed pool event emitter type export.
732 - Fix typedoc documentation generation.
734 ## [2.3.4] - 2022-10-17
738 - Fully automate release process with release-it.
742 - Optimize fair share task scheduling algorithm implementation.
743 - Update benchmarks versus external pools results with latest version.
745 ## [2.3.3] - 2022-10-15
749 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
751 ## [2.3.2] - 2022-10-14
755 - Optimize fair share worker selection strategy implementation.
759 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
761 ## [2.3.1] - 2022-10-13
765 - Pool worker choice strategies:
766 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
767 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
769 ## [2.2.2] - 2022-10-09
773 - Fixed `README.md` file.
775 ## [2.2.1] - 2022-10-08
779 - Dynamic worker choice strategy change at runtime.
781 ## [2.2.0] - 2022-01-05
785 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
787 ## [2.1.0] - 2021-08-29
791 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
795 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
796 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
797 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
798 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
800 ## [2.0.2] - 2021-05-12
804 - Fix `busy` event emission on fixed pool type
806 ## [2.0.1] - 2021-03-16
810 - Check if pool options are properly set.
811 - `busy` event is emitted on all pool types.
813 ## [2.0.0] - 2021-03-01
817 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
821 - `FullPool` event is now renamed to `busy`.
822 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
823 _Find more details on our JSDoc._
825 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
827 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
829 ### Pool options types declaration merge
831 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
833 #### New `export` strategy
837 const DynamicThreadPool = require('poolifier/lib/dynamic')
839 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
842 But you should always prefer just using
845 const { DynamicThreadPool } = require('poolifier')
848 #### New type definitions for input data and response
850 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
851 _This is not a limitation by poolifier but Node.js._
853 #### Public property replacements
855 `numWorkers` property is now `numberOfWorkers`
857 #### Internal (protected) properties and methods renaming
859 These properties are not intended for end users
861 - `id` => `nextMessageId`
863 These methods are not intended for end users
865 - `_chooseWorker` => `chooseWorker`
866 - `_newWorker` => `createWorker`
867 - `_execute` => `internalExecute`
868 - `_chooseWorker` => `chooseWorker`
869 - `_checkAlive` => `checkAlive`
871 - `_runAsync` => `runAsync`
873 ## [1.1.0] - 2020-05-21
877 - ThreadWorker support async functions as option
878 - Various external library patches
880 ## [1.0.0] - 2020-01-24
884 - FixedThreadPool implementation
885 - DynamicThreadPool implementation
886 - WorkerThread implementation to improve developer experience