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.28] - 2023-08-16
14 - Ensure pool workers are properly initialized.
18 - HTTP server pool examples: express-cluster, express-hybrid.
22 - Remove now useless branching in worker hot code path.
24 ## [2.6.27] - 2023-08-15
28 - Add `KillHandler` type definition to exported types.
32 - Add `destroy` event to pool API.
34 ## [2.6.26] - 2023-08-15
38 - Add kill handler to worker options allowing to execute custom code when worker is killed.
39 - Add `listTaskFunctions()` method to pool API.
40 - SMTP server pool example: nodemailer.
42 ## [2.6.25] - 2023-08-13
46 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
47 - WebSocket server pool examples: ws-cluster, ws-hybrid.
49 ## [2.6.24] - 2023-08-12
53 - Add array of transferable objects to the `execute()` method arguments.
54 - WebSocket server pool examples: ws-worker_threads.
56 ## [2.6.23] - 2023-08-11
60 - 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.
64 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
65 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
67 ## [2.6.22] - 2023-08-10
71 - Add missing `types` field to package.json `exports`.
75 - Structure markdown documentation (PR #811).
77 ## [2.6.21] - 2023-08-03
81 - Improve code documentation.
82 - Code refactoring and cleanup for better maintainability and readability.
84 ## [2.6.20] - 2023-07-21
88 - Fix queued tasks redistribution on error task execution starvation.
89 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
93 - Drastically reduce lookups by worker in the worker nodes.
95 ## [2.6.19] - 2023-07-20
99 - Dedicated internal communication channel for worker_threads pools.
101 ## [2.6.18] - 2023-07-19
105 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
107 ## [2.6.17] - 2023-07-16
111 - Add `listTaskFunctions()` method to worker API.
113 ## [2.6.16] - 2023-07-12
117 - Fix pool startup detection.
118 - Fix worker task functions handling.
120 ## [2.6.15] - 2023-07-11
124 - Take into account worker node readiness in worker choice strategies.
126 ## [2.6.14] - 2023-07-10
130 - Fix task function statistics tracking.
132 ## [2.6.13] - 2023-07-10
136 - Add per task function statistics tracking.
137 - Add public methods to manipulate the worker task functions at runtime.
139 ## [2.6.12] - 2023-07-09
143 - Workaround import issue with `node:os` module in node 16.x.x.
145 ## [2.6.11] - 2023-07-09
149 - Fix pool readiness semantic.
151 ## [2.6.10] - 2023-07-08
155 - Ensure workers are not recreated on error at pool startup.
159 - Add `ready` and `strategy` fields to pool information.
160 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
161 - Add dynamic pool sizing checks.
163 ## [2.6.9] - 2023-07-07
167 - Recreate the right worker type on uncaught exception.
171 - Add minimum and maximum to internal measurement statistics.
172 - Add `runTime` and `waitTime` to pool information.
173 - Check worker inactive time only on dynamic worker.
175 ## [2.6.8] - 2023-07-03
179 - Brown paper bag release to fix version handling in pool information.
181 ## [2.6.7] - 2023-07-03
185 - Ensure worker queued tasks at error are reassigned to other pool workers.
189 - Add pool `utilization` ratio to pool information.
190 - Add `version` to pool information.
191 - Add worker information to worker nodes.
193 ## [2.6.6] - 2023-07-01
197 - Add safe helper `availableParallelism` to help sizing the pool.
201 - Ensure message handler is only registered in worker.
203 ## [2.6.5] - 2023-06-27
207 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
211 - Artificial version bump to 2.6.5 to workaround publication issue.
212 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
213 - Ensure pool event is emitted before task error promise rejection.
214 - Fix queued tasks count computation.
218 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
220 ## [2.6.4] - 2023-06-27
224 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
228 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
229 - Ensure pool event is emitted before task error promise rejection.
230 - Fix queued tasks count computation.
234 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
236 ## [2.6.3] - 2023-06-19
240 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
241 - Update strategies internals after statistics computation.
245 - Optimize O(1) queue implementation.
247 ## [2.6.2] - 2023-06-12
251 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
253 ## [2.6.1] - 2023-06-10
257 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
261 - Fix average statistics computation: ensure failed tasks are not accounted.
263 ## [2.6.0] - 2023-06-09
267 - Add `LEAST_ELU` worker choice strategy (experimental).
268 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
272 - Refactor pool worker node usage internals.
273 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
274 - Breaking change: pool information `info` property object fields have been renamed.
278 - Fix wait time accounting.
279 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
280 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
282 ## [2.5.4] - 2023-06-07
286 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
290 - Compute statistics at the worker level only if needed.
291 - Add `worker_threads` options to thread pool options.
295 - Make the `LEAST_BUSY` strategy only relies on task runtime.
297 ## [2.5.3] - 2023-06-04
301 - Refine pool information content.
302 - Limit pool internals public exposure.
304 ## [2.5.2] - 2023-06-02
308 - Add `taskError` pool event for task execution error.
309 - Add pool information `info` property to pool.
310 - Emit pool information on `busy` and `full` pool events.
312 ## [2.5.1] - 2023-06-01
316 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
317 - Add `error` pool event for uncaught worker error.
319 ## [2.5.0] - 2023-05-31
323 - Switch pool event emitter to `EventEmitterAsyncResource`.
324 - Add tasks wait time accounting in per worker tasks usage.
325 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
329 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
331 ## [2.4.14] - 2023-05-09
335 - Ensure no undefined task runtime can land in the tasks history.
336 - Fix median computation implementation once again.
340 - Unit tests for median and queue implementations.
342 ## [2.4.13] - 2023-05-08
346 - Fix worker choice strategy options validation.
347 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
349 ## [2.4.12] - 2023-05-06
353 - Support multiple task functions per worker.
354 - Add custom worker weights support to worker choice strategies options.
358 - Use O(1) queue implementation for tasks queueing.
362 - Fix median computation implementation.
363 - Fix fair share worker choice strategy internals update.
365 ## [2.4.11] - 2023-04-23
369 - Optimize free worker finding in worker choice strategies.
371 ## [2.4.10] - 2023-04-15
375 - Fix typescript type definition for task function: ensure the input data is optional.
376 - Fix typescript type definition for pool execute(): ensure the input data is optional.
378 ## [2.4.9] - 2023-04-15
382 - Add tasks queue enablement runtime setter to pool.
383 - Add tasks queue options runtime setter to pool.
384 - Add worker choice strategy options runtime setter to pool.
388 - Remove the tasks queuing experimental status.
392 - Fix task function type definition and validation.
393 - Fix worker choice strategy options handling.
395 ## [2.4.8] - 2023-04-12
399 - Fix message between main worker and worker type definition for tasks.
400 - Fix code documentation.
402 ## [2.4.7] - 2023-04-11
406 - Add worker tasks queue options to pool options.
410 - Fix missing documentation.
412 ## [2.4.6] - 2023-04-10
416 - Ensure one task at a time is executed per worker with tasks queueing enabled.
417 - Properly count worker executing tasks with tasks queueing enabled.
419 ## [2.4.5] - 2023-04-09
423 - Use monotonic high resolution timer for worker tasks runtime.
424 - Add worker tasks median runtime to statistics.
425 - Add worker tasks queue (experimental).
427 ## [2.4.4] - 2023-04-07
431 - Add `PoolEvents` enumeration and `PoolEvent` type.
435 - Destroy worker only on alive check.
437 ## [2.4.3] - 2023-04-07
441 - Fix typedoc generation with inheritance.
443 ## [2.4.2] - 2023-04-06
447 - Add `full` event to dynamic pool.
448 - Keep worker choice strategy in memory for conditional reuse.
452 - Fix possible negative worker key at worker removal in worker choice strategies.
454 ## [2.4.1] - 2023-04-05
458 - Optimize worker choice strategy for dynamic pool.
462 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
464 ## [2.4.0] - 2023-04-04
468 - Add `LESS_BUSY` worker choice strategy.
472 - Optimize worker storage in pool.
473 - Optimize worker alive status check.
474 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
475 - Optimize `LESS_USED` worker choice strategy.
476 - Update benchmarks versus external threads pools.
477 - Optimize tasks usage statistics requirements for worker choice strategy.
481 - Ensure trimmable characters are checked at pool initialization.
482 - Fix message id integer overflow.
483 - Fix pool worker removal in worker choice strategy internals.
484 - Fix package publication with pnpm.
486 ## [2.4.0-3] - 2023-04-04
490 - Add `LESS_BUSY` worker choice strategy.
494 - Optimize worker storage in pool.
495 - Optimize worker alive status check.
496 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
497 - Optimize `LESS_USED` worker choice strategy.
498 - Update benchmarks versus external threads pools.
502 - Ensure trimmable characters are checked at pool initialization.
503 - Fix message id integer overflow.
504 - Fix pool worker removal in worker choice strategy internals.
505 - Fix package publication with pnpm.
507 ## [2.4.0-2] - 2023-04-03
511 - Add `LESS_BUSY` worker choice strategy.
515 - Optimize worker storage in pool.
516 - Optimize worker alive status check.
517 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
518 - Optimize `LESS_USED` worker choice strategy.
522 - Ensure trimmable characters are checked at pool initialization.
523 - Fix message id integer overflow.
524 - Fix pool worker removal in worker choice strategy internals.
525 - Fix package publication with pnpm.
527 ## [2.4.0-1] - 2023-04-03
531 - Add `LESS_BUSY` worker choice strategy.
535 - Optimize worker storage in pool.
536 - Optimize worker alive status check.
537 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
538 - Optimize `LESS_USED` worker choice strategy.
542 - Ensure trimmable characters are checked at pool initialization.
543 - Fix message id integer overflow.
544 - Fix pool worker removal in worker choice strategy internals.
546 ## [2.4.0-0] - 2023-04-03
550 - Add `LESS_BUSY` worker choice strategy.
554 - Optimize worker storage in pool.
555 - Optimize worker alive status check.
556 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
557 - Optimize `LESS_USED` worker choice strategy.
561 - Ensure trimmable characters are checked at pool initialization.
562 - Fix message id integer overflow.
563 - Fix pool worker removal in worker choice strategy internals.
565 ## [2.3.10] - 2023-03-18
569 - Fix package.json `exports` syntax for ESM and CommonJS.
573 - Permit SemVer pre-release publication.
575 ## [2.3.10-2] - 2023-03-18
579 - Fix package.json `exports` syntax for ESM and CommonJS.
581 ## [2.3.10-1] - 2023-03-18
585 - Permit SemVer pre-release publication.
587 ## [2.3.10-0] - 2023-03-18
591 - Fix package.json `exports` syntax for ESM and CommonJS.
593 ## [2.3.9] - 2023-03-18
597 - Introduce ESM module support along with CommonJS one.
601 - Fix brown paper bag bug referencing the same object literal.
603 ## [2.3.8] - 2023-03-18
607 - Switch internal benchmarking code to benny.
608 - Switch to TypeScript 5.x.x.
609 - Switch rollup bundler plugins to core ones.
610 - Switch to TSDoc syntax.
611 - Enforce conventional commits.
615 - Fix random integer generator.
616 - Fix worker choice strategy pool type identification at initialization.
618 ## [2.3.7] - 2022-10-23
622 - Switch to open collective FOSS project funding platform.
623 - Switch to ts-standard linter configuration on TypeScript code.
627 - Fixed missing async on pool execute method.
628 - Fixed typing in TypeScript example.
629 - Fixed types in unit tests.
631 ## [2.3.6] - 2022-10-22
635 - Cleanup pool attributes and methods.
636 - Refine error types thrown.
640 - Fix continuous integration build on windows.
641 - Fix code coverage reporting by using c8 instead of nyc.
643 ## [2.3.5] - 2022-10-21
647 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
648 - Optimize tasks usage lookup implementation.
652 - Fix missed pool event emitter type export.
653 - Fix typedoc documentation generation.
655 ## [2.3.4] - 2022-10-17
659 - Fully automate release process with release-it.
663 - Optimize fair share task scheduling algorithm implementation.
664 - Update benchmarks versus external pools results with latest version.
666 ## [2.3.3] - 2022-10-15
670 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
672 ## [2.3.2] - 2022-10-14
676 - Optimize fair share worker selection strategy implementation.
680 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
682 ## [2.3.1] - 2022-10-13
686 - Pool worker choice strategies:
687 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
688 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
690 ## [2.2.2] - 2022-10-09
694 - Fixed `README.md` file.
696 ## [2.2.1] - 2022-10-08
700 - Dynamic worker choice strategy change at runtime.
702 ## [2.2.0] - 2022-01-05
706 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
708 ## [2.1.0] - 2021-08-29
712 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
716 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
717 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
718 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
719 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
721 ## [2.0.2] - 2021-05-12
725 - Fix `busy` event emission on fixed pool type
727 ## [2.0.1] - 2021-03-16
731 - Check if pool options are properly set.
732 - `busy` event is emitted on all pool types.
734 ## [2.0.0] - 2021-03-01
738 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
742 - `FullPool` event is now renamed to `busy`.
743 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
744 _Find more details on our JSDoc._
746 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
748 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
750 ### Pool options types declaration merge
752 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
754 #### New `export` strategy
758 const DynamicThreadPool = require('poolifier/lib/dynamic')
760 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
763 But you should always prefer just using
766 const { DynamicThreadPool } = require('poolifier')
769 #### New type definitions for input data and response
771 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
772 _This is not a limitation by poolifier but Node.js._
774 #### Public property replacements
776 `numWorkers` property is now `numberOfWorkers`
778 #### Internal (protected) properties and methods renaming
780 These properties are not intended for end users
782 - `id` => `nextMessageId`
784 These methods are not intended for end users
786 - `_chooseWorker` => `chooseWorker`
787 - `_newWorker` => `createWorker`
788 - `_execute` => `internalExecute`
789 - `_chooseWorker` => `chooseWorker`
790 - `_checkAlive` => `checkAlive`
792 - `_runAsync` => `runAsync`
794 ## [1.1.0] - 2020-05-21
798 - ThreadWorker support async functions as option
799 - Various external library patches
801 ## [1.0.0] - 2020-01-24
805 - FixedThreadPool implementation
806 - DynamicThreadPool implementation
807 - WorkerThread implementation to improve developer experience