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 - Ensure pool workers are properly initialized.
16 - HTTP server pool examples: express-cluster, express-hybrid.
18 ## [2.6.27] - 2023-08-15
22 - Add `KillHandler` type definition to exported types.
26 - Add `destroy` event to pool API.
28 ## [2.6.26] - 2023-08-15
32 - Add kill handler to worker options allowing to execute custom code when worker is killed.
33 - Add `listTaskFunctions()` method to pool API.
34 - SMTP server pool example: nodemailer.
36 ## [2.6.25] - 2023-08-13
40 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
41 - WebSocket server pool examples: ws-cluster, ws-hybrid.
43 ## [2.6.24] - 2023-08-12
47 - Add array of transferable objects to the `execute()` method arguments.
48 - WebSocket server pool examples: ws-worker_threads.
50 ## [2.6.23] - 2023-08-11
54 - 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.
58 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
59 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
61 ## [2.6.22] - 2023-08-10
65 - Add missing `types` field to package.json `exports`.
69 - Structure markdown documentation (PR #811).
71 ## [2.6.21] - 2023-08-03
75 - Improve code documentation.
76 - Code refactoring and cleanup for better maintainability and readability.
78 ## [2.6.20] - 2023-07-21
82 - Fix queued tasks redistribution on error task execution starvation.
83 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
87 - Drastically reduce lookups by worker in the worker nodes.
89 ## [2.6.19] - 2023-07-20
93 - Dedicated internal communication channel for worker_threads pools.
95 ## [2.6.18] - 2023-07-19
99 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
101 ## [2.6.17] - 2023-07-16
105 - Add `listTaskFunctions()` method to worker API.
107 ## [2.6.16] - 2023-07-12
111 - Fix pool startup detection.
112 - Fix worker task functions handling.
114 ## [2.6.15] - 2023-07-11
118 - Take into account worker node readiness in worker choice strategies.
120 ## [2.6.14] - 2023-07-10
124 - Fix task function statistics tracking.
126 ## [2.6.13] - 2023-07-10
130 - Add per task function statistics tracking.
131 - Add public methods to manipulate the worker task functions at runtime.
133 ## [2.6.12] - 2023-07-09
137 - Workaround import issue with `node:os` module in node 16.x.x.
139 ## [2.6.11] - 2023-07-09
143 - Fix pool readiness semantic.
145 ## [2.6.10] - 2023-07-08
149 - Ensure workers are not recreated on error at pool startup.
153 - Add `ready` and `strategy` fields to pool information.
154 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
155 - Add dynamic pool sizing checks.
157 ## [2.6.9] - 2023-07-07
161 - Recreate the right worker type on uncaught exception.
165 - Add minimum and maximum to internal measurement statistics.
166 - Add `runTime` and `waitTime` to pool information.
167 - Check worker inactive time only on dynamic worker.
169 ## [2.6.8] - 2023-07-03
173 - Brown paper bag release to fix version handling in pool information.
175 ## [2.6.7] - 2023-07-03
179 - Ensure worker queued tasks at error are reassigned to other pool workers.
183 - Add pool `utilization` ratio to pool information.
184 - Add `version` to pool information.
185 - Add worker information to worker nodes.
187 ## [2.6.6] - 2023-07-01
191 - Add safe helper `availableParallelism` to help sizing the pool.
195 - Ensure message handler is only registered in worker.
197 ## [2.6.5] - 2023-06-27
201 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
205 - Artificial version bump to 2.6.5 to workaround publication issue.
206 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
207 - Ensure pool event is emitted before task error promise rejection.
208 - Fix queued tasks count computation.
212 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
214 ## [2.6.4] - 2023-06-27
218 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
222 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
223 - Ensure pool event is emitted before task error promise rejection.
224 - Fix queued tasks count computation.
228 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
230 ## [2.6.3] - 2023-06-19
234 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
235 - Update strategies internals after statistics computation.
239 - Optimize O(1) queue implementation.
241 ## [2.6.2] - 2023-06-12
245 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
247 ## [2.6.1] - 2023-06-10
251 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
255 - Fix average statistics computation: ensure failed tasks are not accounted.
257 ## [2.6.0] - 2023-06-09
261 - Add `LEAST_ELU` worker choice strategy (experimental).
262 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
266 - Refactor pool worker node usage internals.
267 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
268 - Breaking change: pool information `info` property object fields have been renamed.
272 - Fix wait time accounting.
273 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
274 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
276 ## [2.5.4] - 2023-06-07
280 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
284 - Compute statistics at the worker level only if needed.
285 - Add `worker_threads` options to thread pool options.
289 - Make the `LEAST_BUSY` strategy only relies on task runtime.
291 ## [2.5.3] - 2023-06-04
295 - Refine pool information content.
296 - Limit pool internals public exposure.
298 ## [2.5.2] - 2023-06-02
302 - Add `taskError` pool event for task execution error.
303 - Add pool information `info` property to pool.
304 - Emit pool information on `busy` and `full` pool events.
306 ## [2.5.1] - 2023-06-01
310 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
311 - Add `error` pool event for uncaught worker error.
313 ## [2.5.0] - 2023-05-31
317 - Switch pool event emitter to `EventEmitterAsyncResource`.
318 - Add tasks wait time accounting in per worker tasks usage.
319 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
323 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
325 ## [2.4.14] - 2023-05-09
329 - Ensure no undefined task runtime can land in the tasks history.
330 - Fix median computation implementation once again.
334 - Unit tests for median and queue implementations.
336 ## [2.4.13] - 2023-05-08
340 - Fix worker choice strategy options validation.
341 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
343 ## [2.4.12] - 2023-05-06
347 - Support multiple task functions per worker.
348 - Add custom worker weights support to worker choice strategies options.
352 - Use O(1) queue implementation for tasks queueing.
356 - Fix median computation implementation.
357 - Fix fair share worker choice strategy internals update.
359 ## [2.4.11] - 2023-04-23
363 - Optimize free worker finding in worker choice strategies.
365 ## [2.4.10] - 2023-04-15
369 - Fix typescript type definition for task function: ensure the input data is optional.
370 - Fix typescript type definition for pool execute(): ensure the input data is optional.
372 ## [2.4.9] - 2023-04-15
376 - Add tasks queue enablement runtime setter to pool.
377 - Add tasks queue options runtime setter to pool.
378 - Add worker choice strategy options runtime setter to pool.
382 - Remove the tasks queuing experimental status.
386 - Fix task function type definition and validation.
387 - Fix worker choice strategy options handling.
389 ## [2.4.8] - 2023-04-12
393 - Fix message between main worker and worker type definition for tasks.
394 - Fix code documentation.
396 ## [2.4.7] - 2023-04-11
400 - Add worker tasks queue options to pool options.
404 - Fix missing documentation.
406 ## [2.4.6] - 2023-04-10
410 - Ensure one task at a time is executed per worker with tasks queueing enabled.
411 - Properly count worker executing tasks with tasks queueing enabled.
413 ## [2.4.5] - 2023-04-09
417 - Use monotonic high resolution timer for worker tasks runtime.
418 - Add worker tasks median runtime to statistics.
419 - Add worker tasks queue (experimental).
421 ## [2.4.4] - 2023-04-07
425 - Add `PoolEvents` enumeration and `PoolEvent` type.
429 - Destroy worker only on alive check.
431 ## [2.4.3] - 2023-04-07
435 - Fix typedoc generation with inheritance.
437 ## [2.4.2] - 2023-04-06
441 - Add `full` event to dynamic pool.
442 - Keep worker choice strategy in memory for conditional reuse.
446 - Fix possible negative worker key at worker removal in worker choice strategies.
448 ## [2.4.1] - 2023-04-05
452 - Optimize worker choice strategy for dynamic pool.
456 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
458 ## [2.4.0] - 2023-04-04
462 - Add `LESS_BUSY` worker choice strategy.
466 - Optimize worker storage in pool.
467 - Optimize worker alive status check.
468 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
469 - Optimize `LESS_USED` worker choice strategy.
470 - Update benchmarks versus external threads pools.
471 - Optimize tasks usage statistics requirements for worker choice strategy.
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-3] - 2023-04-04
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.
492 - Update benchmarks versus external threads pools.
496 - Ensure trimmable characters are checked at pool initialization.
497 - Fix message id integer overflow.
498 - Fix pool worker removal in worker choice strategy internals.
499 - Fix package publication with pnpm.
501 ## [2.4.0-2] - 2023-04-03
505 - Add `LESS_BUSY` worker choice strategy.
509 - Optimize worker storage in pool.
510 - Optimize worker alive status check.
511 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
512 - Optimize `LESS_USED` worker choice strategy.
516 - Ensure trimmable characters are checked at pool initialization.
517 - Fix message id integer overflow.
518 - Fix pool worker removal in worker choice strategy internals.
519 - Fix package publication with pnpm.
521 ## [2.4.0-1] - 2023-04-03
525 - Add `LESS_BUSY` worker choice strategy.
529 - Optimize worker storage in pool.
530 - Optimize worker alive status check.
531 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
532 - Optimize `LESS_USED` worker choice strategy.
536 - Ensure trimmable characters are checked at pool initialization.
537 - Fix message id integer overflow.
538 - Fix pool worker removal in worker choice strategy internals.
540 ## [2.4.0-0] - 2023-04-03
544 - Add `LESS_BUSY` worker choice strategy.
548 - Optimize worker storage in pool.
549 - Optimize worker alive status check.
550 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
551 - Optimize `LESS_USED` worker choice strategy.
555 - Ensure trimmable characters are checked at pool initialization.
556 - Fix message id integer overflow.
557 - Fix pool worker removal in worker choice strategy internals.
559 ## [2.3.10] - 2023-03-18
563 - Fix package.json `exports` syntax for ESM and CommonJS.
567 - Permit SemVer pre-release publication.
569 ## [2.3.10-2] - 2023-03-18
573 - Fix package.json `exports` syntax for ESM and CommonJS.
575 ## [2.3.10-1] - 2023-03-18
579 - Permit SemVer pre-release publication.
581 ## [2.3.10-0] - 2023-03-18
585 - Fix package.json `exports` syntax for ESM and CommonJS.
587 ## [2.3.9] - 2023-03-18
591 - Introduce ESM module support along with CommonJS one.
595 - Fix brown paper bag bug referencing the same object literal.
597 ## [2.3.8] - 2023-03-18
601 - Switch internal benchmarking code to benny.
602 - Switch to TypeScript 5.x.x.
603 - Switch rollup bundler plugins to core ones.
604 - Switch to TSDoc syntax.
605 - Enforce conventional commits.
609 - Fix random integer generator.
610 - Fix worker choice strategy pool type identification at initialization.
612 ## [2.3.7] - 2022-10-23
616 - Switch to open collective FOSS project funding platform.
617 - Switch to ts-standard linter configuration on TypeScript code.
621 - Fixed missing async on pool execute method.
622 - Fixed typing in TypeScript example.
623 - Fixed types in unit tests.
625 ## [2.3.6] - 2022-10-22
629 - Cleanup pool attributes and methods.
630 - Refine error types thrown.
634 - Fix continuous integration build on windows.
635 - Fix code coverage reporting by using c8 instead of nyc.
637 ## [2.3.5] - 2022-10-21
641 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
642 - Optimize tasks usage lookup implementation.
646 - Fix missed pool event emitter type export.
647 - Fix typedoc documentation generation.
649 ## [2.3.4] - 2022-10-17
653 - Fully automate release process with release-it.
657 - Optimize fair share task scheduling algorithm implementation.
658 - Update benchmarks versus external pools results with latest version.
660 ## [2.3.3] - 2022-10-15
664 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
666 ## [2.3.2] - 2022-10-14
670 - Optimize fair share worker selection strategy implementation.
674 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
676 ## [2.3.1] - 2022-10-13
680 - Pool worker choice strategies:
681 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
682 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
684 ## [2.2.2] - 2022-10-09
688 - Fixed `README.md` file.
690 ## [2.2.1] - 2022-10-08
694 - Dynamic worker choice strategy change at runtime.
696 ## [2.2.0] - 2022-01-05
700 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
702 ## [2.1.0] - 2021-08-29
706 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
710 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
711 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
712 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
713 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
715 ## [2.0.2] - 2021-05-12
719 - Fix `busy` event emission on fixed pool type
721 ## [2.0.1] - 2021-03-16
725 - Check if pool options are properly set.
726 - `busy` event is emitted on all pool types.
728 ## [2.0.0] - 2021-03-01
732 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
736 - `FullPool` event is now renamed to `busy`.
737 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
738 _Find more details on our JSDoc._
740 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
742 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
744 ### Pool options types declaration merge
746 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
748 #### New `export` strategy
752 const DynamicThreadPool = require('poolifier/lib/dynamic')
754 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
757 But you should always prefer just using
760 const { DynamicThreadPool } = require('poolifier')
763 #### New type definitions for input data and response
765 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
766 _This is not a limitation by poolifier but Node.js._
768 #### Public property replacements
770 `numWorkers` property is now `numberOfWorkers`
772 #### Internal (protected) properties and methods renaming
774 These properties are not intended for end users
776 - `id` => `nextMessageId`
778 These methods are not intended for end users
780 - `_chooseWorker` => `chooseWorker`
781 - `_newWorker` => `createWorker`
782 - `_execute` => `internalExecute`
783 - `_chooseWorker` => `chooseWorker`
784 - `_checkAlive` => `checkAlive`
786 - `_runAsync` => `runAsync`
788 ## [1.1.0] - 2020-05-21
792 - ThreadWorker support async functions as option
793 - Various external library patches
795 ## [1.0.0] - 2020-01-24
799 - FixedThreadPool implementation
800 - DynamicThreadPool implementation
801 - WorkerThread implementation to improve developer experience