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