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.20] - 2023-07-21
14 - Fix queued tasks redistribution on error task execution starvation.
15 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
19 - Drastically reduce lookups by worker in the worker nodes.
21 ## [2.6.19] - 2023-07-20
25 - Dedicated internal communication channel for worker_threads pools.
27 ## [2.6.18] - 2023-07-19
31 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
33 ## [2.6.17] - 2023-07-16
37 - Add `listTaskFunctions()` method to worker class.
39 ## [2.6.16] - 2023-07-12
43 - Fix pool startup detection.
44 - Fix worker task functions handling.
46 ## [2.6.15] - 2023-07-11
50 - Take into account worker node readiness in worker choice strategies.
52 ## [2.6.14] - 2023-07-10
56 - Fix task function statistics tracking.
58 ## [2.6.13] - 2023-07-10
62 - Add per task function statistics tracking.
63 - Add public methods to manipulate the worker task functions at runtime.
65 ## [2.6.12] - 2023-07-09
69 - Workaround import issue with `node:os` module in node 16.x.x.
71 ## [2.6.11] - 2023-07-09
75 - Fix pool readiness semantic.
77 ## [2.6.10] - 2023-07-08
81 - Ensure workers are not recreated on error at pool startup.
85 - Add `ready` and `strategy` fields to pool information.
86 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
87 - Add dynamic pool sizing checks.
89 ## [2.6.9] - 2023-07-07
93 - Recreate the right worker type on uncaught exception.
97 - Add minimum and maximum to internal measurement statistics.
98 - Add `runTime` and `waitTime` to pool information.
99 - Check worker inactive time only on dynamic worker.
101 ## [2.6.8] - 2023-07-03
105 - Brown paper bag release to fix version handling in pool information.
107 ## [2.6.7] - 2023-07-03
111 - Ensure worker queued tasks at error are reassigned to other pool workers.
115 - Add pool `utilization` ratio to pool information.
116 - Add `version` to pool information.
117 - Add worker information to worker nodes.
119 ## [2.6.6] - 2023-07-01
123 - Add safe helper `availableParallelism` to help sizing the pool.
127 - Ensure message handler is only registered in worker.
129 ## [2.6.5] - 2023-06-27
133 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
137 - Artificial version bump to 2.6.5 to workaround publication issue.
138 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
139 - Ensure pool event is emitted before task error promise rejection.
140 - Fix queued tasks count computation.
144 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
146 ## [2.6.4] - 2023-06-27
150 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
154 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
155 - Ensure pool event is emitted before task error promise rejection.
156 - Fix queued tasks count computation.
160 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
162 ## [2.6.3] - 2023-06-19
166 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
167 - Update strategies internals after statistics computation.
171 - Optimize O(1) queue implementation.
173 ## [2.6.2] - 2023-06-12
177 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
179 ## [2.6.1] - 2023-06-10
183 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
187 - Fix average statistics computation: ensure failed tasks are not accounted.
189 ## [2.6.0] - 2023-06-09
193 - Add `LEAST_ELU` worker choice strategy (experimental).
194 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
198 - Refactor pool worker node usage internals.
199 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
200 - Breaking change: pool information `info` property object fields have been renamed.
204 - Fix wait time accounting.
205 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
206 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
208 ## [2.5.4] - 2023-06-07
212 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
216 - Compute statistics at the worker level only if needed.
217 - Add `worker_threads` options to thread pool options.
221 - Make the `LEAST_BUSY` strategy only relies on task runtime.
223 ## [2.5.3] - 2023-06-04
227 - Refine pool information content.
228 - Limit pool internals public exposure.
230 ## [2.5.2] - 2023-06-02
234 - Add `taskError` pool event for task execution error.
235 - Add pool information `info` property to pool.
236 - Emit pool information on `busy` and `full` pool events.
238 ## [2.5.1] - 2023-06-01
242 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
243 - Add `error` pool event for uncaught worker error.
245 ## [2.5.0] - 2023-05-31
249 - Switch pool event emitter to `EventEmitterAsyncResource`.
250 - Add tasks wait time accounting in per worker tasks usage.
251 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
255 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
257 ## [2.4.14] - 2023-05-09
261 - Ensure no undefined task runtime can land in the tasks history.
262 - Fix median computation implementation once again.
266 - Unit tests for median and queue implementations.
268 ## [2.4.13] - 2023-05-08
272 - Fix worker choice strategy options validation.
273 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
275 ## [2.4.12] - 2023-05-06
279 - Support multiple task functions per worker.
280 - Add custom worker weights support to worker choice strategies options.
284 - Use O(1) queue implementation for tasks queueing.
288 - Fix median computation implementation.
289 - Fix fair share worker choice strategy internals update.
291 ## [2.4.11] - 2023-04-23
295 - Optimize free worker finding in worker choice strategies.
297 ## [2.4.10] - 2023-04-15
301 - Fix typescript type definition for worker function: ensure the input data is optional.
302 - Fix typescript type definition for pool execute(): ensure the input data is optional.
304 ## [2.4.9] - 2023-04-15
308 - Add tasks queue enablement runtime setter to pool.
309 - Add tasks queue options runtime setter to pool.
310 - Add worker choice strategy options runtime setter to pool.
314 - Remove the tasks queuing experimental status.
318 - Fix worker function type definition and validation.
319 - Fix worker choice strategy options handling.
321 ## [2.4.8] - 2023-04-12
325 - Fix message between main worker and worker type definition for tasks.
326 - Fix code documentation.
328 ## [2.4.7] - 2023-04-11
332 - Add worker tasks queue options to pool options.
336 - Fix missing documentation.
338 ## [2.4.6] - 2023-04-10
342 - Ensure one task at a time is executed per worker with tasks queueing enabled.
343 - Properly count worker executing tasks with tasks queueing enabled.
345 ## [2.4.5] - 2023-04-09
349 - Use monotonic high resolution timer for worker tasks runtime.
350 - Add worker tasks median runtime to statistics.
351 - Add worker tasks queue (experimental).
353 ## [2.4.4] - 2023-04-07
357 - Add `PoolEvents` enumeration and `PoolEvent` type.
361 - Destroy worker only on alive check.
363 ## [2.4.3] - 2023-04-07
367 - Fix typedoc generation with inheritance.
369 ## [2.4.2] - 2023-04-06
373 - Add `full` event to dynamic pool.
374 - Keep worker choice strategy in memory for conditional reuse.
378 - Fix possible negative worker key at worker removal in worker choice strategies.
380 ## [2.4.1] - 2023-04-05
384 - Optimize worker choice strategy for dynamic pool.
388 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
390 ## [2.4.0] - 2023-04-04
394 - Add `LESS_BUSY` worker choice strategy.
398 - Optimize worker storage in pool.
399 - Optimize worker alive status check.
400 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
401 - Optimize `LESS_USED` worker choice strategy.
402 - Update benchmarks versus external threads pools.
403 - Optimize tasks usage statistics requirements for worker choice strategy.
407 - Ensure trimmable characters are checked at pool initialization.
408 - Fix message id integer overflow.
409 - Fix pool worker removal in worker choice strategy internals.
410 - Fix package publication with pnpm.
412 ## [2.4.0-3] - 2023-04-04
416 - Add `LESS_BUSY` worker choice strategy.
420 - Optimize worker storage in pool.
421 - Optimize worker alive status check.
422 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
423 - Optimize `LESS_USED` worker choice strategy.
424 - Update benchmarks versus external threads pools.
428 - Ensure trimmable characters are checked at pool initialization.
429 - Fix message id integer overflow.
430 - Fix pool worker removal in worker choice strategy internals.
431 - Fix package publication with pnpm.
433 ## [2.4.0-2] - 2023-04-03
437 - Add `LESS_BUSY` worker choice strategy.
441 - Optimize worker storage in pool.
442 - Optimize worker alive status check.
443 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
444 - Optimize `LESS_USED` worker choice strategy.
448 - Ensure trimmable characters are checked at pool initialization.
449 - Fix message id integer overflow.
450 - Fix pool worker removal in worker choice strategy internals.
451 - Fix package publication with pnpm.
453 ## [2.4.0-1] - 2023-04-03
457 - Add `LESS_BUSY` worker choice strategy.
461 - Optimize worker storage in pool.
462 - Optimize worker alive status check.
463 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
464 - Optimize `LESS_USED` worker choice strategy.
468 - Ensure trimmable characters are checked at pool initialization.
469 - Fix message id integer overflow.
470 - Fix pool worker removal in worker choice strategy internals.
472 ## [2.4.0-0] - 2023-04-03
476 - Add `LESS_BUSY` worker choice strategy.
480 - Optimize worker storage in pool.
481 - Optimize worker alive status check.
482 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
483 - Optimize `LESS_USED` worker choice strategy.
487 - Ensure trimmable characters are checked at pool initialization.
488 - Fix message id integer overflow.
489 - Fix pool worker removal in worker choice strategy internals.
491 ## [2.3.10] - 2023-03-18
495 - Fix `exports` syntax for ESM and CommonJS.
499 - Permit SemVer pre-release publication.
501 ## [2.3.10-2] - 2023-03-18
505 - Fix `exports` syntax for ESM and CommonJS.
507 ## [2.3.10-1] - 2023-03-18
511 - Permit SemVer pre-release publication.
513 ## [2.3.10-0] - 2023-03-18
517 - Fix `exports` syntax for ESM and CommonJS.
519 ## [2.3.9] - 2023-03-18
523 - Introduce ESM module support along with CommonJS one.
527 - Fix brown paper bag bug referencing the same object literal.
529 ## [2.3.8] - 2023-03-18
533 - Switch internal benchmarking code to benny.
534 - Switch to TypeScript 5.x.x.
535 - Switch rollup bundler plugins to core ones.
536 - Switch to TSDoc syntax.
537 - Enforce conventional commits.
541 - Fix random integer generator.
542 - Fix worker choice strategy pool type identification at initialization.
544 ## [2.3.7] - 2022-10-23
548 - Switch to open collective FOSS project funding platform.
549 - Switch to ts-standard linter configuration on TypeScript code.
553 - Fixed missing async on pool execute method.
554 - Fixed typing in TypeScript example.
555 - Fixed types in unit tests.
557 ## [2.3.6] - 2022-10-22
561 - Cleanup pool attributes and methods.
562 - Refine error types thrown.
566 - Fix continuous integration build on windows.
567 - Fix code coverage reporting by using c8 instead of nyc.
569 ## [2.3.5] - 2022-10-21
573 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
574 - Optimize tasks usage lookup implementation.
578 - Fix missed pool event emitter type export.
579 - Fix typedoc documentation generation.
581 ## [2.3.4] - 2022-10-17
585 - Fully automate release process with release-it.
589 - Optimize fair share task scheduling algorithm implementation.
590 - Update benchmarks versus external pools results with latest version.
592 ## [2.3.3] - 2022-10-15
596 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
598 ## [2.3.2] - 2022-10-14
602 - Optimize fair share worker selection strategy implementation.
606 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
608 ## [2.3.1] - 2022-10-13
612 - Pool worker choice strategies:
613 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
614 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
616 ## [2.2.2] - 2022-10-09
620 - Fixed `README.md` file.
622 ## [2.2.1] - 2022-10-08
626 - Dynamic worker choice strategy change at runtime.
628 ## [2.2.0] - 2022-01-05
632 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
634 ## [2.1.0] - 2021-08-29
638 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
642 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
643 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
644 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
645 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
647 ## [2.0.2] - 2021-05-12
651 - Fix `busy` event emission on fixed pool type
653 ## [2.0.1] - 2021-03-16
657 - Check if pool options are properly set.
658 - `busy` event is emitted on all pool types.
660 ## [2.0.0] - 2021-03-01
664 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
668 - `FullPool` event is now renamed to `busy`.
669 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
670 _Find more details on our JSDoc._
672 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
674 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
676 ### Pool options types declaration merge
678 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
680 #### New `export` strategy
684 const DynamicThreadPool = require('poolifier/lib/dynamic')
686 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
689 But you should always prefer just using
692 const { DynamicThreadPool } = require('poolifier')
695 #### New type definitions for input data and response
697 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
698 _This is not a limitation by poolifier but NodeJS._
700 #### Public property replacements
702 `numWorkers` property is now `numberOfWorkers`
704 #### Internal (protected) properties and methods renaming
706 These properties are not intended for end users
708 - `id` => `nextMessageId`
710 These methods are not intended for end users
712 - `_chooseWorker` => `chooseWorker`
713 - `_newWorker` => `createWorker`
714 - `_execute` => `internalExecute`
715 - `_chooseWorker` => `chooseWorker`
716 - `_checkAlive` => `checkAlive`
718 - `_runAsync` => `runAsync`
720 ## [1.1.0] - 2020-05-21
724 - ThreadWorker support async functions as option
725 - Various external library patches
727 ## [1.0.0] - 2020-01-24
731 - FixedThreadPool implementation
732 - DynamicThreadPool implementation
733 - WorkerThread implementation to improve developer experience