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 - Optimize worker storage in pool.
13 - Optimize worker alive status check.
17 - Ensure trimmable characters are checked at pool initialization.
19 ## [2.3.10] - 2023-03-18
23 - Fix `exports` syntax for ESM and CommonJS.
27 - Permit SemVer pre-release publication.
29 ## [2.3.10-2] - 2023-03-18
33 - Fix `exports` syntax for ESM and CommonJS.
35 ## [2.3.10-1] - 2023-03-18
39 - Permit SemVer pre-release publication.
41 ## [2.3.10-0] - 2023-03-18
45 - Fix `exports` syntax for ESM and CommonJS.
47 ## [2.3.9] - 2023-03-18
51 - Introduce ESM module support along with CommonJS one.
55 - Fix brown paper bag bug referencing the same object literal.
57 ## [2.3.8] - 2023-03-18
61 - Switch internal benchmarking code to benny.
62 - Switch to TypeScript 5.x.x.
63 - Switch rollup bundler plugins to core ones.
64 - Switch to TSDoc syntax.
65 - Enforce conventional commits.
69 - Fix random integer generator.
70 - Fix worker choice strategy pool type identification at initialization.
72 ## [2.3.7] - 2022-10-23
76 - Switch to open collective FOSS project funding platform.
77 - Switch to ts-standard linter configuration on TypeScript code.
81 - Fixed missing async on pool execute method.
82 - Fixed typing in TypeScript example.
83 - Fixed types in unit tests.
85 ## [2.3.6] - 2022-10-22
89 - Cleanup pool attributes and methods.
90 - Refine error types thrown.
94 - Fix continuous integration build on windows.
95 - Fix code coverage reporting by using c8 instead of nyc.
97 ## [2.3.5] - 2022-10-21
101 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
102 - Optimize tasks usage lookup implementation.
106 - Fix missed pool event emitter type export.
107 - Fix typedoc documentation generation.
109 ## [2.3.4] - 2022-10-17
113 - Fully automate release process with release-it.
117 - Optimize fair share task scheduling algorithm implementation.
118 - Update benchmarks versus external pools results with latest version.
120 ## [2.3.3] - 2022-10-15
124 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
126 ## [2.3.2] - 2022-10-14
130 - Optimize fair share worker selection strategy implementation.
134 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
136 ## [2.3.1] - 2022-10-13
140 - Pool worker choice strategies:
141 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
142 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
144 ## [2.2.2] - 2022-10-09
148 - Fixed `README.md` file.
150 ## [2.2.1] - 2022-10-08
154 - Dynamic worker choice strategy change at runtime.
156 ## [2.2.0] - 2022-01-05
160 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
162 ## [2.1.0] - 2021-08-29
166 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
170 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
171 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
172 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
173 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
175 ## [2.0.2] - 2021-05-12
179 - Fix `busy` event emission on fixed pool type
181 ## [2.0.1] - 2021-03-16
185 - Check if pool options are properly set.
186 - `busy` event is emitted on all pool types.
188 ## [2.0.0] - 2021-03-01
192 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
196 - `FullPool` event is now renamed to `busy`.
197 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
198 _Find more details on our JSDoc._
200 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
202 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
204 ### Pool options types declaration merge
206 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
208 #### New `export` strategy
212 const DynamicThreadPool = require('poolifier/lib/dynamic')
214 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
217 But you should always prefer just using
220 const { DynamicThreadPool } = require('poolifier')
223 #### New type definitions for input data and response
225 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
226 _This is not a limitation by poolifier but NodeJS._
228 #### Public property replacements
230 `numWorkers` property is now `numberOfWorkers`
232 #### Internal (protected) properties and methods renaming
234 These properties are not intended for end users
236 - `id` => `nextMessageId`
238 These methods are not intended for end users
240 - `_chooseWorker` => `chooseWorker`
241 - `_newWorker` => `createWorker`
242 - `_execute` => `internalExecute`
243 - `_chooseWorker` => `chooseWorker`
244 - `_checkAlive` => `checkAlive`
246 - `_runAsync` => `runAsync`
248 ## [1.1.0] - 2020-05-21
252 - ThreadWorker support async functions as option
253 - Various external library patches
255 ## [1.0.0] - 2020-01-24
259 - FixedThreadPool implementation
260 - DynamicThreadPool implementation
261 - WorkerThread implementation to improve developer experience