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.27] - 2023-08-15
14 - Add `KillHandler` type definition to exported types.
18 - Add `destroy` event to pool API.
20 ## [2.6.26] - 2023-08-15
24 - Add kill handler to worker options allowing to execute custom code when worker is killed.
25 - Add `listTaskFunctions()` method to pool API.
26 - SMTP server pool example: nodemailer.
28 ## [2.6.25] - 2023-08-13
32 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
33 - WebSocket server pool examples: ws-cluster, ws-hybrid.
35 ## [2.6.24] - 2023-08-12
39 - Add array of transferable objects to the `execute()` method arguments.
40 - WebSocket server pool examples: ws-worker_threads.
42 ## [2.6.23] - 2023-08-11
46 - 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.
50 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
51 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
53 ## [2.6.22] - 2023-08-10
57 - Add missing `types` field to package.json `exports`.
61 - Structure markdown documentation (PR #811).
63 ## [2.6.21] - 2023-08-03
67 - Improve code documentation.
68 - Code refactoring and cleanup for better maintainability and readability.
70 ## [2.6.20] - 2023-07-21
74 - Fix queued tasks redistribution on error task execution starvation.
75 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
79 - Drastically reduce lookups by worker in the worker nodes.
81 ## [2.6.19] - 2023-07-20
85 - Dedicated internal communication channel for worker_threads pools.
87 ## [2.6.18] - 2023-07-19
91 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
93 ## [2.6.17] - 2023-07-16
97 - Add `listTaskFunctions()` method to worker API.
99 ## [2.6.16] - 2023-07-12
103 - Fix pool startup detection.
104 - Fix worker task functions handling.
106 ## [2.6.15] - 2023-07-11
110 - Take into account worker node readiness in worker choice strategies.
112 ## [2.6.14] - 2023-07-10
116 - Fix task function statistics tracking.
118 ## [2.6.13] - 2023-07-10
122 - Add per task function statistics tracking.
123 - Add public methods to manipulate the worker task functions at runtime.
125 ## [2.6.12] - 2023-07-09
129 - Workaround import issue with `node:os` module in node 16.x.x.
131 ## [2.6.11] - 2023-07-09
135 - Fix pool readiness semantic.
137 ## [2.6.10] - 2023-07-08
141 - Ensure workers are not recreated on error at pool startup.
145 - Add `ready` and `strategy` fields to pool information.
146 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
147 - Add dynamic pool sizing checks.
149 ## [2.6.9] - 2023-07-07
153 - Recreate the right worker type on uncaught exception.
157 - Add minimum and maximum to internal measurement statistics.
158 - Add `runTime` and `waitTime` to pool information.
159 - Check worker inactive time only on dynamic worker.
161 ## [2.6.8] - 2023-07-03
165 - Brown paper bag release to fix version handling in pool information.
167 ## [2.6.7] - 2023-07-03
171 - Ensure worker queued tasks at error are reassigned to other pool workers.
175 - Add pool `utilization` ratio to pool information.
176 - Add `version` to pool information.
177 - Add worker information to worker nodes.
179 ## [2.6.6] - 2023-07-01
183 - Add safe helper `availableParallelism` to help sizing the pool.
187 - Ensure message handler is only registered in worker.
189 ## [2.6.5] - 2023-06-27
193 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
197 - Artificial version bump to 2.6.5 to workaround publication issue.
198 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
199 - Ensure pool event is emitted before task error promise rejection.
200 - Fix queued tasks count computation.
204 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
206 ## [2.6.4] - 2023-06-27
210 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
214 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
215 - Ensure pool event is emitted before task error promise rejection.
216 - Fix queued tasks count computation.
220 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
222 ## [2.6.3] - 2023-06-19
226 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
227 - Update strategies internals after statistics computation.
231 - Optimize O(1) queue implementation.
233 ## [2.6.2] - 2023-06-12
237 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
239 ## [2.6.1] - 2023-06-10
243 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
247 - Fix average statistics computation: ensure failed tasks are not accounted.
249 ## [2.6.0] - 2023-06-09
253 - Add `LEAST_ELU` worker choice strategy (experimental).
254 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
258 - Refactor pool worker node usage internals.
259 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
260 - Breaking change: pool information `info` property object fields have been renamed.
264 - Fix wait time accounting.
265 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
266 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
268 ## [2.5.4] - 2023-06-07
272 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
276 - Compute statistics at the worker level only if needed.
277 - Add `worker_threads` options to thread pool options.
281 - Make the `LEAST_BUSY` strategy only relies on task runtime.
283 ## [2.5.3] - 2023-06-04
287 - Refine pool information content.
288 - Limit pool internals public exposure.
290 ## [2.5.2] - 2023-06-02
294 - Add `taskError` pool event for task execution error.
295 - Add pool information `info` property to pool.
296 - Emit pool information on `busy` and `full` pool events.
298 ## [2.5.1] - 2023-06-01
302 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
303 - Add `error` pool event for uncaught worker error.
305 ## [2.5.0] - 2023-05-31
309 - Switch pool event emitter to `EventEmitterAsyncResource`.
310 - Add tasks wait time accounting in per worker tasks usage.
311 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
315 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
317 ## [2.4.14] - 2023-05-09
321 - Ensure no undefined task runtime can land in the tasks history.
322 - Fix median computation implementation once again.
326 - Unit tests for median and queue implementations.
328 ## [2.4.13] - 2023-05-08
332 - Fix worker choice strategy options validation.
333 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
335 ## [2.4.12] - 2023-05-06
339 - Support multiple task functions per worker.
340 - Add custom worker weights support to worker choice strategies options.
344 - Use O(1) queue implementation for tasks queueing.
348 - Fix median computation implementation.
349 - Fix fair share worker choice strategy internals update.
351 ## [2.4.11] - 2023-04-23
355 - Optimize free worker finding in worker choice strategies.
357 ## [2.4.10] - 2023-04-15
361 - Fix typescript type definition for task function: ensure the input data is optional.
362 - Fix typescript type definition for pool execute(): ensure the input data is optional.
364 ## [2.4.9] - 2023-04-15
368 - Add tasks queue enablement runtime setter to pool.
369 - Add tasks queue options runtime setter to pool.
370 - Add worker choice strategy options runtime setter to pool.
374 - Remove the tasks queuing experimental status.
378 - Fix task function type definition and validation.
379 - Fix worker choice strategy options handling.
381 ## [2.4.8] - 2023-04-12
385 - Fix message between main worker and worker type definition for tasks.
386 - Fix code documentation.
388 ## [2.4.7] - 2023-04-11
392 - Add worker tasks queue options to pool options.
396 - Fix missing documentation.
398 ## [2.4.6] - 2023-04-10
402 - Ensure one task at a time is executed per worker with tasks queueing enabled.
403 - Properly count worker executing tasks with tasks queueing enabled.
405 ## [2.4.5] - 2023-04-09
409 - Use monotonic high resolution timer for worker tasks runtime.
410 - Add worker tasks median runtime to statistics.
411 - Add worker tasks queue (experimental).
413 ## [2.4.4] - 2023-04-07
417 - Add `PoolEvents` enumeration and `PoolEvent` type.
421 - Destroy worker only on alive check.
423 ## [2.4.3] - 2023-04-07
427 - Fix typedoc generation with inheritance.
429 ## [2.4.2] - 2023-04-06
433 - Add `full` event to dynamic pool.
434 - Keep worker choice strategy in memory for conditional reuse.
438 - Fix possible negative worker key at worker removal in worker choice strategies.
440 ## [2.4.1] - 2023-04-05
444 - Optimize worker choice strategy for dynamic pool.
448 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
450 ## [2.4.0] - 2023-04-04
454 - Add `LESS_BUSY` worker choice strategy.
458 - Optimize worker storage in pool.
459 - Optimize worker alive status check.
460 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
461 - Optimize `LESS_USED` worker choice strategy.
462 - Update benchmarks versus external threads pools.
463 - Optimize tasks usage statistics requirements for worker choice strategy.
467 - Ensure trimmable characters are checked at pool initialization.
468 - Fix message id integer overflow.
469 - Fix pool worker removal in worker choice strategy internals.
470 - Fix package publication with pnpm.
472 ## [2.4.0-3] - 2023-04-04
476 - Add `LESS_BUSY` worker choice strategy.
480 - Optimize worker storage in pool.
481 - Optimize worker alive status check.
482 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
483 - Optimize `LESS_USED` worker choice strategy.
484 - Update benchmarks versus external threads pools.
488 - Ensure trimmable characters are checked at pool initialization.
489 - Fix message id integer overflow.
490 - Fix pool worker removal in worker choice strategy internals.
491 - Fix package publication with pnpm.
493 ## [2.4.0-2] - 2023-04-03
497 - Add `LESS_BUSY` worker choice strategy.
501 - Optimize worker storage in pool.
502 - Optimize worker alive status check.
503 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
504 - Optimize `LESS_USED` worker choice strategy.
508 - Ensure trimmable characters are checked at pool initialization.
509 - Fix message id integer overflow.
510 - Fix pool worker removal in worker choice strategy internals.
511 - Fix package publication with pnpm.
513 ## [2.4.0-1] - 2023-04-03
517 - Add `LESS_BUSY` worker choice strategy.
521 - Optimize worker storage in pool.
522 - Optimize worker alive status check.
523 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
524 - Optimize `LESS_USED` worker choice strategy.
528 - Ensure trimmable characters are checked at pool initialization.
529 - Fix message id integer overflow.
530 - Fix pool worker removal in worker choice strategy internals.
532 ## [2.4.0-0] - 2023-04-03
536 - Add `LESS_BUSY` worker choice strategy.
540 - Optimize worker storage in pool.
541 - Optimize worker alive status check.
542 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
543 - Optimize `LESS_USED` worker choice strategy.
547 - Ensure trimmable characters are checked at pool initialization.
548 - Fix message id integer overflow.
549 - Fix pool worker removal in worker choice strategy internals.
551 ## [2.3.10] - 2023-03-18
555 - Fix package.json `exports` syntax for ESM and CommonJS.
559 - Permit SemVer pre-release publication.
561 ## [2.3.10-2] - 2023-03-18
565 - Fix package.json `exports` syntax for ESM and CommonJS.
567 ## [2.3.10-1] - 2023-03-18
571 - Permit SemVer pre-release publication.
573 ## [2.3.10-0] - 2023-03-18
577 - Fix package.json `exports` syntax for ESM and CommonJS.
579 ## [2.3.9] - 2023-03-18
583 - Introduce ESM module support along with CommonJS one.
587 - Fix brown paper bag bug referencing the same object literal.
589 ## [2.3.8] - 2023-03-18
593 - Switch internal benchmarking code to benny.
594 - Switch to TypeScript 5.x.x.
595 - Switch rollup bundler plugins to core ones.
596 - Switch to TSDoc syntax.
597 - Enforce conventional commits.
601 - Fix random integer generator.
602 - Fix worker choice strategy pool type identification at initialization.
604 ## [2.3.7] - 2022-10-23
608 - Switch to open collective FOSS project funding platform.
609 - Switch to ts-standard linter configuration on TypeScript code.
613 - Fixed missing async on pool execute method.
614 - Fixed typing in TypeScript example.
615 - Fixed types in unit tests.
617 ## [2.3.6] - 2022-10-22
621 - Cleanup pool attributes and methods.
622 - Refine error types thrown.
626 - Fix continuous integration build on windows.
627 - Fix code coverage reporting by using c8 instead of nyc.
629 ## [2.3.5] - 2022-10-21
633 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
634 - Optimize tasks usage lookup implementation.
638 - Fix missed pool event emitter type export.
639 - Fix typedoc documentation generation.
641 ## [2.3.4] - 2022-10-17
645 - Fully automate release process with release-it.
649 - Optimize fair share task scheduling algorithm implementation.
650 - Update benchmarks versus external pools results with latest version.
652 ## [2.3.3] - 2022-10-15
656 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
658 ## [2.3.2] - 2022-10-14
662 - Optimize fair share worker selection strategy implementation.
666 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
668 ## [2.3.1] - 2022-10-13
672 - Pool worker choice strategies:
673 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
674 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
676 ## [2.2.2] - 2022-10-09
680 - Fixed `README.md` file.
682 ## [2.2.1] - 2022-10-08
686 - Dynamic worker choice strategy change at runtime.
688 ## [2.2.0] - 2022-01-05
692 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
694 ## [2.1.0] - 2021-08-29
698 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
702 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
703 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
704 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
705 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
707 ## [2.0.2] - 2021-05-12
711 - Fix `busy` event emission on fixed pool type
713 ## [2.0.1] - 2021-03-16
717 - Check if pool options are properly set.
718 - `busy` event is emitted on all pool types.
720 ## [2.0.0] - 2021-03-01
724 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
728 - `FullPool` event is now renamed to `busy`.
729 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
730 _Find more details on our JSDoc._
732 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
734 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
736 ### Pool options types declaration merge
738 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
740 #### New `export` strategy
744 const DynamicThreadPool = require('poolifier/lib/dynamic')
746 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
749 But you should always prefer just using
752 const { DynamicThreadPool } = require('poolifier')
755 #### New type definitions for input data and response
757 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
758 _This is not a limitation by poolifier but Node.js._
760 #### Public property replacements
762 `numWorkers` property is now `numberOfWorkers`
764 #### Internal (protected) properties and methods renaming
766 These properties are not intended for end users
768 - `id` => `nextMessageId`
770 These methods are not intended for end users
772 - `_chooseWorker` => `chooseWorker`
773 - `_newWorker` => `createWorker`
774 - `_execute` => `internalExecute`
775 - `_chooseWorker` => `chooseWorker`
776 - `_checkAlive` => `checkAlive`
778 - `_runAsync` => `runAsync`
780 ## [1.1.0] - 2020-05-21
784 - ThreadWorker support async functions as option
785 - Various external library patches
787 ## [1.0.0] - 2020-01-24
791 - FixedThreadPool implementation
792 - DynamicThreadPool implementation
793 - WorkerThread implementation to improve developer experience