X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CHANGELOG.md;h=36db7f829fa91065b5fda757ae6753ed32faf0a6;hb=ffcbbad84f63b8a77f2b1a08f82deef5430f646e;hp=02624b45619c05a14917e0d3aa1fadc5e716d53c;hpb=777b7824df53fc7a599e6d7bc2f1f917f6193f0d;p=poolifier.git

diff --git a/CHANGELOG.md b/CHANGELOG.md
index 02624b45..36db7f82 100644
--- a/CHANGELOG.md
+++ b/CHANGELOG.md
@@ -5,11 +5,205 @@ 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/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
-## [2.0.0] - not released yet
+## [Unreleased]
+
+### Changed
+
+- Optimize worker storage in pool.
+- Optimize worker alive status check.
+
+### Fixed
+
+- Ensure trimmable characters are checked at pool initialization.
+
+## [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
 
-We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
+- Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
+
+## [2.1.0] - 2021-08-29
+
+### Added
+
+- Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
+
+### Breaking Changes
+
+- `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
+- `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
+- `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-05-12
+
+### Bug fixes
+
+- Fix `busy` event emission on fixed pool type
+
+## [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-03-01
+
+### Bug fixes
+
+- Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
+
+### Breaking Changes
+
+- `FullPool` event is now renamed to `busy`.
+- `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
+  _Find more details on our JSDoc._
+
+- `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
+
+- We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
+
+### Pool options types declaration merge
+
+`FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
 
 #### New `export` strategy
 
@@ -26,26 +220,39 @@ But you should always prefer just using
 const { DynamicThreadPool } = require('poolifier')
 ```
 
-#### Internal (protected) methods renaming
+#### 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._
+
+#### Public property replacements
+
+`numWorkers` property is now `numberOfWorkers`
+
+#### Internal (protected) properties and methods renaming
+
+These properties are not intended for end users
+
+- `id` => `nextMessageId`
 
-Those methods are not intended to be used from final users
+These methods are not intended for end users
 
 - `_chooseWorker` => `chooseWorker`
-- `_newWorker` => `newWorker`
+- `_newWorker` => `createWorker`
 - `_execute` => `internalExecute`
 - `_chooseWorker` => `chooseWorker`
 - `_checkAlive` => `checkAlive`
 - `_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