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 - Fix `exports` syntax for ESM and CommonJS.
14 ## [2.3.9] - 2023-03-18
18 - Introduce ESM module support along with CommonJS one.
22 - Fix brown paper bag bug referencing the same object literal.
24 ## [2.3.8] - 2023-03-18
28 - Switch internal benchmarking code to benny.
29 - Switch to TypeScript 5.x.x.
30 - Switch rollup bundler plugins to core ones.
31 - Switch to TSDoc syntax.
32 - Enforce conventional commits.
36 - Fix random integer generator.
37 - Fix worker choice strategy pool type identification at initialization.
39 ## [2.3.7] - 2022-10-23
43 - Switch to open collective FOSS project funding platform.
44 - Switch to ts-standard linter configuration on TypeScript code.
48 - Fixed missing async on pool execute method.
49 - Fixed typing in TypeScript example.
50 - Fixed types in unit tests.
52 ## [2.3.6] - 2022-10-22
56 - Cleanup pool attributes and methods.
57 - Refine error types thrown.
61 - Fix continuous integration build on windows.
62 - Fix code coverage reporting by using c8 instead of nyc.
64 ## [2.3.5] - 2022-10-21
68 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
69 - Optimize tasks usage lookup implementation.
73 - Fix missed pool event emitter type export.
74 - Fix typedoc documentation generation.
76 ## [2.3.4] - 2022-10-17
80 - Fully automate release process with release-it.
84 - Optimize fair share task scheduling algorithm implementation.
85 - Update benchmarks versus external pools results with latest version.
87 ## [2.3.3] - 2022-10-15
91 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
93 ## [2.3.2] - 2022-10-14
97 - Optimize fair share worker selection strategy implementation.
101 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
103 ## [2.3.1] - 2022-10-13
107 - Pool worker choice strategies:
108 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
109 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
111 ## [2.2.2] - 2022-10-09
115 - Fixed `README.md` file.
117 ## [2.2.1] - 2022-10-08
121 - Dynamic worker choice strategy change at runtime.
123 ## [2.2.0] - 2022-01-05
127 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
129 ## [2.1.0] - 2021-08-29
133 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
137 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
138 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
139 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
140 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
142 ## [2.0.2] - 2021-05-12
146 - Fix `busy` event emission on fixed pool type
148 ## [2.0.1] - 2021-03-16
152 - Check if pool options are properly set.
153 - `busy` event is emitted on all pool types.
155 ## [2.0.0] - 2021-03-01
159 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
163 - `FullPool` event is now renamed to `busy`.
164 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
165 _Find more details on our JSDoc._
167 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
169 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
171 ### Pool options types declaration merge
173 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
175 #### New `export` strategy
179 const DynamicThreadPool = require('poolifier/lib/dynamic')
181 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
184 But you should always prefer just using
187 const { DynamicThreadPool } = require('poolifier')
190 #### New type definitions for input data and response
192 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
193 _This is not a limitation by poolifier but NodeJS._
195 #### Public property replacements
197 `numWorkers` property is now `numberOfWorkers`
199 #### Internal (protected) properties and methods renaming
201 These properties are not intended for end users
203 - `id` => `nextMessageId`
205 These methods are not intended for end users
207 - `_chooseWorker` => `chooseWorker`
208 - `_newWorker` => `createWorker`
209 - `_execute` => `internalExecute`
210 - `_chooseWorker` => `chooseWorker`
211 - `_checkAlive` => `checkAlive`
213 - `_runAsync` => `runAsync`
215 ## [1.1.0] - 2020-05-21
219 - ThreadWorker support async functions as option
220 - Various external library patches
222 ## [1.0.0] - 2020-01-24
226 - FixedThreadPool implementation
227 - DynamicThreadPool implementation
228 - WorkerThread implementation to improve developer experience