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