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