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.
27 ## [2.4.0-0] - 2023-04-03
31 - Add `LESS_BUSY` worker choice strategy.
35 - Optimize worker storage in pool.
36 - Optimize worker alive status check.
37 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
38 - Optimize `LESS_USED` worker choice strategy.
42 - Ensure trimmable characters are checked at pool initialization.
43 - Fix message id integer overflow.
44 - Fix pool worker removal in worker choice strategy internals.
46 ## [2.3.10] - 2023-03-18
50 - Fix `exports` syntax for ESM and CommonJS.
54 - Permit SemVer pre-release publication.
56 ## [2.3.10-2] - 2023-03-18
60 - Fix `exports` syntax for ESM and CommonJS.
62 ## [2.3.10-1] - 2023-03-18
66 - Permit SemVer pre-release publication.
68 ## [2.3.10-0] - 2023-03-18
72 - Fix `exports` syntax for ESM and CommonJS.
74 ## [2.3.9] - 2023-03-18
78 - Introduce ESM module support along with CommonJS one.
82 - Fix brown paper bag bug referencing the same object literal.
84 ## [2.3.8] - 2023-03-18
88 - Switch internal benchmarking code to benny.
89 - Switch to TypeScript 5.x.x.
90 - Switch rollup bundler plugins to core ones.
91 - Switch to TSDoc syntax.
92 - Enforce conventional commits.
96 - Fix random integer generator.
97 - Fix worker choice strategy pool type identification at initialization.
99 ## [2.3.7] - 2022-10-23
103 - Switch to open collective FOSS project funding platform.
104 - Switch to ts-standard linter configuration on TypeScript code.
108 - Fixed missing async on pool execute method.
109 - Fixed typing in TypeScript example.
110 - Fixed types in unit tests.
112 ## [2.3.6] - 2022-10-22
116 - Cleanup pool attributes and methods.
117 - Refine error types thrown.
121 - Fix continuous integration build on windows.
122 - Fix code coverage reporting by using c8 instead of nyc.
124 ## [2.3.5] - 2022-10-21
128 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
129 - Optimize tasks usage lookup implementation.
133 - Fix missed pool event emitter type export.
134 - Fix typedoc documentation generation.
136 ## [2.3.4] - 2022-10-17
140 - Fully automate release process with release-it.
144 - Optimize fair share task scheduling algorithm implementation.
145 - Update benchmarks versus external pools results with latest version.
147 ## [2.3.3] - 2022-10-15
151 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
153 ## [2.3.2] - 2022-10-14
157 - Optimize fair share worker selection strategy implementation.
161 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
163 ## [2.3.1] - 2022-10-13
167 - Pool worker choice strategies:
168 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
169 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
171 ## [2.2.2] - 2022-10-09
175 - Fixed `README.md` file.
177 ## [2.2.1] - 2022-10-08
181 - Dynamic worker choice strategy change at runtime.
183 ## [2.2.0] - 2022-01-05
187 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
189 ## [2.1.0] - 2021-08-29
193 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
197 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
198 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
199 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
200 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
202 ## [2.0.2] - 2021-05-12
206 - Fix `busy` event emission on fixed pool type
208 ## [2.0.1] - 2021-03-16
212 - Check if pool options are properly set.
213 - `busy` event is emitted on all pool types.
215 ## [2.0.0] - 2021-03-01
219 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
223 - `FullPool` event is now renamed to `busy`.
224 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
225 _Find more details on our JSDoc._
227 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
229 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
231 ### Pool options types declaration merge
233 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
235 #### New `export` strategy
239 const DynamicThreadPool = require('poolifier/lib/dynamic')
241 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
244 But you should always prefer just using
247 const { DynamicThreadPool } = require('poolifier')
250 #### New type definitions for input data and response
252 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
253 _This is not a limitation by poolifier but NodeJS._
255 #### Public property replacements
257 `numWorkers` property is now `numberOfWorkers`
259 #### Internal (protected) properties and methods renaming
261 These properties are not intended for end users
263 - `id` => `nextMessageId`
265 These methods are not intended for end users
267 - `_chooseWorker` => `chooseWorker`
268 - `_newWorker` => `createWorker`
269 - `_execute` => `internalExecute`
270 - `_chooseWorker` => `chooseWorker`
271 - `_checkAlive` => `checkAlive`
273 - `_runAsync` => `runAsync`
275 ## [1.1.0] - 2020-05-21
279 - ThreadWorker support async functions as option
280 - Various external library patches
282 ## [1.0.0] - 2020-01-24
286 - FixedThreadPool implementation
287 - DynamicThreadPool implementation
288 - WorkerThread implementation to improve developer experience