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 queued tasks redistribution on error task execution starvation.
13 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
17 - Drastically reduce lookups by worker in the worker nodes.
19 ## [2.6.19] - 2023-07-20
23 - Dedicated internal communication channel for worker_threads pools.
25 ## [2.6.18] - 2023-07-19
29 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
31 ## [2.6.17] - 2023-07-16
35 - Add `listTaskFunctions()` method to worker class.
37 ## [2.6.16] - 2023-07-12
41 - Fix pool startup detection.
42 - Fix worker task functions handling.
44 ## [2.6.15] - 2023-07-11
48 - Take into account worker node readiness in worker choice strategies.
50 ## [2.6.14] - 2023-07-10
54 - Fix task function statistics tracking.
56 ## [2.6.13] - 2023-07-10
60 - Add per task function statistics tracking.
61 - Add public methods to manipulate the worker task functions at runtime.
63 ## [2.6.12] - 2023-07-09
67 - Workaround import issue with `node:os` module in node 16.x.x.
69 ## [2.6.11] - 2023-07-09
73 - Fix pool readiness semantic.
75 ## [2.6.10] - 2023-07-08
79 - Ensure workers are not recreated on error at pool startup.
83 - Add `ready` and `strategy` fields to pool information.
84 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
85 - Add dynamic pool sizing checks.
87 ## [2.6.9] - 2023-07-07
91 - Recreate the right worker type on uncaught exception.
95 - Add minimum and maximum to internal measurement statistics.
96 - Add `runTime` and `waitTime` to pool information.
97 - Check worker inactive time only on dynamic worker.
99 ## [2.6.8] - 2023-07-03
103 - Brown paper bag release to fix version handling in pool information.
105 ## [2.6.7] - 2023-07-03
109 - Ensure worker queued tasks at error are reassigned to other pool workers.
113 - Add pool `utilization` ratio to pool information.
114 - Add `version` to pool information.
115 - Add worker information to worker nodes.
117 ## [2.6.6] - 2023-07-01
121 - Add safe helper `availableParallelism` to help sizing the pool.
125 - Ensure message handler is only registered in worker.
127 ## [2.6.5] - 2023-06-27
131 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
135 - Artificial version bump to 2.6.5 to workaround publication issue.
136 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
137 - Ensure pool event is emitted before task error promise rejection.
138 - Fix queued tasks count computation.
142 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
144 ## [2.6.4] - 2023-06-27
148 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
152 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
153 - Ensure pool event is emitted before task error promise rejection.
154 - Fix queued tasks count computation.
158 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
160 ## [2.6.3] - 2023-06-19
164 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
165 - Update strategies internals after statistics computation.
169 - Optimize O(1) queue implementation.
171 ## [2.6.2] - 2023-06-12
175 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
177 ## [2.6.1] - 2023-06-10
181 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
185 - Fix average statistics computation: ensure failed tasks are not accounted.
187 ## [2.6.0] - 2023-06-09
191 - Add `LEAST_ELU` worker choice strategy (experimental).
192 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
196 - Refactor pool worker node usage internals.
197 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
198 - Breaking change: pool information `info` property object fields have been renamed.
202 - Fix wait time accounting.
203 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
204 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
206 ## [2.5.4] - 2023-06-07
210 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
214 - Compute statistics at the worker level only if needed.
215 - Add `worker_threads` options to thread pool options.
219 - Make the `LEAST_BUSY` strategy only relies on task runtime.
221 ## [2.5.3] - 2023-06-04
225 - Refine pool information content.
226 - Limit pool internals public exposure.
228 ## [2.5.2] - 2023-06-02
232 - Add `taskError` pool event for task execution error.
233 - Add pool information `info` property to pool.
234 - Emit pool information on `busy` and `full` pool events.
236 ## [2.5.1] - 2023-06-01
240 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
241 - Add `error` pool event for uncaught worker error.
243 ## [2.5.0] - 2023-05-31
247 - Switch pool event emitter to `EventEmitterAsyncResource`.
248 - Add tasks wait time accounting in per worker tasks usage.
249 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
253 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
255 ## [2.4.14] - 2023-05-09
259 - Ensure no undefined task runtime can land in the tasks history.
260 - Fix median computation implementation once again.
264 - Unit tests for median and queue implementations.
266 ## [2.4.13] - 2023-05-08
270 - Fix worker choice strategy options validation.
271 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
273 ## [2.4.12] - 2023-05-06
277 - Support multiple task functions per worker.
278 - Add custom worker weights support to worker choice strategies options.
282 - Use O(1) queue implementation for tasks queueing.
286 - Fix median computation implementation.
287 - Fix fair share worker choice strategy internals update.
289 ## [2.4.11] - 2023-04-23
293 - Optimize free worker finding in worker choice strategies.
295 ## [2.4.10] - 2023-04-15
299 - Fix typescript type definition for worker function: ensure the input data is optional.
300 - Fix typescript type definition for pool execute(): ensure the input data is optional.
302 ## [2.4.9] - 2023-04-15
306 - Add tasks queue enablement runtime setter to pool.
307 - Add tasks queue options runtime setter to pool.
308 - Add worker choice strategy options runtime setter to pool.
312 - Remove the tasks queuing experimental status.
316 - Fix worker function type definition and validation.
317 - Fix worker choice strategy options handling.
319 ## [2.4.8] - 2023-04-12
323 - Fix message between main worker and worker type definition for tasks.
324 - Fix code documentation.
326 ## [2.4.7] - 2023-04-11
330 - Add worker tasks queue options to pool options.
334 - Fix missing documentation.
336 ## [2.4.6] - 2023-04-10
340 - Ensure one task at a time is executed per worker with tasks queueing enabled.
341 - Properly count worker executing tasks with tasks queueing enabled.
343 ## [2.4.5] - 2023-04-09
347 - Use monotonic high resolution timer for worker tasks runtime.
348 - Add worker tasks median runtime to statistics.
349 - Add worker tasks queue (experimental).
351 ## [2.4.4] - 2023-04-07
355 - Add `PoolEvents` enumeration and `PoolEvent` type.
359 - Destroy worker only on alive check.
361 ## [2.4.3] - 2023-04-07
365 - Fix typedoc generation with inheritance.
367 ## [2.4.2] - 2023-04-06
371 - Add `full` event to dynamic pool.
372 - Keep worker choice strategy in memory for conditional reuse.
376 - Fix possible negative worker key at worker removal in worker choice strategies.
378 ## [2.4.1] - 2023-04-05
382 - Optimize worker choice strategy for dynamic pool.
386 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
388 ## [2.4.0] - 2023-04-04
392 - Add `LESS_BUSY` worker choice strategy.
396 - Optimize worker storage in pool.
397 - Optimize worker alive status check.
398 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
399 - Optimize `LESS_USED` worker choice strategy.
400 - Update benchmarks versus external threads pools.
401 - Optimize tasks usage statistics requirements for worker choice strategy.
405 - Ensure trimmable characters are checked at pool initialization.
406 - Fix message id integer overflow.
407 - Fix pool worker removal in worker choice strategy internals.
408 - Fix package publication with pnpm.
410 ## [2.4.0-3] - 2023-04-04
414 - Add `LESS_BUSY` worker choice strategy.
418 - Optimize worker storage in pool.
419 - Optimize worker alive status check.
420 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
421 - Optimize `LESS_USED` worker choice strategy.
422 - Update benchmarks versus external threads pools.
426 - Ensure trimmable characters are checked at pool initialization.
427 - Fix message id integer overflow.
428 - Fix pool worker removal in worker choice strategy internals.
429 - Fix package publication with pnpm.
431 ## [2.4.0-2] - 2023-04-03
435 - Add `LESS_BUSY` worker choice strategy.
439 - Optimize worker storage in pool.
440 - Optimize worker alive status check.
441 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
442 - Optimize `LESS_USED` worker choice strategy.
446 - Ensure trimmable characters are checked at pool initialization.
447 - Fix message id integer overflow.
448 - Fix pool worker removal in worker choice strategy internals.
449 - Fix package publication with pnpm.
451 ## [2.4.0-1] - 2023-04-03
455 - Add `LESS_BUSY` worker choice strategy.
459 - Optimize worker storage in pool.
460 - Optimize worker alive status check.
461 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
462 - Optimize `LESS_USED` worker choice strategy.
466 - Ensure trimmable characters are checked at pool initialization.
467 - Fix message id integer overflow.
468 - Fix pool worker removal in worker choice strategy internals.
470 ## [2.4.0-0] - 2023-04-03
474 - Add `LESS_BUSY` worker choice strategy.
478 - Optimize worker storage in pool.
479 - Optimize worker alive status check.
480 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
481 - Optimize `LESS_USED` worker choice strategy.
485 - Ensure trimmable characters are checked at pool initialization.
486 - Fix message id integer overflow.
487 - Fix pool worker removal in worker choice strategy internals.
489 ## [2.3.10] - 2023-03-18
493 - Fix `exports` syntax for ESM and CommonJS.
497 - Permit SemVer pre-release publication.
499 ## [2.3.10-2] - 2023-03-18
503 - Fix `exports` syntax for ESM and CommonJS.
505 ## [2.3.10-1] - 2023-03-18
509 - Permit SemVer pre-release publication.
511 ## [2.3.10-0] - 2023-03-18
515 - Fix `exports` syntax for ESM and CommonJS.
517 ## [2.3.9] - 2023-03-18
521 - Introduce ESM module support along with CommonJS one.
525 - Fix brown paper bag bug referencing the same object literal.
527 ## [2.3.8] - 2023-03-18
531 - Switch internal benchmarking code to benny.
532 - Switch to TypeScript 5.x.x.
533 - Switch rollup bundler plugins to core ones.
534 - Switch to TSDoc syntax.
535 - Enforce conventional commits.
539 - Fix random integer generator.
540 - Fix worker choice strategy pool type identification at initialization.
542 ## [2.3.7] - 2022-10-23
546 - Switch to open collective FOSS project funding platform.
547 - Switch to ts-standard linter configuration on TypeScript code.
551 - Fixed missing async on pool execute method.
552 - Fixed typing in TypeScript example.
553 - Fixed types in unit tests.
555 ## [2.3.6] - 2022-10-22
559 - Cleanup pool attributes and methods.
560 - Refine error types thrown.
564 - Fix continuous integration build on windows.
565 - Fix code coverage reporting by using c8 instead of nyc.
567 ## [2.3.5] - 2022-10-21
571 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
572 - Optimize tasks usage lookup implementation.
576 - Fix missed pool event emitter type export.
577 - Fix typedoc documentation generation.
579 ## [2.3.4] - 2022-10-17
583 - Fully automate release process with release-it.
587 - Optimize fair share task scheduling algorithm implementation.
588 - Update benchmarks versus external pools results with latest version.
590 ## [2.3.3] - 2022-10-15
594 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
596 ## [2.3.2] - 2022-10-14
600 - Optimize fair share worker selection strategy implementation.
604 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
606 ## [2.3.1] - 2022-10-13
610 - Pool worker choice strategies:
611 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
612 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
614 ## [2.2.2] - 2022-10-09
618 - Fixed `README.md` file.
620 ## [2.2.1] - 2022-10-08
624 - Dynamic worker choice strategy change at runtime.
626 ## [2.2.0] - 2022-01-05
630 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
632 ## [2.1.0] - 2021-08-29
636 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
640 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
641 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
642 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
643 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
645 ## [2.0.2] - 2021-05-12
649 - Fix `busy` event emission on fixed pool type
651 ## [2.0.1] - 2021-03-16
655 - Check if pool options are properly set.
656 - `busy` event is emitted on all pool types.
658 ## [2.0.0] - 2021-03-01
662 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
666 - `FullPool` event is now renamed to `busy`.
667 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
668 _Find more details on our JSDoc._
670 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
672 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
674 ### Pool options types declaration merge
676 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
678 #### New `export` strategy
682 const DynamicThreadPool = require('poolifier/lib/dynamic')
684 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
687 But you should always prefer just using
690 const { DynamicThreadPool } = require('poolifier')
693 #### New type definitions for input data and response
695 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
696 _This is not a limitation by poolifier but NodeJS._
698 #### Public property replacements
700 `numWorkers` property is now `numberOfWorkers`
702 #### Internal (protected) properties and methods renaming
704 These properties are not intended for end users
706 - `id` => `nextMessageId`
708 These methods are not intended for end users
710 - `_chooseWorker` => `chooseWorker`
711 - `_newWorker` => `createWorker`
712 - `_execute` => `internalExecute`
713 - `_chooseWorker` => `chooseWorker`
714 - `_checkAlive` => `checkAlive`
716 - `_runAsync` => `runAsync`
718 ## [1.1.0] - 2020-05-21
722 - ThreadWorker support async functions as option
723 - Various external library patches
725 ## [1.0.0] - 2020-01-24
729 - FixedThreadPool implementation
730 - DynamicThreadPool implementation
731 - WorkerThread implementation to improve developer experience