3 All notable changes to this project will be documented in this file.
5 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
10 ## [2.3.9] - 2023-03-18
14 - Introduce ESM module support along with CommonJS one.
18 - Fix brown paper bag bug referencing the same object literal.
20 ## [2.3.8] - 2023-03-18
24 - Switch internal benchmarking code to benny.
25 - Switch to TypeScript 5.x.x.
26 - Switch rollup bundler plugins to core ones.
27 - Switch to TSDoc syntax.
28 - Enforce conventional commits.
32 - Fix random integer generator.
33 - Fix worker choice strategy pool type identification at initialization.
35 ## [2.3.7] - 2022-10-23
39 - Switch to open collective FOSS project funding platform.
40 - Switch to ts-standard linter configuration on TypeScript code.
44 - Fixed missing async on pool execute method.
45 - Fixed typing in TypeScript example.
46 - Fixed types in unit tests.
48 ## [2.3.6] - 2022-10-22
52 - Cleanup pool attributes and methods.
53 - Refine error types thrown.
57 - Fix continuous integration build on windows.
58 - Fix code coverage reporting by using c8 instead of nyc.
60 ## [2.3.5] - 2022-10-21
64 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
65 - Optimize tasks usage lookup implementation.
69 - Fix missed pool event emitter type export.
70 - Fix typedoc documentation generation.
72 ## [2.3.4] - 2022-10-17
76 - Fully automate release process with release-it.
80 - Optimize fair share task scheduling algorithm implementation.
81 - Update benchmarks versus external pools results with latest version.
83 ## [2.3.3] - 2022-10-15
87 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
89 ## [2.3.2] - 2022-10-14
93 - Optimize fair share worker selection strategy implementation.
97 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
99 ## [2.3.1] - 2022-10-13
103 - Pool worker choice strategies:
104 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
105 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
107 ## [2.2.2] - 2022-10-09
111 - Fixed `README.md` file.
113 ## [2.2.1] - 2022-10-08
117 - Dynamic worker choice strategy change at runtime.
119 ## [2.2.0] - 2022-01-05
123 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
125 ## [2.1.0] - 2021-08-29
129 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
133 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
134 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
135 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
136 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
138 ## [2.0.2] - 2021-05-12
142 - Fix `busy` event emission on fixed pool type
144 ## [2.0.1] - 2021-03-16
148 - Check if pool options are properly set.
149 - `busy` event is emitted on all pool types.
151 ## [2.0.0] - 2021-03-01
155 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
159 - `FullPool` event is now renamed to `busy`.
160 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
161 _Find more details on our JSDoc._
163 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
165 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
167 ### Pool options types declaration merge
169 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
171 #### New `export` strategy
175 const DynamicThreadPool = require('poolifier/lib/dynamic')
177 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
180 But you should always prefer just using
183 const { DynamicThreadPool } = require('poolifier')
186 #### New type definitions for input data and response
188 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
189 _This is not a limitation by poolifier but NodeJS._
191 #### Public property replacements
193 `numWorkers` property is now `numberOfWorkers`
195 #### Internal (protected) properties and methods renaming
197 These properties are not intended for end users
199 - `id` => `nextMessageId`
201 These methods are not intended for end users
203 - `_chooseWorker` => `chooseWorker`
204 - `_newWorker` => `createWorker`
205 - `_execute` => `internalExecute`
206 - `_chooseWorker` => `chooseWorker`
207 - `_checkAlive` => `checkAlive`
209 - `_runAsync` => `runAsync`
211 ## [1.1.0] - 2020-05-21
215 - ThreadWorker support async functions as option
216 - Various external library patches
218 ## [1.0.0] - 2020-01-24
222 - FixedThreadPool implementation
223 - DynamicThreadPool implementation
224 - WorkerThread implementation to improve developer experience