X-Git-Url: https://git.piment-noir.org/?a=blobdiff_plain;f=CHANGELOG.md;h=2f81e0fe3907f67d9587a8b0b17856698a879d48;hb=refs%2Ftags%2Fv2.3.1;hp=cf61e7816c3cb4fb5ae3efd4904e5f1b3fe6da1a;hpb=cf9aa6c3340ad00792aa3c5e1a9d047cd0140fc2;p=poolifier.git diff --git a/CHANGELOG.md b/CHANGELOG.md index cf61e781..2f81e0fe 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,118 @@ 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.3.1] - 2022-13-10 + +### 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-09-10 + +### Fixed + +- Fixed `README.md` file. + +## [2.2.1] - 2022-08-10 + +### Added + +- Dynamic worker choice strategy change at runtime. + +## [2.2.0] - 2022-05-01 + +### 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 + +### Added + +- Add an optional pool option `messageHandler` to `PoolOptions` 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-12-05 + +### Bug fixes + +- Fix `busy` event emission on fixed pool type + +## [2.0.1] - 2021-16-03 + +### Bug fixes + +- Check if pool options are properly set. +- `busy` event is emitted on all pool types. + +## [2.0.0] - 2021-01-03 + +### 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`. + +#### New `export` strategy + +```js +// Before +const DynamicThreadPool = require('poolifier/lib/dynamic') +// After +const { DynamicThreadPool } = require('poolifier/lib/dynamic') +``` + +But you should always prefer just using + +```js +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._ + +#### Public property replacements + +`numWorkers` property is now `numberOfWorkers` + +#### Internal (protected) properties and methods renaming + +These properties are not intended for end users + +- `id` => `nextMessageId` + +These methods are not intended for end users + +- `_chooseWorker` => `chooseWorker` +- `_newWorker` => `createWorker` +- `_execute` => `internalExecute` +- `_chooseWorker` => `chooseWorker` +- `_checkAlive` => `checkAlive` +- `_run` => `run` +- `_runAsync` => `runAsync` + ## [1.1.0] - 2020-21-05 ### Added