X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CHANGELOG.md;h=80df7b6ca94f3daf60b0c179773453d495edffa1;hb=c4424e52e4924efa5eef704cb5dcb82f2760e0da;hp=27033633acacc75d95b79e9ea7414e243ca60954;hpb=a32959dad7ec3668f607e26153ad7610ff5438f9;p=poolifier.git diff --git a/CHANGELOG.md b/CHANGELOG.md index 27033633..80df7b6c 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -9,8 +9,279 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Added +- Add array of transferable objects to the `execute()` method arguments. +- WebSocket server pool examples: ws + +## [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, fastify. + +## [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 task 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. + +## [2.6.18] - 2023-07-19 + +### Changed + +- Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller. + +## [2.6.17] - 2023-07-16 + +### Added + +- Add `listTaskFunctions()` method to worker class. + +## [2.6.16] - 2023-07-12 + +### Fixed + +- Fix pool startup detection. +- Fix worker task functions handling. + +## [2.6.15] - 2023-07-11 + +### Added + +- Take into account worker node readiness in worker choice strategies. + +## [2.6.14] - 2023-07-10 + +### Fixed + +- Fix task function statistics tracking. + +## [2.6.13] - 2023-07-10 + +### Added + +- Add per task function statistics tracking. +- Add public methods to manipulate the worker task functions at runtime. + +## [2.6.12] - 2023-07-09 + +### Fixed + +- Workaround import issue with `node:os` module in node 16.x.x. + +## [2.6.11] - 2023-07-09 + +### Fixed + +- Fix pool readiness semantic. + +## [2.6.10] - 2023-07-08 + +### Fixed + +- Ensure workers are not recreated on error at pool startup. + +### Added + +- Add `ready` and `strategy` fields to pool information. +- Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready. +- Add dynamic pool sizing checks. + +## [2.6.9] - 2023-07-07 + +### Fixed + +- Recreate the right worker type on uncaught exception. + +### Added + +- Add minimum and maximum to internal measurement statistics. +- Add `runTime` and `waitTime` to pool information. +- Check worker inactive time only on dynamic worker. + +## [2.6.8] - 2023-07-03 + +### Fixed + +- Brown paper bag release to fix version handling in pool information. + +## [2.6.7] - 2023-07-03 + +### Fixed + +- Ensure worker queued tasks at error are reassigned to other pool workers. + +### Added + +- Add pool `utilization` ratio to pool information. +- Add `version` to pool information. +- Add worker information to worker nodes. + +## [2.6.6] - 2023-07-01 + +### Added + +- Add safe helper `availableParallelism` to help sizing the pool. + +### Fixed + +- Ensure message handler is only registered in worker. + +## [2.6.5] - 2023-06-27 + +### Known issues + +- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 + +### Fixed + +- Artificial version bump to 2.6.5 to workaround publication issue. +- Ensure cluster pool destroy() gracefully shutdowns worker's server. +- Ensure pool event is emitted before task error promise rejection. +- Fix queued tasks count computation. + +### Removed + +- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC. + +## [2.6.4] - 2023-06-27 + +### Known issues + +- Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 + +### Fixed + +- Ensure cluster pool destroy() gracefully shutdowns worker's server. +- Ensure pool event is emitted before task error promise rejection. +- Fix queued tasks count computation. + +### Removed + +- Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC. + +## [2.6.3] - 2023-06-19 + +### Fixed + +- Ensure no tasks are queued when trying to soft kill a dynamic worker. +- Update strategies internals after statistics computation. + +### Changed + +- Optimize O(1) queue implementation. + +## [2.6.2] - 2023-06-12 + +### Fixed + +- Fix new worker use after creation in dynamic pool given the current worker choice strategy. + +## [2.6.1] - 2023-06-10 + +### Added + +- Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md). + +### Fixed + +- Fix average statistics computation: ensure failed tasks are not accounted. + +## [2.6.0] - 2023-06-09 + +### Added + +- Add `LEAST_ELU` worker choice strategy (experimental). +- Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy. + +### Changed + +- Refactor pool worker node usage internals. +- Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed. +- Breaking change: pool information `info` property object fields have been renamed. + +### Fixed + +- Fix wait time accounting. +- Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time. +- Ensure worker choice strategy `LEAST_USED` accounts also queued tasks. + +## [2.5.4] - 2023-06-07 + +### Added + +- Add Event Loop Utilization (ELU) statistics to worker tasks usage. + +### Changed + +- Compute statistics at the worker level only if needed. +- Add `worker_threads` options to thread pool options. + +### Fixed + +- Make the `LEAST_BUSY` strategy only relies on task runtime. + +## [2.5.3] - 2023-06-04 + +### Changed + +- Refine pool information content. +- Limit pool internals public exposure. + +## [2.5.2] - 2023-06-02 + +### Added + +- Add `taskError` pool event for task execution error. +- Add pool information `info` property to pool. +- Emit pool information on `busy` and `full` pool events. + +## [2.5.1] - 2023-06-01 + +### Added + +- Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`. +- Add `error` pool event for uncaught worker error. + +## [2.5.0] - 2023-05-31 + +### Added + - Switch pool event emitter to `EventEmitterAsyncResource`. - Add tasks wait time accounting in per worker tasks usage. +- Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental). ### Changed @@ -60,7 +331,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 @@ -77,7 +348,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 @@ -102,7 +373,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 ### Fixed - Ensure one task at a time is executed per worker with tasks queueing enabled. -- Properly count worker running tasks with tasks queueing enabled. +- Properly count worker executing tasks with tasks queueing enabled. ## [2.4.5] - 2023-04-09 @@ -254,7 +525,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 @@ -264,7 +535,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 @@ -276,7 +547,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 @@ -391,7 +662,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 @@ -456,8 +727,8 @@ 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 serializable data. -_This is not a limitation by poolifier but NodeJS._ +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 Node.js._ #### Public property replacements