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 | ||
58a06a6c JB |
10 | ## [2.6.16] - 2023-07-12 |
11 | ||
2a69b8c5 JB |
12 | ### Fixed |
13 | ||
80520ca4 | 14 | - Fix pool startup detection. |
2a69b8c5 JB |
15 | - Fix worker task functions handling. |
16 | ||
b5900b02 JB |
17 | ## [2.6.15] - 2023-07-11 |
18 | ||
19dbc45b JB |
19 | ### Added |
20 | ||
21 | - Take into account worker node readiness in worker choice strategies. | |
22 | ||
4a0db581 JB |
23 | ## [2.6.14] - 2023-07-10 |
24 | ||
87e44747 JB |
25 | ### Fixed |
26 | ||
27 | - Fix task function statistics tracking. | |
28 | ||
0265272f JB |
29 | ## [2.6.13] - 2023-07-10 |
30 | ||
968a2e8c JB |
31 | ### Added |
32 | ||
33 | - Add per task function statistics tracking. | |
782299f8 | 34 | - Add public methods to manipulate the worker task functions at runtime. |
968a2e8c | 35 | |
44c8c00f JB |
36 | ## [2.6.12] - 2023-07-09 |
37 | ||
aa4bf4b2 JB |
38 | ### Fixed |
39 | ||
40 | - Workaround import issue with `node:os` module in node 16.x.x. | |
41 | ||
b7cfced1 JB |
42 | ## [2.6.11] - 2023-07-09 |
43 | ||
d5024c00 JB |
44 | ### Fixed |
45 | ||
46 | - Fix pool readiness semantic. | |
47 | ||
f313a208 JB |
48 | ## [2.6.10] - 2023-07-08 |
49 | ||
2431bdb4 JB |
50 | ### Fixed |
51 | ||
52 | - Ensure workers are not recreated on error at pool startup. | |
53 | ||
54 | ### Added | |
55 | ||
56 | - Add `ready` and `strategy` fields to pool information. | |
57 | - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready. | |
caadbd41 | 58 | - Add dynamic pool sizing checks. |
2431bdb4 | 59 | |
369d0a51 JB |
60 | ## [2.6.9] - 2023-07-07 |
61 | ||
2845f2a5 JB |
62 | ### Fixed |
63 | ||
64 | - Recreate the right worker type on uncaught exception. | |
65 | ||
66 | ### Added | |
67 | ||
68 | - Add minimum and maximum to internal measurement statistics. | |
1dcf8b7b | 69 | - Add `runTime` and `waitTime` to pool information. |
75d3401a | 70 | - Check worker inactive time only on dynamic worker. |
2845f2a5 | 71 | |
fc97d613 JB |
72 | ## [2.6.8] - 2023-07-03 |
73 | ||
92b1feaa JB |
74 | ### Fixed |
75 | ||
76 | - Brown paper bag release to fix version handling in pool information. | |
77 | ||
52d54060 JB |
78 | ## [2.6.7] - 2023-07-03 |
79 | ||
5bc91f3e JB |
80 | ### Fixed |
81 | ||
82 | - Ensure worker queued tasks at error are reassigned to other pool workers. | |
83 | ||
afe0d5bf JB |
84 | ### Added |
85 | ||
86 | - Add pool `utilization` ratio to pool information. | |
23ccf9d7 | 87 | - Add `version` to pool information. |
e5b3047d | 88 | - Add worker information to worker nodes. |
afe0d5bf | 89 | |
f42c583f JB |
90 | ## [2.6.6] - 2023-07-01 |
91 | ||
6961ca9a JB |
92 | ### Added |
93 | ||
94 | - Add safe helper `availableParallelism` to help sizing the pool. | |
95 | ||
3749facb JB |
96 | ### Fixed |
97 | ||
98 | - Ensure message handler is only registered in worker. | |
99 | ||
6fed2513 JB |
100 | ## [2.6.5] - 2023-06-27 |
101 | ||
c72f6987 JB |
102 | ### Known issues |
103 | ||
70726c28 | 104 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 |
c72f6987 JB |
105 | |
106 | ### Fixed | |
107 | ||
108 | - Artificial version bump to 2.6.5 to workaround publication issue. | |
109 | - Ensure cluster pool destroy() gracefully shutdowns worker's server. | |
110 | - Ensure pool event is emitted before task error promise rejection. | |
111 | - Fix queued tasks count computation. | |
112 | ||
113 | ### Removed | |
114 | ||
115 | - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC. | |
116 | ||
6426631b JB |
117 | ## [2.6.4] - 2023-06-27 |
118 | ||
941f9a7c JB |
119 | ### Known issues |
120 | ||
70726c28 | 121 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 |
941f9a7c | 122 | |
2c039e43 JB |
123 | ### Fixed |
124 | ||
125 | - Ensure cluster pool destroy() gracefully shutdowns worker's server. | |
126 | - Ensure pool event is emitted before task error promise rejection. | |
9c16fb4b | 127 | - Fix queued tasks count computation. |
2c039e43 | 128 | |
941f9a7c JB |
129 | ### Removed |
130 | ||
131 | - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC. | |
132 | ||
bc1b0765 JB |
133 | ## [2.6.3] - 2023-06-19 |
134 | ||
a6a2dc4c JB |
135 | ### Fixed |
136 | ||
137 | - Ensure no tasks are queued when trying to soft kill a dynamic worker. | |
f0d7f803 | 138 | - Update strategies internals after statistics computation. |
a6a2dc4c | 139 | |
7b56f532 JB |
140 | ### Changed |
141 | ||
142 | - Optimize O(1) queue implementation. | |
143 | ||
b628596c JB |
144 | ## [2.6.2] - 2023-06-12 |
145 | ||
a9e89d00 JB |
146 | ### Fixed |
147 | ||
148 | - Fix new worker use after creation in dynamic pool given the current worker choice strategy. | |
149 | ||
4368a898 JB |
150 | ## [2.6.1] - 2023-06-10 |
151 | ||
931d43e2 JB |
152 | ### Added |
153 | ||
154 | - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md). | |
155 | ||
f1c06930 JB |
156 | ### Fixed |
157 | ||
158 | - Fix average statistics computation: ensure failed tasks are not accounted. | |
159 | ||
16671b07 JB |
160 | ## [2.6.0] - 2023-06-09 |
161 | ||
a1347286 JB |
162 | ### Added |
163 | ||
5af9c0f7 | 164 | - Add `LEAST_ELU` worker choice strategy (experimental). |
9adcefab | 165 | - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy. |
a1347286 | 166 | |
1c6fe997 JB |
167 | ### Changed |
168 | ||
169 | - Refactor pool worker node usage internals. | |
477f48e7 | 170 | - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed. |
f63a9dda | 171 | - Breaking change: pool information `info` property object fields have been renamed. |
1c6fe997 JB |
172 | |
173 | ### Fixed | |
174 | ||
175 | - Fix wait time accounting. | |
176 | - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time. | |
177 | - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks. | |
178 | ||
aa07d6ee JB |
179 | ## [2.5.4] - 2023-06-07 |
180 | ||
b6b32453 JB |
181 | ### Added |
182 | ||
183 | - Add Event Loop Utilization (ELU) statistics to worker tasks usage. | |
184 | ||
185 | ### Changed | |
186 | ||
187 | - Compute statistics at the worker level only if needed. | |
90082c8c | 188 | - Add `worker-threads` options to thread pool options. |
b6b32453 | 189 | |
272d4d8f JB |
190 | ### Fixed |
191 | ||
192 | - Make the `LEAST_BUSY` strategy only relies on task runtime. | |
193 | ||
ed47fb3d JB |
194 | ## [2.5.3] - 2023-06-04 |
195 | ||
89a4abfd JB |
196 | ### Changed |
197 | ||
198 | - Refine pool information content. | |
b4213b7f | 199 | - Limit pool internals public exposure. |
89a4abfd | 200 | |
8a9febf5 JB |
201 | ## [2.5.2] - 2023-06-02 |
202 | ||
91ee39ed JB |
203 | ### Added |
204 | ||
205 | - Add `taskError` pool event for task execution error. | |
6b27d407 | 206 | - Add pool information `info` property to pool. |
91ee39ed JB |
207 | - Emit pool information on `busy` and `full` pool events. |
208 | ||
8babb151 JB |
209 | ## [2.5.1] - 2023-06-01 |
210 | ||
0e05c4dc JB |
211 | ### Added |
212 | ||
1f68cede | 213 | - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`. |
91ee39ed | 214 | - Add `error` pool event for uncaught worker error. |
0e05c4dc | 215 | |
a8766181 JB |
216 | ## [2.5.0] - 2023-05-31 |
217 | ||
e4543b14 JB |
218 | ### Added |
219 | ||
220 | - Switch pool event emitter to `EventEmitterAsyncResource`. | |
6da80d38 | 221 | - Add tasks wait time accounting in per worker tasks usage. |
5af9c0f7 | 222 | - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental). |
e4543b14 JB |
223 | |
224 | ### Changed | |
225 | ||
226 | - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`. | |
227 | ||
570efb11 JB |
228 | ## [2.4.14] - 2023-05-09 |
229 | ||
b0f28bad JB |
230 | ### Fixed |
231 | ||
232 | - Ensure no undefined task runtime can land in the tasks history. | |
233 | - Fix median computation implementation once again. | |
234 | ||
110b6d13 JB |
235 | ### Added |
236 | ||
237 | - Unit tests for median and queue implementations. | |
238 | ||
72584880 JB |
239 | ## [2.4.13] - 2023-05-08 |
240 | ||
b0d6ed8f JB |
241 | ### Fixed |
242 | ||
e3058615 | 243 | - Fix worker choice strategy options validation. |
b0d6ed8f JB |
244 | - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission. |
245 | ||
06140c32 JB |
246 | ## [2.4.12] - 2023-05-06 |
247 | ||
a86b6df1 JB |
248 | ### Added |
249 | ||
250 | - Support multiple task functions per worker. | |
08f3f44c | 251 | - Add custom worker weights support to worker choice strategies options. |
a86b6df1 | 252 | |
29ee7e9a JB |
253 | ### Changed |
254 | ||
255 | - Use O(1) queue implementation for tasks queueing. | |
256 | ||
0682ba15 JB |
257 | ### Fixed |
258 | ||
259 | - Fix median computation implementation. | |
260 | - Fix fair share worker choice strategy internals update. | |
261 | ||
936d53ec JB |
262 | ## [2.4.11] - 2023-04-23 |
263 | ||
cb70b19d JB |
264 | ### Changed |
265 | ||
266 | - Optimize free worker finding in worker choice strategies. | |
267 | ||
15bb637a JB |
268 | ## [2.4.10] - 2023-04-15 |
269 | ||
ef41a6e6 JB |
270 | ### Fixed |
271 | ||
272 | - Fix typescript type definition for worker function: ensure the input data is optional. | |
273 | - Fix typescript type definition for pool execute(): ensure the input data is optional. | |
274 | ||
181eb2b4 JB |
275 | ## [2.4.9] - 2023-04-15 |
276 | ||
a20f0ba5 JB |
277 | ### Added |
278 | ||
279 | - Add tasks queue enablement runtime setter to pool. | |
280 | - Add tasks queue options runtime setter to pool. | |
281 | - Add worker choice strategy options runtime setter to pool. | |
282 | ||
283 | ### Changed | |
284 | ||
285 | - Remove the tasks queuing experimental status. | |
286 | ||
d4aeae5a JB |
287 | ### Fixed |
288 | ||
289 | - Fix worker function type definition and validation. | |
2fc5cae3 | 290 | - Fix worker choice strategy options handling. |
d4aeae5a | 291 | |
1d9e7023 JB |
292 | ## [2.4.8] - 2023-04-12 |
293 | ||
f9b4bbf8 JB |
294 | ### Fixed |
295 | ||
296 | - Fix message between main worker and worker type definition for tasks. | |
297 | - Fix code documentation. | |
298 | ||
12ae3210 JB |
299 | ## [2.4.7] - 2023-04-11 |
300 | ||
7171d33f JB |
301 | ### Added |
302 | ||
303 | - Add worker tasks queue options to pool options. | |
304 | ||
e8bd29ce JB |
305 | ### Fixed |
306 | ||
307 | - Fix missing documentation. | |
308 | ||
42c7bc10 JB |
309 | ## [2.4.6] - 2023-04-10 |
310 | ||
681196cc JB |
311 | ### Fixed |
312 | ||
313 | - Ensure one task at a time is executed per worker with tasks queueing enabled. | |
1c6fe997 | 314 | - Properly count worker executing tasks with tasks queueing enabled. |
681196cc | 315 | |
54d360e3 JB |
316 | ## [2.4.5] - 2023-04-09 |
317 | ||
3fafb1b2 JB |
318 | ### Added |
319 | ||
9e775f96 JB |
320 | - Use monotonic high resolution timer for worker tasks runtime. |
321 | - Add worker tasks median runtime to statistics. | |
ff733df7 | 322 | - Add worker tasks queue (experimental). |
3fafb1b2 | 323 | |
92fa3eb6 JB |
324 | ## [2.4.4] - 2023-04-07 |
325 | ||
aee46736 JB |
326 | ### Added |
327 | ||
328 | - Add `PoolEvents` enumeration and `PoolEvent` type. | |
329 | ||
36b5e78f JB |
330 | ### Fixed |
331 | ||
ff0c2b3e | 332 | - Destroy worker only on alive check. |
36b5e78f | 333 | |
9fb0f324 JB |
334 | ## [2.4.3] - 2023-04-07 |
335 | ||
28cf3617 JB |
336 | ### Fixed |
337 | ||
338 | - Fix typedoc generation with inheritance. | |
339 | ||
848f0f27 JB |
340 | ## [2.4.2] - 2023-04-06 |
341 | ||
164d950a JB |
342 | ### Added |
343 | ||
344 | - Add `full` event to dynamic pool. | |
32417142 | 345 | - Keep worker choice strategy in memory for conditional reuse. |
164d950a | 346 | |
78ab2555 JB |
347 | ### Fixed |
348 | ||
349 | - Fix possible negative worker key at worker removal in worker choice strategies. | |
350 | ||
79aafe9f JB |
351 | ## [2.4.1] - 2023-04-05 |
352 | ||
9cd39dd4 JB |
353 | ### Changed |
354 | ||
355 | - Optimize worker choice strategy for dynamic pool. | |
356 | ||
965415bb JB |
357 | ### Fixed |
358 | ||
359 | - Ensure dynamic pool does not alter worker choice strategy expected behavior. | |
360 | ||
d8b60b1c JB |
361 | ## [2.4.0] - 2023-04-04 |
362 | ||
c6bd2650 JB |
363 | ### Added |
364 | ||
365 | - Add `LESS_BUSY` worker choice strategy. | |
366 | ||
367 | ### Changed | |
368 | ||
369 | - Optimize worker storage in pool. | |
370 | - Optimize worker alive status check. | |
371 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
372 | - Optimize `LESS_USED` worker choice strategy. | |
373 | - Update benchmarks versus external threads pools. | |
374 | - Optimize tasks usage statistics requirements for worker choice strategy. | |
375 | ||
376 | ### Fixed | |
377 | ||
378 | - Ensure trimmable characters are checked at pool initialization. | |
379 | - Fix message id integer overflow. | |
380 | - Fix pool worker removal in worker choice strategy internals. | |
381 | - Fix package publication with pnpm. | |
382 | ||
d0a3f018 JB |
383 | ## [2.4.0-3] - 2023-04-04 |
384 | ||
b2ede285 JB |
385 | ### Added |
386 | ||
387 | - Add `LESS_BUSY` worker choice strategy. | |
388 | ||
389 | ### Changed | |
390 | ||
391 | - Optimize worker storage in pool. | |
392 | - Optimize worker alive status check. | |
393 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
394 | - Optimize `LESS_USED` worker choice strategy. | |
395 | - Update benchmarks versus external threads pools. | |
396 | ||
397 | ### Fixed | |
398 | ||
399 | - Ensure trimmable characters are checked at pool initialization. | |
400 | - Fix message id integer overflow. | |
401 | - Fix pool worker removal in worker choice strategy internals. | |
402 | - Fix package publication with pnpm. | |
403 | ||
a015ea40 JB |
404 | ## [2.4.0-2] - 2023-04-03 |
405 | ||
698f4bbc JB |
406 | ### Added |
407 | ||
408 | - Add `LESS_BUSY` worker choice strategy. | |
409 | ||
410 | ### Changed | |
411 | ||
412 | - Optimize worker storage in pool. | |
413 | - Optimize worker alive status check. | |
414 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
415 | - Optimize `LESS_USED` worker choice strategy. | |
416 | ||
417 | ### Fixed | |
418 | ||
419 | - Ensure trimmable characters are checked at pool initialization. | |
420 | - Fix message id integer overflow. | |
421 | - Fix pool worker removal in worker choice strategy internals. | |
422 | - Fix package publication with pnpm. | |
423 | ||
8fe15920 JB |
424 | ## [2.4.0-1] - 2023-04-03 |
425 | ||
5b301c28 JB |
426 | ### Added |
427 | ||
428 | - Add `LESS_BUSY` worker choice strategy. | |
429 | ||
430 | ### Changed | |
431 | ||
432 | - Optimize worker storage in pool. | |
433 | - Optimize worker alive status check. | |
434 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
435 | - Optimize `LESS_USED` worker choice strategy. | |
436 | ||
437 | ### Fixed | |
438 | ||
439 | - Ensure trimmable characters are checked at pool initialization. | |
440 | - Fix message id integer overflow. | |
441 | - Fix pool worker removal in worker choice strategy internals. | |
442 | ||
2fb9ca9c JB |
443 | ## [2.4.0-0] - 2023-04-03 |
444 | ||
168c526f JB |
445 | ### Added |
446 | ||
447 | - Add `LESS_BUSY` worker choice strategy. | |
448 | ||
1d71a908 JB |
449 | ### Changed |
450 | ||
ffcbbad8 | 451 | - Optimize worker storage in pool. |
1d71a908 | 452 | - Optimize worker alive status check. |
65a60b3b | 453 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 454 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 455 | |
ffcbbad8 JB |
456 | ### Fixed |
457 | ||
458 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 459 | - Fix message id integer overflow. |
97a2abc3 | 460 | - Fix pool worker removal in worker choice strategy internals. |
ffcbbad8 | 461 | |
08372738 JB |
462 | ## [2.3.10] - 2023-03-18 |
463 | ||
710826bc JB |
464 | ### Fixed |
465 | ||
466 | - Fix `exports` syntax for ESM and CommonJS. | |
467 | ||
468 | ### Changed | |
469 | ||
470 | - Permit SemVer pre-release publication. | |
76e5ac6f | 471 | |
e4796ecd JB |
472 | ## [2.3.10-2] - 2023-03-18 |
473 | ||
6abad580 JB |
474 | ### Fixed |
475 | ||
476 | - Fix `exports` syntax for ESM and CommonJS. | |
477 | ||
a2ee98cc JB |
478 | ## [2.3.10-1] - 2023-03-18 |
479 | ||
7e060cee JB |
480 | ### Changed |
481 | ||
90483887 | 482 | - Permit SemVer pre-release publication. |
7e060cee | 483 | |
c81bfafb JB |
484 | ## [2.3.10-0] - 2023-03-18 |
485 | ||
fe18768d JB |
486 | ### Fixed |
487 | ||
488 | - Fix `exports` syntax for ESM and CommonJS. | |
489 | ||
d7b78217 JB |
490 | ## [2.3.9] - 2023-03-18 |
491 | ||
ed6dd37f JB |
492 | ### Changed |
493 | ||
494 | - Introduce ESM module support along with CommonJS one. | |
495 | ||
496 | ### Fixed | |
497 | ||
498 | - Fix brown paper bag bug referencing the same object literal. | |
499 | ||
68e2ad86 JB |
500 | ## [2.3.8] - 2023-03-18 |
501 | ||
ca6c7d70 JB |
502 | ### Changed |
503 | ||
504 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
505 | - Switch to TypeScript 5.x.x. |
506 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 507 | - Switch to TSDoc syntax. |
fbdedeb9 | 508 | - Enforce conventional commits. |
ca6c7d70 | 509 | |
d15211d4 JB |
510 | ### Fixed |
511 | ||
512 | - Fix random integer generator. | |
fbdedeb9 | 513 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 514 | |
995705ea JB |
515 | ## [2.3.7] - 2022-10-23 |
516 | ||
b953022b JB |
517 | ### Changed |
518 | ||
519 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
520 | - Switch to ts-standard linter configuration on TypeScript code. |
521 | ||
522 | ### Fixed | |
523 | ||
524 | - Fixed missing async on pool execute method. | |
525 | - Fixed typing in TypeScript example. | |
526 | - Fixed types in unit tests. | |
b953022b | 527 | |
3b9f6953 JB |
528 | ## [2.3.6] - 2022-10-22 |
529 | ||
f80cead4 JB |
530 | ### Changed |
531 | ||
532 | - Cleanup pool attributes and methods. | |
533 | - Refine error types thrown. | |
534 | ||
535 | ### Fixed | |
536 | ||
537 | - Fix continuous integration build on windows. | |
538 | - Fix code coverage reporting by using c8 instead of nyc. | |
539 | ||
efc22107 JB |
540 | ## [2.3.5] - 2022-10-21 |
541 | ||
7a6a0a96 JB |
542 | ### Changed |
543 | ||
a05c10de JB |
544 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
545 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 546 | |
b4904890 JB |
547 | ### Fixed |
548 | ||
549 | - Fix missed pool event emitter type export. | |
550 | - Fix typedoc documentation generation. | |
551 | ||
a875f8d1 JB |
552 | ## [2.3.4] - 2022-10-17 |
553 | ||
73cda448 JB |
554 | ### Added |
555 | ||
556 | - Fully automate release process with release-it. | |
557 | ||
45a5a54c JB |
558 | ### Changed |
559 | ||
73cda448 | 560 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 561 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 562 | |
90ee1b18 | 563 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
564 | |
565 | ### Added | |
566 | ||
567 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
568 | ||
90ee1b18 | 569 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
570 | |
571 | ### Changed | |
572 | ||
573 | - Optimize fair share worker selection strategy implementation. | |
574 | ||
575 | ### Fixed | |
576 | ||
577 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
578 | ||
90ee1b18 | 579 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
580 | |
581 | ### Added | |
582 | ||
583 | - Pool worker choice strategies: | |
584 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
585 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
586 | ||
90ee1b18 | 587 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
588 | |
589 | ### Fixed | |
590 | ||
591 | - Fixed `README.md` file. | |
592 | ||
90ee1b18 | 593 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 594 | |
bdaf31cd JB |
595 | ### Added |
596 | ||
597 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 598 | |
90ee1b18 | 599 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
600 | |
601 | ### Breaking Changes | |
602 | ||
603 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
604 | ||
90ee1b18 | 605 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
606 | |
607 | ### Added | |
608 | ||
609 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
610 | |
611 | ### Breaking Changes | |
612 | ||
613 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
614 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
615 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 616 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 617 | |
90ee1b18 | 618 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
619 | |
620 | ### Bug fixes | |
621 | ||
622 | - Fix `busy` event emission on fixed pool type | |
623 | ||
90ee1b18 | 624 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
625 | |
626 | ### Bug fixes | |
627 | ||
628 | - Check if pool options are properly set. | |
629 | - `busy` event is emitted on all pool types. | |
630 | ||
90ee1b18 | 631 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 632 | |
f3f833ab | 633 | ### Bug fixes |
d63d3be3 | 634 | |
ddbeaffd | 635 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 636 | |
fa0f5b28 S |
637 | ### Breaking Changes |
638 | ||
7f685093 | 639 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 640 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 641 | _Find more details on our JSDoc._ |
ddbeaffd | 642 | |
1927ee67 APA |
643 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
644 | ||
ddbeaffd | 645 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 646 | |
ec2ccfc8 JB |
647 | ### Pool options types declaration merge |
648 | ||
649 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
650 | ||
fa0f5b28 S |
651 | #### New `export` strategy |
652 | ||
653 | ```js | |
654 | // Before | |
777b7824 | 655 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 656 | // After |
777b7824 | 657 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
658 | ``` |
659 | ||
660 | But you should always prefer just using | |
661 | ||
662 | ```js | |
777b7824 | 663 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
664 | ``` |
665 | ||
d3c8a1a8 S |
666 | #### New type definitions for input data and response |
667 | ||
6677a3d3 | 668 | For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data. |
d3c8a1a8 S |
669 | _This is not a limitation by poolifier but NodeJS._ |
670 | ||
3a4b605f | 671 | #### Public property replacements |
5c5a1fb7 | 672 | |
3a4b605f | 673 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 674 | |
280c2a77 | 675 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 676 | |
280c2a77 S |
677 | These properties are not intended for end users |
678 | ||
679 | - `id` => `nextMessageId` | |
680 | ||
681 | These methods are not intended for end users | |
fa0f5b28 S |
682 | |
683 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 684 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
685 | - `_execute` => `internalExecute` |
686 | - `_chooseWorker` => `chooseWorker` | |
687 | - `_checkAlive` => `checkAlive` | |
688 | - `_run` => `run` | |
689 | - `_runAsync` => `runAsync` | |
690 | ||
90ee1b18 | 691 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
692 | |
693 | ### Added | |
694 | ||
695 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 696 | - Various external library patches |
0312f71a | 697 | |
90ee1b18 | 698 | ## [1.0.0] - 2020-01-24 |
522eea03 | 699 | |
700 | ### Added | |
701 | ||
702 | - FixedThreadPool implementation | |
703 | - DynamicThreadPool implementation | |
0312f71a | 704 | - WorkerThread implementation to improve developer experience |