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 - Add `queueMaxSize` option to tasks queue options.
14 ## [2.6.31] - 2023-08-20
18 - Fix worker choice strategy retries mechanism in some edge cases.
22 - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage.
23 - Remove the experimental status of the `LEAST_ELU` worker choice strategy.
25 ## [2.6.30] - 2023-08-19
29 - Ensure pool event `backPressure` is emitted.
30 - Ensure pool event `full` is emitted only once.
31 - Ensure worker node cannot be instantiated without proper arguments.
33 ## [2.6.29] - 2023-08-18
37 - Fix race condition between ready and task functions worker message handling at startup.
38 - Fix duplicate task function worker usage statistics computation per task function.
39 - Update task function worker usage statistics if and only if there's at least two different task functions.
40 - Fix race condition at task function worker usage executing task computation leading to negative value.
44 - 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).
45 - Use back pressure detection in worker choice strategies.
46 - Add worker choice strategies retries mechanism if no worker is eligible.
48 ## [2.6.28] - 2023-08-16
52 - Ensure pool workers are properly initialized.
56 - HTTP server pool examples: express-cluster, express-hybrid.
60 - Remove now useless branching in worker hot code path.
62 ## [2.6.27] - 2023-08-15
66 - Add `KillHandler` type definition to exported types.
70 - Add `destroy` event to pool API.
72 ## [2.6.26] - 2023-08-15
76 - Add kill handler to worker options allowing to execute custom code when worker is killed.
77 - Add `listTaskFunctions()` method to pool API.
78 - SMTP server pool example: nodemailer.
80 ## [2.6.25] - 2023-08-13
84 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
85 - WebSocket server pool examples: ws-cluster, ws-hybrid.
87 ## [2.6.24] - 2023-08-12
91 - Add array of transferable objects to the `execute()` method arguments.
92 - WebSocket server pool examples: ws-worker_threads.
94 ## [2.6.23] - 2023-08-11
98 - 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.
102 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
103 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
105 ## [2.6.22] - 2023-08-10
109 - Add missing `types` field to package.json `exports`.
113 - Structure markdown documentation (PR #811).
115 ## [2.6.21] - 2023-08-03
119 - Improve code documentation.
120 - Code refactoring and cleanup for better maintainability and readability.
122 ## [2.6.20] - 2023-07-21
126 - Fix queued tasks redistribution on error task execution starvation.
127 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
131 - Drastically reduce lookups by worker in the worker nodes.
133 ## [2.6.19] - 2023-07-20
137 - Dedicated internal communication channel for worker_threads pools.
139 ## [2.6.18] - 2023-07-19
143 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
145 ## [2.6.17] - 2023-07-16
149 - Add `listTaskFunctions()` method to worker API.
151 ## [2.6.16] - 2023-07-12
155 - Fix pool startup detection.
156 - Fix worker task functions handling.
158 ## [2.6.15] - 2023-07-11
162 - Take into account worker node readiness in worker choice strategies.
164 ## [2.6.14] - 2023-07-10
168 - Fix task function statistics tracking.
170 ## [2.6.13] - 2023-07-10
174 - Add per task function statistics tracking.
175 - Add public methods to manipulate the worker task functions at runtime.
177 ## [2.6.12] - 2023-07-09
181 - Workaround import issue with `node:os` module in node 16.x.x.
183 ## [2.6.11] - 2023-07-09
187 - Fix pool readiness semantic.
189 ## [2.6.10] - 2023-07-08
193 - Ensure workers are not recreated on error at pool startup.
197 - Add `ready` and `strategy` fields to pool information.
198 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
199 - Add dynamic pool sizing checks.
201 ## [2.6.9] - 2023-07-07
205 - Recreate the right worker type on uncaught exception.
209 - Add minimum and maximum to internal measurement statistics.
210 - Add `runTime` and `waitTime` to pool information.
211 - Check worker inactive time only on dynamic worker.
213 ## [2.6.8] - 2023-07-03
217 - Brown paper bag release to fix version handling in pool information.
219 ## [2.6.7] - 2023-07-03
223 - Ensure worker queued tasks at error are reassigned to other pool workers.
227 - Add pool `utilization` ratio to pool information.
228 - Add `version` to pool information.
229 - Add worker information to worker nodes.
231 ## [2.6.6] - 2023-07-01
235 - Add safe helper `availableParallelism()` to help sizing the pool.
239 - Ensure message handler is only registered in worker.
241 ## [2.6.5] - 2023-06-27
245 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
249 - Artificial version bump to 2.6.5 to workaround publication issue.
250 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
251 - Ensure pool event is emitted before task error promise rejection.
252 - Fix queued tasks count computation.
256 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
258 ## [2.6.4] - 2023-06-27
262 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
266 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
267 - Ensure pool event is emitted before task error promise rejection.
268 - Fix queued tasks count computation.
272 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
274 ## [2.6.3] - 2023-06-19
278 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
279 - Update strategies internals after statistics computation.
283 - Optimize O(1) queue implementation.
285 ## [2.6.2] - 2023-06-12
289 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
291 ## [2.6.1] - 2023-06-10
295 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
299 - Fix average statistics computation: ensure failed tasks are not accounted.
301 ## [2.6.0] - 2023-06-09
305 - Add `LEAST_ELU` worker choice strategy (experimental).
306 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
310 - Refactor pool worker node usage internals.
311 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
312 - Breaking change: pool information `info` property object fields have been renamed.
316 - Fix wait time accounting.
317 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
318 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
320 ## [2.5.4] - 2023-06-07
324 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
328 - Compute statistics at the worker level only if needed.
329 - Add `worker_threads` options to thread pool options.
333 - Make the `LEAST_BUSY` strategy only relies on task runtime.
335 ## [2.5.3] - 2023-06-04
339 - Refine pool information content.
340 - Limit pool internals public exposure.
342 ## [2.5.2] - 2023-06-02
346 - Add `taskError` pool event for task execution error.
347 - Add pool information `info` property to pool.
348 - Emit pool information on `busy` and `full` pool events.
350 ## [2.5.1] - 2023-06-01
354 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
355 - Add `error` pool event for uncaught worker error.
357 ## [2.5.0] - 2023-05-31
361 - Switch pool event emitter to `EventEmitterAsyncResource`.
362 - Add tasks wait time accounting in per worker tasks usage.
363 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
367 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
369 ## [2.4.14] - 2023-05-09
373 - Ensure no undefined task runtime can land in the tasks history.
374 - Fix median computation implementation once again.
378 - Unit tests for median and queue implementations.
380 ## [2.4.13] - 2023-05-08
384 - Fix worker choice strategy options validation.
385 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
387 ## [2.4.12] - 2023-05-06
391 - Support multiple task functions per worker.
392 - Add custom worker weights support to worker choice strategies options.
396 - Use O(1) queue implementation for tasks queueing.
400 - Fix median computation implementation.
401 - Fix fair share worker choice strategy internals update.
403 ## [2.4.11] - 2023-04-23
407 - Optimize free worker finding in worker choice strategies.
409 ## [2.4.10] - 2023-04-15
413 - Fix typescript type definition for task function: ensure the input data is optional.
414 - Fix typescript type definition for pool execute(): ensure the input data is optional.
416 ## [2.4.9] - 2023-04-15
420 - Add tasks queue enablement runtime setter to pool.
421 - Add tasks queue options runtime setter to pool.
422 - Add worker choice strategy options runtime setter to pool.
426 - Remove the tasks queuing experimental status.
430 - Fix task function type definition and validation.
431 - Fix worker choice strategy options handling.
433 ## [2.4.8] - 2023-04-12
437 - Fix message between main worker and worker type definition for tasks.
438 - Fix code documentation.
440 ## [2.4.7] - 2023-04-11
444 - Add worker tasks queue options to pool options.
448 - Fix missing documentation.
450 ## [2.4.6] - 2023-04-10
454 - Ensure one task at a time is executed per worker with tasks queueing enabled.
455 - Properly count worker executing tasks with tasks queueing enabled.
457 ## [2.4.5] - 2023-04-09
461 - Use monotonic high resolution timer for worker tasks runtime.
462 - Add worker tasks median runtime to statistics.
463 - Add worker tasks queue (experimental).
465 ## [2.4.4] - 2023-04-07
469 - Add `PoolEvents` enumeration and `PoolEvent` type.
473 - Destroy worker only on alive check.
475 ## [2.4.3] - 2023-04-07
479 - Fix typedoc generation with inheritance.
481 ## [2.4.2] - 2023-04-06
485 - Add `full` event to dynamic pool.
486 - Keep worker choice strategy in memory for conditional reuse.
490 - Fix possible negative worker key at worker removal in worker choice strategies.
492 ## [2.4.1] - 2023-04-05
496 - Optimize worker choice strategy for dynamic pool.
500 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
502 ## [2.4.0] - 2023-04-04
506 - Add `LESS_BUSY` worker choice strategy.
510 - Optimize worker storage in pool.
511 - Optimize worker alive status check.
512 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
513 - Optimize `LESS_USED` worker choice strategy.
514 - Update benchmarks versus external threads pools.
515 - Optimize tasks usage statistics requirements for worker choice strategy.
519 - Ensure trimmable characters are checked at pool initialization.
520 - Fix message id integer overflow.
521 - Fix pool worker removal in worker choice strategy internals.
522 - Fix package publication with pnpm.
524 ## [2.4.0-3] - 2023-04-04
528 - Add `LESS_BUSY` worker choice strategy.
532 - Optimize worker storage in pool.
533 - Optimize worker alive status check.
534 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
535 - Optimize `LESS_USED` worker choice strategy.
536 - Update benchmarks versus external threads pools.
540 - Ensure trimmable characters are checked at pool initialization.
541 - Fix message id integer overflow.
542 - Fix pool worker removal in worker choice strategy internals.
543 - Fix package publication with pnpm.
545 ## [2.4.0-2] - 2023-04-03
549 - Add `LESS_BUSY` worker choice strategy.
553 - Optimize worker storage in pool.
554 - Optimize worker alive status check.
555 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
556 - Optimize `LESS_USED` 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-1] - 2023-04-03
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.
580 - Ensure trimmable characters are checked at pool initialization.
581 - Fix message id integer overflow.
582 - Fix pool worker removal in worker choice strategy internals.
584 ## [2.4.0-0] - 2023-04-03
588 - Add `LESS_BUSY` worker choice strategy.
592 - Optimize worker storage in pool.
593 - Optimize worker alive status check.
594 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
595 - Optimize `LESS_USED` worker choice strategy.
599 - Ensure trimmable characters are checked at pool initialization.
600 - Fix message id integer overflow.
601 - Fix pool worker removal in worker choice strategy internals.
603 ## [2.3.10] - 2023-03-18
607 - Fix package.json `exports` syntax for ESM and CommonJS.
611 - Permit SemVer pre-release publication.
613 ## [2.3.10-2] - 2023-03-18
617 - Fix package.json `exports` syntax for ESM and CommonJS.
619 ## [2.3.10-1] - 2023-03-18
623 - Permit SemVer pre-release publication.
625 ## [2.3.10-0] - 2023-03-18
629 - Fix package.json `exports` syntax for ESM and CommonJS.
631 ## [2.3.9] - 2023-03-18
635 - Introduce ESM module support along with CommonJS one.
639 - Fix brown paper bag bug referencing the same object literal.
641 ## [2.3.8] - 2023-03-18
645 - Switch internal benchmarking code to benny.
646 - Switch to TypeScript 5.x.x.
647 - Switch rollup bundler plugins to core ones.
648 - Switch to TSDoc syntax.
649 - Enforce conventional commits.
653 - Fix random integer generator.
654 - Fix worker choice strategy pool type identification at initialization.
656 ## [2.3.7] - 2022-10-23
660 - Switch to open collective FOSS project funding platform.
661 - Switch to ts-standard linter configuration on TypeScript code.
665 - Fixed missing async on pool execute method.
666 - Fixed typing in TypeScript example.
667 - Fixed types in unit tests.
669 ## [2.3.6] - 2022-10-22
673 - Cleanup pool attributes and methods.
674 - Refine error types thrown.
678 - Fix continuous integration build on windows.
679 - Fix code coverage reporting by using c8 instead of nyc.
681 ## [2.3.5] - 2022-10-21
685 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
686 - Optimize tasks usage lookup implementation.
690 - Fix missed pool event emitter type export.
691 - Fix typedoc documentation generation.
693 ## [2.3.4] - 2022-10-17
697 - Fully automate release process with release-it.
701 - Optimize fair share task scheduling algorithm implementation.
702 - Update benchmarks versus external pools results with latest version.
704 ## [2.3.3] - 2022-10-15
708 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
710 ## [2.3.2] - 2022-10-14
714 - Optimize fair share worker selection strategy implementation.
718 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
720 ## [2.3.1] - 2022-10-13
724 - Pool worker choice strategies:
725 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
726 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
728 ## [2.2.2] - 2022-10-09
732 - Fixed `README.md` file.
734 ## [2.2.1] - 2022-10-08
738 - Dynamic worker choice strategy change at runtime.
740 ## [2.2.0] - 2022-01-05
744 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
746 ## [2.1.0] - 2021-08-29
750 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
754 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
755 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
756 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
757 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
759 ## [2.0.2] - 2021-05-12
763 - Fix `busy` event emission on fixed pool type
765 ## [2.0.1] - 2021-03-16
769 - Check if pool options are properly set.
770 - `busy` event is emitted on all pool types.
772 ## [2.0.0] - 2021-03-01
776 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
780 - `FullPool` event is now renamed to `busy`.
781 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
782 _Find more details on our JSDoc._
784 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
786 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
788 ### Pool options types declaration merge
790 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
792 #### New `export` strategy
796 const DynamicThreadPool = require('poolifier/lib/dynamic')
798 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
801 But you should always prefer just using
804 const { DynamicThreadPool } = require('poolifier')
807 #### New type definitions for input data and response
809 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
810 _This is not a limitation by poolifier but Node.js._
812 #### Public property replacements
814 `numWorkers` property is now `numberOfWorkers`
816 #### Internal (protected) properties and methods renaming
818 These properties are not intended for end users
820 - `id` => `nextMessageId`
822 These methods are not intended for end users
824 - `_chooseWorker` => `chooseWorker`
825 - `_newWorker` => `createWorker`
826 - `_execute` => `internalExecute`
827 - `_chooseWorker` => `chooseWorker`
828 - `_checkAlive` => `checkAlive`
830 - `_runAsync` => `runAsync`
832 ## [1.1.0] - 2020-05-21
836 - ThreadWorker support async functions as option
837 - Various external library patches
839 ## [1.0.0] - 2020-01-24
843 - FixedThreadPool implementation
844 - DynamicThreadPool implementation
845 - WorkerThread implementation to improve developer experience