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 task function statistics tracking.
14 ## [2.6.13] - 2023-07-10
18 - Add per task function statistics tracking.
19 - Add public methods to manipulate the worker task functions at runtime.
21 ## [2.6.12] - 2023-07-09
25 - Workaround import issue with `node:os` module in node 16.x.x.
27 ## [2.6.11] - 2023-07-09
31 - Fix pool readiness semantic.
33 ## [2.6.10] - 2023-07-08
37 - Ensure workers are not recreated on error at pool startup.
41 - Add `ready` and `strategy` fields to pool information.
42 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
43 - Add dynamic pool sizing checks.
45 ## [2.6.9] - 2023-07-07
49 - Recreate the right worker type on uncaught exception.
53 - Add minimum and maximum to internal measurement statistics.
54 - Add `runTime` and `waitTime` to pool information.
55 - Check worker inactive time only on dynamic worker.
57 ## [2.6.8] - 2023-07-03
61 - Brown paper bag release to fix version handling in pool information.
63 ## [2.6.7] - 2023-07-03
67 - Ensure worker queued tasks at error are reassigned to other pool workers.
71 - Add pool `utilization` ratio to pool information.
72 - Add `version` to pool information.
73 - Add worker information to worker nodes.
75 ## [2.6.6] - 2023-07-01
79 - Add safe helper `availableParallelism` to help sizing the pool.
83 - Ensure message handler is only registered in worker.
85 ## [2.6.5] - 2023-06-27
89 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
93 - Artificial version bump to 2.6.5 to workaround publication issue.
94 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
95 - Ensure pool event is emitted before task error promise rejection.
96 - Fix queued tasks count computation.
100 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
102 ## [2.6.4] - 2023-06-27
106 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
110 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
111 - Ensure pool event is emitted before task error promise rejection.
112 - Fix queued tasks count computation.
116 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
118 ## [2.6.3] - 2023-06-19
122 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
123 - Update strategies internals after statistics computation.
127 - Optimize O(1) queue implementation.
129 ## [2.6.2] - 2023-06-12
133 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
135 ## [2.6.1] - 2023-06-10
139 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
143 - Fix average statistics computation: ensure failed tasks are not accounted.
145 ## [2.6.0] - 2023-06-09
149 - Add `LEAST_ELU` worker choice strategy (experimental).
150 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
154 - Refactor pool worker node usage internals.
155 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
156 - Breaking change: pool information `info` property object fields have been renamed.
160 - Fix wait time accounting.
161 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
162 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
164 ## [2.5.4] - 2023-06-07
168 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
172 - Compute statistics at the worker level only if needed.
173 - Add `worker-threads` options to thread pool options.
177 - Make the `LEAST_BUSY` strategy only relies on task runtime.
179 ## [2.5.3] - 2023-06-04
183 - Refine pool information content.
184 - Limit pool internals public exposure.
186 ## [2.5.2] - 2023-06-02
190 - Add `taskError` pool event for task execution error.
191 - Add pool information `info` property to pool.
192 - Emit pool information on `busy` and `full` pool events.
194 ## [2.5.1] - 2023-06-01
198 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
199 - Add `error` pool event for uncaught worker error.
201 ## [2.5.0] - 2023-05-31
205 - Switch pool event emitter to `EventEmitterAsyncResource`.
206 - Add tasks wait time accounting in per worker tasks usage.
207 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
211 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
213 ## [2.4.14] - 2023-05-09
217 - Ensure no undefined task runtime can land in the tasks history.
218 - Fix median computation implementation once again.
222 - Unit tests for median and queue implementations.
224 ## [2.4.13] - 2023-05-08
228 - Fix worker choice strategy options validation.
229 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
231 ## [2.4.12] - 2023-05-06
235 - Support multiple task functions per worker.
236 - Add custom worker weights support to worker choice strategies options.
240 - Use O(1) queue implementation for tasks queueing.
244 - Fix median computation implementation.
245 - Fix fair share worker choice strategy internals update.
247 ## [2.4.11] - 2023-04-23
251 - Optimize free worker finding in worker choice strategies.
253 ## [2.4.10] - 2023-04-15
257 - Fix typescript type definition for worker function: ensure the input data is optional.
258 - Fix typescript type definition for pool execute(): ensure the input data is optional.
260 ## [2.4.9] - 2023-04-15
264 - Add tasks queue enablement runtime setter to pool.
265 - Add tasks queue options runtime setter to pool.
266 - Add worker choice strategy options runtime setter to pool.
270 - Remove the tasks queuing experimental status.
274 - Fix worker function type definition and validation.
275 - Fix worker choice strategy options handling.
277 ## [2.4.8] - 2023-04-12
281 - Fix message between main worker and worker type definition for tasks.
282 - Fix code documentation.
284 ## [2.4.7] - 2023-04-11
288 - Add worker tasks queue options to pool options.
292 - Fix missing documentation.
294 ## [2.4.6] - 2023-04-10
298 - Ensure one task at a time is executed per worker with tasks queueing enabled.
299 - Properly count worker executing tasks with tasks queueing enabled.
301 ## [2.4.5] - 2023-04-09
305 - Use monotonic high resolution timer for worker tasks runtime.
306 - Add worker tasks median runtime to statistics.
307 - Add worker tasks queue (experimental).
309 ## [2.4.4] - 2023-04-07
313 - Add `PoolEvents` enumeration and `PoolEvent` type.
317 - Destroy worker only on alive check.
319 ## [2.4.3] - 2023-04-07
323 - Fix typedoc generation with inheritance.
325 ## [2.4.2] - 2023-04-06
329 - Add `full` event to dynamic pool.
330 - Keep worker choice strategy in memory for conditional reuse.
334 - Fix possible negative worker key at worker removal in worker choice strategies.
336 ## [2.4.1] - 2023-04-05
340 - Optimize worker choice strategy for dynamic pool.
344 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
346 ## [2.4.0] - 2023-04-04
350 - Add `LESS_BUSY` worker choice strategy.
354 - Optimize worker storage in pool.
355 - Optimize worker alive status check.
356 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
357 - Optimize `LESS_USED` worker choice strategy.
358 - Update benchmarks versus external threads pools.
359 - Optimize tasks usage statistics requirements for worker choice strategy.
363 - Ensure trimmable characters are checked at pool initialization.
364 - Fix message id integer overflow.
365 - Fix pool worker removal in worker choice strategy internals.
366 - Fix package publication with pnpm.
368 ## [2.4.0-3] - 2023-04-04
372 - Add `LESS_BUSY` worker choice strategy.
376 - Optimize worker storage in pool.
377 - Optimize worker alive status check.
378 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
379 - Optimize `LESS_USED` worker choice strategy.
380 - Update benchmarks versus external threads pools.
384 - Ensure trimmable characters are checked at pool initialization.
385 - Fix message id integer overflow.
386 - Fix pool worker removal in worker choice strategy internals.
387 - Fix package publication with pnpm.
389 ## [2.4.0-2] - 2023-04-03
393 - Add `LESS_BUSY` worker choice strategy.
397 - Optimize worker storage in pool.
398 - Optimize worker alive status check.
399 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
400 - Optimize `LESS_USED` worker choice strategy.
404 - Ensure trimmable characters are checked at pool initialization.
405 - Fix message id integer overflow.
406 - Fix pool worker removal in worker choice strategy internals.
407 - Fix package publication with pnpm.
409 ## [2.4.0-1] - 2023-04-03
413 - Add `LESS_BUSY` worker choice strategy.
417 - Optimize worker storage in pool.
418 - Optimize worker alive status check.
419 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
420 - Optimize `LESS_USED` worker choice strategy.
424 - Ensure trimmable characters are checked at pool initialization.
425 - Fix message id integer overflow.
426 - Fix pool worker removal in worker choice strategy internals.
428 ## [2.4.0-0] - 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.3.10] - 2023-03-18
451 - Fix `exports` syntax for ESM and CommonJS.
455 - Permit SemVer pre-release publication.
457 ## [2.3.10-2] - 2023-03-18
461 - Fix `exports` syntax for ESM and CommonJS.
463 ## [2.3.10-1] - 2023-03-18
467 - Permit SemVer pre-release publication.
469 ## [2.3.10-0] - 2023-03-18
473 - Fix `exports` syntax for ESM and CommonJS.
475 ## [2.3.9] - 2023-03-18
479 - Introduce ESM module support along with CommonJS one.
483 - Fix brown paper bag bug referencing the same object literal.
485 ## [2.3.8] - 2023-03-18
489 - Switch internal benchmarking code to benny.
490 - Switch to TypeScript 5.x.x.
491 - Switch rollup bundler plugins to core ones.
492 - Switch to TSDoc syntax.
493 - Enforce conventional commits.
497 - Fix random integer generator.
498 - Fix worker choice strategy pool type identification at initialization.
500 ## [2.3.7] - 2022-10-23
504 - Switch to open collective FOSS project funding platform.
505 - Switch to ts-standard linter configuration on TypeScript code.
509 - Fixed missing async on pool execute method.
510 - Fixed typing in TypeScript example.
511 - Fixed types in unit tests.
513 ## [2.3.6] - 2022-10-22
517 - Cleanup pool attributes and methods.
518 - Refine error types thrown.
522 - Fix continuous integration build on windows.
523 - Fix code coverage reporting by using c8 instead of nyc.
525 ## [2.3.5] - 2022-10-21
529 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
530 - Optimize tasks usage lookup implementation.
534 - Fix missed pool event emitter type export.
535 - Fix typedoc documentation generation.
537 ## [2.3.4] - 2022-10-17
541 - Fully automate release process with release-it.
545 - Optimize fair share task scheduling algorithm implementation.
546 - Update benchmarks versus external pools results with latest version.
548 ## [2.3.3] - 2022-10-15
552 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
554 ## [2.3.2] - 2022-10-14
558 - Optimize fair share worker selection strategy implementation.
562 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
564 ## [2.3.1] - 2022-10-13
568 - Pool worker choice strategies:
569 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
570 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
572 ## [2.2.2] - 2022-10-09
576 - Fixed `README.md` file.
578 ## [2.2.1] - 2022-10-08
582 - Dynamic worker choice strategy change at runtime.
584 ## [2.2.0] - 2022-01-05
588 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
590 ## [2.1.0] - 2021-08-29
594 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
598 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
599 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
600 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
601 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
603 ## [2.0.2] - 2021-05-12
607 - Fix `busy` event emission on fixed pool type
609 ## [2.0.1] - 2021-03-16
613 - Check if pool options are properly set.
614 - `busy` event is emitted on all pool types.
616 ## [2.0.0] - 2021-03-01
620 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
624 - `FullPool` event is now renamed to `busy`.
625 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
626 _Find more details on our JSDoc._
628 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
630 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
632 ### Pool options types declaration merge
634 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
636 #### New `export` strategy
640 const DynamicThreadPool = require('poolifier/lib/dynamic')
642 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
645 But you should always prefer just using
648 const { DynamicThreadPool } = require('poolifier')
651 #### New type definitions for input data and response
653 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
654 _This is not a limitation by poolifier but NodeJS._
656 #### Public property replacements
658 `numWorkers` property is now `numberOfWorkers`
660 #### Internal (protected) properties and methods renaming
662 These properties are not intended for end users
664 - `id` => `nextMessageId`
666 These methods are not intended for end users
668 - `_chooseWorker` => `chooseWorker`
669 - `_newWorker` => `createWorker`
670 - `_execute` => `internalExecute`
671 - `_chooseWorker` => `chooseWorker`
672 - `_checkAlive` => `checkAlive`
674 - `_runAsync` => `runAsync`
676 ## [1.1.0] - 2020-05-21
680 - ThreadWorker support async functions as option
681 - Various external library patches
683 ## [1.0.0] - 2020-01-24
687 - FixedThreadPool implementation
688 - DynamicThreadPool implementation
689 - WorkerThread implementation to improve developer experience