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