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 - Optimize worker choice strategy for dynamic pool.
16 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
18 ## [2.4.0] - 2023-04-04
22 - Add `LESS_BUSY` worker choice strategy.
26 - Optimize worker storage in pool.
27 - Optimize worker alive status check.
28 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
29 - Optimize `LESS_USED` worker choice strategy.
30 - Update benchmarks versus external threads pools.
31 - Optimize tasks usage statistics requirements for worker choice strategy.
35 - Ensure trimmable characters are checked at pool initialization.
36 - Fix message id integer overflow.
37 - Fix pool worker removal in worker choice strategy internals.
38 - Fix package publication with pnpm.
40 ## [2.4.0-3] - 2023-04-04
44 - Add `LESS_BUSY` worker choice strategy.
48 - Optimize worker storage in pool.
49 - Optimize worker alive status check.
50 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
51 - Optimize `LESS_USED` worker choice strategy.
52 - Update benchmarks versus external threads pools.
56 - Ensure trimmable characters are checked at pool initialization.
57 - Fix message id integer overflow.
58 - Fix pool worker removal in worker choice strategy internals.
59 - Fix package publication with pnpm.
61 ## [2.4.0-2] - 2023-04-03
65 - Add `LESS_BUSY` worker choice strategy.
69 - Optimize worker storage in pool.
70 - Optimize worker alive status check.
71 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
72 - Optimize `LESS_USED` worker choice strategy.
76 - Ensure trimmable characters are checked at pool initialization.
77 - Fix message id integer overflow.
78 - Fix pool worker removal in worker choice strategy internals.
79 - Fix package publication with pnpm.
81 ## [2.4.0-1] - 2023-04-03
85 - Add `LESS_BUSY` worker choice strategy.
89 - Optimize worker storage in pool.
90 - Optimize worker alive status check.
91 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
92 - Optimize `LESS_USED` worker choice strategy.
96 - Ensure trimmable characters are checked at pool initialization.
97 - Fix message id integer overflow.
98 - Fix pool worker removal in worker choice strategy internals.
100 ## [2.4.0-0] - 2023-04-03
104 - Add `LESS_BUSY` worker choice strategy.
108 - Optimize worker storage in pool.
109 - Optimize worker alive status check.
110 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
111 - Optimize `LESS_USED` worker choice strategy.
115 - Ensure trimmable characters are checked at pool initialization.
116 - Fix message id integer overflow.
117 - Fix pool worker removal in worker choice strategy internals.
119 ## [2.3.10] - 2023-03-18
123 - Fix `exports` syntax for ESM and CommonJS.
127 - Permit SemVer pre-release publication.
129 ## [2.3.10-2] - 2023-03-18
133 - Fix `exports` syntax for ESM and CommonJS.
135 ## [2.3.10-1] - 2023-03-18
139 - Permit SemVer pre-release publication.
141 ## [2.3.10-0] - 2023-03-18
145 - Fix `exports` syntax for ESM and CommonJS.
147 ## [2.3.9] - 2023-03-18
151 - Introduce ESM module support along with CommonJS one.
155 - Fix brown paper bag bug referencing the same object literal.
157 ## [2.3.8] - 2023-03-18
161 - Switch internal benchmarking code to benny.
162 - Switch to TypeScript 5.x.x.
163 - Switch rollup bundler plugins to core ones.
164 - Switch to TSDoc syntax.
165 - Enforce conventional commits.
169 - Fix random integer generator.
170 - Fix worker choice strategy pool type identification at initialization.
172 ## [2.3.7] - 2022-10-23
176 - Switch to open collective FOSS project funding platform.
177 - Switch to ts-standard linter configuration on TypeScript code.
181 - Fixed missing async on pool execute method.
182 - Fixed typing in TypeScript example.
183 - Fixed types in unit tests.
185 ## [2.3.6] - 2022-10-22
189 - Cleanup pool attributes and methods.
190 - Refine error types thrown.
194 - Fix continuous integration build on windows.
195 - Fix code coverage reporting by using c8 instead of nyc.
197 ## [2.3.5] - 2022-10-21
201 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
202 - Optimize tasks usage lookup implementation.
206 - Fix missed pool event emitter type export.
207 - Fix typedoc documentation generation.
209 ## [2.3.4] - 2022-10-17
213 - Fully automate release process with release-it.
217 - Optimize fair share task scheduling algorithm implementation.
218 - Update benchmarks versus external pools results with latest version.
220 ## [2.3.3] - 2022-10-15
224 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
226 ## [2.3.2] - 2022-10-14
230 - Optimize fair share worker selection strategy implementation.
234 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
236 ## [2.3.1] - 2022-10-13
240 - Pool worker choice strategies:
241 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
242 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
244 ## [2.2.2] - 2022-10-09
248 - Fixed `README.md` file.
250 ## [2.2.1] - 2022-10-08
254 - Dynamic worker choice strategy change at runtime.
256 ## [2.2.0] - 2022-01-05
260 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
262 ## [2.1.0] - 2021-08-29
266 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
270 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
271 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
272 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
273 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
275 ## [2.0.2] - 2021-05-12
279 - Fix `busy` event emission on fixed pool type
281 ## [2.0.1] - 2021-03-16
285 - Check if pool options are properly set.
286 - `busy` event is emitted on all pool types.
288 ## [2.0.0] - 2021-03-01
292 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
296 - `FullPool` event is now renamed to `busy`.
297 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
298 _Find more details on our JSDoc._
300 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
302 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
304 ### Pool options types declaration merge
306 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
308 #### New `export` strategy
312 const DynamicThreadPool = require('poolifier/lib/dynamic')
314 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
317 But you should always prefer just using
320 const { DynamicThreadPool } = require('poolifier')
323 #### New type definitions for input data and response
325 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
326 _This is not a limitation by poolifier but NodeJS._
328 #### Public property replacements
330 `numWorkers` property is now `numberOfWorkers`
332 #### Internal (protected) properties and methods renaming
334 These properties are not intended for end users
336 - `id` => `nextMessageId`
338 These methods are not intended for end users
340 - `_chooseWorker` => `chooseWorker`
341 - `_newWorker` => `createWorker`
342 - `_execute` => `internalExecute`
343 - `_chooseWorker` => `chooseWorker`
344 - `_checkAlive` => `checkAlive`
346 - `_runAsync` => `runAsync`
348 ## [1.1.0] - 2020-05-21
352 - ThreadWorker support async functions as option
353 - Various external library patches
355 ## [1.0.0] - 2020-01-24
359 - FixedThreadPool implementation
360 - DynamicThreadPool implementation
361 - WorkerThread implementation to improve developer experience