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.
13 - Keep worker choice strategy in memory for conditional reuse.
17 - Fix possible negative worker key at worker removal in worker choice strategies.
19 ## [2.4.1] - 2023-04-05
23 - Optimize worker choice strategy for dynamic pool.
27 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
29 ## [2.4.0] - 2023-04-04
33 - Add `LESS_BUSY` worker choice strategy.
37 - Optimize worker storage in pool.
38 - Optimize worker alive status check.
39 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
40 - Optimize `LESS_USED` worker choice strategy.
41 - Update benchmarks versus external threads pools.
42 - Optimize tasks usage statistics requirements for worker choice strategy.
46 - Ensure trimmable characters are checked at pool initialization.
47 - Fix message id integer overflow.
48 - Fix pool worker removal in worker choice strategy internals.
49 - Fix package publication with pnpm.
51 ## [2.4.0-3] - 2023-04-04
55 - Add `LESS_BUSY` worker choice strategy.
59 - Optimize worker storage in pool.
60 - Optimize worker alive status check.
61 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
62 - Optimize `LESS_USED` worker choice strategy.
63 - Update benchmarks versus external threads pools.
67 - Ensure trimmable characters are checked at pool initialization.
68 - Fix message id integer overflow.
69 - Fix pool worker removal in worker choice strategy internals.
70 - Fix package publication with pnpm.
72 ## [2.4.0-2] - 2023-04-03
76 - Add `LESS_BUSY` worker choice strategy.
80 - Optimize worker storage in pool.
81 - Optimize worker alive status check.
82 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
83 - Optimize `LESS_USED` worker choice strategy.
87 - Ensure trimmable characters are checked at pool initialization.
88 - Fix message id integer overflow.
89 - Fix pool worker removal in worker choice strategy internals.
90 - Fix package publication with pnpm.
92 ## [2.4.0-1] - 2023-04-03
96 - Add `LESS_BUSY` worker choice strategy.
100 - Optimize worker storage in pool.
101 - Optimize worker alive status check.
102 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
103 - Optimize `LESS_USED` worker choice strategy.
107 - Ensure trimmable characters are checked at pool initialization.
108 - Fix message id integer overflow.
109 - Fix pool worker removal in worker choice strategy internals.
111 ## [2.4.0-0] - 2023-04-03
115 - Add `LESS_BUSY` worker choice strategy.
119 - Optimize worker storage in pool.
120 - Optimize worker alive status check.
121 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
122 - Optimize `LESS_USED` worker choice strategy.
126 - Ensure trimmable characters are checked at pool initialization.
127 - Fix message id integer overflow.
128 - Fix pool worker removal in worker choice strategy internals.
130 ## [2.3.10] - 2023-03-18
134 - Fix `exports` syntax for ESM and CommonJS.
138 - Permit SemVer pre-release publication.
140 ## [2.3.10-2] - 2023-03-18
144 - Fix `exports` syntax for ESM and CommonJS.
146 ## [2.3.10-1] - 2023-03-18
150 - Permit SemVer pre-release publication.
152 ## [2.3.10-0] - 2023-03-18
156 - Fix `exports` syntax for ESM and CommonJS.
158 ## [2.3.9] - 2023-03-18
162 - Introduce ESM module support along with CommonJS one.
166 - Fix brown paper bag bug referencing the same object literal.
168 ## [2.3.8] - 2023-03-18
172 - Switch internal benchmarking code to benny.
173 - Switch to TypeScript 5.x.x.
174 - Switch rollup bundler plugins to core ones.
175 - Switch to TSDoc syntax.
176 - Enforce conventional commits.
180 - Fix random integer generator.
181 - Fix worker choice strategy pool type identification at initialization.
183 ## [2.3.7] - 2022-10-23
187 - Switch to open collective FOSS project funding platform.
188 - Switch to ts-standard linter configuration on TypeScript code.
192 - Fixed missing async on pool execute method.
193 - Fixed typing in TypeScript example.
194 - Fixed types in unit tests.
196 ## [2.3.6] - 2022-10-22
200 - Cleanup pool attributes and methods.
201 - Refine error types thrown.
205 - Fix continuous integration build on windows.
206 - Fix code coverage reporting by using c8 instead of nyc.
208 ## [2.3.5] - 2022-10-21
212 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
213 - Optimize tasks usage lookup implementation.
217 - Fix missed pool event emitter type export.
218 - Fix typedoc documentation generation.
220 ## [2.3.4] - 2022-10-17
224 - Fully automate release process with release-it.
228 - Optimize fair share task scheduling algorithm implementation.
229 - Update benchmarks versus external pools results with latest version.
231 ## [2.3.3] - 2022-10-15
235 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
237 ## [2.3.2] - 2022-10-14
241 - Optimize fair share worker selection strategy implementation.
245 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
247 ## [2.3.1] - 2022-10-13
251 - Pool worker choice strategies:
252 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
253 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
255 ## [2.2.2] - 2022-10-09
259 - Fixed `README.md` file.
261 ## [2.2.1] - 2022-10-08
265 - Dynamic worker choice strategy change at runtime.
267 ## [2.2.0] - 2022-01-05
271 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
273 ## [2.1.0] - 2021-08-29
277 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
281 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
282 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
283 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
284 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
286 ## [2.0.2] - 2021-05-12
290 - Fix `busy` event emission on fixed pool type
292 ## [2.0.1] - 2021-03-16
296 - Check if pool options are properly set.
297 - `busy` event is emitted on all pool types.
299 ## [2.0.0] - 2021-03-01
303 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
307 - `FullPool` event is now renamed to `busy`.
308 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
309 _Find more details on our JSDoc._
311 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
313 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
315 ### Pool options types declaration merge
317 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
319 #### New `export` strategy
323 const DynamicThreadPool = require('poolifier/lib/dynamic')
325 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
328 But you should always prefer just using
331 const { DynamicThreadPool } = require('poolifier')
334 #### New type definitions for input data and response
336 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
337 _This is not a limitation by poolifier but NodeJS._
339 #### Public property replacements
341 `numWorkers` property is now `numberOfWorkers`
343 #### Internal (protected) properties and methods renaming
345 These properties are not intended for end users
347 - `id` => `nextMessageId`
349 These methods are not intended for end users
351 - `_chooseWorker` => `chooseWorker`
352 - `_newWorker` => `createWorker`
353 - `_execute` => `internalExecute`
354 - `_chooseWorker` => `chooseWorker`
355 - `_checkAlive` => `checkAlive`
357 - `_runAsync` => `runAsync`
359 ## [1.1.0] - 2020-05-21
363 - ThreadWorker support async functions as option
364 - Various external library patches
366 ## [1.0.0] - 2020-01-24
370 - FixedThreadPool implementation
371 - DynamicThreadPool implementation
372 - WorkerThread implementation to improve developer experience