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.9] - 2023-07-07
14 - Recreate the right worker type on uncaught exception.
18 - Add minimum and maximum to internal measurement statistics.
19 - Add `runTime` and `waitTime` to pool information.
20 - Check worker inactive time only on dynamic worker.
22 ## [2.6.8] - 2023-07-03
26 - Brown paper bag release to fix version handling in pool information.
28 ## [2.6.7] - 2023-07-03
32 - Ensure worker queued tasks at error are reassigned to other pool workers.
36 - Add pool `utilization` ratio to pool information.
37 - Add `version` to pool information.
38 - Add worker information to worker nodes.
40 ## [2.6.6] - 2023-07-01
44 - Add safe helper `availableParallelism` to help sizing the pool.
48 - Ensure message handler is only registered in worker.
50 ## [2.6.5] - 2023-06-27
54 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
58 - Artificial version bump to 2.6.5 to workaround publication issue.
59 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
60 - Ensure pool event is emitted before task error promise rejection.
61 - Fix queued tasks count computation.
65 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
67 ## [2.6.4] - 2023-06-27
71 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
75 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
76 - Ensure pool event is emitted before task error promise rejection.
77 - Fix queued tasks count computation.
81 - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC.
83 ## [2.6.3] - 2023-06-19
87 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
88 - Update strategies internals after statistics computation.
92 - Optimize O(1) queue implementation.
94 ## [2.6.2] - 2023-06-12
98 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
100 ## [2.6.1] - 2023-06-10
104 - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md).
108 - Fix average statistics computation: ensure failed tasks are not accounted.
110 ## [2.6.0] - 2023-06-09
114 - Add `LEAST_ELU` worker choice strategy (experimental).
115 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
119 - Refactor pool worker node usage internals.
120 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
121 - Breaking change: pool information `info` property object fields have been renamed.
125 - Fix wait time accounting.
126 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
127 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
129 ## [2.5.4] - 2023-06-07
133 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
137 - Compute statistics at the worker level only if needed.
138 - Add `worker-threads` options to thread pool options.
142 - Make the `LEAST_BUSY` strategy only relies on task runtime.
144 ## [2.5.3] - 2023-06-04
148 - Refine pool information content.
149 - Limit pool internals public exposure.
151 ## [2.5.2] - 2023-06-02
155 - Add `taskError` pool event for task execution error.
156 - Add pool information `info` property to pool.
157 - Emit pool information on `busy` and `full` pool events.
159 ## [2.5.1] - 2023-06-01
163 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
164 - Add `error` pool event for uncaught worker error.
166 ## [2.5.0] - 2023-05-31
170 - Switch pool event emitter to `EventEmitterAsyncResource`.
171 - Add tasks wait time accounting in per worker tasks usage.
172 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
176 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
178 ## [2.4.14] - 2023-05-09
182 - Ensure no undefined task runtime can land in the tasks history.
183 - Fix median computation implementation once again.
187 - Unit tests for median and queue implementations.
189 ## [2.4.13] - 2023-05-08
193 - Fix worker choice strategy options validation.
194 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
196 ## [2.4.12] - 2023-05-06
200 - Support multiple task functions per worker.
201 - Add custom worker weights support to worker choice strategies options.
205 - Use O(1) queue implementation for tasks queueing.
209 - Fix median computation implementation.
210 - Fix fair share worker choice strategy internals update.
212 ## [2.4.11] - 2023-04-23
216 - Optimize free worker finding in worker choice strategies.
218 ## [2.4.10] - 2023-04-15
222 - Fix typescript type definition for worker function: ensure the input data is optional.
223 - Fix typescript type definition for pool execute(): ensure the input data is optional.
225 ## [2.4.9] - 2023-04-15
229 - Add tasks queue enablement runtime setter to pool.
230 - Add tasks queue options runtime setter to pool.
231 - Add worker choice strategy options runtime setter to pool.
235 - Remove the tasks queuing experimental status.
239 - Fix worker function type definition and validation.
240 - Fix worker choice strategy options handling.
242 ## [2.4.8] - 2023-04-12
246 - Fix message between main worker and worker type definition for tasks.
247 - Fix code documentation.
249 ## [2.4.7] - 2023-04-11
253 - Add worker tasks queue options to pool options.
257 - Fix missing documentation.
259 ## [2.4.6] - 2023-04-10
263 - Ensure one task at a time is executed per worker with tasks queueing enabled.
264 - Properly count worker executing tasks with tasks queueing enabled.
266 ## [2.4.5] - 2023-04-09
270 - Use monotonic high resolution timer for worker tasks runtime.
271 - Add worker tasks median runtime to statistics.
272 - Add worker tasks queue (experimental).
274 ## [2.4.4] - 2023-04-07
278 - Add `PoolEvents` enumeration and `PoolEvent` type.
282 - Destroy worker only on alive check.
284 ## [2.4.3] - 2023-04-07
288 - Fix typedoc generation with inheritance.
290 ## [2.4.2] - 2023-04-06
294 - Add `full` event to dynamic pool.
295 - Keep worker choice strategy in memory for conditional reuse.
299 - Fix possible negative worker key at worker removal in worker choice strategies.
301 ## [2.4.1] - 2023-04-05
305 - Optimize worker choice strategy for dynamic pool.
309 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
311 ## [2.4.0] - 2023-04-04
315 - Add `LESS_BUSY` worker choice strategy.
319 - Optimize worker storage in pool.
320 - Optimize worker alive status check.
321 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
322 - Optimize `LESS_USED` worker choice strategy.
323 - Update benchmarks versus external threads pools.
324 - Optimize tasks usage statistics requirements for worker choice strategy.
328 - Ensure trimmable characters are checked at pool initialization.
329 - Fix message id integer overflow.
330 - Fix pool worker removal in worker choice strategy internals.
331 - Fix package publication with pnpm.
333 ## [2.4.0-3] - 2023-04-04
337 - Add `LESS_BUSY` worker choice strategy.
341 - Optimize worker storage in pool.
342 - Optimize worker alive status check.
343 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
344 - Optimize `LESS_USED` worker choice strategy.
345 - Update benchmarks versus external threads pools.
349 - Ensure trimmable characters are checked at pool initialization.
350 - Fix message id integer overflow.
351 - Fix pool worker removal in worker choice strategy internals.
352 - Fix package publication with pnpm.
354 ## [2.4.0-2] - 2023-04-03
358 - Add `LESS_BUSY` worker choice strategy.
362 - Optimize worker storage in pool.
363 - Optimize worker alive status check.
364 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
365 - Optimize `LESS_USED` worker choice strategy.
369 - Ensure trimmable characters are checked at pool initialization.
370 - Fix message id integer overflow.
371 - Fix pool worker removal in worker choice strategy internals.
372 - Fix package publication with pnpm.
374 ## [2.4.0-1] - 2023-04-03
378 - Add `LESS_BUSY` worker choice strategy.
382 - Optimize worker storage in pool.
383 - Optimize worker alive status check.
384 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
385 - Optimize `LESS_USED` worker choice strategy.
389 - Ensure trimmable characters are checked at pool initialization.
390 - Fix message id integer overflow.
391 - Fix pool worker removal in worker choice strategy internals.
393 ## [2.4.0-0] - 2023-04-03
397 - Add `LESS_BUSY` worker choice strategy.
401 - Optimize worker storage in pool.
402 - Optimize worker alive status check.
403 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
404 - Optimize `LESS_USED` worker choice strategy.
408 - Ensure trimmable characters are checked at pool initialization.
409 - Fix message id integer overflow.
410 - Fix pool worker removal in worker choice strategy internals.
412 ## [2.3.10] - 2023-03-18
416 - Fix `exports` syntax for ESM and CommonJS.
420 - Permit SemVer pre-release publication.
422 ## [2.3.10-2] - 2023-03-18
426 - Fix `exports` syntax for ESM and CommonJS.
428 ## [2.3.10-1] - 2023-03-18
432 - Permit SemVer pre-release publication.
434 ## [2.3.10-0] - 2023-03-18
438 - Fix `exports` syntax for ESM and CommonJS.
440 ## [2.3.9] - 2023-03-18
444 - Introduce ESM module support along with CommonJS one.
448 - Fix brown paper bag bug referencing the same object literal.
450 ## [2.3.8] - 2023-03-18
454 - Switch internal benchmarking code to benny.
455 - Switch to TypeScript 5.x.x.
456 - Switch rollup bundler plugins to core ones.
457 - Switch to TSDoc syntax.
458 - Enforce conventional commits.
462 - Fix random integer generator.
463 - Fix worker choice strategy pool type identification at initialization.
465 ## [2.3.7] - 2022-10-23
469 - Switch to open collective FOSS project funding platform.
470 - Switch to ts-standard linter configuration on TypeScript code.
474 - Fixed missing async on pool execute method.
475 - Fixed typing in TypeScript example.
476 - Fixed types in unit tests.
478 ## [2.3.6] - 2022-10-22
482 - Cleanup pool attributes and methods.
483 - Refine error types thrown.
487 - Fix continuous integration build on windows.
488 - Fix code coverage reporting by using c8 instead of nyc.
490 ## [2.3.5] - 2022-10-21
494 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
495 - Optimize tasks usage lookup implementation.
499 - Fix missed pool event emitter type export.
500 - Fix typedoc documentation generation.
502 ## [2.3.4] - 2022-10-17
506 - Fully automate release process with release-it.
510 - Optimize fair share task scheduling algorithm implementation.
511 - Update benchmarks versus external pools results with latest version.
513 ## [2.3.3] - 2022-10-15
517 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
519 ## [2.3.2] - 2022-10-14
523 - Optimize fair share worker selection strategy implementation.
527 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
529 ## [2.3.1] - 2022-10-13
533 - Pool worker choice strategies:
534 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
535 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
537 ## [2.2.2] - 2022-10-09
541 - Fixed `README.md` file.
543 ## [2.2.1] - 2022-10-08
547 - Dynamic worker choice strategy change at runtime.
549 ## [2.2.0] - 2022-01-05
553 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
555 ## [2.1.0] - 2021-08-29
559 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
563 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
564 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
565 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
566 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
568 ## [2.0.2] - 2021-05-12
572 - Fix `busy` event emission on fixed pool type
574 ## [2.0.1] - 2021-03-16
578 - Check if pool options are properly set.
579 - `busy` event is emitted on all pool types.
581 ## [2.0.0] - 2021-03-01
585 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
589 - `FullPool` event is now renamed to `busy`.
590 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
591 _Find more details on our JSDoc._
593 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
595 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
597 ### Pool options types declaration merge
599 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
601 #### New `export` strategy
605 const DynamicThreadPool = require('poolifier/lib/dynamic')
607 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
610 But you should always prefer just using
613 const { DynamicThreadPool } = require('poolifier')
616 #### New type definitions for input data and response
618 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
619 _This is not a limitation by poolifier but NodeJS._
621 #### Public property replacements
623 `numWorkers` property is now `numberOfWorkers`
625 #### Internal (protected) properties and methods renaming
627 These properties are not intended for end users
629 - `id` => `nextMessageId`
631 These methods are not intended for end users
633 - `_chooseWorker` => `chooseWorker`
634 - `_newWorker` => `createWorker`
635 - `_execute` => `internalExecute`
636 - `_chooseWorker` => `chooseWorker`
637 - `_checkAlive` => `checkAlive`
639 - `_runAsync` => `runAsync`
641 ## [1.1.0] - 2020-05-21
645 - ThreadWorker support async functions as option
646 - Various external library patches
648 ## [1.0.0] - 2020-01-24
652 - FixedThreadPool implementation
653 - DynamicThreadPool implementation
654 - WorkerThread implementation to improve developer experience