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 no tasks are queued when trying to soft kill a dynamic worker.
16 - Optimize O(1) queue implementation.
17 - Optimize worker choice strategies: pre-choose the worker node key by executing the choice algorithm after tasks submission.
19 ## [2.6.2] - 2023-06-12
23 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
25 ## [2.6.1] - 2023-06-10
29 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
33 - Fix average statistics computation: ensure failed tasks are not accounted.
35 ## [2.6.0] - 2023-06-09
39 - Add `LEAST_ELU` worker choice strategy (experimental).
40 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
44 - Refactor pool worker node usage internals.
45 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
46 - Breaking change: pool information `info` property object fields have been renamed.
50 - Fix wait time accounting.
51 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
52 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
54 ## [2.5.4] - 2023-06-07
58 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
62 - Compute statistics at the worker level only if needed.
63 - Add `worker-threads` options to thread pool options.
67 - Make the `LEAST_BUSY` strategy only relies on task runtime.
69 ## [2.5.3] - 2023-06-04
73 - Refine pool information content.
74 - Limit pool internals public exposure.
76 ## [2.5.2] - 2023-06-02
80 - Add `taskError` pool event for task execution error.
81 - Add pool information `info` property to pool.
82 - Emit pool information on `busy` and `full` pool events.
84 ## [2.5.1] - 2023-06-01
88 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
89 - Add `error` pool event for uncaught worker error.
91 ## [2.5.0] - 2023-05-31
95 - Switch pool event emitter to `EventEmitterAsyncResource`.
96 - Add tasks wait time accounting in per worker tasks usage.
97 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
101 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
103 ## [2.4.14] - 2023-05-09
107 - Ensure no undefined task runtime can land in the tasks history.
108 - Fix median computation implementation once again.
112 - Unit tests for median and queue implementations.
114 ## [2.4.13] - 2023-05-08
118 - Fix worker choice strategy options validation.
119 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
121 ## [2.4.12] - 2023-05-06
125 - Support multiple task functions per worker.
126 - Add custom worker weights support to worker choice strategies options.
130 - Use O(1) queue implementation for tasks queueing.
134 - Fix median computation implementation.
135 - Fix fair share worker choice strategy internals update.
137 ## [2.4.11] - 2023-04-23
141 - Optimize free worker finding in worker choice strategies.
143 ## [2.4.10] - 2023-04-15
147 - Fix typescript type definition for worker function: ensure the input data is optional.
148 - Fix typescript type definition for pool execute(): ensure the input data is optional.
150 ## [2.4.9] - 2023-04-15
154 - Add tasks queue enablement runtime setter to pool.
155 - Add tasks queue options runtime setter to pool.
156 - Add worker choice strategy options runtime setter to pool.
160 - Remove the tasks queuing experimental status.
164 - Fix worker function type definition and validation.
165 - Fix worker choice strategy options handling.
167 ## [2.4.8] - 2023-04-12
171 - Fix message between main worker and worker type definition for tasks.
172 - Fix code documentation.
174 ## [2.4.7] - 2023-04-11
178 - Add worker tasks queue options to pool options.
182 - Fix missing documentation.
184 ## [2.4.6] - 2023-04-10
188 - Ensure one task at a time is executed per worker with tasks queueing enabled.
189 - Properly count worker executing tasks with tasks queueing enabled.
191 ## [2.4.5] - 2023-04-09
195 - Use monotonic high resolution timer for worker tasks runtime.
196 - Add worker tasks median runtime to statistics.
197 - Add worker tasks queue (experimental).
199 ## [2.4.4] - 2023-04-07
203 - Add `PoolEvents` enumeration and `PoolEvent` type.
207 - Destroy worker only on alive check.
209 ## [2.4.3] - 2023-04-07
213 - Fix typedoc generation with inheritance.
215 ## [2.4.2] - 2023-04-06
219 - Add `full` event to dynamic pool.
220 - Keep worker choice strategy in memory for conditional reuse.
224 - Fix possible negative worker key at worker removal in worker choice strategies.
226 ## [2.4.1] - 2023-04-05
230 - Optimize worker choice strategy for dynamic pool.
234 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
236 ## [2.4.0] - 2023-04-04
240 - Add `LESS_BUSY` worker choice strategy.
244 - Optimize worker storage in pool.
245 - Optimize worker alive status check.
246 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
247 - Optimize `LESS_USED` worker choice strategy.
248 - Update benchmarks versus external threads pools.
249 - Optimize tasks usage statistics requirements for worker choice strategy.
253 - Ensure trimmable characters are checked at pool initialization.
254 - Fix message id integer overflow.
255 - Fix pool worker removal in worker choice strategy internals.
256 - Fix package publication with pnpm.
258 ## [2.4.0-3] - 2023-04-04
262 - Add `LESS_BUSY` worker choice strategy.
266 - Optimize worker storage in pool.
267 - Optimize worker alive status check.
268 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
269 - Optimize `LESS_USED` worker choice strategy.
270 - Update benchmarks versus external threads pools.
274 - Ensure trimmable characters are checked at pool initialization.
275 - Fix message id integer overflow.
276 - Fix pool worker removal in worker choice strategy internals.
277 - Fix package publication with pnpm.
279 ## [2.4.0-2] - 2023-04-03
283 - Add `LESS_BUSY` worker choice strategy.
287 - Optimize worker storage in pool.
288 - Optimize worker alive status check.
289 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
290 - Optimize `LESS_USED` worker choice strategy.
294 - Ensure trimmable characters are checked at pool initialization.
295 - Fix message id integer overflow.
296 - Fix pool worker removal in worker choice strategy internals.
297 - Fix package publication with pnpm.
299 ## [2.4.0-1] - 2023-04-03
303 - Add `LESS_BUSY` worker choice strategy.
307 - Optimize worker storage in pool.
308 - Optimize worker alive status check.
309 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
310 - Optimize `LESS_USED` worker choice strategy.
314 - Ensure trimmable characters are checked at pool initialization.
315 - Fix message id integer overflow.
316 - Fix pool worker removal in worker choice strategy internals.
318 ## [2.4.0-0] - 2023-04-03
322 - Add `LESS_BUSY` worker choice strategy.
326 - Optimize worker storage in pool.
327 - Optimize worker alive status check.
328 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
329 - Optimize `LESS_USED` worker choice strategy.
333 - Ensure trimmable characters are checked at pool initialization.
334 - Fix message id integer overflow.
335 - Fix pool worker removal in worker choice strategy internals.
337 ## [2.3.10] - 2023-03-18
341 - Fix `exports` syntax for ESM and CommonJS.
345 - Permit SemVer pre-release publication.
347 ## [2.3.10-2] - 2023-03-18
351 - Fix `exports` syntax for ESM and CommonJS.
353 ## [2.3.10-1] - 2023-03-18
357 - Permit SemVer pre-release publication.
359 ## [2.3.10-0] - 2023-03-18
363 - Fix `exports` syntax for ESM and CommonJS.
365 ## [2.3.9] - 2023-03-18
369 - Introduce ESM module support along with CommonJS one.
373 - Fix brown paper bag bug referencing the same object literal.
375 ## [2.3.8] - 2023-03-18
379 - Switch internal benchmarking code to benny.
380 - Switch to TypeScript 5.x.x.
381 - Switch rollup bundler plugins to core ones.
382 - Switch to TSDoc syntax.
383 - Enforce conventional commits.
387 - Fix random integer generator.
388 - Fix worker choice strategy pool type identification at initialization.
390 ## [2.3.7] - 2022-10-23
394 - Switch to open collective FOSS project funding platform.
395 - Switch to ts-standard linter configuration on TypeScript code.
399 - Fixed missing async on pool execute method.
400 - Fixed typing in TypeScript example.
401 - Fixed types in unit tests.
403 ## [2.3.6] - 2022-10-22
407 - Cleanup pool attributes and methods.
408 - Refine error types thrown.
412 - Fix continuous integration build on windows.
413 - Fix code coverage reporting by using c8 instead of nyc.
415 ## [2.3.5] - 2022-10-21
419 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
420 - Optimize tasks usage lookup implementation.
424 - Fix missed pool event emitter type export.
425 - Fix typedoc documentation generation.
427 ## [2.3.4] - 2022-10-17
431 - Fully automate release process with release-it.
435 - Optimize fair share task scheduling algorithm implementation.
436 - Update benchmarks versus external pools results with latest version.
438 ## [2.3.3] - 2022-10-15
442 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
444 ## [2.3.2] - 2022-10-14
448 - Optimize fair share worker selection strategy implementation.
452 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
454 ## [2.3.1] - 2022-10-13
458 - Pool worker choice strategies:
459 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
460 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
462 ## [2.2.2] - 2022-10-09
466 - Fixed `README.md` file.
468 ## [2.2.1] - 2022-10-08
472 - Dynamic worker choice strategy change at runtime.
474 ## [2.2.0] - 2022-01-05
478 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
480 ## [2.1.0] - 2021-08-29
484 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
488 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
489 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
490 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
491 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
493 ## [2.0.2] - 2021-05-12
497 - Fix `busy` event emission on fixed pool type
499 ## [2.0.1] - 2021-03-16
503 - Check if pool options are properly set.
504 - `busy` event is emitted on all pool types.
506 ## [2.0.0] - 2021-03-01
510 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
514 - `FullPool` event is now renamed to `busy`.
515 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
516 _Find more details on our JSDoc._
518 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
520 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
522 ### Pool options types declaration merge
524 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
526 #### New `export` strategy
530 const DynamicThreadPool = require('poolifier/lib/dynamic')
532 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
535 But you should always prefer just using
538 const { DynamicThreadPool } = require('poolifier')
541 #### New type definitions for input data and response
543 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
544 _This is not a limitation by poolifier but NodeJS._
546 #### Public property replacements
548 `numWorkers` property is now `numberOfWorkers`
550 #### Internal (protected) properties and methods renaming
552 These properties are not intended for end users
554 - `id` => `nextMessageId`
556 These methods are not intended for end users
558 - `_chooseWorker` => `chooseWorker`
559 - `_newWorker` => `createWorker`
560 - `_execute` => `internalExecute`
561 - `_chooseWorker` => `chooseWorker`
562 - `_checkAlive` => `checkAlive`
564 - `_runAsync` => `runAsync`
566 ## [1.1.0] - 2020-05-21
570 - ThreadWorker support async functions as option
571 - Various external library patches
573 ## [1.0.0] - 2020-01-24
577 - FixedThreadPool implementation
578 - DynamicThreadPool implementation
579 - WorkerThread implementation to improve developer experience