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 kill handler to worker options allowing to execute custom code when worker is killed.
13 - SMTP server pool example: nodemailer.
15 ## [2.6.25] - 2023-08-13
19 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
20 - WebSocket server pool examples: ws-cluster, ws-hybrid.
22 ## [2.6.24] - 2023-08-12
26 - Add array of transferable objects to the `execute()` method arguments.
27 - WebSocket server pool examples: ws-worker_threads.
29 ## [2.6.23] - 2023-08-11
33 - 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.
37 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
38 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
40 ## [2.6.22] - 2023-08-10
44 - Add missing `types` field to package.json `exports`.
48 - Structure markdown documentation (PR #811).
50 ## [2.6.21] - 2023-08-03
54 - Improve code documentation.
55 - Code refactoring and cleanup for better maintainability and readability.
57 ## [2.6.20] - 2023-07-21
61 - Fix queued tasks redistribution on error task execution starvation.
62 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
66 - Drastically reduce lookups by worker in the worker nodes.
68 ## [2.6.19] - 2023-07-20
72 - Dedicated internal communication channel for worker_threads pools.
74 ## [2.6.18] - 2023-07-19
78 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
80 ## [2.6.17] - 2023-07-16
84 - Add `listTaskFunctions()` method to worker class.
86 ## [2.6.16] - 2023-07-12
90 - Fix pool startup detection.
91 - Fix worker task functions handling.
93 ## [2.6.15] - 2023-07-11
97 - Take into account worker node readiness in worker choice strategies.
99 ## [2.6.14] - 2023-07-10
103 - Fix task function statistics tracking.
105 ## [2.6.13] - 2023-07-10
109 - Add per task function statistics tracking.
110 - Add public methods to manipulate the worker task functions at runtime.
112 ## [2.6.12] - 2023-07-09
116 - Workaround import issue with `node:os` module in node 16.x.x.
118 ## [2.6.11] - 2023-07-09
122 - Fix pool readiness semantic.
124 ## [2.6.10] - 2023-07-08
128 - Ensure workers are not recreated on error at pool startup.
132 - Add `ready` and `strategy` fields to pool information.
133 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
134 - Add dynamic pool sizing checks.
136 ## [2.6.9] - 2023-07-07
140 - Recreate the right worker type on uncaught exception.
144 - Add minimum and maximum to internal measurement statistics.
145 - Add `runTime` and `waitTime` to pool information.
146 - Check worker inactive time only on dynamic worker.
148 ## [2.6.8] - 2023-07-03
152 - Brown paper bag release to fix version handling in pool information.
154 ## [2.6.7] - 2023-07-03
158 - Ensure worker queued tasks at error are reassigned to other pool workers.
162 - Add pool `utilization` ratio to pool information.
163 - Add `version` to pool information.
164 - Add worker information to worker nodes.
166 ## [2.6.6] - 2023-07-01
170 - Add safe helper `availableParallelism` to help sizing the pool.
174 - Ensure message handler is only registered in worker.
176 ## [2.6.5] - 2023-06-27
180 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
184 - Artificial version bump to 2.6.5 to workaround publication issue.
185 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
186 - Ensure pool event is emitted before task error promise rejection.
187 - Fix queued tasks count computation.
191 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
193 ## [2.6.4] - 2023-06-27
197 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
201 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
202 - Ensure pool event is emitted before task error promise rejection.
203 - Fix queued tasks count computation.
207 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
209 ## [2.6.3] - 2023-06-19
213 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
214 - Update strategies internals after statistics computation.
218 - Optimize O(1) queue implementation.
220 ## [2.6.2] - 2023-06-12
224 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
226 ## [2.6.1] - 2023-06-10
230 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
234 - Fix average statistics computation: ensure failed tasks are not accounted.
236 ## [2.6.0] - 2023-06-09
240 - Add `LEAST_ELU` worker choice strategy (experimental).
241 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
245 - Refactor pool worker node usage internals.
246 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
247 - Breaking change: pool information `info` property object fields have been renamed.
251 - Fix wait time accounting.
252 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
253 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
255 ## [2.5.4] - 2023-06-07
259 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
263 - Compute statistics at the worker level only if needed.
264 - Add `worker_threads` options to thread pool options.
268 - Make the `LEAST_BUSY` strategy only relies on task runtime.
270 ## [2.5.3] - 2023-06-04
274 - Refine pool information content.
275 - Limit pool internals public exposure.
277 ## [2.5.2] - 2023-06-02
281 - Add `taskError` pool event for task execution error.
282 - Add pool information `info` property to pool.
283 - Emit pool information on `busy` and `full` pool events.
285 ## [2.5.1] - 2023-06-01
289 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
290 - Add `error` pool event for uncaught worker error.
292 ## [2.5.0] - 2023-05-31
296 - Switch pool event emitter to `EventEmitterAsyncResource`.
297 - Add tasks wait time accounting in per worker tasks usage.
298 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
302 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
304 ## [2.4.14] - 2023-05-09
308 - Ensure no undefined task runtime can land in the tasks history.
309 - Fix median computation implementation once again.
313 - Unit tests for median and queue implementations.
315 ## [2.4.13] - 2023-05-08
319 - Fix worker choice strategy options validation.
320 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
322 ## [2.4.12] - 2023-05-06
326 - Support multiple task functions per worker.
327 - Add custom worker weights support to worker choice strategies options.
331 - Use O(1) queue implementation for tasks queueing.
335 - Fix median computation implementation.
336 - Fix fair share worker choice strategy internals update.
338 ## [2.4.11] - 2023-04-23
342 - Optimize free worker finding in worker choice strategies.
344 ## [2.4.10] - 2023-04-15
348 - Fix typescript type definition for task function: ensure the input data is optional.
349 - Fix typescript type definition for pool execute(): ensure the input data is optional.
351 ## [2.4.9] - 2023-04-15
355 - Add tasks queue enablement runtime setter to pool.
356 - Add tasks queue options runtime setter to pool.
357 - Add worker choice strategy options runtime setter to pool.
361 - Remove the tasks queuing experimental status.
365 - Fix task function type definition and validation.
366 - Fix worker choice strategy options handling.
368 ## [2.4.8] - 2023-04-12
372 - Fix message between main worker and worker type definition for tasks.
373 - Fix code documentation.
375 ## [2.4.7] - 2023-04-11
379 - Add worker tasks queue options to pool options.
383 - Fix missing documentation.
385 ## [2.4.6] - 2023-04-10
389 - Ensure one task at a time is executed per worker with tasks queueing enabled.
390 - Properly count worker executing tasks with tasks queueing enabled.
392 ## [2.4.5] - 2023-04-09
396 - Use monotonic high resolution timer for worker tasks runtime.
397 - Add worker tasks median runtime to statistics.
398 - Add worker tasks queue (experimental).
400 ## [2.4.4] - 2023-04-07
404 - Add `PoolEvents` enumeration and `PoolEvent` type.
408 - Destroy worker only on alive check.
410 ## [2.4.3] - 2023-04-07
414 - Fix typedoc generation with inheritance.
416 ## [2.4.2] - 2023-04-06
420 - Add `full` event to dynamic pool.
421 - Keep worker choice strategy in memory for conditional reuse.
425 - Fix possible negative worker key at worker removal in worker choice strategies.
427 ## [2.4.1] - 2023-04-05
431 - Optimize worker choice strategy for dynamic pool.
435 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
437 ## [2.4.0] - 2023-04-04
441 - Add `LESS_BUSY` worker choice strategy.
445 - Optimize worker storage in pool.
446 - Optimize worker alive status check.
447 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
448 - Optimize `LESS_USED` worker choice strategy.
449 - Update benchmarks versus external threads pools.
450 - Optimize tasks usage statistics requirements for worker choice strategy.
454 - Ensure trimmable characters are checked at pool initialization.
455 - Fix message id integer overflow.
456 - Fix pool worker removal in worker choice strategy internals.
457 - Fix package publication with pnpm.
459 ## [2.4.0-3] - 2023-04-04
463 - Add `LESS_BUSY` worker choice strategy.
467 - Optimize worker storage in pool.
468 - Optimize worker alive status check.
469 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
470 - Optimize `LESS_USED` worker choice strategy.
471 - Update benchmarks versus external threads pools.
475 - Ensure trimmable characters are checked at pool initialization.
476 - Fix message id integer overflow.
477 - Fix pool worker removal in worker choice strategy internals.
478 - Fix package publication with pnpm.
480 ## [2.4.0-2] - 2023-04-03
484 - Add `LESS_BUSY` worker choice strategy.
488 - Optimize worker storage in pool.
489 - Optimize worker alive status check.
490 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
491 - Optimize `LESS_USED` worker choice strategy.
495 - Ensure trimmable characters are checked at pool initialization.
496 - Fix message id integer overflow.
497 - Fix pool worker removal in worker choice strategy internals.
498 - Fix package publication with pnpm.
500 ## [2.4.0-1] - 2023-04-03
504 - Add `LESS_BUSY` worker choice strategy.
508 - Optimize worker storage in pool.
509 - Optimize worker alive status check.
510 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
511 - Optimize `LESS_USED` worker choice strategy.
515 - Ensure trimmable characters are checked at pool initialization.
516 - Fix message id integer overflow.
517 - Fix pool worker removal in worker choice strategy internals.
519 ## [2.4.0-0] - 2023-04-03
523 - Add `LESS_BUSY` worker choice strategy.
527 - Optimize worker storage in pool.
528 - Optimize worker alive status check.
529 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
530 - Optimize `LESS_USED` worker choice strategy.
534 - Ensure trimmable characters are checked at pool initialization.
535 - Fix message id integer overflow.
536 - Fix pool worker removal in worker choice strategy internals.
538 ## [2.3.10] - 2023-03-18
542 - Fix package.json `exports` syntax for ESM and CommonJS.
546 - Permit SemVer pre-release publication.
548 ## [2.3.10-2] - 2023-03-18
552 - Fix package.json `exports` syntax for ESM and CommonJS.
554 ## [2.3.10-1] - 2023-03-18
558 - Permit SemVer pre-release publication.
560 ## [2.3.10-0] - 2023-03-18
564 - Fix package.json `exports` syntax for ESM and CommonJS.
566 ## [2.3.9] - 2023-03-18
570 - Introduce ESM module support along with CommonJS one.
574 - Fix brown paper bag bug referencing the same object literal.
576 ## [2.3.8] - 2023-03-18
580 - Switch internal benchmarking code to benny.
581 - Switch to TypeScript 5.x.x.
582 - Switch rollup bundler plugins to core ones.
583 - Switch to TSDoc syntax.
584 - Enforce conventional commits.
588 - Fix random integer generator.
589 - Fix worker choice strategy pool type identification at initialization.
591 ## [2.3.7] - 2022-10-23
595 - Switch to open collective FOSS project funding platform.
596 - Switch to ts-standard linter configuration on TypeScript code.
600 - Fixed missing async on pool execute method.
601 - Fixed typing in TypeScript example.
602 - Fixed types in unit tests.
604 ## [2.3.6] - 2022-10-22
608 - Cleanup pool attributes and methods.
609 - Refine error types thrown.
613 - Fix continuous integration build on windows.
614 - Fix code coverage reporting by using c8 instead of nyc.
616 ## [2.3.5] - 2022-10-21
620 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
621 - Optimize tasks usage lookup implementation.
625 - Fix missed pool event emitter type export.
626 - Fix typedoc documentation generation.
628 ## [2.3.4] - 2022-10-17
632 - Fully automate release process with release-it.
636 - Optimize fair share task scheduling algorithm implementation.
637 - Update benchmarks versus external pools results with latest version.
639 ## [2.3.3] - 2022-10-15
643 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
645 ## [2.3.2] - 2022-10-14
649 - Optimize fair share worker selection strategy implementation.
653 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
655 ## [2.3.1] - 2022-10-13
659 - Pool worker choice strategies:
660 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
661 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
663 ## [2.2.2] - 2022-10-09
667 - Fixed `README.md` file.
669 ## [2.2.1] - 2022-10-08
673 - Dynamic worker choice strategy change at runtime.
675 ## [2.2.0] - 2022-01-05
679 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
681 ## [2.1.0] - 2021-08-29
685 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
689 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
690 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
691 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
692 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
694 ## [2.0.2] - 2021-05-12
698 - Fix `busy` event emission on fixed pool type
700 ## [2.0.1] - 2021-03-16
704 - Check if pool options are properly set.
705 - `busy` event is emitted on all pool types.
707 ## [2.0.0] - 2021-03-01
711 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
715 - `FullPool` event is now renamed to `busy`.
716 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
717 _Find more details on our JSDoc._
719 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
721 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
723 ### Pool options types declaration merge
725 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
727 #### New `export` strategy
731 const DynamicThreadPool = require('poolifier/lib/dynamic')
733 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
736 But you should always prefer just using
739 const { DynamicThreadPool } = require('poolifier')
742 #### New type definitions for input data and response
744 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
745 _This is not a limitation by poolifier but Node.js._
747 #### Public property replacements
749 `numWorkers` property is now `numberOfWorkers`
751 #### Internal (protected) properties and methods renaming
753 These properties are not intended for end users
755 - `id` => `nextMessageId`
757 These methods are not intended for end users
759 - `_chooseWorker` => `chooseWorker`
760 - `_newWorker` => `createWorker`
761 - `_execute` => `internalExecute`
762 - `_chooseWorker` => `chooseWorker`
763 - `_checkAlive` => `checkAlive`
765 - `_runAsync` => `runAsync`
767 ## [1.1.0] - 2020-05-21
771 - ThreadWorker support async functions as option
772 - Various external library patches
774 ## [1.0.0] - 2020-01-24
778 - FixedThreadPool implementation
779 - DynamicThreadPool implementation
780 - WorkerThread implementation to improve developer experience