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 to open collective FOSS project funding platform.
13 - Switch to ts-standard linter configuration on TypeScript code.
17 - Fixed missing async on pool execute method.
18 - Fixed typing in TypeScript example.
19 - Fixed types in unit tests.
21 ## [2.3.6] - 2022-10-22
25 - Cleanup pool attributes and methods.
26 - Refine error types thrown.
30 - Fix continuous integration build on windows.
31 - Fix code coverage reporting by using c8 instead of nyc.
33 ## [2.3.5] - 2022-10-21
37 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
38 - Optimize tasks usage lookup implementation.
42 - Fix missed pool event emitter type export.
43 - Fix typedoc documentation generation.
45 ## [2.3.4] - 2022-10-17
49 - Fully automate release process with release-it.
53 - Optimize fair share task scheduling algorithm implementation.
54 - Update benchmarks versus external pools results with latest version.
56 ## [2.3.3] - 2022-10-15
60 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
62 ## [2.3.2] - 2022-10-14
66 - Optimize fair share worker selection strategy implementation.
70 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
72 ## [2.3.1] - 2022-10-13
76 - Pool worker choice strategies:
77 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
78 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
80 ## [2.2.2] - 2022-10-09
84 - Fixed `README.md` file.
86 ## [2.2.1] - 2022-10-08
90 - Dynamic worker choice strategy change at runtime.
92 ## [2.2.0] - 2022-01-05
96 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
98 ## [2.1.0] - 2021-08-29
102 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
106 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
107 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
108 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
109 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
111 ## [2.0.2] - 2021-05-12
115 - Fix `busy` event emission on fixed pool type
117 ## [2.0.1] - 2021-03-16
121 - Check if pool options are properly set.
122 - `busy` event is emitted on all pool types.
124 ## [2.0.0] - 2021-03-01
128 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
132 - `FullPool` event is now renamed to `busy`.
133 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
134 _Find more details on our JSDoc._
136 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
138 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
140 ### Pool options types declaration merge
142 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
144 #### New `export` strategy
148 const DynamicThreadPool = require('poolifier/lib/dynamic')
150 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
153 But you should always prefer just using
156 const { DynamicThreadPool } = require('poolifier')
159 #### New type definitions for input data and response
161 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
162 _This is not a limitation by poolifier but NodeJS._
164 #### Public property replacements
166 `numWorkers` property is now `numberOfWorkers`
168 #### Internal (protected) properties and methods renaming
170 These properties are not intended for end users
172 - `id` => `nextMessageId`
174 These methods are not intended for end users
176 - `_chooseWorker` => `chooseWorker`
177 - `_newWorker` => `createWorker`
178 - `_execute` => `internalExecute`
179 - `_chooseWorker` => `chooseWorker`
180 - `_checkAlive` => `checkAlive`
182 - `_runAsync` => `runAsync`
184 ## [1.1.0] - 2020-05-21
188 - ThreadWorker support async functions as option
189 - Various external library patches
191 ## [1.0.0] - 2020-01-24
195 - FixedThreadPool implementation
196 - DynamicThreadPool implementation
197 - WorkerThread implementation to improve developer experience