Commit | Line | Data |
---|---|---|
522eea03 | 1 | # Changelog |
2 | ||
3 | All notable changes to this project will be documented in this file. | |
4 | ||
d4abc60a | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), |
522eea03 | 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
7 | ||
45a5a54c JB |
8 | ## [Unreleased] |
9 | ||
5b301c28 JB |
10 | ### Added |
11 | ||
12 | - Add `LESS_BUSY` worker choice strategy. | |
13 | ||
14 | ### Changed | |
15 | ||
16 | - Optimize worker storage in pool. | |
17 | - Optimize worker alive status check. | |
18 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
19 | - Optimize `LESS_USED` worker choice strategy. | |
20 | ||
21 | ### Fixed | |
22 | ||
23 | - Ensure trimmable characters are checked at pool initialization. | |
24 | - Fix message id integer overflow. | |
25 | - Fix pool worker removal in worker choice strategy internals. | |
26 | ||
2fb9ca9c JB |
27 | ## [2.4.0-0] - 2023-04-03 |
28 | ||
168c526f JB |
29 | ### Added |
30 | ||
31 | - Add `LESS_BUSY` worker choice strategy. | |
32 | ||
1d71a908 JB |
33 | ### Changed |
34 | ||
ffcbbad8 | 35 | - Optimize worker storage in pool. |
1d71a908 | 36 | - Optimize worker alive status check. |
65a60b3b | 37 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 38 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 39 | |
ffcbbad8 JB |
40 | ### Fixed |
41 | ||
42 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 43 | - Fix message id integer overflow. |
97a2abc3 | 44 | - Fix pool worker removal in worker choice strategy internals. |
ffcbbad8 | 45 | |
08372738 JB |
46 | ## [2.3.10] - 2023-03-18 |
47 | ||
710826bc JB |
48 | ### Fixed |
49 | ||
50 | - Fix `exports` syntax for ESM and CommonJS. | |
51 | ||
52 | ### Changed | |
53 | ||
54 | - Permit SemVer pre-release publication. | |
76e5ac6f | 55 | |
e4796ecd JB |
56 | ## [2.3.10-2] - 2023-03-18 |
57 | ||
6abad580 JB |
58 | ### Fixed |
59 | ||
60 | - Fix `exports` syntax for ESM and CommonJS. | |
61 | ||
a2ee98cc JB |
62 | ## [2.3.10-1] - 2023-03-18 |
63 | ||
7e060cee JB |
64 | ### Changed |
65 | ||
90483887 | 66 | - Permit SemVer pre-release publication. |
7e060cee | 67 | |
c81bfafb JB |
68 | ## [2.3.10-0] - 2023-03-18 |
69 | ||
fe18768d JB |
70 | ### Fixed |
71 | ||
72 | - Fix `exports` syntax for ESM and CommonJS. | |
73 | ||
d7b78217 JB |
74 | ## [2.3.9] - 2023-03-18 |
75 | ||
ed6dd37f JB |
76 | ### Changed |
77 | ||
78 | - Introduce ESM module support along with CommonJS one. | |
79 | ||
80 | ### Fixed | |
81 | ||
82 | - Fix brown paper bag bug referencing the same object literal. | |
83 | ||
68e2ad86 JB |
84 | ## [2.3.8] - 2023-03-18 |
85 | ||
ca6c7d70 JB |
86 | ### Changed |
87 | ||
88 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
89 | - Switch to TypeScript 5.x.x. |
90 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 91 | - Switch to TSDoc syntax. |
fbdedeb9 | 92 | - Enforce conventional commits. |
ca6c7d70 | 93 | |
d15211d4 JB |
94 | ### Fixed |
95 | ||
96 | - Fix random integer generator. | |
fbdedeb9 | 97 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 98 | |
995705ea JB |
99 | ## [2.3.7] - 2022-10-23 |
100 | ||
b953022b JB |
101 | ### Changed |
102 | ||
103 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
104 | - Switch to ts-standard linter configuration on TypeScript code. |
105 | ||
106 | ### Fixed | |
107 | ||
108 | - Fixed missing async on pool execute method. | |
109 | - Fixed typing in TypeScript example. | |
110 | - Fixed types in unit tests. | |
b953022b | 111 | |
3b9f6953 JB |
112 | ## [2.3.6] - 2022-10-22 |
113 | ||
f80cead4 JB |
114 | ### Changed |
115 | ||
116 | - Cleanup pool attributes and methods. | |
117 | - Refine error types thrown. | |
118 | ||
119 | ### Fixed | |
120 | ||
121 | - Fix continuous integration build on windows. | |
122 | - Fix code coverage reporting by using c8 instead of nyc. | |
123 | ||
efc22107 JB |
124 | ## [2.3.5] - 2022-10-21 |
125 | ||
7a6a0a96 JB |
126 | ### Changed |
127 | ||
a05c10de JB |
128 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
129 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 130 | |
b4904890 JB |
131 | ### Fixed |
132 | ||
133 | - Fix missed pool event emitter type export. | |
134 | - Fix typedoc documentation generation. | |
135 | ||
a875f8d1 JB |
136 | ## [2.3.4] - 2022-10-17 |
137 | ||
73cda448 JB |
138 | ### Added |
139 | ||
140 | - Fully automate release process with release-it. | |
141 | ||
45a5a54c JB |
142 | ### Changed |
143 | ||
73cda448 | 144 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 145 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 146 | |
90ee1b18 | 147 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
148 | |
149 | ### Added | |
150 | ||
151 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
152 | ||
90ee1b18 | 153 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
154 | |
155 | ### Changed | |
156 | ||
157 | - Optimize fair share worker selection strategy implementation. | |
158 | ||
159 | ### Fixed | |
160 | ||
161 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
162 | ||
90ee1b18 | 163 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
164 | |
165 | ### Added | |
166 | ||
167 | - Pool worker choice strategies: | |
168 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
169 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
170 | ||
90ee1b18 | 171 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
172 | |
173 | ### Fixed | |
174 | ||
175 | - Fixed `README.md` file. | |
176 | ||
90ee1b18 | 177 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 178 | |
bdaf31cd JB |
179 | ### Added |
180 | ||
181 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 182 | |
90ee1b18 | 183 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
184 | |
185 | ### Breaking Changes | |
186 | ||
187 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
188 | ||
90ee1b18 | 189 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
190 | |
191 | ### Added | |
192 | ||
193 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
194 | |
195 | ### Breaking Changes | |
196 | ||
197 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
198 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
199 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 200 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 201 | |
90ee1b18 | 202 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
203 | |
204 | ### Bug fixes | |
205 | ||
206 | - Fix `busy` event emission on fixed pool type | |
207 | ||
90ee1b18 | 208 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
209 | |
210 | ### Bug fixes | |
211 | ||
212 | - Check if pool options are properly set. | |
213 | - `busy` event is emitted on all pool types. | |
214 | ||
90ee1b18 | 215 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 216 | |
f3f833ab | 217 | ### Bug fixes |
d63d3be3 | 218 | |
ddbeaffd | 219 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 220 | |
fa0f5b28 S |
221 | ### Breaking Changes |
222 | ||
7f685093 | 223 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 224 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 225 | _Find more details on our JSDoc._ |
ddbeaffd | 226 | |
1927ee67 APA |
227 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
228 | ||
ddbeaffd | 229 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 230 | |
ec2ccfc8 JB |
231 | ### Pool options types declaration merge |
232 | ||
233 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
234 | ||
fa0f5b28 S |
235 | #### New `export` strategy |
236 | ||
237 | ```js | |
238 | // Before | |
777b7824 | 239 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 240 | // After |
777b7824 | 241 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
242 | ``` |
243 | ||
244 | But you should always prefer just using | |
245 | ||
246 | ```js | |
777b7824 | 247 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
248 | ``` |
249 | ||
d3c8a1a8 S |
250 | #### New type definitions for input data and response |
251 | ||
ec2ccfc8 | 252 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
253 | _This is not a limitation by poolifier but NodeJS._ |
254 | ||
3a4b605f | 255 | #### Public property replacements |
5c5a1fb7 | 256 | |
3a4b605f | 257 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 258 | |
280c2a77 | 259 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 260 | |
280c2a77 S |
261 | These properties are not intended for end users |
262 | ||
263 | - `id` => `nextMessageId` | |
264 | ||
265 | These methods are not intended for end users | |
fa0f5b28 S |
266 | |
267 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 268 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
269 | - `_execute` => `internalExecute` |
270 | - `_chooseWorker` => `chooseWorker` | |
271 | - `_checkAlive` => `checkAlive` | |
272 | - `_run` => `run` | |
273 | - `_runAsync` => `runAsync` | |
274 | ||
90ee1b18 | 275 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
276 | |
277 | ### Added | |
278 | ||
279 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 280 | - Various external library patches |
0312f71a | 281 | |
90ee1b18 | 282 | ## [1.0.0] - 2020-01-24 |
522eea03 | 283 | |
284 | ### Added | |
285 | ||
286 | - FixedThreadPool implementation | |
287 | - DynamicThreadPool implementation | |
0312f71a | 288 | - WorkerThread implementation to improve developer experience |