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.
16 - Permit SemVer pre-release publication.
20 - Fix `exports` syntax for ESM and CommonJS.
22 ## [2.3.10-1] - 2023-03-18
26 - Permit SemVer pre-release publication.
28 ## [2.3.10-0] - 2023-03-18
32 - Fix `exports` syntax for ESM and CommonJS.
34 ## [2.3.9] - 2023-03-18
38 - Introduce ESM module support along with CommonJS one.
42 - Fix brown paper bag bug referencing the same object literal.
44 ## [2.3.8] - 2023-03-18
48 - Switch internal benchmarking code to benny.
49 - Switch to TypeScript 5.x.x.
50 - Switch rollup bundler plugins to core ones.
51 - Switch to TSDoc syntax.
52 - Enforce conventional commits.
56 - Fix random integer generator.
57 - Fix worker choice strategy pool type identification at initialization.
59 ## [2.3.7] - 2022-10-23
63 - Switch to open collective FOSS project funding platform.
64 - Switch to ts-standard linter configuration on TypeScript code.
68 - Fixed missing async on pool execute method.
69 - Fixed typing in TypeScript example.
70 - Fixed types in unit tests.
72 ## [2.3.6] - 2022-10-22
76 - Cleanup pool attributes and methods.
77 - Refine error types thrown.
81 - Fix continuous integration build on windows.
82 - Fix code coverage reporting by using c8 instead of nyc.
84 ## [2.3.5] - 2022-10-21
88 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
89 - Optimize tasks usage lookup implementation.
93 - Fix missed pool event emitter type export.
94 - Fix typedoc documentation generation.
96 ## [2.3.4] - 2022-10-17
100 - Fully automate release process with release-it.
104 - Optimize fair share task scheduling algorithm implementation.
105 - Update benchmarks versus external pools results with latest version.
107 ## [2.3.3] - 2022-10-15
111 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
113 ## [2.3.2] - 2022-10-14
117 - Optimize fair share worker selection strategy implementation.
121 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
123 ## [2.3.1] - 2022-10-13
127 - Pool worker choice strategies:
128 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
129 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
131 ## [2.2.2] - 2022-10-09
135 - Fixed `README.md` file.
137 ## [2.2.1] - 2022-10-08
141 - Dynamic worker choice strategy change at runtime.
143 ## [2.2.0] - 2022-01-05
147 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
149 ## [2.1.0] - 2021-08-29
153 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
157 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
158 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
159 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
160 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
162 ## [2.0.2] - 2021-05-12
166 - Fix `busy` event emission on fixed pool type
168 ## [2.0.1] - 2021-03-16
172 - Check if pool options are properly set.
173 - `busy` event is emitted on all pool types.
175 ## [2.0.0] - 2021-03-01
179 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
183 - `FullPool` event is now renamed to `busy`.
184 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
185 _Find more details on our JSDoc._
187 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
189 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
191 ### Pool options types declaration merge
193 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
195 #### New `export` strategy
199 const DynamicThreadPool = require('poolifier/lib/dynamic')
201 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
204 But you should always prefer just using
207 const { DynamicThreadPool } = require('poolifier')
210 #### New type definitions for input data and response
212 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
213 _This is not a limitation by poolifier but NodeJS._
215 #### Public property replacements
217 `numWorkers` property is now `numberOfWorkers`
219 #### Internal (protected) properties and methods renaming
221 These properties are not intended for end users
223 - `id` => `nextMessageId`
225 These methods are not intended for end users
227 - `_chooseWorker` => `chooseWorker`
228 - `_newWorker` => `createWorker`
229 - `_execute` => `internalExecute`
230 - `_chooseWorker` => `chooseWorker`
231 - `_checkAlive` => `checkAlive`
233 - `_runAsync` => `runAsync`
235 ## [1.1.0] - 2020-05-21
239 - ThreadWorker support async functions as option
240 - Various external library patches
242 ## [1.0.0] - 2020-01-24
246 - FixedThreadPool implementation
247 - DynamicThreadPool implementation
248 - WorkerThread implementation to improve developer experience