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 pool `utilization` ratio to pool information.
14 ## [2.6.6] - 2023-07-01
18 - Add safe helper `availableParallelism` to help sizing the pool.
22 - Ensure message handler is only registered in worker.
24 ## [2.6.5] - 2023-06-27
28 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
32 - Artificial version bump to 2.6.5 to workaround publication issue.
33 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
34 - Ensure pool event is emitted before task error promise rejection.
35 - Fix queued tasks count computation.
39 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
41 ## [2.6.4] - 2023-06-27
45 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
49 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
50 - Ensure pool event is emitted before task error promise rejection.
51 - Fix queued tasks count computation.
55 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
57 ## [2.6.3] - 2023-06-19
61 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
62 - Update strategies internals after statistics computation.
66 - Optimize O(1) queue implementation.
68 ## [2.6.2] - 2023-06-12
72 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
74 ## [2.6.1] - 2023-06-10
78 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
82 - Fix average statistics computation: ensure failed tasks are not accounted.
84 ## [2.6.0] - 2023-06-09
88 - Add `LEAST_ELU` worker choice strategy (experimental).
89 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
93 - Refactor pool worker node usage internals.
94 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
95 - Breaking change: pool information `info` property object fields have been renamed.
99 - Fix wait time accounting.
100 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
101 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
103 ## [2.5.4] - 2023-06-07
107 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
111 - Compute statistics at the worker level only if needed.
112 - Add `worker-threads` options to thread pool options.
116 - Make the `LEAST_BUSY` strategy only relies on task runtime.
118 ## [2.5.3] - 2023-06-04
122 - Refine pool information content.
123 - Limit pool internals public exposure.
125 ## [2.5.2] - 2023-06-02
129 - Add `taskError` pool event for task execution error.
130 - Add pool information `info` property to pool.
131 - Emit pool information on `busy` and `full` pool events.
133 ## [2.5.1] - 2023-06-01
137 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
138 - Add `error` pool event for uncaught worker error.
140 ## [2.5.0] - 2023-05-31
144 - Switch pool event emitter to `EventEmitterAsyncResource`.
145 - Add tasks wait time accounting in per worker tasks usage.
146 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
150 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
152 ## [2.4.14] - 2023-05-09
156 - Ensure no undefined task runtime can land in the tasks history.
157 - Fix median computation implementation once again.
161 - Unit tests for median and queue implementations.
163 ## [2.4.13] - 2023-05-08
167 - Fix worker choice strategy options validation.
168 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
170 ## [2.4.12] - 2023-05-06
174 - Support multiple task functions per worker.
175 - Add custom worker weights support to worker choice strategies options.
179 - Use O(1) queue implementation for tasks queueing.
183 - Fix median computation implementation.
184 - Fix fair share worker choice strategy internals update.
186 ## [2.4.11] - 2023-04-23
190 - Optimize free worker finding in worker choice strategies.
192 ## [2.4.10] - 2023-04-15
196 - Fix typescript type definition for worker function: ensure the input data is optional.
197 - Fix typescript type definition for pool execute(): ensure the input data is optional.
199 ## [2.4.9] - 2023-04-15
203 - Add tasks queue enablement runtime setter to pool.
204 - Add tasks queue options runtime setter to pool.
205 - Add worker choice strategy options runtime setter to pool.
209 - Remove the tasks queuing experimental status.
213 - Fix worker function type definition and validation.
214 - Fix worker choice strategy options handling.
216 ## [2.4.8] - 2023-04-12
220 - Fix message between main worker and worker type definition for tasks.
221 - Fix code documentation.
223 ## [2.4.7] - 2023-04-11
227 - Add worker tasks queue options to pool options.
231 - Fix missing documentation.
233 ## [2.4.6] - 2023-04-10
237 - Ensure one task at a time is executed per worker with tasks queueing enabled.
238 - Properly count worker executing tasks with tasks queueing enabled.
240 ## [2.4.5] - 2023-04-09
244 - Use monotonic high resolution timer for worker tasks runtime.
245 - Add worker tasks median runtime to statistics.
246 - Add worker tasks queue (experimental).
248 ## [2.4.4] - 2023-04-07
252 - Add `PoolEvents` enumeration and `PoolEvent` type.
256 - Destroy worker only on alive check.
258 ## [2.4.3] - 2023-04-07
262 - Fix typedoc generation with inheritance.
264 ## [2.4.2] - 2023-04-06
268 - Add `full` event to dynamic pool.
269 - Keep worker choice strategy in memory for conditional reuse.
273 - Fix possible negative worker key at worker removal in worker choice strategies.
275 ## [2.4.1] - 2023-04-05
279 - Optimize worker choice strategy for dynamic pool.
283 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
285 ## [2.4.0] - 2023-04-04
289 - Add `LESS_BUSY` worker choice strategy.
293 - Optimize worker storage in pool.
294 - Optimize worker alive status check.
295 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
296 - Optimize `LESS_USED` worker choice strategy.
297 - Update benchmarks versus external threads pools.
298 - Optimize tasks usage statistics requirements for 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-3] - 2023-04-04
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.
319 - Update benchmarks versus external threads pools.
323 - Ensure trimmable characters are checked at pool initialization.
324 - Fix message id integer overflow.
325 - Fix pool worker removal in worker choice strategy internals.
326 - Fix package publication with pnpm.
328 ## [2.4.0-2] - 2023-04-03
332 - Add `LESS_BUSY` worker choice strategy.
336 - Optimize worker storage in pool.
337 - Optimize worker alive status check.
338 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
339 - Optimize `LESS_USED` worker choice strategy.
343 - Ensure trimmable characters are checked at pool initialization.
344 - Fix message id integer overflow.
345 - Fix pool worker removal in worker choice strategy internals.
346 - Fix package publication with pnpm.
348 ## [2.4.0-1] - 2023-04-03
352 - Add `LESS_BUSY` worker choice strategy.
356 - Optimize worker storage in pool.
357 - Optimize worker alive status check.
358 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
359 - Optimize `LESS_USED` worker choice strategy.
363 - Ensure trimmable characters are checked at pool initialization.
364 - Fix message id integer overflow.
365 - Fix pool worker removal in worker choice strategy internals.
367 ## [2.4.0-0] - 2023-04-03
371 - Add `LESS_BUSY` worker choice strategy.
375 - Optimize worker storage in pool.
376 - Optimize worker alive status check.
377 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
378 - Optimize `LESS_USED` worker choice strategy.
382 - Ensure trimmable characters are checked at pool initialization.
383 - Fix message id integer overflow.
384 - Fix pool worker removal in worker choice strategy internals.
386 ## [2.3.10] - 2023-03-18
390 - Fix `exports` syntax for ESM and CommonJS.
394 - Permit SemVer pre-release publication.
396 ## [2.3.10-2] - 2023-03-18
400 - Fix `exports` syntax for ESM and CommonJS.
402 ## [2.3.10-1] - 2023-03-18
406 - Permit SemVer pre-release publication.
408 ## [2.3.10-0] - 2023-03-18
412 - Fix `exports` syntax for ESM and CommonJS.
414 ## [2.3.9] - 2023-03-18
418 - Introduce ESM module support along with CommonJS one.
422 - Fix brown paper bag bug referencing the same object literal.
424 ## [2.3.8] - 2023-03-18
428 - Switch internal benchmarking code to benny.
429 - Switch to TypeScript 5.x.x.
430 - Switch rollup bundler plugins to core ones.
431 - Switch to TSDoc syntax.
432 - Enforce conventional commits.
436 - Fix random integer generator.
437 - Fix worker choice strategy pool type identification at initialization.
439 ## [2.3.7] - 2022-10-23
443 - Switch to open collective FOSS project funding platform.
444 - Switch to ts-standard linter configuration on TypeScript code.
448 - Fixed missing async on pool execute method.
449 - Fixed typing in TypeScript example.
450 - Fixed types in unit tests.
452 ## [2.3.6] - 2022-10-22
456 - Cleanup pool attributes and methods.
457 - Refine error types thrown.
461 - Fix continuous integration build on windows.
462 - Fix code coverage reporting by using c8 instead of nyc.
464 ## [2.3.5] - 2022-10-21
468 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
469 - Optimize tasks usage lookup implementation.
473 - Fix missed pool event emitter type export.
474 - Fix typedoc documentation generation.
476 ## [2.3.4] - 2022-10-17
480 - Fully automate release process with release-it.
484 - Optimize fair share task scheduling algorithm implementation.
485 - Update benchmarks versus external pools results with latest version.
487 ## [2.3.3] - 2022-10-15
491 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
493 ## [2.3.2] - 2022-10-14
497 - Optimize fair share worker selection strategy implementation.
501 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
503 ## [2.3.1] - 2022-10-13
507 - Pool worker choice strategies:
508 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
509 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
511 ## [2.2.2] - 2022-10-09
515 - Fixed `README.md` file.
517 ## [2.2.1] - 2022-10-08
521 - Dynamic worker choice strategy change at runtime.
523 ## [2.2.0] - 2022-01-05
527 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
529 ## [2.1.0] - 2021-08-29
533 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
537 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
538 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
539 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
540 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
542 ## [2.0.2] - 2021-05-12
546 - Fix `busy` event emission on fixed pool type
548 ## [2.0.1] - 2021-03-16
552 - Check if pool options are properly set.
553 - `busy` event is emitted on all pool types.
555 ## [2.0.0] - 2021-03-01
559 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
563 - `FullPool` event is now renamed to `busy`.
564 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
565 _Find more details on our JSDoc._
567 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
569 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
571 ### Pool options types declaration merge
573 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
575 #### New `export` strategy
579 const DynamicThreadPool = require('poolifier/lib/dynamic')
581 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
584 But you should always prefer just using
587 const { DynamicThreadPool } = require('poolifier')
590 #### New type definitions for input data and response
592 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
593 _This is not a limitation by poolifier but NodeJS._
595 #### Public property replacements
597 `numWorkers` property is now `numberOfWorkers`
599 #### Internal (protected) properties and methods renaming
601 These properties are not intended for end users
603 - `id` => `nextMessageId`
605 These methods are not intended for end users
607 - `_chooseWorker` => `chooseWorker`
608 - `_newWorker` => `createWorker`
609 - `_execute` => `internalExecute`
610 - `_chooseWorker` => `chooseWorker`
611 - `_checkAlive` => `checkAlive`
613 - `_runAsync` => `runAsync`
615 ## [1.1.0] - 2020-05-21
619 - ThreadWorker support async functions as option
620 - Various external library patches
622 ## [1.0.0] - 2020-01-24
626 - FixedThreadPool implementation
627 - DynamicThreadPool implementation
628 - WorkerThread implementation to improve developer experience