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