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 - HTTP server pool examples: fastify-cluster.
13 - WebSocket server pool examples: ws-cluster
15 ## [2.6.24] - 2023-08-12
19 - Add array of transferable objects to the `execute()` method arguments.
20 - WebSocket server pool examples: ws
22 ## [2.6.23] - 2023-08-11
26 - 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.
30 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
31 - HTTP server pool examples: express, fastify.
33 ## [2.6.22] - 2023-08-10
37 - Add missing `types` field to package.json `exports`.
41 - Structure markdown documentation (PR #811).
43 ## [2.6.21] - 2023-08-03
47 - Improve code documentation.
48 - Code refactoring and cleanup for better maintainability and readability.
50 ## [2.6.20] - 2023-07-21
54 - Fix queued tasks redistribution on error task execution starvation.
55 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
59 - Drastically reduce lookups by worker in the worker nodes.
61 ## [2.6.19] - 2023-07-20
65 - Dedicated internal communication channel for worker_threads pools.
67 ## [2.6.18] - 2023-07-19
71 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
73 ## [2.6.17] - 2023-07-16
77 - Add `listTaskFunctions()` method to worker class.
79 ## [2.6.16] - 2023-07-12
83 - Fix pool startup detection.
84 - Fix worker task functions handling.
86 ## [2.6.15] - 2023-07-11
90 - Take into account worker node readiness in worker choice strategies.
92 ## [2.6.14] - 2023-07-10
96 - Fix task function statistics tracking.
98 ## [2.6.13] - 2023-07-10
102 - Add per task function statistics tracking.
103 - Add public methods to manipulate the worker task functions at runtime.
105 ## [2.6.12] - 2023-07-09
109 - Workaround import issue with `node:os` module in node 16.x.x.
111 ## [2.6.11] - 2023-07-09
115 - Fix pool readiness semantic.
117 ## [2.6.10] - 2023-07-08
121 - Ensure workers are not recreated on error at pool startup.
125 - Add `ready` and `strategy` fields to pool information.
126 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
127 - Add dynamic pool sizing checks.
129 ## [2.6.9] - 2023-07-07
133 - Recreate the right worker type on uncaught exception.
137 - Add minimum and maximum to internal measurement statistics.
138 - Add `runTime` and `waitTime` to pool information.
139 - Check worker inactive time only on dynamic worker.
141 ## [2.6.8] - 2023-07-03
145 - Brown paper bag release to fix version handling in pool information.
147 ## [2.6.7] - 2023-07-03
151 - Ensure worker queued tasks at error are reassigned to other pool workers.
155 - Add pool `utilization` ratio to pool information.
156 - Add `version` to pool information.
157 - Add worker information to worker nodes.
159 ## [2.6.6] - 2023-07-01
163 - Add safe helper `availableParallelism` to help sizing the pool.
167 - Ensure message handler is only registered in worker.
169 ## [2.6.5] - 2023-06-27
173 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
177 - Artificial version bump to 2.6.5 to workaround publication issue.
178 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
179 - Ensure pool event is emitted before task error promise rejection.
180 - Fix queued tasks count computation.
184 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
186 ## [2.6.4] - 2023-06-27
190 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
194 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
195 - Ensure pool event is emitted before task error promise rejection.
196 - Fix queued tasks count computation.
200 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
202 ## [2.6.3] - 2023-06-19
206 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
207 - Update strategies internals after statistics computation.
211 - Optimize O(1) queue implementation.
213 ## [2.6.2] - 2023-06-12
217 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
219 ## [2.6.1] - 2023-06-10
223 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
227 - Fix average statistics computation: ensure failed tasks are not accounted.
229 ## [2.6.0] - 2023-06-09
233 - Add `LEAST_ELU` worker choice strategy (experimental).
234 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
238 - Refactor pool worker node usage internals.
239 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
240 - Breaking change: pool information `info` property object fields have been renamed.
244 - Fix wait time accounting.
245 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
246 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
248 ## [2.5.4] - 2023-06-07
252 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
256 - Compute statistics at the worker level only if needed.
257 - Add `worker_threads` options to thread pool options.
261 - Make the `LEAST_BUSY` strategy only relies on task runtime.
263 ## [2.5.3] - 2023-06-04
267 - Refine pool information content.
268 - Limit pool internals public exposure.
270 ## [2.5.2] - 2023-06-02
274 - Add `taskError` pool event for task execution error.
275 - Add pool information `info` property to pool.
276 - Emit pool information on `busy` and `full` pool events.
278 ## [2.5.1] - 2023-06-01
282 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
283 - Add `error` pool event for uncaught worker error.
285 ## [2.5.0] - 2023-05-31
289 - Switch pool event emitter to `EventEmitterAsyncResource`.
290 - Add tasks wait time accounting in per worker tasks usage.
291 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
295 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
297 ## [2.4.14] - 2023-05-09
301 - Ensure no undefined task runtime can land in the tasks history.
302 - Fix median computation implementation once again.
306 - Unit tests for median and queue implementations.
308 ## [2.4.13] - 2023-05-08
312 - Fix worker choice strategy options validation.
313 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
315 ## [2.4.12] - 2023-05-06
319 - Support multiple task functions per worker.
320 - Add custom worker weights support to worker choice strategies options.
324 - Use O(1) queue implementation for tasks queueing.
328 - Fix median computation implementation.
329 - Fix fair share worker choice strategy internals update.
331 ## [2.4.11] - 2023-04-23
335 - Optimize free worker finding in worker choice strategies.
337 ## [2.4.10] - 2023-04-15
341 - Fix typescript type definition for task function: ensure the input data is optional.
342 - Fix typescript type definition for pool execute(): ensure the input data is optional.
344 ## [2.4.9] - 2023-04-15
348 - Add tasks queue enablement runtime setter to pool.
349 - Add tasks queue options runtime setter to pool.
350 - Add worker choice strategy options runtime setter to pool.
354 - Remove the tasks queuing experimental status.
358 - Fix task function type definition and validation.
359 - Fix worker choice strategy options handling.
361 ## [2.4.8] - 2023-04-12
365 - Fix message between main worker and worker type definition for tasks.
366 - Fix code documentation.
368 ## [2.4.7] - 2023-04-11
372 - Add worker tasks queue options to pool options.
376 - Fix missing documentation.
378 ## [2.4.6] - 2023-04-10
382 - Ensure one task at a time is executed per worker with tasks queueing enabled.
383 - Properly count worker executing tasks with tasks queueing enabled.
385 ## [2.4.5] - 2023-04-09
389 - Use monotonic high resolution timer for worker tasks runtime.
390 - Add worker tasks median runtime to statistics.
391 - Add worker tasks queue (experimental).
393 ## [2.4.4] - 2023-04-07
397 - Add `PoolEvents` enumeration and `PoolEvent` type.
401 - Destroy worker only on alive check.
403 ## [2.4.3] - 2023-04-07
407 - Fix typedoc generation with inheritance.
409 ## [2.4.2] - 2023-04-06
413 - Add `full` event to dynamic pool.
414 - Keep worker choice strategy in memory for conditional reuse.
418 - Fix possible negative worker key at worker removal in worker choice strategies.
420 ## [2.4.1] - 2023-04-05
424 - Optimize worker choice strategy for dynamic pool.
428 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
430 ## [2.4.0] - 2023-04-04
434 - Add `LESS_BUSY` worker choice strategy.
438 - Optimize worker storage in pool.
439 - Optimize worker alive status check.
440 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
441 - Optimize `LESS_USED` worker choice strategy.
442 - Update benchmarks versus external threads pools.
443 - Optimize tasks usage statistics requirements for worker choice strategy.
447 - Ensure trimmable characters are checked at pool initialization.
448 - Fix message id integer overflow.
449 - Fix pool worker removal in worker choice strategy internals.
450 - Fix package publication with pnpm.
452 ## [2.4.0-3] - 2023-04-04
456 - Add `LESS_BUSY` worker choice strategy.
460 - Optimize worker storage in pool.
461 - Optimize worker alive status check.
462 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
463 - Optimize `LESS_USED` worker choice strategy.
464 - Update benchmarks versus external threads pools.
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.
471 - Fix package publication with pnpm.
473 ## [2.4.0-2] - 2023-04-03
477 - Add `LESS_BUSY` worker choice strategy.
481 - Optimize worker storage in pool.
482 - Optimize worker alive status check.
483 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
484 - Optimize `LESS_USED` worker choice strategy.
488 - Ensure trimmable characters are checked at pool initialization.
489 - Fix message id integer overflow.
490 - Fix pool worker removal in worker choice strategy internals.
491 - Fix package publication with pnpm.
493 ## [2.4.0-1] - 2023-04-03
497 - Add `LESS_BUSY` worker choice strategy.
501 - Optimize worker storage in pool.
502 - Optimize worker alive status check.
503 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
504 - Optimize `LESS_USED` worker choice strategy.
508 - Ensure trimmable characters are checked at pool initialization.
509 - Fix message id integer overflow.
510 - Fix pool worker removal in worker choice strategy internals.
512 ## [2.4.0-0] - 2023-04-03
516 - Add `LESS_BUSY` worker choice strategy.
520 - Optimize worker storage in pool.
521 - Optimize worker alive status check.
522 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
523 - Optimize `LESS_USED` worker choice strategy.
527 - Ensure trimmable characters are checked at pool initialization.
528 - Fix message id integer overflow.
529 - Fix pool worker removal in worker choice strategy internals.
531 ## [2.3.10] - 2023-03-18
535 - Fix package.json `exports` syntax for ESM and CommonJS.
539 - Permit SemVer pre-release publication.
541 ## [2.3.10-2] - 2023-03-18
545 - Fix package.json `exports` syntax for ESM and CommonJS.
547 ## [2.3.10-1] - 2023-03-18
551 - Permit SemVer pre-release publication.
553 ## [2.3.10-0] - 2023-03-18
557 - Fix package.json `exports` syntax for ESM and CommonJS.
559 ## [2.3.9] - 2023-03-18
563 - Introduce ESM module support along with CommonJS one.
567 - Fix brown paper bag bug referencing the same object literal.
569 ## [2.3.8] - 2023-03-18
573 - Switch internal benchmarking code to benny.
574 - Switch to TypeScript 5.x.x.
575 - Switch rollup bundler plugins to core ones.
576 - Switch to TSDoc syntax.
577 - Enforce conventional commits.
581 - Fix random integer generator.
582 - Fix worker choice strategy pool type identification at initialization.
584 ## [2.3.7] - 2022-10-23
588 - Switch to open collective FOSS project funding platform.
589 - Switch to ts-standard linter configuration on TypeScript code.
593 - Fixed missing async on pool execute method.
594 - Fixed typing in TypeScript example.
595 - Fixed types in unit tests.
597 ## [2.3.6] - 2022-10-22
601 - Cleanup pool attributes and methods.
602 - Refine error types thrown.
606 - Fix continuous integration build on windows.
607 - Fix code coverage reporting by using c8 instead of nyc.
609 ## [2.3.5] - 2022-10-21
613 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
614 - Optimize tasks usage lookup implementation.
618 - Fix missed pool event emitter type export.
619 - Fix typedoc documentation generation.
621 ## [2.3.4] - 2022-10-17
625 - Fully automate release process with release-it.
629 - Optimize fair share task scheduling algorithm implementation.
630 - Update benchmarks versus external pools results with latest version.
632 ## [2.3.3] - 2022-10-15
636 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
638 ## [2.3.2] - 2022-10-14
642 - Optimize fair share worker selection strategy implementation.
646 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
648 ## [2.3.1] - 2022-10-13
652 - Pool worker choice strategies:
653 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
654 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
656 ## [2.2.2] - 2022-10-09
660 - Fixed `README.md` file.
662 ## [2.2.1] - 2022-10-08
666 - Dynamic worker choice strategy change at runtime.
668 ## [2.2.0] - 2022-01-05
672 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
674 ## [2.1.0] - 2021-08-29
678 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
682 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
683 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
684 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
685 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
687 ## [2.0.2] - 2021-05-12
691 - Fix `busy` event emission on fixed pool type
693 ## [2.0.1] - 2021-03-16
697 - Check if pool options are properly set.
698 - `busy` event is emitted on all pool types.
700 ## [2.0.0] - 2021-03-01
704 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
708 - `FullPool` event is now renamed to `busy`.
709 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
710 _Find more details on our JSDoc._
712 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
714 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
716 ### Pool options types declaration merge
718 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
720 #### New `export` strategy
724 const DynamicThreadPool = require('poolifier/lib/dynamic')
726 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
729 But you should always prefer just using
732 const { DynamicThreadPool } = require('poolifier')
735 #### New type definitions for input data and response
737 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
738 _This is not a limitation by poolifier but Node.js._
740 #### Public property replacements
742 `numWorkers` property is now `numberOfWorkers`
744 #### Internal (protected) properties and methods renaming
746 These properties are not intended for end users
748 - `id` => `nextMessageId`
750 These methods are not intended for end users
752 - `_chooseWorker` => `chooseWorker`
753 - `_newWorker` => `createWorker`
754 - `_execute` => `internalExecute`
755 - `_chooseWorker` => `chooseWorker`
756 - `_checkAlive` => `checkAlive`
758 - `_runAsync` => `runAsync`
760 ## [1.1.0] - 2020-05-21
764 - ThreadWorker support async functions as option
765 - Various external library patches
767 ## [1.0.0] - 2020-01-24
771 - FixedThreadPool implementation
772 - DynamicThreadPool implementation
773 - WorkerThread implementation to improve developer experience