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 - Fix average statistics computation: ensure failed tasks are not accounted.
14 ## [2.6.0] - 2023-06-09
18 - Add `LEAST_ELU` worker choice strategy (experimental).
19 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
23 - Refactor pool worker node usage internals.
24 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
25 - Breaking change: pool information `info` property object fields have been renamed.
29 - Fix wait time accounting.
30 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
31 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
33 ## [2.5.4] - 2023-06-07
37 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
41 - Compute statistics at the worker level only if needed.
42 - Add `worker-threads` options to thread pool options.
46 - Make the `LEAST_BUSY` strategy only relies on task runtime.
48 ## [2.5.3] - 2023-06-04
52 - Refine pool information content.
53 - Limit pool internals public exposure.
55 ## [2.5.2] - 2023-06-02
59 - Add `taskError` pool event for task execution error.
60 - Add pool information `info` property to pool.
61 - Emit pool information on `busy` and `full` pool events.
63 ## [2.5.1] - 2023-06-01
67 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
68 - Add `error` pool event for uncaught worker error.
70 ## [2.5.0] - 2023-05-31
74 - Switch pool event emitter to `EventEmitterAsyncResource`.
75 - Add tasks wait time accounting in per worker tasks usage.
76 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
80 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
82 ## [2.4.14] - 2023-05-09
86 - Ensure no undefined task runtime can land in the tasks history.
87 - Fix median computation implementation once again.
91 - Unit tests for median and queue implementations.
93 ## [2.4.13] - 2023-05-08
97 - Fix worker choice strategy options validation.
98 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
100 ## [2.4.12] - 2023-05-06
104 - Support multiple task functions per worker.
105 - Add custom worker weights support to worker choice strategies options.
109 - Use O(1) queue implementation for tasks queueing.
113 - Fix median computation implementation.
114 - Fix fair share worker choice strategy internals update.
116 ## [2.4.11] - 2023-04-23
120 - Optimize free worker finding in worker choice strategies.
122 ## [2.4.10] - 2023-04-15
126 - Fix typescript type definition for worker function: ensure the input data is optional.
127 - Fix typescript type definition for pool execute(): ensure the input data is optional.
129 ## [2.4.9] - 2023-04-15
133 - Add tasks queue enablement runtime setter to pool.
134 - Add tasks queue options runtime setter to pool.
135 - Add worker choice strategy options runtime setter to pool.
139 - Remove the tasks queuing experimental status.
143 - Fix worker function type definition and validation.
144 - Fix worker choice strategy options handling.
146 ## [2.4.8] - 2023-04-12
150 - Fix message between main worker and worker type definition for tasks.
151 - Fix code documentation.
153 ## [2.4.7] - 2023-04-11
157 - Add worker tasks queue options to pool options.
161 - Fix missing documentation.
163 ## [2.4.6] - 2023-04-10
167 - Ensure one task at a time is executed per worker with tasks queueing enabled.
168 - Properly count worker executing tasks with tasks queueing enabled.
170 ## [2.4.5] - 2023-04-09
174 - Use monotonic high resolution timer for worker tasks runtime.
175 - Add worker tasks median runtime to statistics.
176 - Add worker tasks queue (experimental).
178 ## [2.4.4] - 2023-04-07
182 - Add `PoolEvents` enumeration and `PoolEvent` type.
186 - Destroy worker only on alive check.
188 ## [2.4.3] - 2023-04-07
192 - Fix typedoc generation with inheritance.
194 ## [2.4.2] - 2023-04-06
198 - Add `full` event to dynamic pool.
199 - Keep worker choice strategy in memory for conditional reuse.
203 - Fix possible negative worker key at worker removal in worker choice strategies.
205 ## [2.4.1] - 2023-04-05
209 - Optimize worker choice strategy for dynamic pool.
213 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
215 ## [2.4.0] - 2023-04-04
219 - Add `LESS_BUSY` worker choice strategy.
223 - Optimize worker storage in pool.
224 - Optimize worker alive status check.
225 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
226 - Optimize `LESS_USED` worker choice strategy.
227 - Update benchmarks versus external threads pools.
228 - Optimize tasks usage statistics requirements for worker choice strategy.
232 - Ensure trimmable characters are checked at pool initialization.
233 - Fix message id integer overflow.
234 - Fix pool worker removal in worker choice strategy internals.
235 - Fix package publication with pnpm.
237 ## [2.4.0-3] - 2023-04-04
241 - Add `LESS_BUSY` worker choice strategy.
245 - Optimize worker storage in pool.
246 - Optimize worker alive status check.
247 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
248 - Optimize `LESS_USED` worker choice strategy.
249 - Update benchmarks versus external threads pools.
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-2] - 2023-04-03
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.
273 - Ensure trimmable characters are checked at pool initialization.
274 - Fix message id integer overflow.
275 - Fix pool worker removal in worker choice strategy internals.
276 - Fix package publication with pnpm.
278 ## [2.4.0-1] - 2023-04-03
282 - Add `LESS_BUSY` worker choice strategy.
286 - Optimize worker storage in pool.
287 - Optimize worker alive status check.
288 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
289 - Optimize `LESS_USED` worker choice strategy.
293 - Ensure trimmable characters are checked at pool initialization.
294 - Fix message id integer overflow.
295 - Fix pool worker removal in worker choice strategy internals.
297 ## [2.4.0-0] - 2023-04-03
301 - Add `LESS_BUSY` worker choice strategy.
305 - Optimize worker storage in pool.
306 - Optimize worker alive status check.
307 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
308 - Optimize `LESS_USED` worker choice strategy.
312 - Ensure trimmable characters are checked at pool initialization.
313 - Fix message id integer overflow.
314 - Fix pool worker removal in worker choice strategy internals.
316 ## [2.3.10] - 2023-03-18
320 - Fix `exports` syntax for ESM and CommonJS.
324 - Permit SemVer pre-release publication.
326 ## [2.3.10-2] - 2023-03-18
330 - Fix `exports` syntax for ESM and CommonJS.
332 ## [2.3.10-1] - 2023-03-18
336 - Permit SemVer pre-release publication.
338 ## [2.3.10-0] - 2023-03-18
342 - Fix `exports` syntax for ESM and CommonJS.
344 ## [2.3.9] - 2023-03-18
348 - Introduce ESM module support along with CommonJS one.
352 - Fix brown paper bag bug referencing the same object literal.
354 ## [2.3.8] - 2023-03-18
358 - Switch internal benchmarking code to benny.
359 - Switch to TypeScript 5.x.x.
360 - Switch rollup bundler plugins to core ones.
361 - Switch to TSDoc syntax.
362 - Enforce conventional commits.
366 - Fix random integer generator.
367 - Fix worker choice strategy pool type identification at initialization.
369 ## [2.3.7] - 2022-10-23
373 - Switch to open collective FOSS project funding platform.
374 - Switch to ts-standard linter configuration on TypeScript code.
378 - Fixed missing async on pool execute method.
379 - Fixed typing in TypeScript example.
380 - Fixed types in unit tests.
382 ## [2.3.6] - 2022-10-22
386 - Cleanup pool attributes and methods.
387 - Refine error types thrown.
391 - Fix continuous integration build on windows.
392 - Fix code coverage reporting by using c8 instead of nyc.
394 ## [2.3.5] - 2022-10-21
398 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
399 - Optimize tasks usage lookup implementation.
403 - Fix missed pool event emitter type export.
404 - Fix typedoc documentation generation.
406 ## [2.3.4] - 2022-10-17
410 - Fully automate release process with release-it.
414 - Optimize fair share task scheduling algorithm implementation.
415 - Update benchmarks versus external pools results with latest version.
417 ## [2.3.3] - 2022-10-15
421 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
423 ## [2.3.2] - 2022-10-14
427 - Optimize fair share worker selection strategy implementation.
431 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
433 ## [2.3.1] - 2022-10-13
437 - Pool worker choice strategies:
438 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
439 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
441 ## [2.2.2] - 2022-10-09
445 - Fixed `README.md` file.
447 ## [2.2.1] - 2022-10-08
451 - Dynamic worker choice strategy change at runtime.
453 ## [2.2.0] - 2022-01-05
457 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
459 ## [2.1.0] - 2021-08-29
463 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
467 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
468 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
469 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
470 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
472 ## [2.0.2] - 2021-05-12
476 - Fix `busy` event emission on fixed pool type
478 ## [2.0.1] - 2021-03-16
482 - Check if pool options are properly set.
483 - `busy` event is emitted on all pool types.
485 ## [2.0.0] - 2021-03-01
489 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
493 - `FullPool` event is now renamed to `busy`.
494 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
495 _Find more details on our JSDoc._
497 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
499 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
501 ### Pool options types declaration merge
503 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
505 #### New `export` strategy
509 const DynamicThreadPool = require('poolifier/lib/dynamic')
511 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
514 But you should always prefer just using
517 const { DynamicThreadPool } = require('poolifier')
520 #### New type definitions for input data and response
522 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
523 _This is not a limitation by poolifier but NodeJS._
525 #### Public property replacements
527 `numWorkers` property is now `numberOfWorkers`
529 #### Internal (protected) properties and methods renaming
531 These properties are not intended for end users
533 - `id` => `nextMessageId`
535 These methods are not intended for end users
537 - `_chooseWorker` => `chooseWorker`
538 - `_newWorker` => `createWorker`
539 - `_execute` => `internalExecute`
540 - `_chooseWorker` => `chooseWorker`
541 - `_checkAlive` => `checkAlive`
543 - `_runAsync` => `runAsync`
545 ## [1.1.0] - 2020-05-21
549 - ThreadWorker support async functions as option
550 - Various external library patches
552 ## [1.0.0] - 2020-01-24
556 - FixedThreadPool implementation
557 - DynamicThreadPool implementation
558 - WorkerThread implementation to improve developer experience