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 `full` event to dynamic pool.
14 ## [2.4.1] - 2023-04-05
18 - Optimize worker choice strategy for dynamic pool.
22 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
24 ## [2.4.0] - 2023-04-04
28 - Add `LESS_BUSY` worker choice strategy.
32 - Optimize worker storage in pool.
33 - Optimize worker alive status check.
34 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
35 - Optimize `LESS_USED` worker choice strategy.
36 - Update benchmarks versus external threads pools.
37 - Optimize tasks usage statistics requirements for worker choice strategy.
41 - Ensure trimmable characters are checked at pool initialization.
42 - Fix message id integer overflow.
43 - Fix pool worker removal in worker choice strategy internals.
44 - Fix package publication with pnpm.
46 ## [2.4.0-3] - 2023-04-04
50 - Add `LESS_BUSY` worker choice strategy.
54 - Optimize worker storage in pool.
55 - Optimize worker alive status check.
56 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
57 - Optimize `LESS_USED` worker choice strategy.
58 - Update benchmarks versus external threads pools.
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.
65 - Fix package publication with pnpm.
67 ## [2.4.0-2] - 2023-04-03
71 - Add `LESS_BUSY` worker choice strategy.
75 - Optimize worker storage in pool.
76 - Optimize worker alive status check.
77 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
78 - Optimize `LESS_USED` worker choice strategy.
82 - Ensure trimmable characters are checked at pool initialization.
83 - Fix message id integer overflow.
84 - Fix pool worker removal in worker choice strategy internals.
85 - Fix package publication with pnpm.
87 ## [2.4.0-1] - 2023-04-03
91 - Add `LESS_BUSY` worker choice strategy.
95 - Optimize worker storage in pool.
96 - Optimize worker alive status check.
97 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
98 - Optimize `LESS_USED` worker choice strategy.
102 - Ensure trimmable characters are checked at pool initialization.
103 - Fix message id integer overflow.
104 - Fix pool worker removal in worker choice strategy internals.
106 ## [2.4.0-0] - 2023-04-03
110 - Add `LESS_BUSY` worker choice strategy.
114 - Optimize worker storage in pool.
115 - Optimize worker alive status check.
116 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
117 - Optimize `LESS_USED` worker choice strategy.
121 - Ensure trimmable characters are checked at pool initialization.
122 - Fix message id integer overflow.
123 - Fix pool worker removal in worker choice strategy internals.
125 ## [2.3.10] - 2023-03-18
129 - Fix `exports` syntax for ESM and CommonJS.
133 - Permit SemVer pre-release publication.
135 ## [2.3.10-2] - 2023-03-18
139 - Fix `exports` syntax for ESM and CommonJS.
141 ## [2.3.10-1] - 2023-03-18
145 - Permit SemVer pre-release publication.
147 ## [2.3.10-0] - 2023-03-18
151 - Fix `exports` syntax for ESM and CommonJS.
153 ## [2.3.9] - 2023-03-18
157 - Introduce ESM module support along with CommonJS one.
161 - Fix brown paper bag bug referencing the same object literal.
163 ## [2.3.8] - 2023-03-18
167 - Switch internal benchmarking code to benny.
168 - Switch to TypeScript 5.x.x.
169 - Switch rollup bundler plugins to core ones.
170 - Switch to TSDoc syntax.
171 - Enforce conventional commits.
175 - Fix random integer generator.
176 - Fix worker choice strategy pool type identification at initialization.
178 ## [2.3.7] - 2022-10-23
182 - Switch to open collective FOSS project funding platform.
183 - Switch to ts-standard linter configuration on TypeScript code.
187 - Fixed missing async on pool execute method.
188 - Fixed typing in TypeScript example.
189 - Fixed types in unit tests.
191 ## [2.3.6] - 2022-10-22
195 - Cleanup pool attributes and methods.
196 - Refine error types thrown.
200 - Fix continuous integration build on windows.
201 - Fix code coverage reporting by using c8 instead of nyc.
203 ## [2.3.5] - 2022-10-21
207 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
208 - Optimize tasks usage lookup implementation.
212 - Fix missed pool event emitter type export.
213 - Fix typedoc documentation generation.
215 ## [2.3.4] - 2022-10-17
219 - Fully automate release process with release-it.
223 - Optimize fair share task scheduling algorithm implementation.
224 - Update benchmarks versus external pools results with latest version.
226 ## [2.3.3] - 2022-10-15
230 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
232 ## [2.3.2] - 2022-10-14
236 - Optimize fair share worker selection strategy implementation.
240 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
242 ## [2.3.1] - 2022-10-13
246 - Pool worker choice strategies:
247 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
248 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
250 ## [2.2.2] - 2022-10-09
254 - Fixed `README.md` file.
256 ## [2.2.1] - 2022-10-08
260 - Dynamic worker choice strategy change at runtime.
262 ## [2.2.0] - 2022-01-05
266 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
268 ## [2.1.0] - 2021-08-29
272 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
276 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
277 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
278 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
279 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
281 ## [2.0.2] - 2021-05-12
285 - Fix `busy` event emission on fixed pool type
287 ## [2.0.1] - 2021-03-16
291 - Check if pool options are properly set.
292 - `busy` event is emitted on all pool types.
294 ## [2.0.0] - 2021-03-01
298 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
302 - `FullPool` event is now renamed to `busy`.
303 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
304 _Find more details on our JSDoc._
306 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
308 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
310 ### Pool options types declaration merge
312 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
314 #### New `export` strategy
318 const DynamicThreadPool = require('poolifier/lib/dynamic')
320 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
323 But you should always prefer just using
326 const { DynamicThreadPool } = require('poolifier')
329 #### New type definitions for input data and response
331 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
332 _This is not a limitation by poolifier but NodeJS._
334 #### Public property replacements
336 `numWorkers` property is now `numberOfWorkers`
338 #### Internal (protected) properties and methods renaming
340 These properties are not intended for end users
342 - `id` => `nextMessageId`
344 These methods are not intended for end users
346 - `_chooseWorker` => `chooseWorker`
347 - `_newWorker` => `createWorker`
348 - `_execute` => `internalExecute`
349 - `_chooseWorker` => `chooseWorker`
350 - `_checkAlive` => `checkAlive`
352 - `_runAsync` => `runAsync`
354 ## [1.1.0] - 2020-05-21
358 - ThreadWorker support async functions as option
359 - Various external library patches
361 ## [1.0.0] - 2020-01-24
365 - FixedThreadPool implementation
366 - DynamicThreadPool implementation
367 - WorkerThread implementation to improve developer experience