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 - Ensure worker queued tasks at error are reassigned to other pool workers.
16 - Add pool `utilization` ratio to pool information.
17 - Add worker information to worker nodes.
19 ## [2.6.6] - 2023-07-01
23 - Add safe helper `availableParallelism` to help sizing the pool.
27 - Ensure message handler is only registered in worker.
29 ## [2.6.5] - 2023-06-27
33 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
37 - Artificial version bump to 2.6.5 to workaround publication issue.
38 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
39 - Ensure pool event is emitted before task error promise rejection.
40 - Fix queued tasks count computation.
44 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
46 ## [2.6.4] - 2023-06-27
50 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
54 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
55 - Ensure pool event is emitted before task error promise rejection.
56 - Fix queued tasks count computation.
60 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
62 ## [2.6.3] - 2023-06-19
66 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
67 - Update strategies internals after statistics computation.
71 - Optimize O(1) queue implementation.
73 ## [2.6.2] - 2023-06-12
77 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
79 ## [2.6.1] - 2023-06-10
83 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
87 - Fix average statistics computation: ensure failed tasks are not accounted.
89 ## [2.6.0] - 2023-06-09
93 - Add `LEAST_ELU` worker choice strategy (experimental).
94 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
98 - Refactor pool worker node usage internals.
99 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
100 - Breaking change: pool information `info` property object fields have been renamed.
104 - Fix wait time accounting.
105 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
106 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
108 ## [2.5.4] - 2023-06-07
112 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
116 - Compute statistics at the worker level only if needed.
117 - Add `worker-threads` options to thread pool options.
121 - Make the `LEAST_BUSY` strategy only relies on task runtime.
123 ## [2.5.3] - 2023-06-04
127 - Refine pool information content.
128 - Limit pool internals public exposure.
130 ## [2.5.2] - 2023-06-02
134 - Add `taskError` pool event for task execution error.
135 - Add pool information `info` property to pool.
136 - Emit pool information on `busy` and `full` pool events.
138 ## [2.5.1] - 2023-06-01
142 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
143 - Add `error` pool event for uncaught worker error.
145 ## [2.5.0] - 2023-05-31
149 - Switch pool event emitter to `EventEmitterAsyncResource`.
150 - Add tasks wait time accounting in per worker tasks usage.
151 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
155 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
157 ## [2.4.14] - 2023-05-09
161 - Ensure no undefined task runtime can land in the tasks history.
162 - Fix median computation implementation once again.
166 - Unit tests for median and queue implementations.
168 ## [2.4.13] - 2023-05-08
172 - Fix worker choice strategy options validation.
173 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
175 ## [2.4.12] - 2023-05-06
179 - Support multiple task functions per worker.
180 - Add custom worker weights support to worker choice strategies options.
184 - Use O(1) queue implementation for tasks queueing.
188 - Fix median computation implementation.
189 - Fix fair share worker choice strategy internals update.
191 ## [2.4.11] - 2023-04-23
195 - Optimize free worker finding in worker choice strategies.
197 ## [2.4.10] - 2023-04-15
201 - Fix typescript type definition for worker function: ensure the input data is optional.
202 - Fix typescript type definition for pool execute(): ensure the input data is optional.
204 ## [2.4.9] - 2023-04-15
208 - Add tasks queue enablement runtime setter to pool.
209 - Add tasks queue options runtime setter to pool.
210 - Add worker choice strategy options runtime setter to pool.
214 - Remove the tasks queuing experimental status.
218 - Fix worker function type definition and validation.
219 - Fix worker choice strategy options handling.
221 ## [2.4.8] - 2023-04-12
225 - Fix message between main worker and worker type definition for tasks.
226 - Fix code documentation.
228 ## [2.4.7] - 2023-04-11
232 - Add worker tasks queue options to pool options.
236 - Fix missing documentation.
238 ## [2.4.6] - 2023-04-10
242 - Ensure one task at a time is executed per worker with tasks queueing enabled.
243 - Properly count worker executing tasks with tasks queueing enabled.
245 ## [2.4.5] - 2023-04-09
249 - Use monotonic high resolution timer for worker tasks runtime.
250 - Add worker tasks median runtime to statistics.
251 - Add worker tasks queue (experimental).
253 ## [2.4.4] - 2023-04-07
257 - Add `PoolEvents` enumeration and `PoolEvent` type.
261 - Destroy worker only on alive check.
263 ## [2.4.3] - 2023-04-07
267 - Fix typedoc generation with inheritance.
269 ## [2.4.2] - 2023-04-06
273 - Add `full` event to dynamic pool.
274 - Keep worker choice strategy in memory for conditional reuse.
278 - Fix possible negative worker key at worker removal in worker choice strategies.
280 ## [2.4.1] - 2023-04-05
284 - Optimize worker choice strategy for dynamic pool.
288 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
290 ## [2.4.0] - 2023-04-04
294 - Add `LESS_BUSY` worker choice strategy.
298 - Optimize worker storage in pool.
299 - Optimize worker alive status check.
300 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
301 - Optimize `LESS_USED` worker choice strategy.
302 - Update benchmarks versus external threads pools.
303 - Optimize tasks usage statistics requirements for worker choice strategy.
307 - Ensure trimmable characters are checked at pool initialization.
308 - Fix message id integer overflow.
309 - Fix pool worker removal in worker choice strategy internals.
310 - Fix package publication with pnpm.
312 ## [2.4.0-3] - 2023-04-04
316 - Add `LESS_BUSY` worker choice strategy.
320 - Optimize worker storage in pool.
321 - Optimize worker alive status check.
322 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
323 - Optimize `LESS_USED` worker choice strategy.
324 - Update benchmarks versus external threads pools.
328 - Ensure trimmable characters are checked at pool initialization.
329 - Fix message id integer overflow.
330 - Fix pool worker removal in worker choice strategy internals.
331 - Fix package publication with pnpm.
333 ## [2.4.0-2] - 2023-04-03
337 - Add `LESS_BUSY` worker choice strategy.
341 - Optimize worker storage in pool.
342 - Optimize worker alive status check.
343 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
344 - Optimize `LESS_USED` worker choice strategy.
348 - Ensure trimmable characters are checked at pool initialization.
349 - Fix message id integer overflow.
350 - Fix pool worker removal in worker choice strategy internals.
351 - Fix package publication with pnpm.
353 ## [2.4.0-1] - 2023-04-03
357 - Add `LESS_BUSY` worker choice strategy.
361 - Optimize worker storage in pool.
362 - Optimize worker alive status check.
363 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
364 - Optimize `LESS_USED` worker choice strategy.
368 - Ensure trimmable characters are checked at pool initialization.
369 - Fix message id integer overflow.
370 - Fix pool worker removal in worker choice strategy internals.
372 ## [2.4.0-0] - 2023-04-03
376 - Add `LESS_BUSY` worker choice strategy.
380 - Optimize worker storage in pool.
381 - Optimize worker alive status check.
382 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
383 - Optimize `LESS_USED` worker choice strategy.
387 - Ensure trimmable characters are checked at pool initialization.
388 - Fix message id integer overflow.
389 - Fix pool worker removal in worker choice strategy internals.
391 ## [2.3.10] - 2023-03-18
395 - Fix `exports` syntax for ESM and CommonJS.
399 - Permit SemVer pre-release publication.
401 ## [2.3.10-2] - 2023-03-18
405 - Fix `exports` syntax for ESM and CommonJS.
407 ## [2.3.10-1] - 2023-03-18
411 - Permit SemVer pre-release publication.
413 ## [2.3.10-0] - 2023-03-18
417 - Fix `exports` syntax for ESM and CommonJS.
419 ## [2.3.9] - 2023-03-18
423 - Introduce ESM module support along with CommonJS one.
427 - Fix brown paper bag bug referencing the same object literal.
429 ## [2.3.8] - 2023-03-18
433 - Switch internal benchmarking code to benny.
434 - Switch to TypeScript 5.x.x.
435 - Switch rollup bundler plugins to core ones.
436 - Switch to TSDoc syntax.
437 - Enforce conventional commits.
441 - Fix random integer generator.
442 - Fix worker choice strategy pool type identification at initialization.
444 ## [2.3.7] - 2022-10-23
448 - Switch to open collective FOSS project funding platform.
449 - Switch to ts-standard linter configuration on TypeScript code.
453 - Fixed missing async on pool execute method.
454 - Fixed typing in TypeScript example.
455 - Fixed types in unit tests.
457 ## [2.3.6] - 2022-10-22
461 - Cleanup pool attributes and methods.
462 - Refine error types thrown.
466 - Fix continuous integration build on windows.
467 - Fix code coverage reporting by using c8 instead of nyc.
469 ## [2.3.5] - 2022-10-21
473 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
474 - Optimize tasks usage lookup implementation.
478 - Fix missed pool event emitter type export.
479 - Fix typedoc documentation generation.
481 ## [2.3.4] - 2022-10-17
485 - Fully automate release process with release-it.
489 - Optimize fair share task scheduling algorithm implementation.
490 - Update benchmarks versus external pools results with latest version.
492 ## [2.3.3] - 2022-10-15
496 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
498 ## [2.3.2] - 2022-10-14
502 - Optimize fair share worker selection strategy implementation.
506 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
508 ## [2.3.1] - 2022-10-13
512 - Pool worker choice strategies:
513 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
514 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
516 ## [2.2.2] - 2022-10-09
520 - Fixed `README.md` file.
522 ## [2.2.1] - 2022-10-08
526 - Dynamic worker choice strategy change at runtime.
528 ## [2.2.0] - 2022-01-05
532 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
534 ## [2.1.0] - 2021-08-29
538 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
542 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
543 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
544 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
545 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
547 ## [2.0.2] - 2021-05-12
551 - Fix `busy` event emission on fixed pool type
553 ## [2.0.1] - 2021-03-16
557 - Check if pool options are properly set.
558 - `busy` event is emitted on all pool types.
560 ## [2.0.0] - 2021-03-01
564 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
568 - `FullPool` event is now renamed to `busy`.
569 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
570 _Find more details on our JSDoc._
572 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
574 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
576 ### Pool options types declaration merge
578 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
580 #### New `export` strategy
584 const DynamicThreadPool = require('poolifier/lib/dynamic')
586 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
589 But you should always prefer just using
592 const { DynamicThreadPool } = require('poolifier')
595 #### New type definitions for input data and response
597 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
598 _This is not a limitation by poolifier but NodeJS._
600 #### Public property replacements
602 `numWorkers` property is now `numberOfWorkers`
604 #### Internal (protected) properties and methods renaming
606 These properties are not intended for end users
608 - `id` => `nextMessageId`
610 These methods are not intended for end users
612 - `_chooseWorker` => `chooseWorker`
613 - `_newWorker` => `createWorker`
614 - `_execute` => `internalExecute`
615 - `_chooseWorker` => `chooseWorker`
616 - `_checkAlive` => `checkAlive`
618 - `_runAsync` => `runAsync`
620 ## [1.1.0] - 2020-05-21
624 - ThreadWorker support async functions as option
625 - Various external library patches
627 ## [1.0.0] - 2020-01-24
631 - FixedThreadPool implementation
632 - DynamicThreadPool implementation
633 - WorkerThread implementation to improve developer experience