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.25] - 2023-08-13
14 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
15 - WebSocket server pool examples: ws-cluster, ws-hybrid.
17 ## [2.6.24] - 2023-08-12
21 - Add array of transferable objects to the `execute()` method arguments.
22 - WebSocket server pool examples: ws-worker_threads.
24 ## [2.6.23] - 2023-08-11
28 - 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.
32 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
33 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
35 ## [2.6.22] - 2023-08-10
39 - Add missing `types` field to package.json `exports`.
43 - Structure markdown documentation (PR #811).
45 ## [2.6.21] - 2023-08-03
49 - Improve code documentation.
50 - Code refactoring and cleanup for better maintainability and readability.
52 ## [2.6.20] - 2023-07-21
56 - Fix queued tasks redistribution on error task execution starvation.
57 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
61 - Drastically reduce lookups by worker in the worker nodes.
63 ## [2.6.19] - 2023-07-20
67 - Dedicated internal communication channel for worker_threads pools.
69 ## [2.6.18] - 2023-07-19
73 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
75 ## [2.6.17] - 2023-07-16
79 - Add `listTaskFunctions()` method to worker class.
81 ## [2.6.16] - 2023-07-12
85 - Fix pool startup detection.
86 - Fix worker task functions handling.
88 ## [2.6.15] - 2023-07-11
92 - Take into account worker node readiness in worker choice strategies.
94 ## [2.6.14] - 2023-07-10
98 - Fix task function statistics tracking.
100 ## [2.6.13] - 2023-07-10
104 - Add per task function statistics tracking.
105 - Add public methods to manipulate the worker task functions at runtime.
107 ## [2.6.12] - 2023-07-09
111 - Workaround import issue with `node:os` module in node 16.x.x.
113 ## [2.6.11] - 2023-07-09
117 - Fix pool readiness semantic.
119 ## [2.6.10] - 2023-07-08
123 - Ensure workers are not recreated on error at pool startup.
127 - Add `ready` and `strategy` fields to pool information.
128 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
129 - Add dynamic pool sizing checks.
131 ## [2.6.9] - 2023-07-07
135 - Recreate the right worker type on uncaught exception.
139 - Add minimum and maximum to internal measurement statistics.
140 - Add `runTime` and `waitTime` to pool information.
141 - Check worker inactive time only on dynamic worker.
143 ## [2.6.8] - 2023-07-03
147 - Brown paper bag release to fix version handling in pool information.
149 ## [2.6.7] - 2023-07-03
153 - Ensure worker queued tasks at error are reassigned to other pool workers.
157 - Add pool `utilization` ratio to pool information.
158 - Add `version` to pool information.
159 - Add worker information to worker nodes.
161 ## [2.6.6] - 2023-07-01
165 - Add safe helper `availableParallelism` to help sizing the pool.
169 - Ensure message handler is only registered in worker.
171 ## [2.6.5] - 2023-06-27
175 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
179 - Artificial version bump to 2.6.5 to workaround publication issue.
180 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
181 - Ensure pool event is emitted before task error promise rejection.
182 - Fix queued tasks count computation.
186 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
188 ## [2.6.4] - 2023-06-27
192 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
196 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
197 - Ensure pool event is emitted before task error promise rejection.
198 - Fix queued tasks count computation.
202 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
204 ## [2.6.3] - 2023-06-19
208 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
209 - Update strategies internals after statistics computation.
213 - Optimize O(1) queue implementation.
215 ## [2.6.2] - 2023-06-12
219 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
221 ## [2.6.1] - 2023-06-10
225 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
229 - Fix average statistics computation: ensure failed tasks are not accounted.
231 ## [2.6.0] - 2023-06-09
235 - Add `LEAST_ELU` worker choice strategy (experimental).
236 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
240 - Refactor pool worker node usage internals.
241 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
242 - Breaking change: pool information `info` property object fields have been renamed.
246 - Fix wait time accounting.
247 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
248 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
250 ## [2.5.4] - 2023-06-07
254 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
258 - Compute statistics at the worker level only if needed.
259 - Add `worker_threads` options to thread pool options.
263 - Make the `LEAST_BUSY` strategy only relies on task runtime.
265 ## [2.5.3] - 2023-06-04
269 - Refine pool information content.
270 - Limit pool internals public exposure.
272 ## [2.5.2] - 2023-06-02
276 - Add `taskError` pool event for task execution error.
277 - Add pool information `info` property to pool.
278 - Emit pool information on `busy` and `full` pool events.
280 ## [2.5.1] - 2023-06-01
284 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
285 - Add `error` pool event for uncaught worker error.
287 ## [2.5.0] - 2023-05-31
291 - Switch pool event emitter to `EventEmitterAsyncResource`.
292 - Add tasks wait time accounting in per worker tasks usage.
293 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
297 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
299 ## [2.4.14] - 2023-05-09
303 - Ensure no undefined task runtime can land in the tasks history.
304 - Fix median computation implementation once again.
308 - Unit tests for median and queue implementations.
310 ## [2.4.13] - 2023-05-08
314 - Fix worker choice strategy options validation.
315 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
317 ## [2.4.12] - 2023-05-06
321 - Support multiple task functions per worker.
322 - Add custom worker weights support to worker choice strategies options.
326 - Use O(1) queue implementation for tasks queueing.
330 - Fix median computation implementation.
331 - Fix fair share worker choice strategy internals update.
333 ## [2.4.11] - 2023-04-23
337 - Optimize free worker finding in worker choice strategies.
339 ## [2.4.10] - 2023-04-15
343 - Fix typescript type definition for task function: ensure the input data is optional.
344 - Fix typescript type definition for pool execute(): ensure the input data is optional.
346 ## [2.4.9] - 2023-04-15
350 - Add tasks queue enablement runtime setter to pool.
351 - Add tasks queue options runtime setter to pool.
352 - Add worker choice strategy options runtime setter to pool.
356 - Remove the tasks queuing experimental status.
360 - Fix task function type definition and validation.
361 - Fix worker choice strategy options handling.
363 ## [2.4.8] - 2023-04-12
367 - Fix message between main worker and worker type definition for tasks.
368 - Fix code documentation.
370 ## [2.4.7] - 2023-04-11
374 - Add worker tasks queue options to pool options.
378 - Fix missing documentation.
380 ## [2.4.6] - 2023-04-10
384 - Ensure one task at a time is executed per worker with tasks queueing enabled.
385 - Properly count worker executing tasks with tasks queueing enabled.
387 ## [2.4.5] - 2023-04-09
391 - Use monotonic high resolution timer for worker tasks runtime.
392 - Add worker tasks median runtime to statistics.
393 - Add worker tasks queue (experimental).
395 ## [2.4.4] - 2023-04-07
399 - Add `PoolEvents` enumeration and `PoolEvent` type.
403 - Destroy worker only on alive check.
405 ## [2.4.3] - 2023-04-07
409 - Fix typedoc generation with inheritance.
411 ## [2.4.2] - 2023-04-06
415 - Add `full` event to dynamic pool.
416 - Keep worker choice strategy in memory for conditional reuse.
420 - Fix possible negative worker key at worker removal in worker choice strategies.
422 ## [2.4.1] - 2023-04-05
426 - Optimize worker choice strategy for dynamic pool.
430 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
432 ## [2.4.0] - 2023-04-04
436 - Add `LESS_BUSY` worker choice strategy.
440 - Optimize worker storage in pool.
441 - Optimize worker alive status check.
442 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
443 - Optimize `LESS_USED` worker choice strategy.
444 - Update benchmarks versus external threads pools.
445 - Optimize tasks usage statistics requirements for worker choice strategy.
449 - Ensure trimmable characters are checked at pool initialization.
450 - Fix message id integer overflow.
451 - Fix pool worker removal in worker choice strategy internals.
452 - Fix package publication with pnpm.
454 ## [2.4.0-3] - 2023-04-04
458 - Add `LESS_BUSY` worker choice strategy.
462 - Optimize worker storage in pool.
463 - Optimize worker alive status check.
464 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
465 - Optimize `LESS_USED` worker choice strategy.
466 - Update benchmarks versus external threads pools.
470 - Ensure trimmable characters are checked at pool initialization.
471 - Fix message id integer overflow.
472 - Fix pool worker removal in worker choice strategy internals.
473 - Fix package publication with pnpm.
475 ## [2.4.0-2] - 2023-04-03
479 - Add `LESS_BUSY` worker choice strategy.
483 - Optimize worker storage in pool.
484 - Optimize worker alive status check.
485 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
486 - Optimize `LESS_USED` worker choice strategy.
490 - Ensure trimmable characters are checked at pool initialization.
491 - Fix message id integer overflow.
492 - Fix pool worker removal in worker choice strategy internals.
493 - Fix package publication with pnpm.
495 ## [2.4.0-1] - 2023-04-03
499 - Add `LESS_BUSY` worker choice strategy.
503 - Optimize worker storage in pool.
504 - Optimize worker alive status check.
505 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
506 - Optimize `LESS_USED` worker choice strategy.
510 - Ensure trimmable characters are checked at pool initialization.
511 - Fix message id integer overflow.
512 - Fix pool worker removal in worker choice strategy internals.
514 ## [2.4.0-0] - 2023-04-03
518 - Add `LESS_BUSY` worker choice strategy.
522 - Optimize worker storage in pool.
523 - Optimize worker alive status check.
524 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
525 - Optimize `LESS_USED` worker choice strategy.
529 - Ensure trimmable characters are checked at pool initialization.
530 - Fix message id integer overflow.
531 - Fix pool worker removal in worker choice strategy internals.
533 ## [2.3.10] - 2023-03-18
537 - Fix package.json `exports` syntax for ESM and CommonJS.
541 - Permit SemVer pre-release publication.
543 ## [2.3.10-2] - 2023-03-18
547 - Fix package.json `exports` syntax for ESM and CommonJS.
549 ## [2.3.10-1] - 2023-03-18
553 - Permit SemVer pre-release publication.
555 ## [2.3.10-0] - 2023-03-18
559 - Fix package.json `exports` syntax for ESM and CommonJS.
561 ## [2.3.9] - 2023-03-18
565 - Introduce ESM module support along with CommonJS one.
569 - Fix brown paper bag bug referencing the same object literal.
571 ## [2.3.8] - 2023-03-18
575 - Switch internal benchmarking code to benny.
576 - Switch to TypeScript 5.x.x.
577 - Switch rollup bundler plugins to core ones.
578 - Switch to TSDoc syntax.
579 - Enforce conventional commits.
583 - Fix random integer generator.
584 - Fix worker choice strategy pool type identification at initialization.
586 ## [2.3.7] - 2022-10-23
590 - Switch to open collective FOSS project funding platform.
591 - Switch to ts-standard linter configuration on TypeScript code.
595 - Fixed missing async on pool execute method.
596 - Fixed typing in TypeScript example.
597 - Fixed types in unit tests.
599 ## [2.3.6] - 2022-10-22
603 - Cleanup pool attributes and methods.
604 - Refine error types thrown.
608 - Fix continuous integration build on windows.
609 - Fix code coverage reporting by using c8 instead of nyc.
611 ## [2.3.5] - 2022-10-21
615 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
616 - Optimize tasks usage lookup implementation.
620 - Fix missed pool event emitter type export.
621 - Fix typedoc documentation generation.
623 ## [2.3.4] - 2022-10-17
627 - Fully automate release process with release-it.
631 - Optimize fair share task scheduling algorithm implementation.
632 - Update benchmarks versus external pools results with latest version.
634 ## [2.3.3] - 2022-10-15
638 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
640 ## [2.3.2] - 2022-10-14
644 - Optimize fair share worker selection strategy implementation.
648 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
650 ## [2.3.1] - 2022-10-13
654 - Pool worker choice strategies:
655 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
656 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
658 ## [2.2.2] - 2022-10-09
662 - Fixed `README.md` file.
664 ## [2.2.1] - 2022-10-08
668 - Dynamic worker choice strategy change at runtime.
670 ## [2.2.0] - 2022-01-05
674 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
676 ## [2.1.0] - 2021-08-29
680 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
684 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
685 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
686 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
687 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
689 ## [2.0.2] - 2021-05-12
693 - Fix `busy` event emission on fixed pool type
695 ## [2.0.1] - 2021-03-16
699 - Check if pool options are properly set.
700 - `busy` event is emitted on all pool types.
702 ## [2.0.0] - 2021-03-01
706 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
710 - `FullPool` event is now renamed to `busy`.
711 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
712 _Find more details on our JSDoc._
714 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
716 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
718 ### Pool options types declaration merge
720 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
722 #### New `export` strategy
726 const DynamicThreadPool = require('poolifier/lib/dynamic')
728 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
731 But you should always prefer just using
734 const { DynamicThreadPool } = require('poolifier')
737 #### New type definitions for input data and response
739 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
740 _This is not a limitation by poolifier but Node.js._
742 #### Public property replacements
744 `numWorkers` property is now `numberOfWorkers`
746 #### Internal (protected) properties and methods renaming
748 These properties are not intended for end users
750 - `id` => `nextMessageId`
752 These methods are not intended for end users
754 - `_chooseWorker` => `chooseWorker`
755 - `_newWorker` => `createWorker`
756 - `_execute` => `internalExecute`
757 - `_chooseWorker` => `chooseWorker`
758 - `_checkAlive` => `checkAlive`
760 - `_runAsync` => `runAsync`
762 ## [1.1.0] - 2020-05-21
766 - ThreadWorker support async functions as option
767 - Various external library patches
769 ## [1.0.0] - 2020-01-24
773 - FixedThreadPool implementation
774 - DynamicThreadPool implementation
775 - WorkerThread implementation to improve developer experience