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.3] - 2023-06-19
14 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
15 - Update strategies internals after statistics computation.
19 - Optimize O(1) queue implementation.
21 ## [2.6.2] - 2023-06-12
25 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
27 ## [2.6.1] - 2023-06-10
31 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
35 - Fix average statistics computation: ensure failed tasks are not accounted.
37 ## [2.6.0] - 2023-06-09
41 - Add `LEAST_ELU` worker choice strategy (experimental).
42 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
46 - Refactor pool worker node usage internals.
47 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
48 - Breaking change: pool information `info` property object fields have been renamed.
52 - Fix wait time accounting.
53 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
54 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
56 ## [2.5.4] - 2023-06-07
60 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
64 - Compute statistics at the worker level only if needed.
65 - Add `worker-threads` options to thread pool options.
69 - Make the `LEAST_BUSY` strategy only relies on task runtime.
71 ## [2.5.3] - 2023-06-04
75 - Refine pool information content.
76 - Limit pool internals public exposure.
78 ## [2.5.2] - 2023-06-02
82 - Add `taskError` pool event for task execution error.
83 - Add pool information `info` property to pool.
84 - Emit pool information on `busy` and `full` pool events.
86 ## [2.5.1] - 2023-06-01
90 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
91 - Add `error` pool event for uncaught worker error.
93 ## [2.5.0] - 2023-05-31
97 - Switch pool event emitter to `EventEmitterAsyncResource`.
98 - Add tasks wait time accounting in per worker tasks usage.
99 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
103 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
105 ## [2.4.14] - 2023-05-09
109 - Ensure no undefined task runtime can land in the tasks history.
110 - Fix median computation implementation once again.
114 - Unit tests for median and queue implementations.
116 ## [2.4.13] - 2023-05-08
120 - Fix worker choice strategy options validation.
121 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
123 ## [2.4.12] - 2023-05-06
127 - Support multiple task functions per worker.
128 - Add custom worker weights support to worker choice strategies options.
132 - Use O(1) queue implementation for tasks queueing.
136 - Fix median computation implementation.
137 - Fix fair share worker choice strategy internals update.
139 ## [2.4.11] - 2023-04-23
143 - Optimize free worker finding in worker choice strategies.
145 ## [2.4.10] - 2023-04-15
149 - Fix typescript type definition for worker function: ensure the input data is optional.
150 - Fix typescript type definition for pool execute(): ensure the input data is optional.
152 ## [2.4.9] - 2023-04-15
156 - Add tasks queue enablement runtime setter to pool.
157 - Add tasks queue options runtime setter to pool.
158 - Add worker choice strategy options runtime setter to pool.
162 - Remove the tasks queuing experimental status.
166 - Fix worker function type definition and validation.
167 - Fix worker choice strategy options handling.
169 ## [2.4.8] - 2023-04-12
173 - Fix message between main worker and worker type definition for tasks.
174 - Fix code documentation.
176 ## [2.4.7] - 2023-04-11
180 - Add worker tasks queue options to pool options.
184 - Fix missing documentation.
186 ## [2.4.6] - 2023-04-10
190 - Ensure one task at a time is executed per worker with tasks queueing enabled.
191 - Properly count worker executing tasks with tasks queueing enabled.
193 ## [2.4.5] - 2023-04-09
197 - Use monotonic high resolution timer for worker tasks runtime.
198 - Add worker tasks median runtime to statistics.
199 - Add worker tasks queue (experimental).
201 ## [2.4.4] - 2023-04-07
205 - Add `PoolEvents` enumeration and `PoolEvent` type.
209 - Destroy worker only on alive check.
211 ## [2.4.3] - 2023-04-07
215 - Fix typedoc generation with inheritance.
217 ## [2.4.2] - 2023-04-06
221 - Add `full` event to dynamic pool.
222 - Keep worker choice strategy in memory for conditional reuse.
226 - Fix possible negative worker key at worker removal in worker choice strategies.
228 ## [2.4.1] - 2023-04-05
232 - Optimize worker choice strategy for dynamic pool.
236 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
238 ## [2.4.0] - 2023-04-04
242 - Add `LESS_BUSY` worker choice strategy.
246 - Optimize worker storage in pool.
247 - Optimize worker alive status check.
248 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
249 - Optimize `LESS_USED` worker choice strategy.
250 - Update benchmarks versus external threads pools.
251 - Optimize tasks usage statistics requirements for worker choice strategy.
255 - Ensure trimmable characters are checked at pool initialization.
256 - Fix message id integer overflow.
257 - Fix pool worker removal in worker choice strategy internals.
258 - Fix package publication with pnpm.
260 ## [2.4.0-3] - 2023-04-04
264 - Add `LESS_BUSY` worker choice strategy.
268 - Optimize worker storage in pool.
269 - Optimize worker alive status check.
270 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
271 - Optimize `LESS_USED` worker choice strategy.
272 - Update benchmarks versus external threads pools.
276 - Ensure trimmable characters are checked at pool initialization.
277 - Fix message id integer overflow.
278 - Fix pool worker removal in worker choice strategy internals.
279 - Fix package publication with pnpm.
281 ## [2.4.0-2] - 2023-04-03
285 - Add `LESS_BUSY` worker choice strategy.
289 - Optimize worker storage in pool.
290 - Optimize worker alive status check.
291 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
292 - Optimize `LESS_USED` worker choice strategy.
296 - Ensure trimmable characters are checked at pool initialization.
297 - Fix message id integer overflow.
298 - Fix pool worker removal in worker choice strategy internals.
299 - Fix package publication with pnpm.
301 ## [2.4.0-1] - 2023-04-03
305 - Add `LESS_BUSY` worker choice strategy.
309 - Optimize worker storage in pool.
310 - Optimize worker alive status check.
311 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
312 - Optimize `LESS_USED` worker choice strategy.
316 - Ensure trimmable characters are checked at pool initialization.
317 - Fix message id integer overflow.
318 - Fix pool worker removal in worker choice strategy internals.
320 ## [2.4.0-0] - 2023-04-03
324 - Add `LESS_BUSY` worker choice strategy.
328 - Optimize worker storage in pool.
329 - Optimize worker alive status check.
330 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
331 - Optimize `LESS_USED` worker choice strategy.
335 - Ensure trimmable characters are checked at pool initialization.
336 - Fix message id integer overflow.
337 - Fix pool worker removal in worker choice strategy internals.
339 ## [2.3.10] - 2023-03-18
343 - Fix `exports` syntax for ESM and CommonJS.
347 - Permit SemVer pre-release publication.
349 ## [2.3.10-2] - 2023-03-18
353 - Fix `exports` syntax for ESM and CommonJS.
355 ## [2.3.10-1] - 2023-03-18
359 - Permit SemVer pre-release publication.
361 ## [2.3.10-0] - 2023-03-18
365 - Fix `exports` syntax for ESM and CommonJS.
367 ## [2.3.9] - 2023-03-18
371 - Introduce ESM module support along with CommonJS one.
375 - Fix brown paper bag bug referencing the same object literal.
377 ## [2.3.8] - 2023-03-18
381 - Switch internal benchmarking code to benny.
382 - Switch to TypeScript 5.x.x.
383 - Switch rollup bundler plugins to core ones.
384 - Switch to TSDoc syntax.
385 - Enforce conventional commits.
389 - Fix random integer generator.
390 - Fix worker choice strategy pool type identification at initialization.
392 ## [2.3.7] - 2022-10-23
396 - Switch to open collective FOSS project funding platform.
397 - Switch to ts-standard linter configuration on TypeScript code.
401 - Fixed missing async on pool execute method.
402 - Fixed typing in TypeScript example.
403 - Fixed types in unit tests.
405 ## [2.3.6] - 2022-10-22
409 - Cleanup pool attributes and methods.
410 - Refine error types thrown.
414 - Fix continuous integration build on windows.
415 - Fix code coverage reporting by using c8 instead of nyc.
417 ## [2.3.5] - 2022-10-21
421 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
422 - Optimize tasks usage lookup implementation.
426 - Fix missed pool event emitter type export.
427 - Fix typedoc documentation generation.
429 ## [2.3.4] - 2022-10-17
433 - Fully automate release process with release-it.
437 - Optimize fair share task scheduling algorithm implementation.
438 - Update benchmarks versus external pools results with latest version.
440 ## [2.3.3] - 2022-10-15
444 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
446 ## [2.3.2] - 2022-10-14
450 - Optimize fair share worker selection strategy implementation.
454 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
456 ## [2.3.1] - 2022-10-13
460 - Pool worker choice strategies:
461 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
462 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
464 ## [2.2.2] - 2022-10-09
468 - Fixed `README.md` file.
470 ## [2.2.1] - 2022-10-08
474 - Dynamic worker choice strategy change at runtime.
476 ## [2.2.0] - 2022-01-05
480 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
482 ## [2.1.0] - 2021-08-29
486 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
490 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
491 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
492 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
493 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
495 ## [2.0.2] - 2021-05-12
499 - Fix `busy` event emission on fixed pool type
501 ## [2.0.1] - 2021-03-16
505 - Check if pool options are properly set.
506 - `busy` event is emitted on all pool types.
508 ## [2.0.0] - 2021-03-01
512 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
516 - `FullPool` event is now renamed to `busy`.
517 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
518 _Find more details on our JSDoc._
520 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
522 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
524 ### Pool options types declaration merge
526 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
528 #### New `export` strategy
532 const DynamicThreadPool = require('poolifier/lib/dynamic')
534 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
537 But you should always prefer just using
540 const { DynamicThreadPool } = require('poolifier')
543 #### New type definitions for input data and response
545 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
546 _This is not a limitation by poolifier but NodeJS._
548 #### Public property replacements
550 `numWorkers` property is now `numberOfWorkers`
552 #### Internal (protected) properties and methods renaming
554 These properties are not intended for end users
556 - `id` => `nextMessageId`
558 These methods are not intended for end users
560 - `_chooseWorker` => `chooseWorker`
561 - `_newWorker` => `createWorker`
562 - `_execute` => `internalExecute`
563 - `_chooseWorker` => `chooseWorker`
564 - `_checkAlive` => `checkAlive`
566 - `_runAsync` => `runAsync`
568 ## [1.1.0] - 2020-05-21
572 - ThreadWorker support async functions as option
573 - Various external library patches
575 ## [1.0.0] - 2020-01-24
579 - FixedThreadPool implementation
580 - DynamicThreadPool implementation
581 - WorkerThread implementation to improve developer experience