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).
12 - Add `LESS_BUSY` worker choice strategy.
16 - Optimize worker storage in pool.
17 - Optimize worker alive status check.
18 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
19 - Optimize `LESS_USED` worker choice strategy.
23 - Ensure trimmable characters are checked at pool initialization.
24 - Fix message id integer overflow.
25 - Fix pool worker removal in worker choice strategy internals.
26 - Fix package publication with pnpm.
28 ## [2.4.0-1] - 2023-04-03
32 - Add `LESS_BUSY` worker choice strategy.
36 - Optimize worker storage in pool.
37 - Optimize worker alive status check.
38 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
39 - Optimize `LESS_USED` worker choice strategy.
43 - Ensure trimmable characters are checked at pool initialization.
44 - Fix message id integer overflow.
45 - Fix pool worker removal in worker choice strategy internals.
47 ## [2.4.0-0] - 2023-04-03
51 - Add `LESS_BUSY` worker choice strategy.
55 - Optimize worker storage in pool.
56 - Optimize worker alive status check.
57 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
58 - Optimize `LESS_USED` worker choice strategy.
62 - Ensure trimmable characters are checked at pool initialization.
63 - Fix message id integer overflow.
64 - Fix pool worker removal in worker choice strategy internals.
66 ## [2.3.10] - 2023-03-18
70 - Fix `exports` syntax for ESM and CommonJS.
74 - Permit SemVer pre-release publication.
76 ## [2.3.10-2] - 2023-03-18
80 - Fix `exports` syntax for ESM and CommonJS.
82 ## [2.3.10-1] - 2023-03-18
86 - Permit SemVer pre-release publication.
88 ## [2.3.10-0] - 2023-03-18
92 - Fix `exports` syntax for ESM and CommonJS.
94 ## [2.3.9] - 2023-03-18
98 - Introduce ESM module support along with CommonJS one.
102 - Fix brown paper bag bug referencing the same object literal.
104 ## [2.3.8] - 2023-03-18
108 - Switch internal benchmarking code to benny.
109 - Switch to TypeScript 5.x.x.
110 - Switch rollup bundler plugins to core ones.
111 - Switch to TSDoc syntax.
112 - Enforce conventional commits.
116 - Fix random integer generator.
117 - Fix worker choice strategy pool type identification at initialization.
119 ## [2.3.7] - 2022-10-23
123 - Switch to open collective FOSS project funding platform.
124 - Switch to ts-standard linter configuration on TypeScript code.
128 - Fixed missing async on pool execute method.
129 - Fixed typing in TypeScript example.
130 - Fixed types in unit tests.
132 ## [2.3.6] - 2022-10-22
136 - Cleanup pool attributes and methods.
137 - Refine error types thrown.
141 - Fix continuous integration build on windows.
142 - Fix code coverage reporting by using c8 instead of nyc.
144 ## [2.3.5] - 2022-10-21
148 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
149 - Optimize tasks usage lookup implementation.
153 - Fix missed pool event emitter type export.
154 - Fix typedoc documentation generation.
156 ## [2.3.4] - 2022-10-17
160 - Fully automate release process with release-it.
164 - Optimize fair share task scheduling algorithm implementation.
165 - Update benchmarks versus external pools results with latest version.
167 ## [2.3.3] - 2022-10-15
171 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
173 ## [2.3.2] - 2022-10-14
177 - Optimize fair share worker selection strategy implementation.
181 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
183 ## [2.3.1] - 2022-10-13
187 - Pool worker choice strategies:
188 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
189 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
191 ## [2.2.2] - 2022-10-09
195 - Fixed `README.md` file.
197 ## [2.2.1] - 2022-10-08
201 - Dynamic worker choice strategy change at runtime.
203 ## [2.2.0] - 2022-01-05
207 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
209 ## [2.1.0] - 2021-08-29
213 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
217 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
218 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
219 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
220 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
222 ## [2.0.2] - 2021-05-12
226 - Fix `busy` event emission on fixed pool type
228 ## [2.0.1] - 2021-03-16
232 - Check if pool options are properly set.
233 - `busy` event is emitted on all pool types.
235 ## [2.0.0] - 2021-03-01
239 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
243 - `FullPool` event is now renamed to `busy`.
244 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
245 _Find more details on our JSDoc._
247 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
249 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
251 ### Pool options types declaration merge
253 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
255 #### New `export` strategy
259 const DynamicThreadPool = require('poolifier/lib/dynamic')
261 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
264 But you should always prefer just using
267 const { DynamicThreadPool } = require('poolifier')
270 #### New type definitions for input data and response
272 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
273 _This is not a limitation by poolifier but NodeJS._
275 #### Public property replacements
277 `numWorkers` property is now `numberOfWorkers`
279 #### Internal (protected) properties and methods renaming
281 These properties are not intended for end users
283 - `id` => `nextMessageId`
285 These methods are not intended for end users
287 - `_chooseWorker` => `chooseWorker`
288 - `_newWorker` => `createWorker`
289 - `_execute` => `internalExecute`
290 - `_chooseWorker` => `chooseWorker`
291 - `_checkAlive` => `checkAlive`
293 - `_runAsync` => `runAsync`
295 ## [1.1.0] - 2020-05-21
299 - ThreadWorker support async functions as option
300 - Various external library patches
302 ## [1.0.0] - 2020-01-24
306 - FixedThreadPool implementation
307 - DynamicThreadPool implementation
308 - WorkerThread implementation to improve developer experience