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 | ||
89a4abfd JB |
10 | ### Changed |
11 | ||
12 | - Refine pool information content. | |
13 | ||
8a9febf5 JB |
14 | ## [2.5.2] - 2023-06-02 |
15 | ||
91ee39ed JB |
16 | ### Added |
17 | ||
18 | - Add `taskError` pool event for task execution error. | |
6b27d407 | 19 | - Add pool information `info` property to pool. |
91ee39ed JB |
20 | - Emit pool information on `busy` and `full` pool events. |
21 | ||
8babb151 JB |
22 | ## [2.5.1] - 2023-06-01 |
23 | ||
0e05c4dc JB |
24 | ### Added |
25 | ||
1f68cede | 26 | - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`. |
91ee39ed | 27 | - Add `error` pool event for uncaught worker error. |
0e05c4dc | 28 | |
a8766181 JB |
29 | ## [2.5.0] - 2023-05-31 |
30 | ||
e4543b14 JB |
31 | ### Added |
32 | ||
33 | - Switch pool event emitter to `EventEmitterAsyncResource`. | |
6da80d38 | 34 | - Add tasks wait time accounting in per worker tasks usage. |
71002f09 | 35 | - Add interleaved weighted round robin worker choice strategy (experimental). |
e4543b14 JB |
36 | |
37 | ### Changed | |
38 | ||
39 | - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`. | |
40 | ||
570efb11 JB |
41 | ## [2.4.14] - 2023-05-09 |
42 | ||
b0f28bad JB |
43 | ### Fixed |
44 | ||
45 | - Ensure no undefined task runtime can land in the tasks history. | |
46 | - Fix median computation implementation once again. | |
47 | ||
110b6d13 JB |
48 | ### Added |
49 | ||
50 | - Unit tests for median and queue implementations. | |
51 | ||
72584880 JB |
52 | ## [2.4.13] - 2023-05-08 |
53 | ||
b0d6ed8f JB |
54 | ### Fixed |
55 | ||
e3058615 | 56 | - Fix worker choice strategy options validation. |
b0d6ed8f JB |
57 | - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission. |
58 | ||
06140c32 JB |
59 | ## [2.4.12] - 2023-05-06 |
60 | ||
a86b6df1 JB |
61 | ### Added |
62 | ||
63 | - Support multiple task functions per worker. | |
08f3f44c | 64 | - Add custom worker weights support to worker choice strategies options. |
a86b6df1 | 65 | |
29ee7e9a JB |
66 | ### Changed |
67 | ||
68 | - Use O(1) queue implementation for tasks queueing. | |
69 | ||
0682ba15 JB |
70 | ### Fixed |
71 | ||
72 | - Fix median computation implementation. | |
73 | - Fix fair share worker choice strategy internals update. | |
74 | ||
936d53ec JB |
75 | ## [2.4.11] - 2023-04-23 |
76 | ||
cb70b19d JB |
77 | ### Changed |
78 | ||
79 | - Optimize free worker finding in worker choice strategies. | |
80 | ||
15bb637a JB |
81 | ## [2.4.10] - 2023-04-15 |
82 | ||
ef41a6e6 JB |
83 | ### Fixed |
84 | ||
85 | - Fix typescript type definition for worker function: ensure the input data is optional. | |
86 | - Fix typescript type definition for pool execute(): ensure the input data is optional. | |
87 | ||
181eb2b4 JB |
88 | ## [2.4.9] - 2023-04-15 |
89 | ||
a20f0ba5 JB |
90 | ### Added |
91 | ||
92 | - Add tasks queue enablement runtime setter to pool. | |
93 | - Add tasks queue options runtime setter to pool. | |
94 | - Add worker choice strategy options runtime setter to pool. | |
95 | ||
96 | ### Changed | |
97 | ||
98 | - Remove the tasks queuing experimental status. | |
99 | ||
d4aeae5a JB |
100 | ### Fixed |
101 | ||
102 | - Fix worker function type definition and validation. | |
2fc5cae3 | 103 | - Fix worker choice strategy options handling. |
d4aeae5a | 104 | |
1d9e7023 JB |
105 | ## [2.4.8] - 2023-04-12 |
106 | ||
f9b4bbf8 JB |
107 | ### Fixed |
108 | ||
109 | - Fix message between main worker and worker type definition for tasks. | |
110 | - Fix code documentation. | |
111 | ||
12ae3210 JB |
112 | ## [2.4.7] - 2023-04-11 |
113 | ||
7171d33f JB |
114 | ### Added |
115 | ||
116 | - Add worker tasks queue options to pool options. | |
117 | ||
e8bd29ce JB |
118 | ### Fixed |
119 | ||
120 | - Fix missing documentation. | |
121 | ||
42c7bc10 JB |
122 | ## [2.4.6] - 2023-04-10 |
123 | ||
681196cc JB |
124 | ### Fixed |
125 | ||
126 | - Ensure one task at a time is executed per worker with tasks queueing enabled. | |
76545787 | 127 | - Properly count worker running tasks with tasks queueing enabled. |
681196cc | 128 | |
54d360e3 JB |
129 | ## [2.4.5] - 2023-04-09 |
130 | ||
3fafb1b2 JB |
131 | ### Added |
132 | ||
9e775f96 JB |
133 | - Use monotonic high resolution timer for worker tasks runtime. |
134 | - Add worker tasks median runtime to statistics. | |
ff733df7 | 135 | - Add worker tasks queue (experimental). |
3fafb1b2 | 136 | |
92fa3eb6 JB |
137 | ## [2.4.4] - 2023-04-07 |
138 | ||
aee46736 JB |
139 | ### Added |
140 | ||
141 | - Add `PoolEvents` enumeration and `PoolEvent` type. | |
142 | ||
36b5e78f JB |
143 | ### Fixed |
144 | ||
ff0c2b3e | 145 | - Destroy worker only on alive check. |
36b5e78f | 146 | |
9fb0f324 JB |
147 | ## [2.4.3] - 2023-04-07 |
148 | ||
28cf3617 JB |
149 | ### Fixed |
150 | ||
151 | - Fix typedoc generation with inheritance. | |
152 | ||
848f0f27 JB |
153 | ## [2.4.2] - 2023-04-06 |
154 | ||
164d950a JB |
155 | ### Added |
156 | ||
157 | - Add `full` event to dynamic pool. | |
32417142 | 158 | - Keep worker choice strategy in memory for conditional reuse. |
164d950a | 159 | |
78ab2555 JB |
160 | ### Fixed |
161 | ||
162 | - Fix possible negative worker key at worker removal in worker choice strategies. | |
163 | ||
79aafe9f JB |
164 | ## [2.4.1] - 2023-04-05 |
165 | ||
9cd39dd4 JB |
166 | ### Changed |
167 | ||
168 | - Optimize worker choice strategy for dynamic pool. | |
169 | ||
965415bb JB |
170 | ### Fixed |
171 | ||
172 | - Ensure dynamic pool does not alter worker choice strategy expected behavior. | |
173 | ||
d8b60b1c JB |
174 | ## [2.4.0] - 2023-04-04 |
175 | ||
c6bd2650 JB |
176 | ### Added |
177 | ||
178 | - Add `LESS_BUSY` worker choice strategy. | |
179 | ||
180 | ### Changed | |
181 | ||
182 | - Optimize worker storage in pool. | |
183 | - Optimize worker alive status check. | |
184 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
185 | - Optimize `LESS_USED` worker choice strategy. | |
186 | - Update benchmarks versus external threads pools. | |
187 | - Optimize tasks usage statistics requirements for worker choice strategy. | |
188 | ||
189 | ### Fixed | |
190 | ||
191 | - Ensure trimmable characters are checked at pool initialization. | |
192 | - Fix message id integer overflow. | |
193 | - Fix pool worker removal in worker choice strategy internals. | |
194 | - Fix package publication with pnpm. | |
195 | ||
d0a3f018 JB |
196 | ## [2.4.0-3] - 2023-04-04 |
197 | ||
b2ede285 JB |
198 | ### Added |
199 | ||
200 | - Add `LESS_BUSY` worker choice strategy. | |
201 | ||
202 | ### Changed | |
203 | ||
204 | - Optimize worker storage in pool. | |
205 | - Optimize worker alive status check. | |
206 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
207 | - Optimize `LESS_USED` worker choice strategy. | |
208 | - Update benchmarks versus external threads pools. | |
209 | ||
210 | ### Fixed | |
211 | ||
212 | - Ensure trimmable characters are checked at pool initialization. | |
213 | - Fix message id integer overflow. | |
214 | - Fix pool worker removal in worker choice strategy internals. | |
215 | - Fix package publication with pnpm. | |
216 | ||
a015ea40 JB |
217 | ## [2.4.0-2] - 2023-04-03 |
218 | ||
698f4bbc JB |
219 | ### Added |
220 | ||
221 | - Add `LESS_BUSY` worker choice strategy. | |
222 | ||
223 | ### Changed | |
224 | ||
225 | - Optimize worker storage in pool. | |
226 | - Optimize worker alive status check. | |
227 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
228 | - Optimize `LESS_USED` worker choice strategy. | |
229 | ||
230 | ### Fixed | |
231 | ||
232 | - Ensure trimmable characters are checked at pool initialization. | |
233 | - Fix message id integer overflow. | |
234 | - Fix pool worker removal in worker choice strategy internals. | |
235 | - Fix package publication with pnpm. | |
236 | ||
8fe15920 JB |
237 | ## [2.4.0-1] - 2023-04-03 |
238 | ||
5b301c28 JB |
239 | ### Added |
240 | ||
241 | - Add `LESS_BUSY` worker choice strategy. | |
242 | ||
243 | ### Changed | |
244 | ||
245 | - Optimize worker storage in pool. | |
246 | - Optimize worker alive status check. | |
247 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
248 | - Optimize `LESS_USED` worker choice strategy. | |
249 | ||
250 | ### Fixed | |
251 | ||
252 | - Ensure trimmable characters are checked at pool initialization. | |
253 | - Fix message id integer overflow. | |
254 | - Fix pool worker removal in worker choice strategy internals. | |
255 | ||
2fb9ca9c JB |
256 | ## [2.4.0-0] - 2023-04-03 |
257 | ||
168c526f JB |
258 | ### Added |
259 | ||
260 | - Add `LESS_BUSY` worker choice strategy. | |
261 | ||
1d71a908 JB |
262 | ### Changed |
263 | ||
ffcbbad8 | 264 | - Optimize worker storage in pool. |
1d71a908 | 265 | - Optimize worker alive status check. |
65a60b3b | 266 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 267 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 268 | |
ffcbbad8 JB |
269 | ### Fixed |
270 | ||
271 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 272 | - Fix message id integer overflow. |
97a2abc3 | 273 | - Fix pool worker removal in worker choice strategy internals. |
ffcbbad8 | 274 | |
08372738 JB |
275 | ## [2.3.10] - 2023-03-18 |
276 | ||
710826bc JB |
277 | ### Fixed |
278 | ||
279 | - Fix `exports` syntax for ESM and CommonJS. | |
280 | ||
281 | ### Changed | |
282 | ||
283 | - Permit SemVer pre-release publication. | |
76e5ac6f | 284 | |
e4796ecd JB |
285 | ## [2.3.10-2] - 2023-03-18 |
286 | ||
6abad580 JB |
287 | ### Fixed |
288 | ||
289 | - Fix `exports` syntax for ESM and CommonJS. | |
290 | ||
a2ee98cc JB |
291 | ## [2.3.10-1] - 2023-03-18 |
292 | ||
7e060cee JB |
293 | ### Changed |
294 | ||
90483887 | 295 | - Permit SemVer pre-release publication. |
7e060cee | 296 | |
c81bfafb JB |
297 | ## [2.3.10-0] - 2023-03-18 |
298 | ||
fe18768d JB |
299 | ### Fixed |
300 | ||
301 | - Fix `exports` syntax for ESM and CommonJS. | |
302 | ||
d7b78217 JB |
303 | ## [2.3.9] - 2023-03-18 |
304 | ||
ed6dd37f JB |
305 | ### Changed |
306 | ||
307 | - Introduce ESM module support along with CommonJS one. | |
308 | ||
309 | ### Fixed | |
310 | ||
311 | - Fix brown paper bag bug referencing the same object literal. | |
312 | ||
68e2ad86 JB |
313 | ## [2.3.8] - 2023-03-18 |
314 | ||
ca6c7d70 JB |
315 | ### Changed |
316 | ||
317 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
318 | - Switch to TypeScript 5.x.x. |
319 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 320 | - Switch to TSDoc syntax. |
fbdedeb9 | 321 | - Enforce conventional commits. |
ca6c7d70 | 322 | |
d15211d4 JB |
323 | ### Fixed |
324 | ||
325 | - Fix random integer generator. | |
fbdedeb9 | 326 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 327 | |
995705ea JB |
328 | ## [2.3.7] - 2022-10-23 |
329 | ||
b953022b JB |
330 | ### Changed |
331 | ||
332 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
333 | - Switch to ts-standard linter configuration on TypeScript code. |
334 | ||
335 | ### Fixed | |
336 | ||
337 | - Fixed missing async on pool execute method. | |
338 | - Fixed typing in TypeScript example. | |
339 | - Fixed types in unit tests. | |
b953022b | 340 | |
3b9f6953 JB |
341 | ## [2.3.6] - 2022-10-22 |
342 | ||
f80cead4 JB |
343 | ### Changed |
344 | ||
345 | - Cleanup pool attributes and methods. | |
346 | - Refine error types thrown. | |
347 | ||
348 | ### Fixed | |
349 | ||
350 | - Fix continuous integration build on windows. | |
351 | - Fix code coverage reporting by using c8 instead of nyc. | |
352 | ||
efc22107 JB |
353 | ## [2.3.5] - 2022-10-21 |
354 | ||
7a6a0a96 JB |
355 | ### Changed |
356 | ||
a05c10de JB |
357 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
358 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 359 | |
b4904890 JB |
360 | ### Fixed |
361 | ||
362 | - Fix missed pool event emitter type export. | |
363 | - Fix typedoc documentation generation. | |
364 | ||
a875f8d1 JB |
365 | ## [2.3.4] - 2022-10-17 |
366 | ||
73cda448 JB |
367 | ### Added |
368 | ||
369 | - Fully automate release process with release-it. | |
370 | ||
45a5a54c JB |
371 | ### Changed |
372 | ||
73cda448 | 373 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 374 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 375 | |
90ee1b18 | 376 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
377 | |
378 | ### Added | |
379 | ||
380 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
381 | ||
90ee1b18 | 382 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
383 | |
384 | ### Changed | |
385 | ||
386 | - Optimize fair share worker selection strategy implementation. | |
387 | ||
388 | ### Fixed | |
389 | ||
390 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
391 | ||
90ee1b18 | 392 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
393 | |
394 | ### Added | |
395 | ||
396 | - Pool worker choice strategies: | |
397 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
398 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
399 | ||
90ee1b18 | 400 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
401 | |
402 | ### Fixed | |
403 | ||
404 | - Fixed `README.md` file. | |
405 | ||
90ee1b18 | 406 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 407 | |
bdaf31cd JB |
408 | ### Added |
409 | ||
410 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 411 | |
90ee1b18 | 412 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
413 | |
414 | ### Breaking Changes | |
415 | ||
416 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
417 | ||
90ee1b18 | 418 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
419 | |
420 | ### Added | |
421 | ||
422 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
423 | |
424 | ### Breaking Changes | |
425 | ||
426 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
427 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
428 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 429 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 430 | |
90ee1b18 | 431 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
432 | |
433 | ### Bug fixes | |
434 | ||
435 | - Fix `busy` event emission on fixed pool type | |
436 | ||
90ee1b18 | 437 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
438 | |
439 | ### Bug fixes | |
440 | ||
441 | - Check if pool options are properly set. | |
442 | - `busy` event is emitted on all pool types. | |
443 | ||
90ee1b18 | 444 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 445 | |
f3f833ab | 446 | ### Bug fixes |
d63d3be3 | 447 | |
ddbeaffd | 448 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 449 | |
fa0f5b28 S |
450 | ### Breaking Changes |
451 | ||
7f685093 | 452 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 453 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 454 | _Find more details on our JSDoc._ |
ddbeaffd | 455 | |
1927ee67 APA |
456 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
457 | ||
ddbeaffd | 458 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 459 | |
ec2ccfc8 JB |
460 | ### Pool options types declaration merge |
461 | ||
462 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
463 | ||
fa0f5b28 S |
464 | #### New `export` strategy |
465 | ||
466 | ```js | |
467 | // Before | |
777b7824 | 468 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 469 | // After |
777b7824 | 470 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
471 | ``` |
472 | ||
473 | But you should always prefer just using | |
474 | ||
475 | ```js | |
777b7824 | 476 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
477 | ``` |
478 | ||
d3c8a1a8 S |
479 | #### New type definitions for input data and response |
480 | ||
ec2ccfc8 | 481 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
482 | _This is not a limitation by poolifier but NodeJS._ |
483 | ||
3a4b605f | 484 | #### Public property replacements |
5c5a1fb7 | 485 | |
3a4b605f | 486 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 487 | |
280c2a77 | 488 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 489 | |
280c2a77 S |
490 | These properties are not intended for end users |
491 | ||
492 | - `id` => `nextMessageId` | |
493 | ||
494 | These methods are not intended for end users | |
fa0f5b28 S |
495 | |
496 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 497 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
498 | - `_execute` => `internalExecute` |
499 | - `_chooseWorker` => `chooseWorker` | |
500 | - `_checkAlive` => `checkAlive` | |
501 | - `_run` => `run` | |
502 | - `_runAsync` => `runAsync` | |
503 | ||
90ee1b18 | 504 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
505 | |
506 | ### Added | |
507 | ||
508 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 509 | - Various external library patches |
0312f71a | 510 | |
90ee1b18 | 511 | ## [1.0.0] - 2020-01-24 |
522eea03 | 512 | |
513 | ### Added | |
514 | ||
515 | - FixedThreadPool implementation | |
516 | - DynamicThreadPool implementation | |
0312f71a | 517 | - WorkerThread implementation to improve developer experience |