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 - Recreate the right worker type on uncaught exception.
16 - Add minimum and maximum to internal measurement statistics.
17 - Add `runTime` and `waitTime` to pool information.
18 - Check worker inactive time only on dynamic worker.
20 ## [2.6.8] - 2023-07-03
24 - Brown paper bag release to fix version handling in pool information.
26 ## [2.6.7] - 2023-07-03
30 - Ensure worker queued tasks at error are reassigned to other pool workers.
34 - Add pool `utilization` ratio to pool information.
35 - Add `version` to pool information.
36 - Add worker information to worker nodes.
38 ## [2.6.6] - 2023-07-01
42 - Add safe helper `availableParallelism` to help sizing the pool.
46 - Ensure message handler is only registered in worker.
48 ## [2.6.5] - 2023-06-27
52 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
56 - Artificial version bump to 2.6.5 to workaround publication issue.
57 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
58 - Ensure pool event is emitted before task error promise rejection.
59 - Fix queued tasks count computation.
63 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
65 ## [2.6.4] - 2023-06-27
69 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
73 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
74 - Ensure pool event is emitted before task error promise rejection.
75 - Fix queued tasks count computation.
79 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
81 ## [2.6.3] - 2023-06-19
85 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
86 - Update strategies internals after statistics computation.
90 - Optimize O(1) queue implementation.
92 ## [2.6.2] - 2023-06-12
96 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
98 ## [2.6.1] - 2023-06-10
102 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
106 - Fix average statistics computation: ensure failed tasks are not accounted.
108 ## [2.6.0] - 2023-06-09
112 - Add `LEAST_ELU` worker choice strategy (experimental).
113 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
117 - Refactor pool worker node usage internals.
118 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
119 - Breaking change: pool information `info` property object fields have been renamed.
123 - Fix wait time accounting.
124 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
125 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
127 ## [2.5.4] - 2023-06-07
131 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
135 - Compute statistics at the worker level only if needed.
136 - Add `worker-threads` options to thread pool options.
140 - Make the `LEAST_BUSY` strategy only relies on task runtime.
142 ## [2.5.3] - 2023-06-04
146 - Refine pool information content.
147 - Limit pool internals public exposure.
149 ## [2.5.2] - 2023-06-02
153 - Add `taskError` pool event for task execution error.
154 - Add pool information `info` property to pool.
155 - Emit pool information on `busy` and `full` pool events.
157 ## [2.5.1] - 2023-06-01
161 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
162 - Add `error` pool event for uncaught worker error.
164 ## [2.5.0] - 2023-05-31
168 - Switch pool event emitter to `EventEmitterAsyncResource`.
169 - Add tasks wait time accounting in per worker tasks usage.
170 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
174 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
176 ## [2.4.14] - 2023-05-09
180 - Ensure no undefined task runtime can land in the tasks history.
181 - Fix median computation implementation once again.
185 - Unit tests for median and queue implementations.
187 ## [2.4.13] - 2023-05-08
191 - Fix worker choice strategy options validation.
192 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
194 ## [2.4.12] - 2023-05-06
198 - Support multiple task functions per worker.
199 - Add custom worker weights support to worker choice strategies options.
203 - Use O(1) queue implementation for tasks queueing.
207 - Fix median computation implementation.
208 - Fix fair share worker choice strategy internals update.
210 ## [2.4.11] - 2023-04-23
214 - Optimize free worker finding in worker choice strategies.
216 ## [2.4.10] - 2023-04-15
220 - Fix typescript type definition for worker function: ensure the input data is optional.
221 - Fix typescript type definition for pool execute(): ensure the input data is optional.
223 ## [2.4.9] - 2023-04-15
227 - Add tasks queue enablement runtime setter to pool.
228 - Add tasks queue options runtime setter to pool.
229 - Add worker choice strategy options runtime setter to pool.
233 - Remove the tasks queuing experimental status.
237 - Fix worker function type definition and validation.
238 - Fix worker choice strategy options handling.
240 ## [2.4.8] - 2023-04-12
244 - Fix message between main worker and worker type definition for tasks.
245 - Fix code documentation.
247 ## [2.4.7] - 2023-04-11
251 - Add worker tasks queue options to pool options.
255 - Fix missing documentation.
257 ## [2.4.6] - 2023-04-10
261 - Ensure one task at a time is executed per worker with tasks queueing enabled.
262 - Properly count worker executing tasks with tasks queueing enabled.
264 ## [2.4.5] - 2023-04-09
268 - Use monotonic high resolution timer for worker tasks runtime.
269 - Add worker tasks median runtime to statistics.
270 - Add worker tasks queue (experimental).
272 ## [2.4.4] - 2023-04-07
276 - Add `PoolEvents` enumeration and `PoolEvent` type.
280 - Destroy worker only on alive check.
282 ## [2.4.3] - 2023-04-07
286 - Fix typedoc generation with inheritance.
288 ## [2.4.2] - 2023-04-06
292 - Add `full` event to dynamic pool.
293 - Keep worker choice strategy in memory for conditional reuse.
297 - Fix possible negative worker key at worker removal in worker choice strategies.
299 ## [2.4.1] - 2023-04-05
303 - Optimize worker choice strategy for dynamic pool.
307 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
309 ## [2.4.0] - 2023-04-04
313 - Add `LESS_BUSY` worker choice strategy.
317 - Optimize worker storage in pool.
318 - Optimize worker alive status check.
319 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
320 - Optimize `LESS_USED` worker choice strategy.
321 - Update benchmarks versus external threads pools.
322 - Optimize tasks usage statistics requirements for worker choice strategy.
326 - Ensure trimmable characters are checked at pool initialization.
327 - Fix message id integer overflow.
328 - Fix pool worker removal in worker choice strategy internals.
329 - Fix package publication with pnpm.
331 ## [2.4.0-3] - 2023-04-04
335 - Add `LESS_BUSY` worker choice strategy.
339 - Optimize worker storage in pool.
340 - Optimize worker alive status check.
341 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
342 - Optimize `LESS_USED` worker choice strategy.
343 - Update benchmarks versus external threads pools.
347 - Ensure trimmable characters are checked at pool initialization.
348 - Fix message id integer overflow.
349 - Fix pool worker removal in worker choice strategy internals.
350 - Fix package publication with pnpm.
352 ## [2.4.0-2] - 2023-04-03
356 - Add `LESS_BUSY` worker choice strategy.
360 - Optimize worker storage in pool.
361 - Optimize worker alive status check.
362 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
363 - Optimize `LESS_USED` worker choice strategy.
367 - Ensure trimmable characters are checked at pool initialization.
368 - Fix message id integer overflow.
369 - Fix pool worker removal in worker choice strategy internals.
370 - Fix package publication with pnpm.
372 ## [2.4.0-1] - 2023-04-03
376 - Add `LESS_BUSY` worker choice strategy.
380 - Optimize worker storage in pool.
381 - Optimize worker alive status check.
382 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
383 - Optimize `LESS_USED` worker choice strategy.
387 - Ensure trimmable characters are checked at pool initialization.
388 - Fix message id integer overflow.
389 - Fix pool worker removal in worker choice strategy internals.
391 ## [2.4.0-0] - 2023-04-03
395 - Add `LESS_BUSY` worker choice strategy.
399 - Optimize worker storage in pool.
400 - Optimize worker alive status check.
401 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
402 - Optimize `LESS_USED` worker choice strategy.
406 - Ensure trimmable characters are checked at pool initialization.
407 - Fix message id integer overflow.
408 - Fix pool worker removal in worker choice strategy internals.
410 ## [2.3.10] - 2023-03-18
414 - Fix `exports` syntax for ESM and CommonJS.
418 - Permit SemVer pre-release publication.
420 ## [2.3.10-2] - 2023-03-18
424 - Fix `exports` syntax for ESM and CommonJS.
426 ## [2.3.10-1] - 2023-03-18
430 - Permit SemVer pre-release publication.
432 ## [2.3.10-0] - 2023-03-18
436 - Fix `exports` syntax for ESM and CommonJS.
438 ## [2.3.9] - 2023-03-18
442 - Introduce ESM module support along with CommonJS one.
446 - Fix brown paper bag bug referencing the same object literal.
448 ## [2.3.8] - 2023-03-18
452 - Switch internal benchmarking code to benny.
453 - Switch to TypeScript 5.x.x.
454 - Switch rollup bundler plugins to core ones.
455 - Switch to TSDoc syntax.
456 - Enforce conventional commits.
460 - Fix random integer generator.
461 - Fix worker choice strategy pool type identification at initialization.
463 ## [2.3.7] - 2022-10-23
467 - Switch to open collective FOSS project funding platform.
468 - Switch to ts-standard linter configuration on TypeScript code.
472 - Fixed missing async on pool execute method.
473 - Fixed typing in TypeScript example.
474 - Fixed types in unit tests.
476 ## [2.3.6] - 2022-10-22
480 - Cleanup pool attributes and methods.
481 - Refine error types thrown.
485 - Fix continuous integration build on windows.
486 - Fix code coverage reporting by using c8 instead of nyc.
488 ## [2.3.5] - 2022-10-21
492 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
493 - Optimize tasks usage lookup implementation.
497 - Fix missed pool event emitter type export.
498 - Fix typedoc documentation generation.
500 ## [2.3.4] - 2022-10-17
504 - Fully automate release process with release-it.
508 - Optimize fair share task scheduling algorithm implementation.
509 - Update benchmarks versus external pools results with latest version.
511 ## [2.3.3] - 2022-10-15
515 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
517 ## [2.3.2] - 2022-10-14
521 - Optimize fair share worker selection strategy implementation.
525 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
527 ## [2.3.1] - 2022-10-13
531 - Pool worker choice strategies:
532 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
533 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
535 ## [2.2.2] - 2022-10-09
539 - Fixed `README.md` file.
541 ## [2.2.1] - 2022-10-08
545 - Dynamic worker choice strategy change at runtime.
547 ## [2.2.0] - 2022-01-05
551 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
553 ## [2.1.0] - 2021-08-29
557 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
561 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
562 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
563 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
564 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
566 ## [2.0.2] - 2021-05-12
570 - Fix `busy` event emission on fixed pool type
572 ## [2.0.1] - 2021-03-16
576 - Check if pool options are properly set.
577 - `busy` event is emitted on all pool types.
579 ## [2.0.0] - 2021-03-01
583 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
587 - `FullPool` event is now renamed to `busy`.
588 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
589 _Find more details on our JSDoc._
591 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
593 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
595 ### Pool options types declaration merge
597 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
599 #### New `export` strategy
603 const DynamicThreadPool = require('poolifier/lib/dynamic')
605 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
608 But you should always prefer just using
611 const { DynamicThreadPool } = require('poolifier')
614 #### New type definitions for input data and response
616 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
617 _This is not a limitation by poolifier but NodeJS._
619 #### Public property replacements
621 `numWorkers` property is now `numberOfWorkers`
623 #### Internal (protected) properties and methods renaming
625 These properties are not intended for end users
627 - `id` => `nextMessageId`
629 These methods are not intended for end users
631 - `_chooseWorker` => `chooseWorker`
632 - `_newWorker` => `createWorker`
633 - `_execute` => `internalExecute`
634 - `_chooseWorker` => `chooseWorker`
635 - `_checkAlive` => `checkAlive`
637 - `_runAsync` => `runAsync`
639 ## [1.1.0] - 2020-05-21
643 - ThreadWorker support async functions as option
644 - Various external library patches
646 ## [1.0.0] - 2020-01-24
650 - FixedThreadPool implementation
651 - DynamicThreadPool implementation
652 - WorkerThread implementation to improve developer experience