build(deps-dev): apply updates
[poolifier.git] / CHANGELOG.md
index 5f5bda97d82de1e7cf6666d1b1ca181af06e4bdd..27b2a232025762295702b126bff9ba3c5c4d5e86 100644 (file)
@@ -7,6 +7,447 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [4.0.13] - 2024-05-29
+
+### Changed
+
+- Optimize tasks queue implementation.
+- Enable prioritized tasks queueing only when necessary.
+
+## [4.0.12] - 2024-05-25
+
+### Changed
+
+- Optimize circular buffer implementation to store task execution measurements.
+
+## [4.0.11] - 2024-05-21
+
+### Changed
+
+- Switch to optimized circular buffer implementation to store task execution measurements.
+
+## [4.0.10] - 2024-05-20
+
+### Fixed
+
+- Ensure tasks stealing dynamic worker node is not destroyed on inactivity.
+
+## [4.0.9] - 2024-05-19
+
+### Changed
+
+- Add ELU `utilization` statistics to pool information.
+
+## [4.0.8] - 2024-05-15
+
+### Fixed
+
+- Fix default task function worker choice strategy and priority handling.
+
+## [4.0.7] - 2024-05-13
+
+### Changed
+
+- Add ELU statistics to pool information.
+
+## [4.0.6] - 2024-05-10
+
+### Fixed
+
+- Fix pools' `addTaskFunction()` type definition.
+
+## [4.0.5] - 2024-05-09
+
+### Fixed
+
+- Avoid queued tasks redistribution on the errored worker node.
+
+## [4.0.4] - 2024-05-08
+
+### Fixed
+
+- Disable `tasksStealingOnBackPressure` by default until performance issues under heavy load are sorted out.
+
+## [4.0.3] - 2024-05-08
+
+### Changed
+
+- Optimize task(s) stealing by dequeuing task(s) from the last prioritized bucket.
+
+## [4.0.2] - 2024-05-06
+
+### Fixed
+
+- Ensure poolifier worker task performance measurement requirements are synchronized with task function objects' worker choice strategies.
+
+## [4.0.1] - 2024-05-02
+
+### Fixed
+
+- Ensure dynamic worker node are initialized with sensible worker node usage default values to avoid worker choice strategies biased decisions.
+- Account for tasks wait time in task execution time computation in worker choice strategies to avoid biased decisions under load with several prioritized task functions and tasks queue enabled.
+
+## [4.0.0] - 2024-04-30
+
+### Changed
+
+- Support per task function(s) priority and worker choice strategy definition via a task function object: `{ taskFunction: (data?: Data) => Response | Promise<Response>, priority?: number, strategy?: WorkerChoiceStrategy }`.
+- Add priority queue based tasks queueing. One priority queue is divided into prioritized buckets to avoid queued tasks starvation under load.
+- BREAKING CHANGE: `listTaskFunctionNames()` to `listTaskFunctionsProperties()` in pool and worker API returning registered task functions properties.
+- BREAKING CHANGE: `strategy` field in pool information renamed to `defaultStrategy`.
+
+### Fixed
+
+- Ensure worker choice strategy options changes at runtime are propagated to poolifier workers.
+
+## [3.1.30] - 2024-04-22
+
+### Fixed
+
+- Fix `transferList` argument type definition.
+
+## [3.1.29] - 2024-04-02
+
+### Fixed
+
+- Fix possible race condition at worker node recreation on worker `error` and `exit` events.
+
+## [3.1.28] - 2024-04-01
+
+### Fixed
+
+- Ensure the minimum number of workers on a started pool is guaranteed.
+
+## [3.1.27] - 2024-03-27
+
+### Fixed
+
+- Fix publishing on JSR, take 4.
+
+## [3.1.26] - 2024-03-27
+
+### Fixed
+
+- Fix publishing on JSR, take 3.
+
+## [3.1.25] - 2024-03-27
+
+### Fixed
+
+- Fix publishing on JSR, take 2.
+
+## [3.1.24] - 2024-03-27
+
+### Fixed
+
+- Fix publishing on JSR.
+
+## [3.1.23] - 2024-03-27
+
+### Changed
+
+- Publish on JSR.
+
+## [3.1.22] - 2024-03-15
+
+### Fixed
+
+- Fix pool event emitter registered callbacks removal at `destroy()`.
+
+## [3.1.21] - 2024-02-22
+
+### Fixed
+
+- Fix null exception regression: [#1496](https://github.com/poolifier/poolifier/issues/1496).
+
+## [3.1.20] - 2024-02-11
+
+### Fixed
+
+- Ensure `worker_threads` workers are unreferenced at termination.
+
+## [3.1.19] - 2024-01-16
+
+### Fixed
+
+- Fix possible null exception at task finishing handling.
+
+### Changed
+
+- Optimize Deque implementation to improve tasks queueing performance.
+
+## [3.1.18] - 2024-01-06
+
+### Fixed
+
+- Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748).
+
+## [3.1.17] - 2024-01-05
+
+### Changed
+
+- Improve performance by clean up unneeded condition checks on hot code paths.
+
+## [3.1.16] - 2024-01-03
+
+### Fixed
+
+- Add missing type to TS type definitions.
+
+## [3.1.15] - 2024-01-02
+
+### Fixed
+
+- Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
+
+## [3.1.15-0] - 2024-01-02
+
+### Fixed
+
+- Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821).
+
+## [3.1.14] - 2024-01-01
+
+### Fixed
+
+- Properly handle dynamic pool with zero minimum size.
+
+## [3.1.13] - 2023-12-30
+
+### Changed
+
+- Reduce branching in several hot code paths.
+- Use faster object cloning implementation.
+
+## [3.1.12] - 2023-12-27
+
+### Fixed
+
+- Fix tasks redistribution triggers at pool destroying.
+
+### Changed
+
+- Switch TypeScript module resolution to Node16.
+
+## [3.1.12-0] - 2023-12-27
+
+### Fixed
+
+- Fix tasks redistribution triggers at pool destroying.
+
+## [3.1.11] - 2023-12-24
+
+### Fixed
+
+- Avoid worker node cross tasks stealing.
+- Ensure only half the pool worker nodes can steal tasks.
+
+## [3.1.10] - 2023-12-23
+
+### Changed
+
+- Avoid useless branching on pool type.
+
+## [3.1.9] - 2023-12-22
+
+### Changed
+
+- Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions.
+
+## [3.1.8] - 2023-12-21
+
+### Fixed
+
+- Fix default worker weight computation.
+- Fix possible null exception at pool destroying.
+
+## [3.1.7] - 2023-12-20
+
+### Fixed
+
+- Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748).
+
+## [3.1.6] - 2023-12-18
+
+### Fixed
+
+- Fix pool destroying with tasks queuing enabled.
+
+## [3.1.5] - 2023-12-18
+
+### Added
+
+- Add queued tasks end timeout support to worker node termination.
+
+## [3.1.4] - 2023-12-18
+
+### Fixed
+
+- Make more robust the fix for possible null exception at handling task execution response.
+
+## [3.1.3] - 2023-12-17
+
+### Fixed
+
+- Fix possible null exception at handling task execution response.
+
+## [3.1.2] - 2023-12-17
+
+### Fixed
+
+- Wait for queued tasks to end at worker node termination.
+
+## [3.1.1] - 2023-12-16
+
+### Fixed
+
+- Fix pool options TS type definition.
+
+## [3.1.0] - 2023-12-16
+
+### Changed
+
+- TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type.
+
+## [3.0.14] - 2023-12-13
+
+### Fixed
+
+- Fix possible null exception with worker_threads pools.
+
+## [3.0.13] - 2023-12-12
+
+### Fixed
+
+- Ensure worker choice strategy wait for worker nodes readiness.
+
+### Changed
+
+- Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop.
+
+## [3.0.12] - 2023-12-12
+
+### Changed
+
+- Add infinite retries support in worker choice strategy.
+
+## [3.0.11] - 2023-12-11
+
+### Fixed
+
+- Ensure pool asynchronous resource properly track tasks execution.
+
+## [3.0.10] - 2023-12-08
+
+### Changed
+
+- Add a fastpath when tasks stealing or redistribution is impossible.
+
+## [3.0.9] - 2023-11-26
+
+### Fixed
+
+- Remove all pool events listener at pool destroying.
+- Remove all worker node events listener at worker node destroying.
+- Fix worker node event emitter listeners handling memory leak at pool options runtime change.
+
+## [3.0.8] - 2023-11-25
+
+### Fixed
+
+- Ensure continuous tasks stealing on idle start at worker node idling.
+
+## [3.0.7] - 2023-11-24
+
+### Changed
+
+- Make continuous tasks stealing start at worker node idling.
+
+## [3.0.6] - 2023-11-24
+
+### Fixed
+
+- Ensure pool statuses are checked at initialization, `start()` or `destroy()`.
+- Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles.
+
+## [3.0.5] - 2023-10-27
+
+### Fixed
+
+- Ensure pool `ready` event can be emitted only once.
+
+## [3.0.4] - 2023-10-20
+
+### Changed
+
+- Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier).
+- Use builtin retry mechanism in worker choice strategies instead of custom one.
+
+## [3.0.3] - 2023-10-19
+
+### Fixed
+
+- Avoid null exception at sending message to worker.
+- Avoid null exception at checking worker node readiness.
+
+## [3.0.2] - 2023-10-17
+
+### Fixed
+
+- Fix race condition at dynamic worker node task assignment and scheduled removal. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468) and [#1496](https://github.com/poolifier/poolifier/issues/1496).
+
+## [3.0.1] - 2023-10-16
+
+### Fixed
+
+- Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468).
+
+### Changed
+
+- Switch the worker node eventing code to `EventTarget` API.
+
+## [3.0.0] - 2023-10-08
+
+### Changed
+
+- Remove Node.js 16.x.x (EOL) support.
+
+## [2.7.5] - 2023-10-03
+
+### Changed
+
+- Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version.
+
+## [2.7.4] - 2023-09-25
+
+### Fixed
+
+- Fix source maps (bundler issue).
+
+## [2.7.3] - 2023-09-24
+
+### Changed
+
+- Convert pool event emitter to event emitter async resource.
+
+## [2.7.2] - 2023-09-23
+
+### Changed
+
+- Add source maps to npm package to ease debugging.
+
+### Added
+
+- Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark).
+
+## [2.7.1] - 2023-09-20
+
+### Fixed
+
+- Ensure worker message listener used one time are removed after usage.
+
+## [2.7.0] - 2023-09-19
+
 ### Fixed
 
 - Fix task stealing related tasks queue options handling at runtime.
@@ -17,7 +458,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API.
+- Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148).
 - Stricter worker constructor arguments validation.
 
 ## [2.6.45] - 2023-09-17
@@ -28,10 +469,10 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Added
 
-- Add `startWorkers` to pool options to whether start the minimum number of workers at pool creation or not.
+- Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not.
 - Add `start()` method to pool API to start the minimum number of workers.
-- Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing on back pressure or not.
-- Continuous internal benchmarking: https://poolifier.github.io/benchmark-results/dev/bench.
+- Add `taskStealing` and `tasksStealingOnBackPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not.
+- Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench).
 
 ## [2.6.44] - 2023-09-08
 
@@ -190,7 +631,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ### Fixed
 
-- Fix race condition between ready and task functions worker message handling at startup.
+- Fix race condition between readiness and task functions worker message handling at startup.
 - Fix duplicate task function worker usage statistics computation per task function.
 - Update task function worker usage statistics if and only if there's at least two different task functions.
 - Fix race condition at task function worker usage executing task computation leading to negative value.