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.1.0/),
6 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
10 ## [2.4.0-2] - 2023-04-03
14 - Add `LESS_BUSY` worker choice strategy.
18 - Optimize worker storage in pool.
19 - Optimize worker alive status check.
20 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
21 - Optimize `LESS_USED` worker choice strategy.
25 - Ensure trimmable characters are checked at pool initialization.
26 - Fix message id integer overflow.
27 - Fix pool worker removal in worker choice strategy internals.
28 - Fix package publication with pnpm.
30 ## [2.4.0-1] - 2023-04-03
34 - Add `LESS_BUSY` worker choice strategy.
38 - Optimize worker storage in pool.
39 - Optimize worker alive status check.
40 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
41 - Optimize `LESS_USED` worker choice strategy.
45 - Ensure trimmable characters are checked at pool initialization.
46 - Fix message id integer overflow.
47 - Fix pool worker removal in worker choice strategy internals.
49 ## [2.4.0-0] - 2023-04-03
53 - Add `LESS_BUSY` worker choice strategy.
57 - Optimize worker storage in pool.
58 - Optimize worker alive status check.
59 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
60 - Optimize `LESS_USED` worker choice strategy.
64 - Ensure trimmable characters are checked at pool initialization.
65 - Fix message id integer overflow.
66 - Fix pool worker removal in worker choice strategy internals.
68 ## [2.3.10] - 2023-03-18
72 - Fix `exports` syntax for ESM and CommonJS.
76 - Permit SemVer pre-release publication.
78 ## [2.3.10-2] - 2023-03-18
82 - Fix `exports` syntax for ESM and CommonJS.
84 ## [2.3.10-1] - 2023-03-18
88 - Permit SemVer pre-release publication.
90 ## [2.3.10-0] - 2023-03-18
94 - Fix `exports` syntax for ESM and CommonJS.
96 ## [2.3.9] - 2023-03-18
100 - Introduce ESM module support along with CommonJS one.
104 - Fix brown paper bag bug referencing the same object literal.
106 ## [2.3.8] - 2023-03-18
110 - Switch internal benchmarking code to benny.
111 - Switch to TypeScript 5.x.x.
112 - Switch rollup bundler plugins to core ones.
113 - Switch to TSDoc syntax.
114 - Enforce conventional commits.
118 - Fix random integer generator.
119 - Fix worker choice strategy pool type identification at initialization.
121 ## [2.3.7] - 2022-10-23
125 - Switch to open collective FOSS project funding platform.
126 - Switch to ts-standard linter configuration on TypeScript code.
130 - Fixed missing async on pool execute method.
131 - Fixed typing in TypeScript example.
132 - Fixed types in unit tests.
134 ## [2.3.6] - 2022-10-22
138 - Cleanup pool attributes and methods.
139 - Refine error types thrown.
143 - Fix continuous integration build on windows.
144 - Fix code coverage reporting by using c8 instead of nyc.
146 ## [2.3.5] - 2022-10-21
150 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
151 - Optimize tasks usage lookup implementation.
155 - Fix missed pool event emitter type export.
156 - Fix typedoc documentation generation.
158 ## [2.3.4] - 2022-10-17
162 - Fully automate release process with release-it.
166 - Optimize fair share task scheduling algorithm implementation.
167 - Update benchmarks versus external pools results with latest version.
169 ## [2.3.3] - 2022-10-15
173 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
175 ## [2.3.2] - 2022-10-14
179 - Optimize fair share worker selection strategy implementation.
183 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
185 ## [2.3.1] - 2022-10-13
189 - Pool worker choice strategies:
190 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
191 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
193 ## [2.2.2] - 2022-10-09
197 - Fixed `README.md` file.
199 ## [2.2.1] - 2022-10-08
203 - Dynamic worker choice strategy change at runtime.
205 ## [2.2.0] - 2022-01-05
209 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
211 ## [2.1.0] - 2021-08-29
215 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
219 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
220 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
221 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
222 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
224 ## [2.0.2] - 2021-05-12
228 - Fix `busy` event emission on fixed pool type
230 ## [2.0.1] - 2021-03-16
234 - Check if pool options are properly set.
235 - `busy` event is emitted on all pool types.
237 ## [2.0.0] - 2021-03-01
241 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
245 - `FullPool` event is now renamed to `busy`.
246 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
247 _Find more details on our JSDoc._
249 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
251 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
253 ### Pool options types declaration merge
255 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
257 #### New `export` strategy
261 const DynamicThreadPool = require('poolifier/lib/dynamic')
263 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
266 But you should always prefer just using
269 const { DynamicThreadPool } = require('poolifier')
272 #### New type definitions for input data and response
274 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
275 _This is not a limitation by poolifier but NodeJS._
277 #### Public property replacements
279 `numWorkers` property is now `numberOfWorkers`
281 #### Internal (protected) properties and methods renaming
283 These properties are not intended for end users
285 - `id` => `nextMessageId`
287 These methods are not intended for end users
289 - `_chooseWorker` => `chooseWorker`
290 - `_newWorker` => `createWorker`
291 - `_execute` => `internalExecute`
292 - `_chooseWorker` => `chooseWorker`
293 - `_checkAlive` => `checkAlive`
295 - `_runAsync` => `runAsync`
297 ## [1.1.0] - 2020-05-21
301 - ThreadWorker support async functions as option
302 - Various external library patches
304 ## [1.0.0] - 2020-01-24
308 - FixedThreadPool implementation
309 - DynamicThreadPool implementation
310 - WorkerThread implementation to improve developer experience