X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CHANGELOG.md;h=ab21a07781f819151919de0ce36a53bf9e7e638f;hb=8a7983a0862fe0b647c4f3c5a6b05155d4ce8c31;hp=0e7f83ae2f767d4273addf3221b7277d4be1c215;hpb=2e2ef9c39a37f5d32bfaf75b7cfe886aac69d8cb;p=poolifier.git diff --git a/CHANGELOG.md b/CHANGELOG.md index 0e7f83ae..ab21a077 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,153 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ## [Unreleased] +## [2.6.33] - 2023-08-24 + +### Fixed + +- Fix queued tasks rescheduling. + +### Changed + +- Rename tasks queue options `queueMaxSize` to `size`. + +### Added + +- Task stealing scheduling algorithm if tasks queueing is enabled. + +## [2.6.32] - 2023-08-23 + +### Fixed + +- Ensure no task can be executed when the pool is destroyed. + +### Added + +- Add `queueMaxSize` option to tasks queue options. +- Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing. +- Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled. + +## [2.6.31] - 2023-08-20 + +### Fixed + +- Fix worker choice strategy retries mechanism in some edge cases. + +### Changed + +- Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage. +- Remove the experimental status of the `LEAST_ELU` worker choice strategy. + +## [2.6.30] - 2023-08-19 + +### Fixed + +- Ensure pool event `backPressure` is emitted. +- Ensure pool event `full` is emitted only once. +- Ensure worker node cannot be instantiated without proper arguments. + +## [2.6.29] - 2023-08-18 + +### Fixed + +- Fix race condition between ready 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. + +### Added + +- Add back pressure detection on the worker node queue. Event `backPressure` is emitted when all worker node queues are full (worker node queue size >= poolMaxSize^2). +- Use back pressure detection in worker choice strategies. +- Add worker choice strategies retries mechanism if no worker is eligible. + +## [2.6.28] - 2023-08-16 + +### Fixed + +- Ensure pool workers are properly initialized. + +### Added + +- HTTP server pool examples: express-cluster, express-hybrid. + +### Changed + +- Remove now useless branching in worker hot code path. + +## [2.6.27] - 2023-08-15 + +### Fixed + +- Add `KillHandler` type definition to exported types. + +### Added + +- Add `destroy` event to pool API. + +## [2.6.26] - 2023-08-15 + +### Added + +- Add kill handler to worker options allowing to execute custom code when worker is killed. +- Add `listTaskFunctions()` method to pool API. +- SMTP server pool example: nodemailer. + +## [2.6.25] - 2023-08-13 + +### Added + +- HTTP server pool examples: fastify-cluster, fastify-hybrid. +- WebSocket server pool examples: ws-cluster, ws-hybrid. + +## [2.6.24] - 2023-08-12 + +### Added + +- Add array of transferable objects to the `execute()` method arguments. +- WebSocket server pool examples: ws-worker_threads. + +## [2.6.23] - 2023-08-11 + +### Fixed + +- Fix pool busyness semantic when tasks queueing is enabled: the pool is busy when the number of executing tasks on each worker has reached the maximum tasks concurrency per worker. + +### Added + +- HTTP client pool examples: fetch, node-fetch and axios with multiple task functions. +- HTTP server pool examples: express-worker_threads, fastify-worker_threads. + +## [2.6.22] - 2023-08-10 + +### Fixed + +- Add missing `types` field to package.json `exports`. + +### Changed + +- Structure markdown documentation (PR #811). + +## [2.6.21] - 2023-08-03 + +### Changed + +- Improve code documentation. +- Code refactoring and cleanup for better maintainability and readability. + +## [2.6.20] - 2023-07-21 + +### Fixed + +- Fix queued tasks redistribution on error task execution starvation. +- Ensure tasks queueing per worker condition is untangled from the pool busyness semantic. + +### Changed + +- Drastically reduce lookups by worker in the worker nodes. + +## [2.6.19] - 2023-07-20 + ### Added - Dedicated internal communication channel for worker_threads pools. @@ -21,7 +168,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Add `listTaskFunctions()` method to worker class. +- Add `listTaskFunctions()` method to worker API. ## [2.6.16] - 2023-07-12 @@ -107,7 +254,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Add safe helper `availableParallelism` to help sizing the pool. +- Add safe helper `availableParallelism()` to help sizing the pool. ### Fixed @@ -122,7 +269,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Artificial version bump to 2.6.5 to workaround publication issue. -- Ensure cluster pool destroy() gracefully shutdowns worker's server. +- Ensure cluster pool `destroy()` gracefully shutdowns worker's server. - Ensure pool event is emitted before task error promise rejection. - Fix queued tasks count computation. @@ -138,7 +285,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- Ensure cluster pool destroy() gracefully shutdowns worker's server. +- Ensure cluster pool `destroy()` gracefully shutdowns worker's server. - Ensure pool event is emitted before task error promise rejection. - Fix queued tasks count computation. @@ -167,7 +314,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added -- Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md). +- Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md). ### Fixed @@ -285,7 +432,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- Fix typescript type definition for worker function: ensure the input data is optional. +- Fix typescript type definition for task function: ensure the input data is optional. - Fix typescript type definition for pool execute(): ensure the input data is optional. ## [2.4.9] - 2023-04-15 @@ -302,7 +449,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- Fix worker function type definition and validation. +- Fix task function type definition and validation. - Fix worker choice strategy options handling. ## [2.4.8] - 2023-04-12 @@ -479,7 +626,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- Fix `exports` syntax for ESM and CommonJS. +- Fix package.json `exports` syntax for ESM and CommonJS. ### Changed @@ -489,7 +636,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- Fix `exports` syntax for ESM and CommonJS. +- Fix package.json `exports` syntax for ESM and CommonJS. ## [2.3.10-1] - 2023-03-18 @@ -501,7 +648,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed -- Fix `exports` syntax for ESM and CommonJS. +- Fix package.json `exports` syntax for ESM and CommonJS. ## [2.3.9] - 2023-03-18 @@ -616,7 +763,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Breaking Changes -- Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. +- Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version. ## [2.1.0] - 2021-08-29 @@ -682,7 +829,7 @@ const { DynamicThreadPool } = require('poolifier') #### New type definitions for input data and response For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data. -_This is not a limitation by poolifier but NodeJS._ +_This is not a limitation by poolifier but Node.js._ #### Public property replacements