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.14] - 2023-07-10
14 - Fix task function statistics tracking.
16 ## [2.6.13] - 2023-07-10
20 - Add per task function statistics tracking.
21 - Add public methods to manipulate the worker task functions at runtime.
23 ## [2.6.12] - 2023-07-09
27 - Workaround import issue with `node:os` module in node 16.x.x.
29 ## [2.6.11] - 2023-07-09
33 - Fix pool readiness semantic.
35 ## [2.6.10] - 2023-07-08
39 - Ensure workers are not recreated on error at pool startup.
43 - Add `ready` and `strategy` fields to pool information.
44 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
45 - Add dynamic pool sizing checks.
47 ## [2.6.9] - 2023-07-07
51 - Recreate the right worker type on uncaught exception.
55 - Add minimum and maximum to internal measurement statistics.
56 - Add `runTime` and `waitTime` to pool information.
57 - Check worker inactive time only on dynamic worker.
59 ## [2.6.8] - 2023-07-03
63 - Brown paper bag release to fix version handling in pool information.
65 ## [2.6.7] - 2023-07-03
69 - Ensure worker queued tasks at error are reassigned to other pool workers.
73 - Add pool `utilization` ratio to pool information.
74 - Add `version` to pool information.
75 - Add worker information to worker nodes.
77 ## [2.6.6] - 2023-07-01
81 - Add safe helper `availableParallelism` to help sizing the pool.
85 - Ensure message handler is only registered in worker.
87 ## [2.6.5] - 2023-06-27
91 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
95 - Artificial version bump to 2.6.5 to workaround publication issue.
96 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
97 - Ensure pool event is emitted before task error promise rejection.
98 - Fix queued tasks count computation.
102 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
104 ## [2.6.4] - 2023-06-27
108 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
112 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
113 - Ensure pool event is emitted before task error promise rejection.
114 - Fix queued tasks count computation.
118 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
120 ## [2.6.3] - 2023-06-19
124 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
125 - Update strategies internals after statistics computation.
129 - Optimize O(1) queue implementation.
131 ## [2.6.2] - 2023-06-12
135 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
137 ## [2.6.1] - 2023-06-10
141 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
145 - Fix average statistics computation: ensure failed tasks are not accounted.
147 ## [2.6.0] - 2023-06-09
151 - Add `LEAST_ELU` worker choice strategy (experimental).
152 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
156 - Refactor pool worker node usage internals.
157 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
158 - Breaking change: pool information `info` property object fields have been renamed.
162 - Fix wait time accounting.
163 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
164 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
166 ## [2.5.4] - 2023-06-07
170 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
174 - Compute statistics at the worker level only if needed.
175 - Add `worker-threads` options to thread pool options.
179 - Make the `LEAST_BUSY` strategy only relies on task runtime.
181 ## [2.5.3] - 2023-06-04
185 - Refine pool information content.
186 - Limit pool internals public exposure.
188 ## [2.5.2] - 2023-06-02
192 - Add `taskError` pool event for task execution error.
193 - Add pool information `info` property to pool.
194 - Emit pool information on `busy` and `full` pool events.
196 ## [2.5.1] - 2023-06-01
200 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
201 - Add `error` pool event for uncaught worker error.
203 ## [2.5.0] - 2023-05-31
207 - Switch pool event emitter to `EventEmitterAsyncResource`.
208 - Add tasks wait time accounting in per worker tasks usage.
209 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
213 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
215 ## [2.4.14] - 2023-05-09
219 - Ensure no undefined task runtime can land in the tasks history.
220 - Fix median computation implementation once again.
224 - Unit tests for median and queue implementations.
226 ## [2.4.13] - 2023-05-08
230 - Fix worker choice strategy options validation.
231 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
233 ## [2.4.12] - 2023-05-06
237 - Support multiple task functions per worker.
238 - Add custom worker weights support to worker choice strategies options.
242 - Use O(1) queue implementation for tasks queueing.
246 - Fix median computation implementation.
247 - Fix fair share worker choice strategy internals update.
249 ## [2.4.11] - 2023-04-23
253 - Optimize free worker finding in worker choice strategies.
255 ## [2.4.10] - 2023-04-15
259 - Fix typescript type definition for worker function: ensure the input data is optional.
260 - Fix typescript type definition for pool execute(): ensure the input data is optional.
262 ## [2.4.9] - 2023-04-15
266 - Add tasks queue enablement runtime setter to pool.
267 - Add tasks queue options runtime setter to pool.
268 - Add worker choice strategy options runtime setter to pool.
272 - Remove the tasks queuing experimental status.
276 - Fix worker function type definition and validation.
277 - Fix worker choice strategy options handling.
279 ## [2.4.8] - 2023-04-12
283 - Fix message between main worker and worker type definition for tasks.
284 - Fix code documentation.
286 ## [2.4.7] - 2023-04-11
290 - Add worker tasks queue options to pool options.
294 - Fix missing documentation.
296 ## [2.4.6] - 2023-04-10
300 - Ensure one task at a time is executed per worker with tasks queueing enabled.
301 - Properly count worker executing tasks with tasks queueing enabled.
303 ## [2.4.5] - 2023-04-09
307 - Use monotonic high resolution timer for worker tasks runtime.
308 - Add worker tasks median runtime to statistics.
309 - Add worker tasks queue (experimental).
311 ## [2.4.4] - 2023-04-07
315 - Add `PoolEvents` enumeration and `PoolEvent` type.
319 - Destroy worker only on alive check.
321 ## [2.4.3] - 2023-04-07
325 - Fix typedoc generation with inheritance.
327 ## [2.4.2] - 2023-04-06
331 - Add `full` event to dynamic pool.
332 - Keep worker choice strategy in memory for conditional reuse.
336 - Fix possible negative worker key at worker removal in worker choice strategies.
338 ## [2.4.1] - 2023-04-05
342 - Optimize worker choice strategy for dynamic pool.
346 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
348 ## [2.4.0] - 2023-04-04
352 - Add `LESS_BUSY` worker choice strategy.
356 - Optimize worker storage in pool.
357 - Optimize worker alive status check.
358 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
359 - Optimize `LESS_USED` worker choice strategy.
360 - Update benchmarks versus external threads pools.
361 - Optimize tasks usage statistics requirements for worker choice strategy.
365 - Ensure trimmable characters are checked at pool initialization.
366 - Fix message id integer overflow.
367 - Fix pool worker removal in worker choice strategy internals.
368 - Fix package publication with pnpm.
370 ## [2.4.0-3] - 2023-04-04
374 - Add `LESS_BUSY` worker choice strategy.
378 - Optimize worker storage in pool.
379 - Optimize worker alive status check.
380 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
381 - Optimize `LESS_USED` worker choice strategy.
382 - Update benchmarks versus external threads pools.
386 - Ensure trimmable characters are checked at pool initialization.
387 - Fix message id integer overflow.
388 - Fix pool worker removal in worker choice strategy internals.
389 - Fix package publication with pnpm.
391 ## [2.4.0-2] - 2023-04-03
395 - Add `LESS_BUSY` worker choice strategy.
399 - Optimize worker storage in pool.
400 - Optimize worker alive status check.
401 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
402 - Optimize `LESS_USED` worker choice strategy.
406 - Ensure trimmable characters are checked at pool initialization.
407 - Fix message id integer overflow.
408 - Fix pool worker removal in worker choice strategy internals.
409 - Fix package publication with pnpm.
411 ## [2.4.0-1] - 2023-04-03
415 - Add `LESS_BUSY` worker choice strategy.
419 - Optimize worker storage in pool.
420 - Optimize worker alive status check.
421 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
422 - Optimize `LESS_USED` worker choice strategy.
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.
430 ## [2.4.0-0] - 2023-04-03
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.
445 - Ensure trimmable characters are checked at pool initialization.
446 - Fix message id integer overflow.
447 - Fix pool worker removal in worker choice strategy internals.
449 ## [2.3.10] - 2023-03-18
453 - Fix `exports` syntax for ESM and CommonJS.
457 - Permit SemVer pre-release publication.
459 ## [2.3.10-2] - 2023-03-18
463 - Fix `exports` syntax for ESM and CommonJS.
465 ## [2.3.10-1] - 2023-03-18
469 - Permit SemVer pre-release publication.
471 ## [2.3.10-0] - 2023-03-18
475 - Fix `exports` syntax for ESM and CommonJS.
477 ## [2.3.9] - 2023-03-18
481 - Introduce ESM module support along with CommonJS one.
485 - Fix brown paper bag bug referencing the same object literal.
487 ## [2.3.8] - 2023-03-18
491 - Switch internal benchmarking code to benny.
492 - Switch to TypeScript 5.x.x.
493 - Switch rollup bundler plugins to core ones.
494 - Switch to TSDoc syntax.
495 - Enforce conventional commits.
499 - Fix random integer generator.
500 - Fix worker choice strategy pool type identification at initialization.
502 ## [2.3.7] - 2022-10-23
506 - Switch to open collective FOSS project funding platform.
507 - Switch to ts-standard linter configuration on TypeScript code.
511 - Fixed missing async on pool execute method.
512 - Fixed typing in TypeScript example.
513 - Fixed types in unit tests.
515 ## [2.3.6] - 2022-10-22
519 - Cleanup pool attributes and methods.
520 - Refine error types thrown.
524 - Fix continuous integration build on windows.
525 - Fix code coverage reporting by using c8 instead of nyc.
527 ## [2.3.5] - 2022-10-21
531 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
532 - Optimize tasks usage lookup implementation.
536 - Fix missed pool event emitter type export.
537 - Fix typedoc documentation generation.
539 ## [2.3.4] - 2022-10-17
543 - Fully automate release process with release-it.
547 - Optimize fair share task scheduling algorithm implementation.
548 - Update benchmarks versus external pools results with latest version.
550 ## [2.3.3] - 2022-10-15
554 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
556 ## [2.3.2] - 2022-10-14
560 - Optimize fair share worker selection strategy implementation.
564 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
566 ## [2.3.1] - 2022-10-13
570 - Pool worker choice strategies:
571 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
572 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
574 ## [2.2.2] - 2022-10-09
578 - Fixed `README.md` file.
580 ## [2.2.1] - 2022-10-08
584 - Dynamic worker choice strategy change at runtime.
586 ## [2.2.0] - 2022-01-05
590 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
592 ## [2.1.0] - 2021-08-29
596 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
600 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
601 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
602 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
603 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
605 ## [2.0.2] - 2021-05-12
609 - Fix `busy` event emission on fixed pool type
611 ## [2.0.1] - 2021-03-16
615 - Check if pool options are properly set.
616 - `busy` event is emitted on all pool types.
618 ## [2.0.0] - 2021-03-01
622 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
626 - `FullPool` event is now renamed to `busy`.
627 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
628 _Find more details on our JSDoc._
630 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
632 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
634 ### Pool options types declaration merge
636 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
638 #### New `export` strategy
642 const DynamicThreadPool = require('poolifier/lib/dynamic')
644 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
647 But you should always prefer just using
650 const { DynamicThreadPool } = require('poolifier')
653 #### New type definitions for input data and response
655 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
656 _This is not a limitation by poolifier but NodeJS._
658 #### Public property replacements
660 `numWorkers` property is now `numberOfWorkers`
662 #### Internal (protected) properties and methods renaming
664 These properties are not intended for end users
666 - `id` => `nextMessageId`
668 These methods are not intended for end users
670 - `_chooseWorker` => `chooseWorker`
671 - `_newWorker` => `createWorker`
672 - `_execute` => `internalExecute`
673 - `_chooseWorker` => `chooseWorker`
674 - `_checkAlive` => `checkAlive`
676 - `_runAsync` => `runAsync`
678 ## [1.1.0] - 2020-05-21
682 - ThreadWorker support async functions as option
683 - Various external library patches
685 ## [1.0.0] - 2020-01-24
689 - FixedThreadPool implementation
690 - DynamicThreadPool implementation
691 - WorkerThread implementation to improve developer experience