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.0.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.
26 ## [2.3.10] - 2023-03-18
30 - Fix `exports` syntax for ESM and CommonJS.
34 - Permit SemVer pre-release publication.
36 ## [2.3.10-2] - 2023-03-18
40 - Fix `exports` syntax for ESM and CommonJS.
42 ## [2.3.10-1] - 2023-03-18
46 - Permit SemVer pre-release publication.
48 ## [2.3.10-0] - 2023-03-18
52 - Fix `exports` syntax for ESM and CommonJS.
54 ## [2.3.9] - 2023-03-18
58 - Introduce ESM module support along with CommonJS one.
62 - Fix brown paper bag bug referencing the same object literal.
64 ## [2.3.8] - 2023-03-18
68 - Switch internal benchmarking code to benny.
69 - Switch to TypeScript 5.x.x.
70 - Switch rollup bundler plugins to core ones.
71 - Switch to TSDoc syntax.
72 - Enforce conventional commits.
76 - Fix random integer generator.
77 - Fix worker choice strategy pool type identification at initialization.
79 ## [2.3.7] - 2022-10-23
83 - Switch to open collective FOSS project funding platform.
84 - Switch to ts-standard linter configuration on TypeScript code.
88 - Fixed missing async on pool execute method.
89 - Fixed typing in TypeScript example.
90 - Fixed types in unit tests.
92 ## [2.3.6] - 2022-10-22
96 - Cleanup pool attributes and methods.
97 - Refine error types thrown.
101 - Fix continuous integration build on windows.
102 - Fix code coverage reporting by using c8 instead of nyc.
104 ## [2.3.5] - 2022-10-21
108 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
109 - Optimize tasks usage lookup implementation.
113 - Fix missed pool event emitter type export.
114 - Fix typedoc documentation generation.
116 ## [2.3.4] - 2022-10-17
120 - Fully automate release process with release-it.
124 - Optimize fair share task scheduling algorithm implementation.
125 - Update benchmarks versus external pools results with latest version.
127 ## [2.3.3] - 2022-10-15
131 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
133 ## [2.3.2] - 2022-10-14
137 - Optimize fair share worker selection strategy implementation.
141 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
143 ## [2.3.1] - 2022-10-13
147 - Pool worker choice strategies:
148 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
149 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
151 ## [2.2.2] - 2022-10-09
155 - Fixed `README.md` file.
157 ## [2.2.1] - 2022-10-08
161 - Dynamic worker choice strategy change at runtime.
163 ## [2.2.0] - 2022-01-05
167 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
169 ## [2.1.0] - 2021-08-29
173 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
177 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
178 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
179 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
180 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
182 ## [2.0.2] - 2021-05-12
186 - Fix `busy` event emission on fixed pool type
188 ## [2.0.1] - 2021-03-16
192 - Check if pool options are properly set.
193 - `busy` event is emitted on all pool types.
195 ## [2.0.0] - 2021-03-01
199 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
203 - `FullPool` event is now renamed to `busy`.
204 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
205 _Find more details on our JSDoc._
207 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
209 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
211 ### Pool options types declaration merge
213 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
215 #### New `export` strategy
219 const DynamicThreadPool = require('poolifier/lib/dynamic')
221 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
224 But you should always prefer just using
227 const { DynamicThreadPool } = require('poolifier')
230 #### New type definitions for input data and response
232 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
233 _This is not a limitation by poolifier but NodeJS._
235 #### Public property replacements
237 `numWorkers` property is now `numberOfWorkers`
239 #### Internal (protected) properties and methods renaming
241 These properties are not intended for end users
243 - `id` => `nextMessageId`
245 These methods are not intended for end users
247 - `_chooseWorker` => `chooseWorker`
248 - `_newWorker` => `createWorker`
249 - `_execute` => `internalExecute`
250 - `_chooseWorker` => `chooseWorker`
251 - `_checkAlive` => `checkAlive`
253 - `_runAsync` => `runAsync`
255 ## [1.1.0] - 2020-05-21
259 - ThreadWorker support async functions as option
260 - Various external library patches
262 ## [1.0.0] - 2020-01-24
266 - FixedThreadPool implementation
267 - DynamicThreadPool implementation
268 - WorkerThread implementation to improve developer experience