X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CHANGELOG.md;h=06ee9476e5b9c2c6853ab87ca0fbc935e6f606f3;hb=15bb637a91abd156aae586ce14c663101a8c6697;hp=ee4d6fd906d371239df3b6d00cf2982f148d21a5;hpb=72ddc5cb5cfc42e923575662697cda8965457384;p=poolifier.git diff --git a/CHANGELOG.md b/CHANGELOG.md index ee4d6fd9..06ee9476 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,16 +2,349 @@ All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). -## [2.2.0] - 2022-05-01 +## [Unreleased] + +## [2.4.10] - 2023-04-15 + +### Fixed + +- Fix typescript type definition for worker 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 + +### Added + +- Add tasks queue enablement runtime setter to pool. +- Add tasks queue options runtime setter to pool. +- Add worker choice strategy options runtime setter to pool. + +### Changed + +- Remove the tasks queuing experimental status. + +### Fixed + +- Fix worker function type definition and validation. +- Fix worker choice strategy options handling. + +## [2.4.8] - 2023-04-12 + +### Fixed + +- Fix message between main worker and worker type definition for tasks. +- Fix code documentation. + +## [2.4.7] - 2023-04-11 + +### Added + +- Add worker tasks queue options to pool options. + +### Fixed + +- Fix missing documentation. + +## [2.4.6] - 2023-04-10 + +### Fixed + +- Ensure one task at a time is executed per worker with tasks queueing enabled. +- Properly count worker running tasks with tasks queueing enabled. + +## [2.4.5] - 2023-04-09 + +### Added + +- Use monotonic high resolution timer for worker tasks run time. +- Add worker tasks median run time to statistics. +- Add worker tasks queue (experimental). + +## [2.4.4] - 2023-04-07 + +### Added + +- Add `PoolEvents` enumeration and `PoolEvent` type. + +### Fixed + +- Destroy worker only on alive check. + +## [2.4.3] - 2023-04-07 + +### Fixed + +- Fix typedoc generation with inheritance. + +## [2.4.2] - 2023-04-06 + +### Added + +- Add `full` event to dynamic pool. +- Keep worker choice strategy in memory for conditional reuse. + +### Fixed + +- Fix possible negative worker key at worker removal in worker choice strategies. + +## [2.4.1] - 2023-04-05 + +### Changed + +- Optimize worker choice strategy for dynamic pool. + +### Fixed + +- Ensure dynamic pool does not alter worker choice strategy expected behavior. + +## [2.4.0] - 2023-04-04 + +### Added + +- Add `LESS_BUSY` worker choice strategy. + +### Changed + +- Optimize worker storage in pool. +- Optimize worker alive status check. +- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. +- Optimize `LESS_USED` worker choice strategy. +- Update benchmarks versus external threads pools. +- Optimize tasks usage statistics requirements for worker choice strategy. + +### Fixed + +- Ensure trimmable characters are checked at pool initialization. +- Fix message id integer overflow. +- Fix pool worker removal in worker choice strategy internals. +- Fix package publication with pnpm. + +## [2.4.0-3] - 2023-04-04 + +### Added + +- Add `LESS_BUSY` worker choice strategy. + +### Changed + +- Optimize worker storage in pool. +- Optimize worker alive status check. +- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. +- Optimize `LESS_USED` worker choice strategy. +- Update benchmarks versus external threads pools. + +### Fixed + +- Ensure trimmable characters are checked at pool initialization. +- Fix message id integer overflow. +- Fix pool worker removal in worker choice strategy internals. +- Fix package publication with pnpm. + +## [2.4.0-2] - 2023-04-03 + +### Added + +- Add `LESS_BUSY` worker choice strategy. + +### Changed + +- Optimize worker storage in pool. +- Optimize worker alive status check. +- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. +- Optimize `LESS_USED` worker choice strategy. + +### Fixed + +- Ensure trimmable characters are checked at pool initialization. +- Fix message id integer overflow. +- Fix pool worker removal in worker choice strategy internals. +- Fix package publication with pnpm. + +## [2.4.0-1] - 2023-04-03 + +### Added + +- Add `LESS_BUSY` worker choice strategy. + +### Changed + +- Optimize worker storage in pool. +- Optimize worker alive status check. +- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. +- Optimize `LESS_USED` worker choice strategy. + +### Fixed + +- Ensure trimmable characters are checked at pool initialization. +- Fix message id integer overflow. +- Fix pool worker removal in worker choice strategy internals. + +## [2.4.0-0] - 2023-04-03 + +### Added + +- Add `LESS_BUSY` worker choice strategy. + +### Changed + +- Optimize worker storage in pool. +- Optimize worker alive status check. +- BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. +- Optimize `LESS_USED` worker choice strategy. + +### Fixed + +- Ensure trimmable characters are checked at pool initialization. +- Fix message id integer overflow. +- Fix pool worker removal in worker choice strategy internals. + +## [2.3.10] - 2023-03-18 + +### Fixed + +- Fix `exports` syntax for ESM and CommonJS. + +### Changed + +- Permit SemVer pre-release publication. + +## [2.3.10-2] - 2023-03-18 + +### Fixed + +- Fix `exports` syntax for ESM and CommonJS. + +## [2.3.10-1] - 2023-03-18 + +### Changed + +- Permit SemVer pre-release publication. + +## [2.3.10-0] - 2023-03-18 + +### Fixed + +- Fix `exports` syntax for ESM and CommonJS. + +## [2.3.9] - 2023-03-18 + +### Changed + +- Introduce ESM module support along with CommonJS one. + +### Fixed + +- Fix brown paper bag bug referencing the same object literal. + +## [2.3.8] - 2023-03-18 + +### Changed + +- Switch internal benchmarking code to benny. +- Switch to TypeScript 5.x.x. +- Switch rollup bundler plugins to core ones. +- Switch to TSDoc syntax. +- Enforce conventional commits. + +### Fixed + +- Fix random integer generator. +- Fix worker choice strategy pool type identification at initialization. + +## [2.3.7] - 2022-10-23 + +### Changed + +- Switch to open collective FOSS project funding platform. +- Switch to ts-standard linter configuration on TypeScript code. + +### Fixed + +- Fixed missing async on pool execute method. +- Fixed typing in TypeScript example. +- Fixed types in unit tests. + +## [2.3.6] - 2022-10-22 + +### Changed + +- Cleanup pool attributes and methods. +- Refine error types thrown. + +### Fixed + +- Fix continuous integration build on windows. +- Fix code coverage reporting by using c8 instead of nyc. + +## [2.3.5] - 2022-10-21 + +### Changed + +- Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. +- Optimize tasks usage lookup implementation. + +### Fixed + +- Fix missed pool event emitter type export. +- Fix typedoc documentation generation. + +## [2.3.4] - 2022-10-17 + +### Added + +- Fully automate release process with release-it. + +### Changed + +- Optimize fair share task scheduling algorithm implementation. +- Update benchmarks versus external pools results with latest version. + +## [2.3.3] - 2022-10-15 + +### Added + +- Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. + +## [2.3.2] - 2022-10-14 + +### Changed + +- Optimize fair share worker selection strategy implementation. + +### Fixed + +- Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. + +## [2.3.1] - 2022-10-13 + +### Added + +- Pool worker choice strategies: + - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. + - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. + +## [2.2.2] - 2022-10-09 + +### Fixed + +- Fixed `README.md` file. + +## [2.2.1] - 2022-10-08 + +### Added + +- Dynamic worker choice strategy change at runtime. + +## [2.2.0] - 2022-01-05 ### Breaking Changes - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. -## [2.1.0] - 2021-29-08 +## [2.1.0] - 2021-08-29 ### Added @@ -24,20 +357,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. -## [2.0.2] - 2021-12-05 +## [2.0.2] - 2021-05-12 ### Bug fixes - Fix `busy` event emission on fixed pool type -## [2.0.1] - 2021-16-03 +## [2.0.1] - 2021-03-16 ### Bug fixes - Check if pool options are properly set. - `busy` event is emitted on all pool types. -## [2.0.0] - 2021-01-03 +## [2.0.0] - 2021-03-01 ### Bug fixes @@ -97,14 +430,14 @@ These methods are not intended for end users - `_run` => `run` - `_runAsync` => `runAsync` -## [1.1.0] - 2020-21-05 +## [1.1.0] - 2020-05-21 ### Added - ThreadWorker support async functions as option - Various external library patches -## [1.0.0] - 2020-24-01 +## [1.0.0] - 2020-01-24 ### Added