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 pool `utilization` ratio to pool information.
13 - Add worker information to worker nodes.
15 ## [2.6.6] - 2023-07-01
19 - Add safe helper `availableParallelism` to help sizing the pool.
23 - Ensure message handler is only registered in worker.
25 ## [2.6.5] - 2023-06-27
29 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
33 - Artificial version bump to 2.6.5 to workaround publication issue.
34 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
35 - Ensure pool event is emitted before task error promise rejection.
36 - Fix queued tasks count computation.
40 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
42 ## [2.6.4] - 2023-06-27
46 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
50 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
51 - Ensure pool event is emitted before task error promise rejection.
52 - Fix queued tasks count computation.
56 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
58 ## [2.6.3] - 2023-06-19
62 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
63 - Update strategies internals after statistics computation.
67 - Optimize O(1) queue implementation.
69 ## [2.6.2] - 2023-06-12
73 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
75 ## [2.6.1] - 2023-06-10
79 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
83 - Fix average statistics computation: ensure failed tasks are not accounted.
85 ## [2.6.0] - 2023-06-09
89 - Add `LEAST_ELU` worker choice strategy (experimental).
90 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
94 - Refactor pool worker node usage internals.
95 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
96 - Breaking change: pool information `info` property object fields have been renamed.
100 - Fix wait time accounting.
101 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
102 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
104 ## [2.5.4] - 2023-06-07
108 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
112 - Compute statistics at the worker level only if needed.
113 - Add `worker-threads` options to thread pool options.
117 - Make the `LEAST_BUSY` strategy only relies on task runtime.
119 ## [2.5.3] - 2023-06-04
123 - Refine pool information content.
124 - Limit pool internals public exposure.
126 ## [2.5.2] - 2023-06-02
130 - Add `taskError` pool event for task execution error.
131 - Add pool information `info` property to pool.
132 - Emit pool information on `busy` and `full` pool events.
134 ## [2.5.1] - 2023-06-01
138 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
139 - Add `error` pool event for uncaught worker error.
141 ## [2.5.0] - 2023-05-31
145 - Switch pool event emitter to `EventEmitterAsyncResource`.
146 - Add tasks wait time accounting in per worker tasks usage.
147 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
151 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
153 ## [2.4.14] - 2023-05-09
157 - Ensure no undefined task runtime can land in the tasks history.
158 - Fix median computation implementation once again.
162 - Unit tests for median and queue implementations.
164 ## [2.4.13] - 2023-05-08
168 - Fix worker choice strategy options validation.
169 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
171 ## [2.4.12] - 2023-05-06
175 - Support multiple task functions per worker.
176 - Add custom worker weights support to worker choice strategies options.
180 - Use O(1) queue implementation for tasks queueing.
184 - Fix median computation implementation.
185 - Fix fair share worker choice strategy internals update.
187 ## [2.4.11] - 2023-04-23
191 - Optimize free worker finding in worker choice strategies.
193 ## [2.4.10] - 2023-04-15
197 - Fix typescript type definition for worker function: ensure the input data is optional.
198 - Fix typescript type definition for pool execute(): ensure the input data is optional.
200 ## [2.4.9] - 2023-04-15
204 - Add tasks queue enablement runtime setter to pool.
205 - Add tasks queue options runtime setter to pool.
206 - Add worker choice strategy options runtime setter to pool.
210 - Remove the tasks queuing experimental status.
214 - Fix worker function type definition and validation.
215 - Fix worker choice strategy options handling.
217 ## [2.4.8] - 2023-04-12
221 - Fix message between main worker and worker type definition for tasks.
222 - Fix code documentation.
224 ## [2.4.7] - 2023-04-11
228 - Add worker tasks queue options to pool options.
232 - Fix missing documentation.
234 ## [2.4.6] - 2023-04-10
238 - Ensure one task at a time is executed per worker with tasks queueing enabled.
239 - Properly count worker executing tasks with tasks queueing enabled.
241 ## [2.4.5] - 2023-04-09
245 - Use monotonic high resolution timer for worker tasks runtime.
246 - Add worker tasks median runtime to statistics.
247 - Add worker tasks queue (experimental).
249 ## [2.4.4] - 2023-04-07
253 - Add `PoolEvents` enumeration and `PoolEvent` type.
257 - Destroy worker only on alive check.
259 ## [2.4.3] - 2023-04-07
263 - Fix typedoc generation with inheritance.
265 ## [2.4.2] - 2023-04-06
269 - Add `full` event to dynamic pool.
270 - Keep worker choice strategy in memory for conditional reuse.
274 - Fix possible negative worker key at worker removal in worker choice strategies.
276 ## [2.4.1] - 2023-04-05
280 - Optimize worker choice strategy for dynamic pool.
284 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
286 ## [2.4.0] - 2023-04-04
290 - Add `LESS_BUSY` worker choice strategy.
294 - Optimize worker storage in pool.
295 - Optimize worker alive status check.
296 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
297 - Optimize `LESS_USED` worker choice strategy.
298 - Update benchmarks versus external threads pools.
299 - Optimize tasks usage statistics requirements for worker choice strategy.
303 - Ensure trimmable characters are checked at pool initialization.
304 - Fix message id integer overflow.
305 - Fix pool worker removal in worker choice strategy internals.
306 - Fix package publication with pnpm.
308 ## [2.4.0-3] - 2023-04-04
312 - Add `LESS_BUSY` worker choice strategy.
316 - Optimize worker storage in pool.
317 - Optimize worker alive status check.
318 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
319 - Optimize `LESS_USED` worker choice strategy.
320 - Update benchmarks versus external threads pools.
324 - Ensure trimmable characters are checked at pool initialization.
325 - Fix message id integer overflow.
326 - Fix pool worker removal in worker choice strategy internals.
327 - Fix package publication with pnpm.
329 ## [2.4.0-2] - 2023-04-03
333 - Add `LESS_BUSY` worker choice strategy.
337 - Optimize worker storage in pool.
338 - Optimize worker alive status check.
339 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
340 - Optimize `LESS_USED` worker choice strategy.
344 - Ensure trimmable characters are checked at pool initialization.
345 - Fix message id integer overflow.
346 - Fix pool worker removal in worker choice strategy internals.
347 - Fix package publication with pnpm.
349 ## [2.4.0-1] - 2023-04-03
353 - Add `LESS_BUSY` worker choice strategy.
357 - Optimize worker storage in pool.
358 - Optimize worker alive status check.
359 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
360 - Optimize `LESS_USED` worker choice strategy.
364 - Ensure trimmable characters are checked at pool initialization.
365 - Fix message id integer overflow.
366 - Fix pool worker removal in worker choice strategy internals.
368 ## [2.4.0-0] - 2023-04-03
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.
383 - Ensure trimmable characters are checked at pool initialization.
384 - Fix message id integer overflow.
385 - Fix pool worker removal in worker choice strategy internals.
387 ## [2.3.10] - 2023-03-18
391 - Fix `exports` syntax for ESM and CommonJS.
395 - Permit SemVer pre-release publication.
397 ## [2.3.10-2] - 2023-03-18
401 - Fix `exports` syntax for ESM and CommonJS.
403 ## [2.3.10-1] - 2023-03-18
407 - Permit SemVer pre-release publication.
409 ## [2.3.10-0] - 2023-03-18
413 - Fix `exports` syntax for ESM and CommonJS.
415 ## [2.3.9] - 2023-03-18
419 - Introduce ESM module support along with CommonJS one.
423 - Fix brown paper bag bug referencing the same object literal.
425 ## [2.3.8] - 2023-03-18
429 - Switch internal benchmarking code to benny.
430 - Switch to TypeScript 5.x.x.
431 - Switch rollup bundler plugins to core ones.
432 - Switch to TSDoc syntax.
433 - Enforce conventional commits.
437 - Fix random integer generator.
438 - Fix worker choice strategy pool type identification at initialization.
440 ## [2.3.7] - 2022-10-23
444 - Switch to open collective FOSS project funding platform.
445 - Switch to ts-standard linter configuration on TypeScript code.
449 - Fixed missing async on pool execute method.
450 - Fixed typing in TypeScript example.
451 - Fixed types in unit tests.
453 ## [2.3.6] - 2022-10-22
457 - Cleanup pool attributes and methods.
458 - Refine error types thrown.
462 - Fix continuous integration build on windows.
463 - Fix code coverage reporting by using c8 instead of nyc.
465 ## [2.3.5] - 2022-10-21
469 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
470 - Optimize tasks usage lookup implementation.
474 - Fix missed pool event emitter type export.
475 - Fix typedoc documentation generation.
477 ## [2.3.4] - 2022-10-17
481 - Fully automate release process with release-it.
485 - Optimize fair share task scheduling algorithm implementation.
486 - Update benchmarks versus external pools results with latest version.
488 ## [2.3.3] - 2022-10-15
492 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
494 ## [2.3.2] - 2022-10-14
498 - Optimize fair share worker selection strategy implementation.
502 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
504 ## [2.3.1] - 2022-10-13
508 - Pool worker choice strategies:
509 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
510 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
512 ## [2.2.2] - 2022-10-09
516 - Fixed `README.md` file.
518 ## [2.2.1] - 2022-10-08
522 - Dynamic worker choice strategy change at runtime.
524 ## [2.2.0] - 2022-01-05
528 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
530 ## [2.1.0] - 2021-08-29
534 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
538 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
539 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
540 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
541 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
543 ## [2.0.2] - 2021-05-12
547 - Fix `busy` event emission on fixed pool type
549 ## [2.0.1] - 2021-03-16
553 - Check if pool options are properly set.
554 - `busy` event is emitted on all pool types.
556 ## [2.0.0] - 2021-03-01
560 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
564 - `FullPool` event is now renamed to `busy`.
565 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
566 _Find more details on our JSDoc._
568 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
570 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
572 ### Pool options types declaration merge
574 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
576 #### New `export` strategy
580 const DynamicThreadPool = require('poolifier/lib/dynamic')
582 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
585 But you should always prefer just using
588 const { DynamicThreadPool } = require('poolifier')
591 #### New type definitions for input data and response
593 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
594 _This is not a limitation by poolifier but NodeJS._
596 #### Public property replacements
598 `numWorkers` property is now `numberOfWorkers`
600 #### Internal (protected) properties and methods renaming
602 These properties are not intended for end users
604 - `id` => `nextMessageId`
606 These methods are not intended for end users
608 - `_chooseWorker` => `chooseWorker`
609 - `_newWorker` => `createWorker`
610 - `_execute` => `internalExecute`
611 - `_chooseWorker` => `chooseWorker`
612 - `_checkAlive` => `checkAlive`
614 - `_runAsync` => `runAsync`
616 ## [1.1.0] - 2020-05-21
620 - ThreadWorker support async functions as option
621 - Various external library patches
623 ## [1.0.0] - 2020-01-24
627 - FixedThreadPool implementation
628 - DynamicThreadPool implementation
629 - WorkerThread implementation to improve developer experience