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 cluster pool destroy() gracefully shutdowns worker's server.
13 - Ensure pool event is emitted before task error promise rejection.
14 - Fix queued tasks count computation.
16 ## [2.6.3] - 2023-06-19
20 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
21 - Update strategies internals after statistics computation.
25 - Optimize O(1) queue implementation.
27 ## [2.6.2] - 2023-06-12
31 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
33 ## [2.6.1] - 2023-06-10
37 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
41 - Fix average statistics computation: ensure failed tasks are not accounted.
43 ## [2.6.0] - 2023-06-09
47 - Add `LEAST_ELU` worker choice strategy (experimental).
48 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
52 - Refactor pool worker node usage internals.
53 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
54 - Breaking change: pool information `info` property object fields have been renamed.
58 - Fix wait time accounting.
59 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
60 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
62 ## [2.5.4] - 2023-06-07
66 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
70 - Compute statistics at the worker level only if needed.
71 - Add `worker-threads` options to thread pool options.
75 - Make the `LEAST_BUSY` strategy only relies on task runtime.
77 ## [2.5.3] - 2023-06-04
81 - Refine pool information content.
82 - Limit pool internals public exposure.
84 ## [2.5.2] - 2023-06-02
88 - Add `taskError` pool event for task execution error.
89 - Add pool information `info` property to pool.
90 - Emit pool information on `busy` and `full` pool events.
92 ## [2.5.1] - 2023-06-01
96 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
97 - Add `error` pool event for uncaught worker error.
99 ## [2.5.0] - 2023-05-31
103 - Switch pool event emitter to `EventEmitterAsyncResource`.
104 - Add tasks wait time accounting in per worker tasks usage.
105 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
109 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
111 ## [2.4.14] - 2023-05-09
115 - Ensure no undefined task runtime can land in the tasks history.
116 - Fix median computation implementation once again.
120 - Unit tests for median and queue implementations.
122 ## [2.4.13] - 2023-05-08
126 - Fix worker choice strategy options validation.
127 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
129 ## [2.4.12] - 2023-05-06
133 - Support multiple task functions per worker.
134 - Add custom worker weights support to worker choice strategies options.
138 - Use O(1) queue implementation for tasks queueing.
142 - Fix median computation implementation.
143 - Fix fair share worker choice strategy internals update.
145 ## [2.4.11] - 2023-04-23
149 - Optimize free worker finding in worker choice strategies.
151 ## [2.4.10] - 2023-04-15
155 - Fix typescript type definition for worker function: ensure the input data is optional.
156 - Fix typescript type definition for pool execute(): ensure the input data is optional.
158 ## [2.4.9] - 2023-04-15
162 - Add tasks queue enablement runtime setter to pool.
163 - Add tasks queue options runtime setter to pool.
164 - Add worker choice strategy options runtime setter to pool.
168 - Remove the tasks queuing experimental status.
172 - Fix worker function type definition and validation.
173 - Fix worker choice strategy options handling.
175 ## [2.4.8] - 2023-04-12
179 - Fix message between main worker and worker type definition for tasks.
180 - Fix code documentation.
182 ## [2.4.7] - 2023-04-11
186 - Add worker tasks queue options to pool options.
190 - Fix missing documentation.
192 ## [2.4.6] - 2023-04-10
196 - Ensure one task at a time is executed per worker with tasks queueing enabled.
197 - Properly count worker executing tasks with tasks queueing enabled.
199 ## [2.4.5] - 2023-04-09
203 - Use monotonic high resolution timer for worker tasks runtime.
204 - Add worker tasks median runtime to statistics.
205 - Add worker tasks queue (experimental).
207 ## [2.4.4] - 2023-04-07
211 - Add `PoolEvents` enumeration and `PoolEvent` type.
215 - Destroy worker only on alive check.
217 ## [2.4.3] - 2023-04-07
221 - Fix typedoc generation with inheritance.
223 ## [2.4.2] - 2023-04-06
227 - Add `full` event to dynamic pool.
228 - Keep worker choice strategy in memory for conditional reuse.
232 - Fix possible negative worker key at worker removal in worker choice strategies.
234 ## [2.4.1] - 2023-04-05
238 - Optimize worker choice strategy for dynamic pool.
242 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
244 ## [2.4.0] - 2023-04-04
248 - Add `LESS_BUSY` worker choice strategy.
252 - Optimize worker storage in pool.
253 - Optimize worker alive status check.
254 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
255 - Optimize `LESS_USED` worker choice strategy.
256 - Update benchmarks versus external threads pools.
257 - Optimize tasks usage statistics requirements for worker choice strategy.
261 - Ensure trimmable characters are checked at pool initialization.
262 - Fix message id integer overflow.
263 - Fix pool worker removal in worker choice strategy internals.
264 - Fix package publication with pnpm.
266 ## [2.4.0-3] - 2023-04-04
270 - Add `LESS_BUSY` worker choice strategy.
274 - Optimize worker storage in pool.
275 - Optimize worker alive status check.
276 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
277 - Optimize `LESS_USED` worker choice strategy.
278 - Update benchmarks versus external threads pools.
282 - Ensure trimmable characters are checked at pool initialization.
283 - Fix message id integer overflow.
284 - Fix pool worker removal in worker choice strategy internals.
285 - Fix package publication with pnpm.
287 ## [2.4.0-2] - 2023-04-03
291 - Add `LESS_BUSY` worker choice strategy.
295 - Optimize worker storage in pool.
296 - Optimize worker alive status check.
297 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
298 - Optimize `LESS_USED` worker choice strategy.
302 - Ensure trimmable characters are checked at pool initialization.
303 - Fix message id integer overflow.
304 - Fix pool worker removal in worker choice strategy internals.
305 - Fix package publication with pnpm.
307 ## [2.4.0-1] - 2023-04-03
311 - Add `LESS_BUSY` worker choice strategy.
315 - Optimize worker storage in pool.
316 - Optimize worker alive status check.
317 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
318 - Optimize `LESS_USED` worker choice strategy.
322 - Ensure trimmable characters are checked at pool initialization.
323 - Fix message id integer overflow.
324 - Fix pool worker removal in worker choice strategy internals.
326 ## [2.4.0-0] - 2023-04-03
330 - Add `LESS_BUSY` worker choice strategy.
334 - Optimize worker storage in pool.
335 - Optimize worker alive status check.
336 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
337 - Optimize `LESS_USED` worker choice strategy.
341 - Ensure trimmable characters are checked at pool initialization.
342 - Fix message id integer overflow.
343 - Fix pool worker removal in worker choice strategy internals.
345 ## [2.3.10] - 2023-03-18
349 - Fix `exports` syntax for ESM and CommonJS.
353 - Permit SemVer pre-release publication.
355 ## [2.3.10-2] - 2023-03-18
359 - Fix `exports` syntax for ESM and CommonJS.
361 ## [2.3.10-1] - 2023-03-18
365 - Permit SemVer pre-release publication.
367 ## [2.3.10-0] - 2023-03-18
371 - Fix `exports` syntax for ESM and CommonJS.
373 ## [2.3.9] - 2023-03-18
377 - Introduce ESM module support along with CommonJS one.
381 - Fix brown paper bag bug referencing the same object literal.
383 ## [2.3.8] - 2023-03-18
387 - Switch internal benchmarking code to benny.
388 - Switch to TypeScript 5.x.x.
389 - Switch rollup bundler plugins to core ones.
390 - Switch to TSDoc syntax.
391 - Enforce conventional commits.
395 - Fix random integer generator.
396 - Fix worker choice strategy pool type identification at initialization.
398 ## [2.3.7] - 2022-10-23
402 - Switch to open collective FOSS project funding platform.
403 - Switch to ts-standard linter configuration on TypeScript code.
407 - Fixed missing async on pool execute method.
408 - Fixed typing in TypeScript example.
409 - Fixed types in unit tests.
411 ## [2.3.6] - 2022-10-22
415 - Cleanup pool attributes and methods.
416 - Refine error types thrown.
420 - Fix continuous integration build on windows.
421 - Fix code coverage reporting by using c8 instead of nyc.
423 ## [2.3.5] - 2022-10-21
427 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
428 - Optimize tasks usage lookup implementation.
432 - Fix missed pool event emitter type export.
433 - Fix typedoc documentation generation.
435 ## [2.3.4] - 2022-10-17
439 - Fully automate release process with release-it.
443 - Optimize fair share task scheduling algorithm implementation.
444 - Update benchmarks versus external pools results with latest version.
446 ## [2.3.3] - 2022-10-15
450 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
452 ## [2.3.2] - 2022-10-14
456 - Optimize fair share worker selection strategy implementation.
460 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
462 ## [2.3.1] - 2022-10-13
466 - Pool worker choice strategies:
467 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
468 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
470 ## [2.2.2] - 2022-10-09
474 - Fixed `README.md` file.
476 ## [2.2.1] - 2022-10-08
480 - Dynamic worker choice strategy change at runtime.
482 ## [2.2.0] - 2022-01-05
486 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
488 ## [2.1.0] - 2021-08-29
492 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
496 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
497 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
498 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
499 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
501 ## [2.0.2] - 2021-05-12
505 - Fix `busy` event emission on fixed pool type
507 ## [2.0.1] - 2021-03-16
511 - Check if pool options are properly set.
512 - `busy` event is emitted on all pool types.
514 ## [2.0.0] - 2021-03-01
518 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
522 - `FullPool` event is now renamed to `busy`.
523 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
524 _Find more details on our JSDoc._
526 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
528 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
530 ### Pool options types declaration merge
532 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
534 #### New `export` strategy
538 const DynamicThreadPool = require('poolifier/lib/dynamic')
540 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
543 But you should always prefer just using
546 const { DynamicThreadPool } = require('poolifier')
549 #### New type definitions for input data and response
551 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
552 _This is not a limitation by poolifier but NodeJS._
554 #### Public property replacements
556 `numWorkers` property is now `numberOfWorkers`
558 #### Internal (protected) properties and methods renaming
560 These properties are not intended for end users
562 - `id` => `nextMessageId`
564 These methods are not intended for end users
566 - `_chooseWorker` => `chooseWorker`
567 - `_newWorker` => `createWorker`
568 - `_execute` => `internalExecute`
569 - `_chooseWorker` => `chooseWorker`
570 - `_checkAlive` => `checkAlive`
572 - `_runAsync` => `runAsync`
574 ## [1.1.0] - 2020-05-21
578 - ThreadWorker support async functions as option
579 - Various external library patches
581 ## [1.0.0] - 2020-01-24
585 - FixedThreadPool implementation
586 - DynamicThreadPool implementation
587 - WorkerThread implementation to improve developer experience