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.
14 ## [2.6.25] - 2023-08-13
18 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
19 - WebSocket server pool examples: ws-cluster, ws-hybrid.
21 ## [2.6.24] - 2023-08-12
25 - Add array of transferable objects to the `execute()` method arguments.
26 - WebSocket server pool examples: ws-worker_threads.
28 ## [2.6.23] - 2023-08-11
32 - 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.
36 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
37 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
39 ## [2.6.22] - 2023-08-10
43 - Add missing `types` field to package.json `exports`.
47 - Structure markdown documentation (PR #811).
49 ## [2.6.21] - 2023-08-03
53 - Improve code documentation.
54 - Code refactoring and cleanup for better maintainability and readability.
56 ## [2.6.20] - 2023-07-21
60 - Fix queued tasks redistribution on error task execution starvation.
61 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
65 - Drastically reduce lookups by worker in the worker nodes.
67 ## [2.6.19] - 2023-07-20
71 - Dedicated internal communication channel for worker_threads pools.
73 ## [2.6.18] - 2023-07-19
77 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
79 ## [2.6.17] - 2023-07-16
83 - Add `listTaskFunctions()` method to worker class.
85 ## [2.6.16] - 2023-07-12
89 - Fix pool startup detection.
90 - Fix worker task functions handling.
92 ## [2.6.15] - 2023-07-11
96 - Take into account worker node readiness in worker choice strategies.
98 ## [2.6.14] - 2023-07-10
102 - Fix task function statistics tracking.
104 ## [2.6.13] - 2023-07-10
108 - Add per task function statistics tracking.
109 - Add public methods to manipulate the worker task functions at runtime.
111 ## [2.6.12] - 2023-07-09
115 - Workaround import issue with `node:os` module in node 16.x.x.
117 ## [2.6.11] - 2023-07-09
121 - Fix pool readiness semantic.
123 ## [2.6.10] - 2023-07-08
127 - Ensure workers are not recreated on error at pool startup.
131 - Add `ready` and `strategy` fields to pool information.
132 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
133 - Add dynamic pool sizing checks.
135 ## [2.6.9] - 2023-07-07
139 - Recreate the right worker type on uncaught exception.
143 - Add minimum and maximum to internal measurement statistics.
144 - Add `runTime` and `waitTime` to pool information.
145 - Check worker inactive time only on dynamic worker.
147 ## [2.6.8] - 2023-07-03
151 - Brown paper bag release to fix version handling in pool information.
153 ## [2.6.7] - 2023-07-03
157 - Ensure worker queued tasks at error are reassigned to other pool workers.
161 - Add pool `utilization` ratio to pool information.
162 - Add `version` to pool information.
163 - Add worker information to worker nodes.
165 ## [2.6.6] - 2023-07-01
169 - Add safe helper `availableParallelism` to help sizing the pool.
173 - Ensure message handler is only registered in worker.
175 ## [2.6.5] - 2023-06-27
179 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
183 - Artificial version bump to 2.6.5 to workaround publication issue.
184 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
185 - Ensure pool event is emitted before task error promise rejection.
186 - Fix queued tasks count computation.
190 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
192 ## [2.6.4] - 2023-06-27
196 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
200 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
201 - Ensure pool event is emitted before task error promise rejection.
202 - Fix queued tasks count computation.
206 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
208 ## [2.6.3] - 2023-06-19
212 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
213 - Update strategies internals after statistics computation.
217 - Optimize O(1) queue implementation.
219 ## [2.6.2] - 2023-06-12
223 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
225 ## [2.6.1] - 2023-06-10
229 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
233 - Fix average statistics computation: ensure failed tasks are not accounted.
235 ## [2.6.0] - 2023-06-09
239 - Add `LEAST_ELU` worker choice strategy (experimental).
240 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
244 - Refactor pool worker node usage internals.
245 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
246 - Breaking change: pool information `info` property object fields have been renamed.
250 - Fix wait time accounting.
251 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
252 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
254 ## [2.5.4] - 2023-06-07
258 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
262 - Compute statistics at the worker level only if needed.
263 - Add `worker_threads` options to thread pool options.
267 - Make the `LEAST_BUSY` strategy only relies on task runtime.
269 ## [2.5.3] - 2023-06-04
273 - Refine pool information content.
274 - Limit pool internals public exposure.
276 ## [2.5.2] - 2023-06-02
280 - Add `taskError` pool event for task execution error.
281 - Add pool information `info` property to pool.
282 - Emit pool information on `busy` and `full` pool events.
284 ## [2.5.1] - 2023-06-01
288 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
289 - Add `error` pool event for uncaught worker error.
291 ## [2.5.0] - 2023-05-31
295 - Switch pool event emitter to `EventEmitterAsyncResource`.
296 - Add tasks wait time accounting in per worker tasks usage.
297 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
301 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
303 ## [2.4.14] - 2023-05-09
307 - Ensure no undefined task runtime can land in the tasks history.
308 - Fix median computation implementation once again.
312 - Unit tests for median and queue implementations.
314 ## [2.4.13] - 2023-05-08
318 - Fix worker choice strategy options validation.
319 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
321 ## [2.4.12] - 2023-05-06
325 - Support multiple task functions per worker.
326 - Add custom worker weights support to worker choice strategies options.
330 - Use O(1) queue implementation for tasks queueing.
334 - Fix median computation implementation.
335 - Fix fair share worker choice strategy internals update.
337 ## [2.4.11] - 2023-04-23
341 - Optimize free worker finding in worker choice strategies.
343 ## [2.4.10] - 2023-04-15
347 - Fix typescript type definition for task function: ensure the input data is optional.
348 - Fix typescript type definition for pool execute(): ensure the input data is optional.
350 ## [2.4.9] - 2023-04-15
354 - Add tasks queue enablement runtime setter to pool.
355 - Add tasks queue options runtime setter to pool.
356 - Add worker choice strategy options runtime setter to pool.
360 - Remove the tasks queuing experimental status.
364 - Fix task function type definition and validation.
365 - Fix worker choice strategy options handling.
367 ## [2.4.8] - 2023-04-12
371 - Fix message between main worker and worker type definition for tasks.
372 - Fix code documentation.
374 ## [2.4.7] - 2023-04-11
378 - Add worker tasks queue options to pool options.
382 - Fix missing documentation.
384 ## [2.4.6] - 2023-04-10
388 - Ensure one task at a time is executed per worker with tasks queueing enabled.
389 - Properly count worker executing tasks with tasks queueing enabled.
391 ## [2.4.5] - 2023-04-09
395 - Use monotonic high resolution timer for worker tasks runtime.
396 - Add worker tasks median runtime to statistics.
397 - Add worker tasks queue (experimental).
399 ## [2.4.4] - 2023-04-07
403 - Add `PoolEvents` enumeration and `PoolEvent` type.
407 - Destroy worker only on alive check.
409 ## [2.4.3] - 2023-04-07
413 - Fix typedoc generation with inheritance.
415 ## [2.4.2] - 2023-04-06
419 - Add `full` event to dynamic pool.
420 - Keep worker choice strategy in memory for conditional reuse.
424 - Fix possible negative worker key at worker removal in worker choice strategies.
426 ## [2.4.1] - 2023-04-05
430 - Optimize worker choice strategy for dynamic pool.
434 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
436 ## [2.4.0] - 2023-04-04
440 - Add `LESS_BUSY` worker choice strategy.
444 - Optimize worker storage in pool.
445 - Optimize worker alive status check.
446 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
447 - Optimize `LESS_USED` worker choice strategy.
448 - Update benchmarks versus external threads pools.
449 - Optimize tasks usage statistics requirements for worker choice strategy.
453 - Ensure trimmable characters are checked at pool initialization.
454 - Fix message id integer overflow.
455 - Fix pool worker removal in worker choice strategy internals.
456 - Fix package publication with pnpm.
458 ## [2.4.0-3] - 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.
474 - Ensure trimmable characters are checked at pool initialization.
475 - Fix message id integer overflow.
476 - Fix pool worker removal in worker choice strategy internals.
477 - Fix package publication with pnpm.
479 ## [2.4.0-2] - 2023-04-03
483 - Add `LESS_BUSY` worker choice strategy.
487 - Optimize worker storage in pool.
488 - Optimize worker alive status check.
489 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
490 - Optimize `LESS_USED` worker choice strategy.
494 - Ensure trimmable characters are checked at pool initialization.
495 - Fix message id integer overflow.
496 - Fix pool worker removal in worker choice strategy internals.
497 - Fix package publication with pnpm.
499 ## [2.4.0-1] - 2023-04-03
503 - Add `LESS_BUSY` worker choice strategy.
507 - Optimize worker storage in pool.
508 - Optimize worker alive status check.
509 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
510 - Optimize `LESS_USED` worker choice strategy.
514 - Ensure trimmable characters are checked at pool initialization.
515 - Fix message id integer overflow.
516 - Fix pool worker removal in worker choice strategy internals.
518 ## [2.4.0-0] - 2023-04-03
522 - Add `LESS_BUSY` worker choice strategy.
526 - Optimize worker storage in pool.
527 - Optimize worker alive status check.
528 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
529 - Optimize `LESS_USED` worker choice strategy.
533 - Ensure trimmable characters are checked at pool initialization.
534 - Fix message id integer overflow.
535 - Fix pool worker removal in worker choice strategy internals.
537 ## [2.3.10] - 2023-03-18
541 - Fix package.json `exports` syntax for ESM and CommonJS.
545 - Permit SemVer pre-release publication.
547 ## [2.3.10-2] - 2023-03-18
551 - Fix package.json `exports` syntax for ESM and CommonJS.
553 ## [2.3.10-1] - 2023-03-18
557 - Permit SemVer pre-release publication.
559 ## [2.3.10-0] - 2023-03-18
563 - Fix package.json `exports` syntax for ESM and CommonJS.
565 ## [2.3.9] - 2023-03-18
569 - Introduce ESM module support along with CommonJS one.
573 - Fix brown paper bag bug referencing the same object literal.
575 ## [2.3.8] - 2023-03-18
579 - Switch internal benchmarking code to benny.
580 - Switch to TypeScript 5.x.x.
581 - Switch rollup bundler plugins to core ones.
582 - Switch to TSDoc syntax.
583 - Enforce conventional commits.
587 - Fix random integer generator.
588 - Fix worker choice strategy pool type identification at initialization.
590 ## [2.3.7] - 2022-10-23
594 - Switch to open collective FOSS project funding platform.
595 - Switch to ts-standard linter configuration on TypeScript code.
599 - Fixed missing async on pool execute method.
600 - Fixed typing in TypeScript example.
601 - Fixed types in unit tests.
603 ## [2.3.6] - 2022-10-22
607 - Cleanup pool attributes and methods.
608 - Refine error types thrown.
612 - Fix continuous integration build on windows.
613 - Fix code coverage reporting by using c8 instead of nyc.
615 ## [2.3.5] - 2022-10-21
619 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
620 - Optimize tasks usage lookup implementation.
624 - Fix missed pool event emitter type export.
625 - Fix typedoc documentation generation.
627 ## [2.3.4] - 2022-10-17
631 - Fully automate release process with release-it.
635 - Optimize fair share task scheduling algorithm implementation.
636 - Update benchmarks versus external pools results with latest version.
638 ## [2.3.3] - 2022-10-15
642 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
644 ## [2.3.2] - 2022-10-14
648 - Optimize fair share worker selection strategy implementation.
652 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
654 ## [2.3.1] - 2022-10-13
658 - Pool worker choice strategies:
659 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
660 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
662 ## [2.2.2] - 2022-10-09
666 - Fixed `README.md` file.
668 ## [2.2.1] - 2022-10-08
672 - Dynamic worker choice strategy change at runtime.
674 ## [2.2.0] - 2022-01-05
678 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
680 ## [2.1.0] - 2021-08-29
684 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
688 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
689 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
690 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
691 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
693 ## [2.0.2] - 2021-05-12
697 - Fix `busy` event emission on fixed pool type
699 ## [2.0.1] - 2021-03-16
703 - Check if pool options are properly set.
704 - `busy` event is emitted on all pool types.
706 ## [2.0.0] - 2021-03-01
710 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
714 - `FullPool` event is now renamed to `busy`.
715 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
716 _Find more details on our JSDoc._
718 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
720 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
722 ### Pool options types declaration merge
724 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
726 #### New `export` strategy
730 const DynamicThreadPool = require('poolifier/lib/dynamic')
732 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
735 But you should always prefer just using
738 const { DynamicThreadPool } = require('poolifier')
741 #### New type definitions for input data and response
743 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
744 _This is not a limitation by poolifier but Node.js._
746 #### Public property replacements
748 `numWorkers` property is now `numberOfWorkers`
750 #### Internal (protected) properties and methods renaming
752 These properties are not intended for end users
754 - `id` => `nextMessageId`
756 These methods are not intended for end users
758 - `_chooseWorker` => `chooseWorker`
759 - `_newWorker` => `createWorker`
760 - `_execute` => `internalExecute`
761 - `_chooseWorker` => `chooseWorker`
762 - `_checkAlive` => `checkAlive`
764 - `_runAsync` => `runAsync`
766 ## [1.1.0] - 2020-05-21
770 - ThreadWorker support async functions as option
771 - Various external library patches
773 ## [1.0.0] - 2020-01-24
777 - FixedThreadPool implementation
778 - DynamicThreadPool implementation
779 - WorkerThread implementation to improve developer experience