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 - Fix worker choice strategy retries mechanism on some edge cases.
16 - Make orthogonal worker choice strategies tasks distribution and dynamic worker creation usage.
18 ## [2.6.30] - 2023-08-19
22 - Ensure pool event `backPressure` is emitted.
23 - Ensure pool event `full` is emitted only once.
24 - Ensure worker node cannot be instantiated without proper arguments.
26 ## [2.6.29] - 2023-08-18
30 - Fix race condition between ready and task functions worker message handling at startup.
31 - Fix duplicate task function worker usage statistics computation per task function.
32 - Update task function worker usage statistics if and only if there's at least two different task functions.
33 - Fix race condition at task function worker usage executing task computation leading to negative value.
37 - Add back pressure detection on the worker node queue. Event `backPressure` is emitted when all worker node queues are full (worker node queue size >= poolMaxSize^2).
38 - Use back pressure detection in worker choice strategies.
39 - Add worker choice strategies retries mechanism if no worker is eligible.
41 ## [2.6.28] - 2023-08-16
45 - Ensure pool workers are properly initialized.
49 - HTTP server pool examples: express-cluster, express-hybrid.
53 - Remove now useless branching in worker hot code path.
55 ## [2.6.27] - 2023-08-15
59 - Add `KillHandler` type definition to exported types.
63 - Add `destroy` event to pool API.
65 ## [2.6.26] - 2023-08-15
69 - Add kill handler to worker options allowing to execute custom code when worker is killed.
70 - Add `listTaskFunctions()` method to pool API.
71 - SMTP server pool example: nodemailer.
73 ## [2.6.25] - 2023-08-13
77 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
78 - WebSocket server pool examples: ws-cluster, ws-hybrid.
80 ## [2.6.24] - 2023-08-12
84 - Add array of transferable objects to the `execute()` method arguments.
85 - WebSocket server pool examples: ws-worker_threads.
87 ## [2.6.23] - 2023-08-11
91 - 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.
95 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
96 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
98 ## [2.6.22] - 2023-08-10
102 - Add missing `types` field to package.json `exports`.
106 - Structure markdown documentation (PR #811).
108 ## [2.6.21] - 2023-08-03
112 - Improve code documentation.
113 - Code refactoring and cleanup for better maintainability and readability.
115 ## [2.6.20] - 2023-07-21
119 - Fix queued tasks redistribution on error task execution starvation.
120 - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic.
124 - Drastically reduce lookups by worker in the worker nodes.
126 ## [2.6.19] - 2023-07-20
130 - Dedicated internal communication channel for worker_threads pools.
132 ## [2.6.18] - 2023-07-19
136 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
138 ## [2.6.17] - 2023-07-16
142 - Add `listTaskFunctions()` method to worker API.
144 ## [2.6.16] - 2023-07-12
148 - Fix pool startup detection.
149 - Fix worker task functions handling.
151 ## [2.6.15] - 2023-07-11
155 - Take into account worker node readiness in worker choice strategies.
157 ## [2.6.14] - 2023-07-10
161 - Fix task function statistics tracking.
163 ## [2.6.13] - 2023-07-10
167 - Add per task function statistics tracking.
168 - Add public methods to manipulate the worker task functions at runtime.
170 ## [2.6.12] - 2023-07-09
174 - Workaround import issue with `node:os` module in node 16.x.x.
176 ## [2.6.11] - 2023-07-09
180 - Fix pool readiness semantic.
182 ## [2.6.10] - 2023-07-08
186 - Ensure workers are not recreated on error at pool startup.
190 - Add `ready` and `strategy` fields to pool information.
191 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
192 - Add dynamic pool sizing checks.
194 ## [2.6.9] - 2023-07-07
198 - Recreate the right worker type on uncaught exception.
202 - Add minimum and maximum to internal measurement statistics.
203 - Add `runTime` and `waitTime` to pool information.
204 - Check worker inactive time only on dynamic worker.
206 ## [2.6.8] - 2023-07-03
210 - Brown paper bag release to fix version handling in pool information.
212 ## [2.6.7] - 2023-07-03
216 - Ensure worker queued tasks at error are reassigned to other pool workers.
220 - Add pool `utilization` ratio to pool information.
221 - Add `version` to pool information.
222 - Add worker information to worker nodes.
224 ## [2.6.6] - 2023-07-01
228 - Add safe helper `availableParallelism()` to help sizing the pool.
232 - Ensure message handler is only registered in worker.
234 ## [2.6.5] - 2023-06-27
238 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
242 - Artificial version bump to 2.6.5 to workaround publication issue.
243 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
244 - Ensure pool event is emitted before task error promise rejection.
245 - Fix queued tasks count computation.
249 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
251 ## [2.6.4] - 2023-06-27
255 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
259 - Ensure cluster pool `destroy()` gracefully shutdowns worker's server.
260 - Ensure pool event is emitted before task error promise rejection.
261 - Fix queued tasks count computation.
265 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
267 ## [2.6.3] - 2023-06-19
271 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
272 - Update strategies internals after statistics computation.
276 - Optimize O(1) queue implementation.
278 ## [2.6.2] - 2023-06-12
282 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
284 ## [2.6.1] - 2023-06-10
288 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
292 - Fix average statistics computation: ensure failed tasks are not accounted.
294 ## [2.6.0] - 2023-06-09
298 - Add `LEAST_ELU` worker choice strategy (experimental).
299 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
303 - Refactor pool worker node usage internals.
304 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
305 - Breaking change: pool information `info` property object fields have been renamed.
309 - Fix wait time accounting.
310 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
311 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
313 ## [2.5.4] - 2023-06-07
317 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
321 - Compute statistics at the worker level only if needed.
322 - Add `worker_threads` options to thread pool options.
326 - Make the `LEAST_BUSY` strategy only relies on task runtime.
328 ## [2.5.3] - 2023-06-04
332 - Refine pool information content.
333 - Limit pool internals public exposure.
335 ## [2.5.2] - 2023-06-02
339 - Add `taskError` pool event for task execution error.
340 - Add pool information `info` property to pool.
341 - Emit pool information on `busy` and `full` pool events.
343 ## [2.5.1] - 2023-06-01
347 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
348 - Add `error` pool event for uncaught worker error.
350 ## [2.5.0] - 2023-05-31
354 - Switch pool event emitter to `EventEmitterAsyncResource`.
355 - Add tasks wait time accounting in per worker tasks usage.
356 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
360 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
362 ## [2.4.14] - 2023-05-09
366 - Ensure no undefined task runtime can land in the tasks history.
367 - Fix median computation implementation once again.
371 - Unit tests for median and queue implementations.
373 ## [2.4.13] - 2023-05-08
377 - Fix worker choice strategy options validation.
378 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
380 ## [2.4.12] - 2023-05-06
384 - Support multiple task functions per worker.
385 - Add custom worker weights support to worker choice strategies options.
389 - Use O(1) queue implementation for tasks queueing.
393 - Fix median computation implementation.
394 - Fix fair share worker choice strategy internals update.
396 ## [2.4.11] - 2023-04-23
400 - Optimize free worker finding in worker choice strategies.
402 ## [2.4.10] - 2023-04-15
406 - Fix typescript type definition for task function: ensure the input data is optional.
407 - Fix typescript type definition for pool execute(): ensure the input data is optional.
409 ## [2.4.9] - 2023-04-15
413 - Add tasks queue enablement runtime setter to pool.
414 - Add tasks queue options runtime setter to pool.
415 - Add worker choice strategy options runtime setter to pool.
419 - Remove the tasks queuing experimental status.
423 - Fix task function type definition and validation.
424 - Fix worker choice strategy options handling.
426 ## [2.4.8] - 2023-04-12
430 - Fix message between main worker and worker type definition for tasks.
431 - Fix code documentation.
433 ## [2.4.7] - 2023-04-11
437 - Add worker tasks queue options to pool options.
441 - Fix missing documentation.
443 ## [2.4.6] - 2023-04-10
447 - Ensure one task at a time is executed per worker with tasks queueing enabled.
448 - Properly count worker executing tasks with tasks queueing enabled.
450 ## [2.4.5] - 2023-04-09
454 - Use monotonic high resolution timer for worker tasks runtime.
455 - Add worker tasks median runtime to statistics.
456 - Add worker tasks queue (experimental).
458 ## [2.4.4] - 2023-04-07
462 - Add `PoolEvents` enumeration and `PoolEvent` type.
466 - Destroy worker only on alive check.
468 ## [2.4.3] - 2023-04-07
472 - Fix typedoc generation with inheritance.
474 ## [2.4.2] - 2023-04-06
478 - Add `full` event to dynamic pool.
479 - Keep worker choice strategy in memory for conditional reuse.
483 - Fix possible negative worker key at worker removal in worker choice strategies.
485 ## [2.4.1] - 2023-04-05
489 - Optimize worker choice strategy for dynamic pool.
493 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
495 ## [2.4.0] - 2023-04-04
499 - Add `LESS_BUSY` worker choice strategy.
503 - Optimize worker storage in pool.
504 - Optimize worker alive status check.
505 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
506 - Optimize `LESS_USED` worker choice strategy.
507 - Update benchmarks versus external threads pools.
508 - Optimize tasks usage statistics requirements for worker choice strategy.
512 - Ensure trimmable characters are checked at pool initialization.
513 - Fix message id integer overflow.
514 - Fix pool worker removal in worker choice strategy internals.
515 - Fix package publication with pnpm.
517 ## [2.4.0-3] - 2023-04-04
521 - Add `LESS_BUSY` worker choice strategy.
525 - Optimize worker storage in pool.
526 - Optimize worker alive status check.
527 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
528 - Optimize `LESS_USED` worker choice strategy.
529 - Update benchmarks versus external threads pools.
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.
536 - Fix package publication with pnpm.
538 ## [2.4.0-2] - 2023-04-03
542 - Add `LESS_BUSY` worker choice strategy.
546 - Optimize worker storage in pool.
547 - Optimize worker alive status check.
548 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
549 - Optimize `LESS_USED` worker choice strategy.
553 - Ensure trimmable characters are checked at pool initialization.
554 - Fix message id integer overflow.
555 - Fix pool worker removal in worker choice strategy internals.
556 - Fix package publication with pnpm.
558 ## [2.4.0-1] - 2023-04-03
562 - Add `LESS_BUSY` worker choice strategy.
566 - Optimize worker storage in pool.
567 - Optimize worker alive status check.
568 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
569 - Optimize `LESS_USED` worker choice strategy.
573 - Ensure trimmable characters are checked at pool initialization.
574 - Fix message id integer overflow.
575 - Fix pool worker removal in worker choice strategy internals.
577 ## [2.4.0-0] - 2023-04-03
581 - Add `LESS_BUSY` worker choice strategy.
585 - Optimize worker storage in pool.
586 - Optimize worker alive status check.
587 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
588 - Optimize `LESS_USED` worker choice strategy.
592 - Ensure trimmable characters are checked at pool initialization.
593 - Fix message id integer overflow.
594 - Fix pool worker removal in worker choice strategy internals.
596 ## [2.3.10] - 2023-03-18
600 - Fix package.json `exports` syntax for ESM and CommonJS.
604 - Permit SemVer pre-release publication.
606 ## [2.3.10-2] - 2023-03-18
610 - Fix package.json `exports` syntax for ESM and CommonJS.
612 ## [2.3.10-1] - 2023-03-18
616 - Permit SemVer pre-release publication.
618 ## [2.3.10-0] - 2023-03-18
622 - Fix package.json `exports` syntax for ESM and CommonJS.
624 ## [2.3.9] - 2023-03-18
628 - Introduce ESM module support along with CommonJS one.
632 - Fix brown paper bag bug referencing the same object literal.
634 ## [2.3.8] - 2023-03-18
638 - Switch internal benchmarking code to benny.
639 - Switch to TypeScript 5.x.x.
640 - Switch rollup bundler plugins to core ones.
641 - Switch to TSDoc syntax.
642 - Enforce conventional commits.
646 - Fix random integer generator.
647 - Fix worker choice strategy pool type identification at initialization.
649 ## [2.3.7] - 2022-10-23
653 - Switch to open collective FOSS project funding platform.
654 - Switch to ts-standard linter configuration on TypeScript code.
658 - Fixed missing async on pool execute method.
659 - Fixed typing in TypeScript example.
660 - Fixed types in unit tests.
662 ## [2.3.6] - 2022-10-22
666 - Cleanup pool attributes and methods.
667 - Refine error types thrown.
671 - Fix continuous integration build on windows.
672 - Fix code coverage reporting by using c8 instead of nyc.
674 ## [2.3.5] - 2022-10-21
678 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
679 - Optimize tasks usage lookup implementation.
683 - Fix missed pool event emitter type export.
684 - Fix typedoc documentation generation.
686 ## [2.3.4] - 2022-10-17
690 - Fully automate release process with release-it.
694 - Optimize fair share task scheduling algorithm implementation.
695 - Update benchmarks versus external pools results with latest version.
697 ## [2.3.3] - 2022-10-15
701 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
703 ## [2.3.2] - 2022-10-14
707 - Optimize fair share worker selection strategy implementation.
711 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
713 ## [2.3.1] - 2022-10-13
717 - Pool worker choice strategies:
718 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
719 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
721 ## [2.2.2] - 2022-10-09
725 - Fixed `README.md` file.
727 ## [2.2.1] - 2022-10-08
731 - Dynamic worker choice strategy change at runtime.
733 ## [2.2.0] - 2022-01-05
737 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
739 ## [2.1.0] - 2021-08-29
743 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
747 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
748 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
749 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
750 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
752 ## [2.0.2] - 2021-05-12
756 - Fix `busy` event emission on fixed pool type
758 ## [2.0.1] - 2021-03-16
762 - Check if pool options are properly set.
763 - `busy` event is emitted on all pool types.
765 ## [2.0.0] - 2021-03-01
769 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
773 - `FullPool` event is now renamed to `busy`.
774 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
775 _Find more details on our JSDoc._
777 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
779 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
781 ### Pool options types declaration merge
783 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
785 #### New `export` strategy
789 const DynamicThreadPool = require('poolifier/lib/dynamic')
791 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
794 But you should always prefer just using
797 const { DynamicThreadPool } = require('poolifier')
800 #### New type definitions for input data and response
802 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
803 _This is not a limitation by poolifier but Node.js._
805 #### Public property replacements
807 `numWorkers` property is now `numberOfWorkers`
809 #### Internal (protected) properties and methods renaming
811 These properties are not intended for end users
813 - `id` => `nextMessageId`
815 These methods are not intended for end users
817 - `_chooseWorker` => `chooseWorker`
818 - `_newWorker` => `createWorker`
819 - `_execute` => `internalExecute`
820 - `_chooseWorker` => `chooseWorker`
821 - `_checkAlive` => `checkAlive`
823 - `_runAsync` => `runAsync`
825 ## [1.1.0] - 2020-05-21
829 - ThreadWorker support async functions as option
830 - Various external library patches
832 ## [1.0.0] - 2020-01-24
836 - FixedThreadPool implementation
837 - DynamicThreadPool implementation
838 - WorkerThread implementation to improve developer experience