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 `listTaskFunctions()` method to worker.
14 ## [2.6.16] - 2023-07-12
18 - Fix pool startup detection.
19 - Fix worker task functions handling.
21 ## [2.6.15] - 2023-07-11
25 - Take into account worker node readiness in worker choice strategies.
27 ## [2.6.14] - 2023-07-10
31 - Fix task function statistics tracking.
33 ## [2.6.13] - 2023-07-10
37 - Add per task function statistics tracking.
38 - Add public methods to manipulate the worker task functions at runtime.
40 ## [2.6.12] - 2023-07-09
44 - Workaround import issue with `node:os` module in node 16.x.x.
46 ## [2.6.11] - 2023-07-09
50 - Fix pool readiness semantic.
52 ## [2.6.10] - 2023-07-08
56 - Ensure workers are not recreated on error at pool startup.
60 - Add `ready` and `strategy` fields to pool information.
61 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
62 - Add dynamic pool sizing checks.
64 ## [2.6.9] - 2023-07-07
68 - Recreate the right worker type on uncaught exception.
72 - Add minimum and maximum to internal measurement statistics.
73 - Add `runTime` and `waitTime` to pool information.
74 - Check worker inactive time only on dynamic worker.
76 ## [2.6.8] - 2023-07-03
80 - Brown paper bag release to fix version handling in pool information.
82 ## [2.6.7] - 2023-07-03
86 - Ensure worker queued tasks at error are reassigned to other pool workers.
90 - Add pool `utilization` ratio to pool information.
91 - Add `version` to pool information.
92 - Add worker information to worker nodes.
94 ## [2.6.6] - 2023-07-01
98 - Add safe helper `availableParallelism` to help sizing the pool.
102 - Ensure message handler is only registered in worker.
104 ## [2.6.5] - 2023-06-27
108 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
112 - Artificial version bump to 2.6.5 to workaround publication issue.
113 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
114 - Ensure pool event is emitted before task error promise rejection.
115 - Fix queued tasks count computation.
119 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
121 ## [2.6.4] - 2023-06-27
125 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
129 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
130 - Ensure pool event is emitted before task error promise rejection.
131 - Fix queued tasks count computation.
135 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
137 ## [2.6.3] - 2023-06-19
141 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
142 - Update strategies internals after statistics computation.
146 - Optimize O(1) queue implementation.
148 ## [2.6.2] - 2023-06-12
152 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
154 ## [2.6.1] - 2023-06-10
158 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
162 - Fix average statistics computation: ensure failed tasks are not accounted.
164 ## [2.6.0] - 2023-06-09
168 - Add `LEAST_ELU` worker choice strategy (experimental).
169 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
173 - Refactor pool worker node usage internals.
174 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
175 - Breaking change: pool information `info` property object fields have been renamed.
179 - Fix wait time accounting.
180 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
181 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
183 ## [2.5.4] - 2023-06-07
187 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
191 - Compute statistics at the worker level only if needed.
192 - Add `worker_threads` options to thread pool options.
196 - Make the `LEAST_BUSY` strategy only relies on task runtime.
198 ## [2.5.3] - 2023-06-04
202 - Refine pool information content.
203 - Limit pool internals public exposure.
205 ## [2.5.2] - 2023-06-02
209 - Add `taskError` pool event for task execution error.
210 - Add pool information `info` property to pool.
211 - Emit pool information on `busy` and `full` pool events.
213 ## [2.5.1] - 2023-06-01
217 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
218 - Add `error` pool event for uncaught worker error.
220 ## [2.5.0] - 2023-05-31
224 - Switch pool event emitter to `EventEmitterAsyncResource`.
225 - Add tasks wait time accounting in per worker tasks usage.
226 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
230 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
232 ## [2.4.14] - 2023-05-09
236 - Ensure no undefined task runtime can land in the tasks history.
237 - Fix median computation implementation once again.
241 - Unit tests for median and queue implementations.
243 ## [2.4.13] - 2023-05-08
247 - Fix worker choice strategy options validation.
248 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
250 ## [2.4.12] - 2023-05-06
254 - Support multiple task functions per worker.
255 - Add custom worker weights support to worker choice strategies options.
259 - Use O(1) queue implementation for tasks queueing.
263 - Fix median computation implementation.
264 - Fix fair share worker choice strategy internals update.
266 ## [2.4.11] - 2023-04-23
270 - Optimize free worker finding in worker choice strategies.
272 ## [2.4.10] - 2023-04-15
276 - Fix typescript type definition for worker function: ensure the input data is optional.
277 - Fix typescript type definition for pool execute(): ensure the input data is optional.
279 ## [2.4.9] - 2023-04-15
283 - Add tasks queue enablement runtime setter to pool.
284 - Add tasks queue options runtime setter to pool.
285 - Add worker choice strategy options runtime setter to pool.
289 - Remove the tasks queuing experimental status.
293 - Fix worker function type definition and validation.
294 - Fix worker choice strategy options handling.
296 ## [2.4.8] - 2023-04-12
300 - Fix message between main worker and worker type definition for tasks.
301 - Fix code documentation.
303 ## [2.4.7] - 2023-04-11
307 - Add worker tasks queue options to pool options.
311 - Fix missing documentation.
313 ## [2.4.6] - 2023-04-10
317 - Ensure one task at a time is executed per worker with tasks queueing enabled.
318 - Properly count worker executing tasks with tasks queueing enabled.
320 ## [2.4.5] - 2023-04-09
324 - Use monotonic high resolution timer for worker tasks runtime.
325 - Add worker tasks median runtime to statistics.
326 - Add worker tasks queue (experimental).
328 ## [2.4.4] - 2023-04-07
332 - Add `PoolEvents` enumeration and `PoolEvent` type.
336 - Destroy worker only on alive check.
338 ## [2.4.3] - 2023-04-07
342 - Fix typedoc generation with inheritance.
344 ## [2.4.2] - 2023-04-06
348 - Add `full` event to dynamic pool.
349 - Keep worker choice strategy in memory for conditional reuse.
353 - Fix possible negative worker key at worker removal in worker choice strategies.
355 ## [2.4.1] - 2023-04-05
359 - Optimize worker choice strategy for dynamic pool.
363 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
365 ## [2.4.0] - 2023-04-04
369 - Add `LESS_BUSY` worker choice strategy.
373 - Optimize worker storage in pool.
374 - Optimize worker alive status check.
375 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
376 - Optimize `LESS_USED` worker choice strategy.
377 - Update benchmarks versus external threads pools.
378 - Optimize tasks usage statistics requirements for worker choice strategy.
382 - Ensure trimmable characters are checked at pool initialization.
383 - Fix message id integer overflow.
384 - Fix pool worker removal in worker choice strategy internals.
385 - Fix package publication with pnpm.
387 ## [2.4.0-3] - 2023-04-04
391 - Add `LESS_BUSY` worker choice strategy.
395 - Optimize worker storage in pool.
396 - Optimize worker alive status check.
397 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
398 - Optimize `LESS_USED` worker choice strategy.
399 - Update benchmarks versus external threads pools.
403 - Ensure trimmable characters are checked at pool initialization.
404 - Fix message id integer overflow.
405 - Fix pool worker removal in worker choice strategy internals.
406 - Fix package publication with pnpm.
408 ## [2.4.0-2] - 2023-04-03
412 - Add `LESS_BUSY` worker choice strategy.
416 - Optimize worker storage in pool.
417 - Optimize worker alive status check.
418 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
419 - Optimize `LESS_USED` worker choice strategy.
423 - Ensure trimmable characters are checked at pool initialization.
424 - Fix message id integer overflow.
425 - Fix pool worker removal in worker choice strategy internals.
426 - Fix package publication with pnpm.
428 ## [2.4.0-1] - 2023-04-03
432 - Add `LESS_BUSY` worker choice strategy.
436 - Optimize worker storage in pool.
437 - Optimize worker alive status check.
438 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
439 - Optimize `LESS_USED` worker choice strategy.
443 - Ensure trimmable characters are checked at pool initialization.
444 - Fix message id integer overflow.
445 - Fix pool worker removal in worker choice strategy internals.
447 ## [2.4.0-0] - 2023-04-03
451 - Add `LESS_BUSY` worker choice strategy.
455 - Optimize worker storage in pool.
456 - Optimize worker alive status check.
457 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
458 - Optimize `LESS_USED` worker choice strategy.
462 - Ensure trimmable characters are checked at pool initialization.
463 - Fix message id integer overflow.
464 - Fix pool worker removal in worker choice strategy internals.
466 ## [2.3.10] - 2023-03-18
470 - Fix `exports` syntax for ESM and CommonJS.
474 - Permit SemVer pre-release publication.
476 ## [2.3.10-2] - 2023-03-18
480 - Fix `exports` syntax for ESM and CommonJS.
482 ## [2.3.10-1] - 2023-03-18
486 - Permit SemVer pre-release publication.
488 ## [2.3.10-0] - 2023-03-18
492 - Fix `exports` syntax for ESM and CommonJS.
494 ## [2.3.9] - 2023-03-18
498 - Introduce ESM module support along with CommonJS one.
502 - Fix brown paper bag bug referencing the same object literal.
504 ## [2.3.8] - 2023-03-18
508 - Switch internal benchmarking code to benny.
509 - Switch to TypeScript 5.x.x.
510 - Switch rollup bundler plugins to core ones.
511 - Switch to TSDoc syntax.
512 - Enforce conventional commits.
516 - Fix random integer generator.
517 - Fix worker choice strategy pool type identification at initialization.
519 ## [2.3.7] - 2022-10-23
523 - Switch to open collective FOSS project funding platform.
524 - Switch to ts-standard linter configuration on TypeScript code.
528 - Fixed missing async on pool execute method.
529 - Fixed typing in TypeScript example.
530 - Fixed types in unit tests.
532 ## [2.3.6] - 2022-10-22
536 - Cleanup pool attributes and methods.
537 - Refine error types thrown.
541 - Fix continuous integration build on windows.
542 - Fix code coverage reporting by using c8 instead of nyc.
544 ## [2.3.5] - 2022-10-21
548 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
549 - Optimize tasks usage lookup implementation.
553 - Fix missed pool event emitter type export.
554 - Fix typedoc documentation generation.
556 ## [2.3.4] - 2022-10-17
560 - Fully automate release process with release-it.
564 - Optimize fair share task scheduling algorithm implementation.
565 - Update benchmarks versus external pools results with latest version.
567 ## [2.3.3] - 2022-10-15
571 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
573 ## [2.3.2] - 2022-10-14
577 - Optimize fair share worker selection strategy implementation.
581 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
583 ## [2.3.1] - 2022-10-13
587 - Pool worker choice strategies:
588 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
589 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
591 ## [2.2.2] - 2022-10-09
595 - Fixed `README.md` file.
597 ## [2.2.1] - 2022-10-08
601 - Dynamic worker choice strategy change at runtime.
603 ## [2.2.0] - 2022-01-05
607 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
609 ## [2.1.0] - 2021-08-29
613 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
617 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
618 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
619 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
620 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
622 ## [2.0.2] - 2021-05-12
626 - Fix `busy` event emission on fixed pool type
628 ## [2.0.1] - 2021-03-16
632 - Check if pool options are properly set.
633 - `busy` event is emitted on all pool types.
635 ## [2.0.0] - 2021-03-01
639 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
643 - `FullPool` event is now renamed to `busy`.
644 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
645 _Find more details on our JSDoc._
647 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
649 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
651 ### Pool options types declaration merge
653 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
655 #### New `export` strategy
659 const DynamicThreadPool = require('poolifier/lib/dynamic')
661 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
664 But you should always prefer just using
667 const { DynamicThreadPool } = require('poolifier')
670 #### New type definitions for input data and response
672 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
673 _This is not a limitation by poolifier but NodeJS._
675 #### Public property replacements
677 `numWorkers` property is now `numberOfWorkers`
679 #### Internal (protected) properties and methods renaming
681 These properties are not intended for end users
683 - `id` => `nextMessageId`
685 These methods are not intended for end users
687 - `_chooseWorker` => `chooseWorker`
688 - `_newWorker` => `createWorker`
689 - `_execute` => `internalExecute`
690 - `_chooseWorker` => `chooseWorker`
691 - `_checkAlive` => `checkAlive`
693 - `_runAsync` => `runAsync`
695 ## [1.1.0] - 2020-05-21
699 - ThreadWorker support async functions as option
700 - Various external library patches
702 ## [1.0.0] - 2020-01-24
706 - FixedThreadPool implementation
707 - DynamicThreadPool implementation
708 - WorkerThread implementation to improve developer experience