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 `LEAST_ELU` worker choice strategy.
16 - Refactor pool worker node usage internals.
17 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
18 - Breaking change: pool information `info` property object fields have been renamed and added.
22 - Fix wait time accounting.
23 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
24 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
26 ## [2.5.4] - 2023-06-07
30 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
34 - Compute statistics at the worker level only if needed.
35 - Add `worker-threads` options to thread pool options.
39 - Make the `LEAST_BUSY` strategy only relies on task runtime.
41 ## [2.5.3] - 2023-06-04
45 - Refine pool information content.
46 - Limit pool internals public exposure.
48 ## [2.5.2] - 2023-06-02
52 - Add `taskError` pool event for task execution error.
53 - Add pool information `info` property to pool.
54 - Emit pool information on `busy` and `full` pool events.
56 ## [2.5.1] - 2023-06-01
60 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
61 - Add `error` pool event for uncaught worker error.
63 ## [2.5.0] - 2023-05-31
67 - Switch pool event emitter to `EventEmitterAsyncResource`.
68 - Add tasks wait time accounting in per worker tasks usage.
69 - Add interleaved weighted round robin worker choice strategy (experimental).
73 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
75 ## [2.4.14] - 2023-05-09
79 - Ensure no undefined task runtime can land in the tasks history.
80 - Fix median computation implementation once again.
84 - Unit tests for median and queue implementations.
86 ## [2.4.13] - 2023-05-08
90 - Fix worker choice strategy options validation.
91 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
93 ## [2.4.12] - 2023-05-06
97 - Support multiple task functions per worker.
98 - Add custom worker weights support to worker choice strategies options.
102 - Use O(1) queue implementation for tasks queueing.
106 - Fix median computation implementation.
107 - Fix fair share worker choice strategy internals update.
109 ## [2.4.11] - 2023-04-23
113 - Optimize free worker finding in worker choice strategies.
115 ## [2.4.10] - 2023-04-15
119 - Fix typescript type definition for worker function: ensure the input data is optional.
120 - Fix typescript type definition for pool execute(): ensure the input data is optional.
122 ## [2.4.9] - 2023-04-15
126 - Add tasks queue enablement runtime setter to pool.
127 - Add tasks queue options runtime setter to pool.
128 - Add worker choice strategy options runtime setter to pool.
132 - Remove the tasks queuing experimental status.
136 - Fix worker function type definition and validation.
137 - Fix worker choice strategy options handling.
139 ## [2.4.8] - 2023-04-12
143 - Fix message between main worker and worker type definition for tasks.
144 - Fix code documentation.
146 ## [2.4.7] - 2023-04-11
150 - Add worker tasks queue options to pool options.
154 - Fix missing documentation.
156 ## [2.4.6] - 2023-04-10
160 - Ensure one task at a time is executed per worker with tasks queueing enabled.
161 - Properly count worker executing tasks with tasks queueing enabled.
163 ## [2.4.5] - 2023-04-09
167 - Use monotonic high resolution timer for worker tasks runtime.
168 - Add worker tasks median runtime to statistics.
169 - Add worker tasks queue (experimental).
171 ## [2.4.4] - 2023-04-07
175 - Add `PoolEvents` enumeration and `PoolEvent` type.
179 - Destroy worker only on alive check.
181 ## [2.4.3] - 2023-04-07
185 - Fix typedoc generation with inheritance.
187 ## [2.4.2] - 2023-04-06
191 - Add `full` event to dynamic pool.
192 - Keep worker choice strategy in memory for conditional reuse.
196 - Fix possible negative worker key at worker removal in worker choice strategies.
198 ## [2.4.1] - 2023-04-05
202 - Optimize worker choice strategy for dynamic pool.
206 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
208 ## [2.4.0] - 2023-04-04
212 - Add `LESS_BUSY` worker choice strategy.
216 - Optimize worker storage in pool.
217 - Optimize worker alive status check.
218 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
219 - Optimize `LESS_USED` worker choice strategy.
220 - Update benchmarks versus external threads pools.
221 - Optimize tasks usage statistics requirements for worker choice strategy.
225 - Ensure trimmable characters are checked at pool initialization.
226 - Fix message id integer overflow.
227 - Fix pool worker removal in worker choice strategy internals.
228 - Fix package publication with pnpm.
230 ## [2.4.0-3] - 2023-04-04
234 - Add `LESS_BUSY` worker choice strategy.
238 - Optimize worker storage in pool.
239 - Optimize worker alive status check.
240 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
241 - Optimize `LESS_USED` worker choice strategy.
242 - Update benchmarks versus external threads pools.
246 - Ensure trimmable characters are checked at pool initialization.
247 - Fix message id integer overflow.
248 - Fix pool worker removal in worker choice strategy internals.
249 - Fix package publication with pnpm.
251 ## [2.4.0-2] - 2023-04-03
255 - Add `LESS_BUSY` worker choice strategy.
259 - Optimize worker storage in pool.
260 - Optimize worker alive status check.
261 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
262 - Optimize `LESS_USED` worker choice strategy.
266 - Ensure trimmable characters are checked at pool initialization.
267 - Fix message id integer overflow.
268 - Fix pool worker removal in worker choice strategy internals.
269 - Fix package publication with pnpm.
271 ## [2.4.0-1] - 2023-04-03
275 - Add `LESS_BUSY` worker choice strategy.
279 - Optimize worker storage in pool.
280 - Optimize worker alive status check.
281 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
282 - Optimize `LESS_USED` worker choice strategy.
286 - Ensure trimmable characters are checked at pool initialization.
287 - Fix message id integer overflow.
288 - Fix pool worker removal in worker choice strategy internals.
290 ## [2.4.0-0] - 2023-04-03
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.
305 - Ensure trimmable characters are checked at pool initialization.
306 - Fix message id integer overflow.
307 - Fix pool worker removal in worker choice strategy internals.
309 ## [2.3.10] - 2023-03-18
313 - Fix `exports` syntax for ESM and CommonJS.
317 - Permit SemVer pre-release publication.
319 ## [2.3.10-2] - 2023-03-18
323 - Fix `exports` syntax for ESM and CommonJS.
325 ## [2.3.10-1] - 2023-03-18
329 - Permit SemVer pre-release publication.
331 ## [2.3.10-0] - 2023-03-18
335 - Fix `exports` syntax for ESM and CommonJS.
337 ## [2.3.9] - 2023-03-18
341 - Introduce ESM module support along with CommonJS one.
345 - Fix brown paper bag bug referencing the same object literal.
347 ## [2.3.8] - 2023-03-18
351 - Switch internal benchmarking code to benny.
352 - Switch to TypeScript 5.x.x.
353 - Switch rollup bundler plugins to core ones.
354 - Switch to TSDoc syntax.
355 - Enforce conventional commits.
359 - Fix random integer generator.
360 - Fix worker choice strategy pool type identification at initialization.
362 ## [2.3.7] - 2022-10-23
366 - Switch to open collective FOSS project funding platform.
367 - Switch to ts-standard linter configuration on TypeScript code.
371 - Fixed missing async on pool execute method.
372 - Fixed typing in TypeScript example.
373 - Fixed types in unit tests.
375 ## [2.3.6] - 2022-10-22
379 - Cleanup pool attributes and methods.
380 - Refine error types thrown.
384 - Fix continuous integration build on windows.
385 - Fix code coverage reporting by using c8 instead of nyc.
387 ## [2.3.5] - 2022-10-21
391 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
392 - Optimize tasks usage lookup implementation.
396 - Fix missed pool event emitter type export.
397 - Fix typedoc documentation generation.
399 ## [2.3.4] - 2022-10-17
403 - Fully automate release process with release-it.
407 - Optimize fair share task scheduling algorithm implementation.
408 - Update benchmarks versus external pools results with latest version.
410 ## [2.3.3] - 2022-10-15
414 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
416 ## [2.3.2] - 2022-10-14
420 - Optimize fair share worker selection strategy implementation.
424 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
426 ## [2.3.1] - 2022-10-13
430 - Pool worker choice strategies:
431 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
432 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
434 ## [2.2.2] - 2022-10-09
438 - Fixed `README.md` file.
440 ## [2.2.1] - 2022-10-08
444 - Dynamic worker choice strategy change at runtime.
446 ## [2.2.0] - 2022-01-05
450 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
452 ## [2.1.0] - 2021-08-29
456 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
460 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
461 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
462 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
463 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
465 ## [2.0.2] - 2021-05-12
469 - Fix `busy` event emission on fixed pool type
471 ## [2.0.1] - 2021-03-16
475 - Check if pool options are properly set.
476 - `busy` event is emitted on all pool types.
478 ## [2.0.0] - 2021-03-01
482 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
486 - `FullPool` event is now renamed to `busy`.
487 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
488 _Find more details on our JSDoc._
490 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
492 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
494 ### Pool options types declaration merge
496 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
498 #### New `export` strategy
502 const DynamicThreadPool = require('poolifier/lib/dynamic')
504 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
507 But you should always prefer just using
510 const { DynamicThreadPool } = require('poolifier')
513 #### New type definitions for input data and response
515 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
516 _This is not a limitation by poolifier but NodeJS._
518 #### Public property replacements
520 `numWorkers` property is now `numberOfWorkers`
522 #### Internal (protected) properties and methods renaming
524 These properties are not intended for end users
526 - `id` => `nextMessageId`
528 These methods are not intended for end users
530 - `_chooseWorker` => `chooseWorker`
531 - `_newWorker` => `createWorker`
532 - `_execute` => `internalExecute`
533 - `_chooseWorker` => `chooseWorker`
534 - `_checkAlive` => `checkAlive`
536 - `_runAsync` => `runAsync`
538 ## [1.1.0] - 2020-05-21
542 - ThreadWorker support async functions as option
543 - Various external library patches
545 ## [1.0.0] - 2020-01-24
549 - FixedThreadPool implementation
550 - DynamicThreadPool implementation
551 - WorkerThread implementation to improve developer experience