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 - Switch internal benchmarking code to benny.
13 - Switch to TypeScript 5.x.x.
14 - Switch rollup bundler plugins to core ones.
15 - Enforce conventional commits.
19 - Fix random integer generator.
20 - Fix worker choice strategy pool type identification at initialization.
22 ## [2.3.7] - 2022-10-23
26 - Switch to open collective FOSS project funding platform.
27 - Switch to ts-standard linter configuration on TypeScript code.
31 - Fixed missing async on pool execute method.
32 - Fixed typing in TypeScript example.
33 - Fixed types in unit tests.
35 ## [2.3.6] - 2022-10-22
39 - Cleanup pool attributes and methods.
40 - Refine error types thrown.
44 - Fix continuous integration build on windows.
45 - Fix code coverage reporting by using c8 instead of nyc.
47 ## [2.3.5] - 2022-10-21
51 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
52 - Optimize tasks usage lookup implementation.
56 - Fix missed pool event emitter type export.
57 - Fix typedoc documentation generation.
59 ## [2.3.4] - 2022-10-17
63 - Fully automate release process with release-it.
67 - Optimize fair share task scheduling algorithm implementation.
68 - Update benchmarks versus external pools results with latest version.
70 ## [2.3.3] - 2022-10-15
74 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
76 ## [2.3.2] - 2022-10-14
80 - Optimize fair share worker selection strategy implementation.
84 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
86 ## [2.3.1] - 2022-10-13
90 - Pool worker choice strategies:
91 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
92 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
94 ## [2.2.2] - 2022-10-09
98 - Fixed `README.md` file.
100 ## [2.2.1] - 2022-10-08
104 - Dynamic worker choice strategy change at runtime.
106 ## [2.2.0] - 2022-01-05
110 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
112 ## [2.1.0] - 2021-08-29
116 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
120 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
121 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
122 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
123 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
125 ## [2.0.2] - 2021-05-12
129 - Fix `busy` event emission on fixed pool type
131 ## [2.0.1] - 2021-03-16
135 - Check if pool options are properly set.
136 - `busy` event is emitted on all pool types.
138 ## [2.0.0] - 2021-03-01
142 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
146 - `FullPool` event is now renamed to `busy`.
147 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
148 _Find more details on our JSDoc._
150 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
152 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
154 ### Pool options types declaration merge
156 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
158 #### New `export` strategy
162 const DynamicThreadPool = require('poolifier/lib/dynamic')
164 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
167 But you should always prefer just using
170 const { DynamicThreadPool } = require('poolifier')
173 #### New type definitions for input data and response
175 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
176 _This is not a limitation by poolifier but NodeJS._
178 #### Public property replacements
180 `numWorkers` property is now `numberOfWorkers`
182 #### Internal (protected) properties and methods renaming
184 These properties are not intended for end users
186 - `id` => `nextMessageId`
188 These methods are not intended for end users
190 - `_chooseWorker` => `chooseWorker`
191 - `_newWorker` => `createWorker`
192 - `_execute` => `internalExecute`
193 - `_chooseWorker` => `chooseWorker`
194 - `_checkAlive` => `checkAlive`
196 - `_runAsync` => `runAsync`
198 ## [1.1.0] - 2020-05-21
202 - ThreadWorker support async functions as option
203 - Various external library patches
205 ## [1.0.0] - 2020-01-24
209 - FixedThreadPool implementation
210 - DynamicThreadPool implementation
211 - WorkerThread implementation to improve developer experience