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.16] - 2023-07-12
14 - Fix pool startup detection.
15 - Fix worker task functions handling.
17 ## [2.6.15] - 2023-07-11
21 - Take into account worker node readiness in worker choice strategies.
23 ## [2.6.14] - 2023-07-10
27 - Fix task function statistics tracking.
29 ## [2.6.13] - 2023-07-10
33 - Add per task function statistics tracking.
34 - Add public methods to manipulate the worker task functions at runtime.
36 ## [2.6.12] - 2023-07-09
40 - Workaround import issue with `node:os` module in node 16.x.x.
42 ## [2.6.11] - 2023-07-09
46 - Fix pool readiness semantic.
48 ## [2.6.10] - 2023-07-08
52 - Ensure workers are not recreated on error at pool startup.
56 - Add `ready` and `strategy` fields to pool information.
57 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
58 - Add dynamic pool sizing checks.
60 ## [2.6.9] - 2023-07-07
64 - Recreate the right worker type on uncaught exception.
68 - Add minimum and maximum to internal measurement statistics.
69 - Add `runTime` and `waitTime` to pool information.
70 - Check worker inactive time only on dynamic worker.
72 ## [2.6.8] - 2023-07-03
76 - Brown paper bag release to fix version handling in pool information.
78 ## [2.6.7] - 2023-07-03
82 - Ensure worker queued tasks at error are reassigned to other pool workers.
86 - Add pool `utilization` ratio to pool information.
87 - Add `version` to pool information.
88 - Add worker information to worker nodes.
90 ## [2.6.6] - 2023-07-01
94 - Add safe helper `availableParallelism` to help sizing the pool.
98 - Ensure message handler is only registered in worker.
100 ## [2.6.5] - 2023-06-27
104 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
108 - Artificial version bump to 2.6.5 to workaround publication issue.
109 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
110 - Ensure pool event is emitted before task error promise rejection.
111 - Fix queued tasks count computation.
115 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
117 ## [2.6.4] - 2023-06-27
121 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
125 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
126 - Ensure pool event is emitted before task error promise rejection.
127 - Fix queued tasks count computation.
131 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
133 ## [2.6.3] - 2023-06-19
137 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
138 - Update strategies internals after statistics computation.
142 - Optimize O(1) queue implementation.
144 ## [2.6.2] - 2023-06-12
148 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
150 ## [2.6.1] - 2023-06-10
154 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
158 - Fix average statistics computation: ensure failed tasks are not accounted.
160 ## [2.6.0] - 2023-06-09
164 - Add `LEAST_ELU` worker choice strategy (experimental).
165 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
169 - Refactor pool worker node usage internals.
170 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
171 - Breaking change: pool information `info` property object fields have been renamed.
175 - Fix wait time accounting.
176 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
177 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
179 ## [2.5.4] - 2023-06-07
183 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
187 - Compute statistics at the worker level only if needed.
188 - Add `worker-threads` options to thread pool options.
192 - Make the `LEAST_BUSY` strategy only relies on task runtime.
194 ## [2.5.3] - 2023-06-04
198 - Refine pool information content.
199 - Limit pool internals public exposure.
201 ## [2.5.2] - 2023-06-02
205 - Add `taskError` pool event for task execution error.
206 - Add pool information `info` property to pool.
207 - Emit pool information on `busy` and `full` pool events.
209 ## [2.5.1] - 2023-06-01
213 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
214 - Add `error` pool event for uncaught worker error.
216 ## [2.5.0] - 2023-05-31
220 - Switch pool event emitter to `EventEmitterAsyncResource`.
221 - Add tasks wait time accounting in per worker tasks usage.
222 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
226 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
228 ## [2.4.14] - 2023-05-09
232 - Ensure no undefined task runtime can land in the tasks history.
233 - Fix median computation implementation once again.
237 - Unit tests for median and queue implementations.
239 ## [2.4.13] - 2023-05-08
243 - Fix worker choice strategy options validation.
244 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
246 ## [2.4.12] - 2023-05-06
250 - Support multiple task functions per worker.
251 - Add custom worker weights support to worker choice strategies options.
255 - Use O(1) queue implementation for tasks queueing.
259 - Fix median computation implementation.
260 - Fix fair share worker choice strategy internals update.
262 ## [2.4.11] - 2023-04-23
266 - Optimize free worker finding in worker choice strategies.
268 ## [2.4.10] - 2023-04-15
272 - Fix typescript type definition for worker function: ensure the input data is optional.
273 - Fix typescript type definition for pool execute(): ensure the input data is optional.
275 ## [2.4.9] - 2023-04-15
279 - Add tasks queue enablement runtime setter to pool.
280 - Add tasks queue options runtime setter to pool.
281 - Add worker choice strategy options runtime setter to pool.
285 - Remove the tasks queuing experimental status.
289 - Fix worker function type definition and validation.
290 - Fix worker choice strategy options handling.
292 ## [2.4.8] - 2023-04-12
296 - Fix message between main worker and worker type definition for tasks.
297 - Fix code documentation.
299 ## [2.4.7] - 2023-04-11
303 - Add worker tasks queue options to pool options.
307 - Fix missing documentation.
309 ## [2.4.6] - 2023-04-10
313 - Ensure one task at a time is executed per worker with tasks queueing enabled.
314 - Properly count worker executing tasks with tasks queueing enabled.
316 ## [2.4.5] - 2023-04-09
320 - Use monotonic high resolution timer for worker tasks runtime.
321 - Add worker tasks median runtime to statistics.
322 - Add worker tasks queue (experimental).
324 ## [2.4.4] - 2023-04-07
328 - Add `PoolEvents` enumeration and `PoolEvent` type.
332 - Destroy worker only on alive check.
334 ## [2.4.3] - 2023-04-07
338 - Fix typedoc generation with inheritance.
340 ## [2.4.2] - 2023-04-06
344 - Add `full` event to dynamic pool.
345 - Keep worker choice strategy in memory for conditional reuse.
349 - Fix possible negative worker key at worker removal in worker choice strategies.
351 ## [2.4.1] - 2023-04-05
355 - Optimize worker choice strategy for dynamic pool.
359 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
361 ## [2.4.0] - 2023-04-04
365 - Add `LESS_BUSY` worker choice strategy.
369 - Optimize worker storage in pool.
370 - Optimize worker alive status check.
371 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
372 - Optimize `LESS_USED` worker choice strategy.
373 - Update benchmarks versus external threads pools.
374 - Optimize tasks usage statistics requirements for worker choice strategy.
378 - Ensure trimmable characters are checked at pool initialization.
379 - Fix message id integer overflow.
380 - Fix pool worker removal in worker choice strategy internals.
381 - Fix package publication with pnpm.
383 ## [2.4.0-3] - 2023-04-04
387 - Add `LESS_BUSY` worker choice strategy.
391 - Optimize worker storage in pool.
392 - Optimize worker alive status check.
393 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
394 - Optimize `LESS_USED` worker choice strategy.
395 - Update benchmarks versus external threads pools.
399 - Ensure trimmable characters are checked at pool initialization.
400 - Fix message id integer overflow.
401 - Fix pool worker removal in worker choice strategy internals.
402 - Fix package publication with pnpm.
404 ## [2.4.0-2] - 2023-04-03
408 - Add `LESS_BUSY` worker choice strategy.
412 - Optimize worker storage in pool.
413 - Optimize worker alive status check.
414 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
415 - Optimize `LESS_USED` worker choice strategy.
419 - Ensure trimmable characters are checked at pool initialization.
420 - Fix message id integer overflow.
421 - Fix pool worker removal in worker choice strategy internals.
422 - Fix package publication with pnpm.
424 ## [2.4.0-1] - 2023-04-03
428 - Add `LESS_BUSY` worker choice strategy.
432 - Optimize worker storage in pool.
433 - Optimize worker alive status check.
434 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
435 - Optimize `LESS_USED` worker choice strategy.
439 - Ensure trimmable characters are checked at pool initialization.
440 - Fix message id integer overflow.
441 - Fix pool worker removal in worker choice strategy internals.
443 ## [2.4.0-0] - 2023-04-03
447 - Add `LESS_BUSY` worker choice strategy.
451 - Optimize worker storage in pool.
452 - Optimize worker alive status check.
453 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
454 - Optimize `LESS_USED` worker choice strategy.
458 - Ensure trimmable characters are checked at pool initialization.
459 - Fix message id integer overflow.
460 - Fix pool worker removal in worker choice strategy internals.
462 ## [2.3.10] - 2023-03-18
466 - Fix `exports` syntax for ESM and CommonJS.
470 - Permit SemVer pre-release publication.
472 ## [2.3.10-2] - 2023-03-18
476 - Fix `exports` syntax for ESM and CommonJS.
478 ## [2.3.10-1] - 2023-03-18
482 - Permit SemVer pre-release publication.
484 ## [2.3.10-0] - 2023-03-18
488 - Fix `exports` syntax for ESM and CommonJS.
490 ## [2.3.9] - 2023-03-18
494 - Introduce ESM module support along with CommonJS one.
498 - Fix brown paper bag bug referencing the same object literal.
500 ## [2.3.8] - 2023-03-18
504 - Switch internal benchmarking code to benny.
505 - Switch to TypeScript 5.x.x.
506 - Switch rollup bundler plugins to core ones.
507 - Switch to TSDoc syntax.
508 - Enforce conventional commits.
512 - Fix random integer generator.
513 - Fix worker choice strategy pool type identification at initialization.
515 ## [2.3.7] - 2022-10-23
519 - Switch to open collective FOSS project funding platform.
520 - Switch to ts-standard linter configuration on TypeScript code.
524 - Fixed missing async on pool execute method.
525 - Fixed typing in TypeScript example.
526 - Fixed types in unit tests.
528 ## [2.3.6] - 2022-10-22
532 - Cleanup pool attributes and methods.
533 - Refine error types thrown.
537 - Fix continuous integration build on windows.
538 - Fix code coverage reporting by using c8 instead of nyc.
540 ## [2.3.5] - 2022-10-21
544 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
545 - Optimize tasks usage lookup implementation.
549 - Fix missed pool event emitter type export.
550 - Fix typedoc documentation generation.
552 ## [2.3.4] - 2022-10-17
556 - Fully automate release process with release-it.
560 - Optimize fair share task scheduling algorithm implementation.
561 - Update benchmarks versus external pools results with latest version.
563 ## [2.3.3] - 2022-10-15
567 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
569 ## [2.3.2] - 2022-10-14
573 - Optimize fair share worker selection strategy implementation.
577 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
579 ## [2.3.1] - 2022-10-13
583 - Pool worker choice strategies:
584 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
585 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
587 ## [2.2.2] - 2022-10-09
591 - Fixed `README.md` file.
593 ## [2.2.1] - 2022-10-08
597 - Dynamic worker choice strategy change at runtime.
599 ## [2.2.0] - 2022-01-05
603 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
605 ## [2.1.0] - 2021-08-29
609 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
613 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
614 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
615 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
616 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
618 ## [2.0.2] - 2021-05-12
622 - Fix `busy` event emission on fixed pool type
624 ## [2.0.1] - 2021-03-16
628 - Check if pool options are properly set.
629 - `busy` event is emitted on all pool types.
631 ## [2.0.0] - 2021-03-01
635 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
639 - `FullPool` event is now renamed to `busy`.
640 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
641 _Find more details on our JSDoc._
643 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
645 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
647 ### Pool options types declaration merge
649 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
651 #### New `export` strategy
655 const DynamicThreadPool = require('poolifier/lib/dynamic')
657 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
660 But you should always prefer just using
663 const { DynamicThreadPool } = require('poolifier')
666 #### New type definitions for input data and response
668 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
669 _This is not a limitation by poolifier but NodeJS._
671 #### Public property replacements
673 `numWorkers` property is now `numberOfWorkers`
675 #### Internal (protected) properties and methods renaming
677 These properties are not intended for end users
679 - `id` => `nextMessageId`
681 These methods are not intended for end users
683 - `_chooseWorker` => `chooseWorker`
684 - `_newWorker` => `createWorker`
685 - `_execute` => `internalExecute`
686 - `_chooseWorker` => `chooseWorker`
687 - `_checkAlive` => `checkAlive`
689 - `_runAsync` => `runAsync`
691 ## [1.1.0] - 2020-05-21
695 - ThreadWorker support async functions as option
696 - Various external library patches
698 ## [1.0.0] - 2020-01-24
702 - FixedThreadPool implementation
703 - DynamicThreadPool implementation
704 - WorkerThread implementation to improve developer experience