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 | 8 | ## [Unreleased] |
9aa78bcb | 9 | |
6d7beb8c JB |
10 | ### Fixed |
11 | ||
12 | - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748). | |
13 | ||
a4bc8d0e JB |
14 | ## [3.1.17] - 2024-01-05 |
15 | ||
2b6b412f JB |
16 | ### Changed |
17 | ||
18 | - Improve performance by clean up unneeded condition checks on hot code paths. | |
19 | ||
0d64fd53 JB |
20 | ## [3.1.16] - 2024-01-03 |
21 | ||
4302d959 JB |
22 | ### Fixed |
23 | ||
24 | - Add missing type to TS type definitions. | |
25 | ||
9122cc2c JB |
26 | ## [3.1.15] - 2024-01-02 |
27 | ||
a4d25410 JB |
28 | ### Fixed |
29 | ||
30 | - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821). | |
31 | ||
565b7e65 JB |
32 | ## [3.1.15-0] - 2024-01-02 |
33 | ||
63406ebd JB |
34 | ### Fixed |
35 | ||
a4d25410 | 36 | - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821). |
63406ebd | 37 | |
56412ef4 JB |
38 | ## [3.1.14] - 2024-01-01 |
39 | ||
e44639e9 JB |
40 | ### Fixed |
41 | ||
42 | - Properly handle dynamic pool with zero minimum size. | |
43 | ||
5e133e82 JB |
44 | ## [3.1.13] - 2023-12-30 |
45 | ||
b20bf19a JB |
46 | ### Changed |
47 | ||
48 | - Reduce branching in several hot code paths. | |
49 | - Use faster object cloning implementation. | |
50 | ||
60aa9f2f JB |
51 | ## [3.1.12] - 2023-12-27 |
52 | ||
28883f84 JB |
53 | ### Fixed |
54 | ||
55 | - Fix tasks redistribution triggers at pool destroying. | |
56 | ||
57 | ### Changed | |
58 | ||
59 | - Switch TypeScript module resolution to Node16. | |
60 | ||
164c80dd JB |
61 | ## [3.1.12-0] - 2023-12-27 |
62 | ||
f4ef37a8 JB |
63 | ### Fixed |
64 | ||
65 | - Fix tasks redistribution triggers at pool destroying. | |
66 | ||
0766991a JB |
67 | ## [3.1.11] - 2023-12-24 |
68 | ||
5eb72b9e JB |
69 | ### Fixed |
70 | ||
71 | - Avoid worker node cross tasks stealing. | |
72 | - Ensure only half the pool worker nodes can steal tasks. | |
73 | ||
4618ccfd JB |
74 | ## [3.1.10] - 2023-12-23 |
75 | ||
09616edb JB |
76 | ### Changed |
77 | ||
78 | - Avoid useless branching on pool type. | |
79 | ||
bba20209 JB |
80 | ## [3.1.9] - 2023-12-22 |
81 | ||
2889bd70 JB |
82 | ### Changed |
83 | ||
84 | - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions. | |
85 | ||
b1bbc365 JB |
86 | ## [3.1.8] - 2023-12-21 |
87 | ||
ad3836ed JB |
88 | ### Fixed |
89 | ||
90 | - Fix default worker weight computation. | |
91 | - Fix possible null exception at pool destroying. | |
92 | ||
72523ab9 JB |
93 | ## [3.1.7] - 2023-12-20 |
94 | ||
55d7d600 JB |
95 | ### Fixed |
96 | ||
97 | - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748). | |
98 | ||
165f3d56 JB |
99 | ## [3.1.6] - 2023-12-18 |
100 | ||
85b2561d JB |
101 | ### Fixed |
102 | ||
103 | - Fix pool destroying with tasks queuing enabled. | |
104 | ||
6c8cec9e JB |
105 | ## [3.1.5] - 2023-12-18 |
106 | ||
32b141fd JB |
107 | ### Added |
108 | ||
109 | - Add queued tasks end timeout support to worker node termination. | |
110 | ||
f11ec29c JB |
111 | ## [3.1.4] - 2023-12-18 |
112 | ||
4e0afe97 JB |
113 | ### Fixed |
114 | ||
115 | - Make more robust the fix for possible null exception at handling task execution response. | |
116 | ||
f592ef16 JB |
117 | ## [3.1.3] - 2023-12-17 |
118 | ||
9b358e72 JB |
119 | ### Fixed |
120 | ||
121 | - Fix possible null exception at handling task execution response. | |
122 | ||
c61772e5 JB |
123 | ## [3.1.2] - 2023-12-17 |
124 | ||
87347ea8 JB |
125 | ### Fixed |
126 | ||
32b141fd | 127 | - Wait for queued tasks to end at worker node termination. |
87347ea8 | 128 | |
6e664bec JB |
129 | ## [3.1.1] - 2023-12-16 |
130 | ||
51280f9b JB |
131 | ### Fixed |
132 | ||
133 | - Fix pool options TS type definition. | |
134 | ||
5362c66b JB |
135 | ## [3.1.0] - 2023-12-16 |
136 | ||
c3719753 JB |
137 | ### Changed |
138 | ||
139 | - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type. | |
140 | ||
42321a2b JB |
141 | ## [3.0.14] - 2023-12-13 |
142 | ||
fa548cda JB |
143 | ### Fixed |
144 | ||
145 | - Fix possible null exception with worker_threads pools. | |
146 | ||
d727d871 JB |
147 | ## [3.0.13] - 2023-12-12 |
148 | ||
fb5a7307 JB |
149 | ### Fixed |
150 | ||
151 | - Ensure worker choice strategy wait for worker nodes readiness. | |
152 | ||
153 | ### Changed | |
154 | ||
155 | - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop. | |
156 | ||
90a43710 JB |
157 | ## [3.0.12] - 2023-12-12 |
158 | ||
9aa78bcb JB |
159 | ### Changed |
160 | ||
161 | - Add infinite retries support in worker choice strategy. | |
45a5a54c | 162 | |
d8163b08 JB |
163 | ## [3.0.11] - 2023-12-11 |
164 | ||
f18fd12b JB |
165 | ### Fixed |
166 | ||
457dd3dc | 167 | - Ensure pool asynchronous resource properly track tasks execution. |
f18fd12b | 168 | |
bd453998 JB |
169 | ## [3.0.10] - 2023-12-08 |
170 | ||
cb71d660 JB |
171 | ### Changed |
172 | ||
457dd3dc | 173 | - Add a fastpath when tasks stealing or redistribution is impossible. |
cb71d660 | 174 | |
d7164344 JB |
175 | ## [3.0.9] - 2023-11-26 |
176 | ||
78f60f82 JB |
177 | ### Fixed |
178 | ||
179 | - Remove all pool events listener at pool destroying. | |
180 | - Remove all worker node events listener at worker node destroying. | |
9f99eb9b | 181 | - Fix worker node event emitter listeners handling memory leak at pool options runtime change. |
78f60f82 | 182 | |
0c08a681 JB |
183 | ## [3.0.8] - 2023-11-25 |
184 | ||
463226a4 JB |
185 | ### Fixed |
186 | ||
457dd3dc | 187 | - Ensure continuous tasks stealing on idle start at worker node idling. |
463226a4 | 188 | |
14dad1fd JB |
189 | ## [3.0.7] - 2023-11-24 |
190 | ||
65542a35 JB |
191 | ### Changed |
192 | ||
193 | - Make continuous tasks stealing start at worker node idling. | |
194 | ||
82c5db63 JB |
195 | ## [3.0.6] - 2023-11-24 |
196 | ||
711623b8 JB |
197 | ### Fixed |
198 | ||
b51d8596 | 199 | - Ensure pool statuses are checked at initialization, `start()` or `destroy()`. |
55082af9 | 200 | - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles. |
711623b8 | 201 | |
5aa31a74 JB |
202 | ## [3.0.5] - 2023-10-27 |
203 | ||
d91689fd JB |
204 | ### Fixed |
205 | ||
55082af9 | 206 | - Ensure pool `ready` event can be emitted only once. |
d91689fd | 207 | |
597775b2 JB |
208 | ## [3.0.4] - 2023-10-20 |
209 | ||
03fb313b JB |
210 | ### Changed |
211 | ||
49d60f11 | 212 | - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier). |
03fb313b JB |
213 | - Use builtin retry mechanism in worker choice strategies instead of custom one. |
214 | ||
6c285176 JB |
215 | ## [3.0.3] - 2023-10-19 |
216 | ||
9761e404 JB |
217 | ### Fixed |
218 | ||
219 | - Avoid null exception at sending message to worker. | |
535fd8d5 | 220 | - Avoid null exception at checking worker node readiness. |
9761e404 | 221 | |
358dc40f JB |
222 | ## [3.0.2] - 2023-10-17 |
223 | ||
97256a85 JB |
224 | ### Fixed |
225 | ||
c3c2b35e | 226 | - Fix race condition at dynamic worker node task assignment and scheduled removal. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468) and [#1496](https://github.com/poolifier/poolifier/issues/1496). |
97256a85 | 227 | |
7a570743 JB |
228 | ## [3.0.1] - 2023-10-16 |
229 | ||
dbfa7948 JB |
230 | ### Fixed |
231 | ||
fc84edac | 232 | - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468). |
dbfa7948 | 233 | |
365f13e4 JB |
234 | ### Changed |
235 | ||
c3c2b35e | 236 | - Switch the worker node eventing code to `EventTarget` API. |
365f13e4 | 237 | |
003b3275 JB |
238 | ## [3.0.0] - 2023-10-08 |
239 | ||
277c49bf JB |
240 | ### Changed |
241 | ||
242 | - Remove Node.js 16.x.x (EOL) support. | |
243 | ||
3c9e911a JB |
244 | ## [2.7.5] - 2023-10-03 |
245 | ||
f80125ca JB |
246 | ### Changed |
247 | ||
248 | - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version. | |
249 | ||
3466e757 JB |
250 | ## [2.7.4] - 2023-09-25 |
251 | ||
67b26ae2 JB |
252 | ### Fixed |
253 | ||
254 | - Fix source maps (bundler issue). | |
255 | ||
eeb1f961 JB |
256 | ## [2.7.3] - 2023-09-24 |
257 | ||
b5604034 JB |
258 | ### Changed |
259 | ||
260 | - Convert pool event emitter to event emitter async resource. | |
261 | ||
f2df6dc8 JB |
262 | ## [2.7.2] - 2023-09-23 |
263 | ||
116ca64b JB |
264 | ### Changed |
265 | ||
266 | - Add source maps to npm package to ease debugging. | |
267 | ||
1e319a70 JB |
268 | ### Added |
269 | ||
270 | - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark). | |
271 | ||
aab2819b JB |
272 | ## [2.7.1] - 2023-09-20 |
273 | ||
ae036c3e JB |
274 | ### Fixed |
275 | ||
276 | - Ensure worker message listener used one time are removed after usage. | |
277 | ||
15d7c489 JB |
278 | ## [2.7.0] - 2023-09-19 |
279 | ||
160557ff JB |
280 | ### Fixed |
281 | ||
282 | - Fix task stealing related tasks queue options handling at runtime. | |
283 | ||
c3284191 JB |
284 | ### Changed |
285 | ||
286 | - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API. | |
287 | ||
288 | ### Added | |
289 | ||
35808931 | 290 | - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148). |
c20084b6 | 291 | - Stricter worker constructor arguments validation. |
c3284191 | 292 | |
04054352 JB |
293 | ## [2.6.45] - 2023-09-17 |
294 | ||
093af25b JB |
295 | ### Changed |
296 | ||
297 | - Disable publication on GitHub packages registry on release until authentication issue is fixed. | |
09d9af02 JB |
298 | |
299 | ### Added | |
300 | ||
ce0ab2d7 | 301 | - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not. |
cde5b54e | 302 | - Add `start()` method to pool API to start the minimum number of workers. |
af98b972 | 303 | - Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not. |
1e319a70 | 304 | - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench). |
f1c674cd | 305 | |
bce9ffdf JB |
306 | ## [2.6.44] - 2023-09-08 |
307 | ||
4cb259d3 JB |
308 | ### Fixed |
309 | ||
310 | - Use a dedicated PAT to publish on GitHub packages registry. | |
311 | ||
312 | ### Added | |
313 | ||
314 | - Publish on GitHub packages registry on release. | |
315 | ||
316 | ### Changed | |
317 | ||
318 | - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128). | |
319 | ||
fbda1e26 JB |
320 | ## [2.6.43] - 2023-09-08 |
321 | ||
15fc82ba JB |
322 | ### Added |
323 | ||
4cb259d3 | 324 | - Publish on GitHub packages registry on release. |
15fc82ba JB |
325 | |
326 | ### Changed | |
327 | ||
4cb259d3 | 328 | - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128). |
15fc82ba | 329 | |
b47306a3 JB |
330 | ## [2.6.42] - 2023-09-06 |
331 | ||
ad11ca81 JB |
332 | ### Changed |
333 | ||
334 | - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ... | |
335 | ||
1b37751d JB |
336 | ## [2.6.41] - 2023-09-03 |
337 | ||
f3a91bac JB |
338 | ### Changed |
339 | ||
340 | - Optimize worker choice strategies implementation. | |
341 | ||
7790a494 JB |
342 | ## [2.6.40] - 2023-09-01 |
343 | ||
6fe200b4 JB |
344 | ### Fixed |
345 | ||
346 | - Do not pre-choose in WRR worker choice strategy to avoid bias. | |
68738842 | 347 | - Avoid array out of bound in worker choice strategies after worker node removal. |
6fe200b4 | 348 | |
766c7f84 JB |
349 | ## [2.6.39] - 2023-08-30 |
350 | ||
edf8ce4e JB |
351 | ### Fixed |
352 | ||
4cb259d3 | 353 | - Fix race condition in worker choice strategies at worker node info querying while not yet initialized. |
edf8ce4e | 354 | |
904a5689 JB |
355 | ## [2.6.38] - 2023-08-30 |
356 | ||
b40c4b06 JB |
357 | ### Added |
358 | ||
359 | - Bundle typescript types declaration into one file. | |
360 | ||
619f403b JB |
361 | ### Changed |
362 | ||
363 | - Improve interleaved weighted round robin worker choice strategy implementation. | |
364 | ||
5a24d71c JB |
365 | ## [2.6.37] - 2023-08-28 |
366 | ||
bdb9d712 JB |
367 | ### Fixed |
368 | ||
369 | - Ensure unused worker usage statistics are deleted at runtime. | |
370 | ||
8c0b113f JB |
371 | ### Changed |
372 | ||
373 | - Rename worker choice strategy options `choiceRetries` to `retries`. | |
574c5c8d | 374 | - Avoid unnecessary branching in worker choice strategies. |
8c0b113f | 375 | |
ba821940 JB |
376 | ## [2.6.36] - 2023-08-27 |
377 | ||
9d2d0da1 JB |
378 | ### Fixed |
379 | ||
380 | - Fix pool `execute()` arguments check. | |
381 | ||
1f0766e7 JB |
382 | ### Changed |
383 | ||
384 | - Make continuous tasks stealing algorithm less aggressive. | |
8780236f | 385 | - Fine tune tasks stealing algorithm under back pressure. |
1f0766e7 | 386 | |
ffd2c1ff JB |
387 | ## [2.6.35] - 2023-08-25 |
388 | ||
dc021bcc JB |
389 | ### Fixed |
390 | ||
391 | - Don't account worker usage statistics for tasks that have failed. | |
3baa0837 | 392 | - Fix pool information runtime and wait time median computation. |
dc021bcc JB |
393 | |
394 | ### Changed | |
395 | ||
396 | - Update simple moving average implementation to use a circular buffer. | |
397 | - Update simple moving median implementation to use a circular buffer. | |
68cbdc84 JB |
398 | - Account for stolen tasks in worker usage statistics and pool information. |
399 | ||
400 | ### Added | |
401 | ||
402 | - Continuous tasks stealing algorithm. | |
dc021bcc | 403 | |
c58bc2a1 JB |
404 | ## [2.6.34] - 2023-08-24 |
405 | ||
0bc68267 JB |
406 | ### Fixes |
407 | ||
408 | - Avoid cascading tasks stealing under back pressure. | |
409 | ||
410 | ### Changed | |
411 | ||
412 | - Add fastpath to queued tasks rescheduling. | |
413 | ||
39fb7ad0 JB |
414 | ## [2.6.33] - 2023-08-24 |
415 | ||
dd951876 JB |
416 | ### Fixed |
417 | ||
418 | - Fix queued tasks rescheduling. | |
419 | ||
ff3f866a JB |
420 | ### Changed |
421 | ||
422 | - Rename tasks queue options `queueMaxSize` to `size`. | |
423 | ||
a6b3272b | 424 | ### Added |
dd951876 | 425 | |
a6b3272b | 426 | - Task stealing scheduling algorithm if tasks queueing is enabled. |
dd951876 | 427 | |
c55c9b5d JB |
428 | ## [2.6.32] - 2023-08-23 |
429 | ||
15b176e0 JB |
430 | ### Fixed |
431 | ||
432 | - Ensure no task can be executed when the pool is destroyed. | |
433 | ||
20c6f652 JB |
434 | ### Added |
435 | ||
436 | - Add `queueMaxSize` option to tasks queue options. | |
574b351d | 437 | - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing. |
72695f86 | 438 | - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled. |
20c6f652 | 439 | |
e560a9f2 JB |
440 | ## [2.6.31] - 2023-08-20 |
441 | ||
b1aae695 JB |
442 | ### Fixed |
443 | ||
3e8611a8 | 444 | - Fix worker choice strategy retries mechanism in some edge cases. |
b1aae695 | 445 | |
94407def JB |
446 | ### Changed |
447 | ||
e695d66f | 448 | - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage. |
a71b05bc | 449 | - Remove the experimental status of the `LEAST_ELU` worker choice strategy. |
94407def | 450 | |
962b9863 JB |
451 | ## [2.6.30] - 2023-08-19 |
452 | ||
33e6bb4c JB |
453 | ### Fixed |
454 | ||
455 | - Ensure pool event `backPressure` is emitted. | |
456 | - Ensure pool event `full` is emitted only once. | |
8735b4e5 | 457 | - Ensure worker node cannot be instantiated without proper arguments. |
33e6bb4c | 458 | |
8cc4ea81 JB |
459 | ## [2.6.29] - 2023-08-18 |
460 | ||
6169563b JB |
461 | ### Fixed |
462 | ||
55082af9 | 463 | - Fix race condition between readiness and task functions worker message handling at startup. |
5dd4043c | 464 | - Fix duplicate task function worker usage statistics computation per task function. |
db0e38ee | 465 | - Update task function worker usage statistics if and only if there's at least two different task functions. |
5bb5be17 | 466 | - Fix race condition at task function worker usage executing task computation leading to negative value. |
6169563b | 467 | |
8990357d JB |
468 | ### Added |
469 | ||
445264e8 | 470 | - Add back pressure detection on the worker node queue. Event `backPressure` is emitted when all worker node queues are full (worker node queue size >= poolMaxSize^2). |
8990357d JB |
471 | - Use back pressure detection in worker choice strategies. |
472 | - Add worker choice strategies retries mechanism if no worker is eligible. | |
473 | ||
21157987 JB |
474 | ## [2.6.28] - 2023-08-16 |
475 | ||
f05ed93c JB |
476 | ### Fixed |
477 | ||
478 | - Ensure pool workers are properly initialized. | |
479 | ||
12d67776 JB |
480 | ### Added |
481 | ||
482 | - HTTP server pool examples: express-cluster, express-hybrid. | |
483 | ||
d18fccb1 JB |
484 | ### Changed |
485 | ||
486 | - Remove now useless branching in worker hot code path. | |
487 | ||
741cdb34 JB |
488 | ## [2.6.27] - 2023-08-15 |
489 | ||
50e7f498 JB |
490 | ### Fixed |
491 | ||
492 | - Add `KillHandler` type definition to exported types. | |
493 | ||
ef3891a3 JB |
494 | ### Added |
495 | ||
496 | - Add `destroy` event to pool API. | |
497 | ||
e9dc6efa JB |
498 | ## [2.6.26] - 2023-08-15 |
499 | ||
2b099bf7 JB |
500 | ### Added |
501 | ||
502 | - Add kill handler to worker options allowing to execute custom code when worker is killed. | |
ef3891a3 | 503 | - Add `listTaskFunctions()` method to pool API. |
1f4553c6 | 504 | - SMTP client pool example: nodemailer. |
2b099bf7 | 505 | |
5b726f72 JB |
506 | ## [2.6.25] - 2023-08-13 |
507 | ||
72855e92 JB |
508 | ### Added |
509 | ||
3b311539 | 510 | - HTTP server pool examples: fastify-cluster, fastify-hybrid. |
02999424 | 511 | - WebSocket server pool examples: ws-cluster, ws-hybrid. |
72855e92 | 512 | |
7aadd6e5 JB |
513 | ## [2.6.24] - 2023-08-12 |
514 | ||
7d91a8cd JB |
515 | ### Added |
516 | ||
517 | - Add array of transferable objects to the `execute()` method arguments. | |
02999424 | 518 | - WebSocket server pool examples: ws-worker_threads. |
7d91a8cd | 519 | |
6b4263b4 JB |
520 | ## [2.6.23] - 2023-08-11 |
521 | ||
3d76750a | 522 | ### Fixed |
8e0af894 | 523 | |
3d76750a | 524 | - Fix pool busyness semantic when tasks queueing is enabled: the pool is busy when the number of executing tasks on each worker has reached the maximum tasks concurrency per worker. |
9606b474 | 525 | |
3d76750a JB |
526 | ### Added |
527 | ||
528 | - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions. | |
02999424 | 529 | - HTTP server pool examples: express-worker_threads, fastify-worker_threads. |
3d76750a JB |
530 | |
531 | ## [2.6.22] - 2023-08-10 | |
9606b474 | 532 | |
3d76750a | 533 | ### Fixed |
9606b474 JB |
534 | |
535 | - Add missing `types` field to package.json `exports`. | |
536 | ||
3d76750a JB |
537 | ### Changed |
538 | ||
539 | - Structure markdown documentation (PR #811). | |
540 | ||
d9647bdd JB |
541 | ## [2.6.21] - 2023-08-03 |
542 | ||
2111ec12 JB |
543 | ### Changed |
544 | ||
545 | - Improve code documentation. | |
546 | - Code refactoring and cleanup for better maintainability and readability. | |
547 | ||
5c30b9d9 JB |
548 | ## [2.6.20] - 2023-07-21 |
549 | ||
10ecf8fd JB |
550 | ### Fixed |
551 | ||
552 | - Fix queued tasks redistribution on error task execution starvation. | |
a1763c54 | 553 | - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic. |
10ecf8fd | 554 | |
aa9eede8 JB |
555 | ### Changed |
556 | ||
7c89e6a4 | 557 | - Drastically reduce lookups by worker in the worker nodes. |
aa9eede8 | 558 | |
62485908 JB |
559 | ## [2.6.19] - 2023-07-20 |
560 | ||
2e2ef9c3 JB |
561 | ### Added |
562 | ||
563 | - Dedicated internal communication channel for worker_threads pools. | |
564 | ||
8f4c9491 JB |
565 | ## [2.6.18] - 2023-07-19 |
566 | ||
8660b972 JB |
567 | ### Changed |
568 | ||
569 | - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller. | |
570 | ||
206a3519 JB |
571 | ## [2.6.17] - 2023-07-16 |
572 | ||
b4899fae JB |
573 | ### Added |
574 | ||
1a3e01ba | 575 | - Add `listTaskFunctions()` method to worker API. |
b4899fae | 576 | |
58a06a6c JB |
577 | ## [2.6.16] - 2023-07-12 |
578 | ||
2a69b8c5 JB |
579 | ### Fixed |
580 | ||
80520ca4 | 581 | - Fix pool startup detection. |
2a69b8c5 JB |
582 | - Fix worker task functions handling. |
583 | ||
b5900b02 JB |
584 | ## [2.6.15] - 2023-07-11 |
585 | ||
19dbc45b JB |
586 | ### Added |
587 | ||
588 | - Take into account worker node readiness in worker choice strategies. | |
589 | ||
4a0db581 JB |
590 | ## [2.6.14] - 2023-07-10 |
591 | ||
87e44747 JB |
592 | ### Fixed |
593 | ||
594 | - Fix task function statistics tracking. | |
595 | ||
0265272f JB |
596 | ## [2.6.13] - 2023-07-10 |
597 | ||
968a2e8c JB |
598 | ### Added |
599 | ||
600 | - Add per task function statistics tracking. | |
782299f8 | 601 | - Add public methods to manipulate the worker task functions at runtime. |
968a2e8c | 602 | |
44c8c00f JB |
603 | ## [2.6.12] - 2023-07-09 |
604 | ||
aa4bf4b2 JB |
605 | ### Fixed |
606 | ||
607 | - Workaround import issue with `node:os` module in node 16.x.x. | |
608 | ||
b7cfced1 JB |
609 | ## [2.6.11] - 2023-07-09 |
610 | ||
d5024c00 JB |
611 | ### Fixed |
612 | ||
613 | - Fix pool readiness semantic. | |
614 | ||
f313a208 JB |
615 | ## [2.6.10] - 2023-07-08 |
616 | ||
2431bdb4 JB |
617 | ### Fixed |
618 | ||
619 | - Ensure workers are not recreated on error at pool startup. | |
620 | ||
621 | ### Added | |
622 | ||
623 | - Add `ready` and `strategy` fields to pool information. | |
624 | - 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 | 625 | - Add dynamic pool sizing checks. |
2431bdb4 | 626 | |
369d0a51 JB |
627 | ## [2.6.9] - 2023-07-07 |
628 | ||
2845f2a5 JB |
629 | ### Fixed |
630 | ||
631 | - Recreate the right worker type on uncaught exception. | |
632 | ||
633 | ### Added | |
634 | ||
635 | - Add minimum and maximum to internal measurement statistics. | |
1dcf8b7b | 636 | - Add `runTime` and `waitTime` to pool information. |
75d3401a | 637 | - Check worker inactive time only on dynamic worker. |
2845f2a5 | 638 | |
fc97d613 JB |
639 | ## [2.6.8] - 2023-07-03 |
640 | ||
92b1feaa JB |
641 | ### Fixed |
642 | ||
643 | - Brown paper bag release to fix version handling in pool information. | |
644 | ||
52d54060 JB |
645 | ## [2.6.7] - 2023-07-03 |
646 | ||
5bc91f3e JB |
647 | ### Fixed |
648 | ||
649 | - Ensure worker queued tasks at error are reassigned to other pool workers. | |
650 | ||
afe0d5bf JB |
651 | ### Added |
652 | ||
653 | - Add pool `utilization` ratio to pool information. | |
23ccf9d7 | 654 | - Add `version` to pool information. |
e5b3047d | 655 | - Add worker information to worker nodes. |
afe0d5bf | 656 | |
f42c583f JB |
657 | ## [2.6.6] - 2023-07-01 |
658 | ||
6961ca9a JB |
659 | ### Added |
660 | ||
d5e3c4ff | 661 | - Add safe helper `availableParallelism()` to help sizing the pool. |
6961ca9a | 662 | |
3749facb JB |
663 | ### Fixed |
664 | ||
665 | - Ensure message handler is only registered in worker. | |
666 | ||
6fed2513 JB |
667 | ## [2.6.5] - 2023-06-27 |
668 | ||
c72f6987 JB |
669 | ### Known issues |
670 | ||
70726c28 | 671 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 |
c72f6987 JB |
672 | |
673 | ### Fixed | |
674 | ||
675 | - Artificial version bump to 2.6.5 to workaround publication issue. | |
d5e3c4ff | 676 | - Ensure cluster pool `destroy()` gracefully shutdowns worker's server. |
c72f6987 JB |
677 | - Ensure pool event is emitted before task error promise rejection. |
678 | - Fix queued tasks count computation. | |
679 | ||
680 | ### Removed | |
681 | ||
2fbe1783 | 682 | - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC. |
c72f6987 | 683 | |
6426631b JB |
684 | ## [2.6.4] - 2023-06-27 |
685 | ||
941f9a7c JB |
686 | ### Known issues |
687 | ||
70726c28 | 688 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 |
941f9a7c | 689 | |
2c039e43 JB |
690 | ### Fixed |
691 | ||
d5e3c4ff | 692 | - Ensure cluster pool `destroy()` gracefully shutdowns worker's server. |
2c039e43 | 693 | - Ensure pool event is emitted before task error promise rejection. |
9c16fb4b | 694 | - Fix queued tasks count computation. |
2c039e43 | 695 | |
941f9a7c JB |
696 | ### Removed |
697 | ||
2fbe1783 | 698 | - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC. |
941f9a7c | 699 | |
bc1b0765 JB |
700 | ## [2.6.3] - 2023-06-19 |
701 | ||
a6a2dc4c JB |
702 | ### Fixed |
703 | ||
704 | - Ensure no tasks are queued when trying to soft kill a dynamic worker. | |
f0d7f803 | 705 | - Update strategies internals after statistics computation. |
a6a2dc4c | 706 | |
7b56f532 JB |
707 | ### Changed |
708 | ||
709 | - Optimize O(1) queue implementation. | |
710 | ||
b628596c JB |
711 | ## [2.6.2] - 2023-06-12 |
712 | ||
a9e89d00 JB |
713 | ### Fixed |
714 | ||
715 | - Fix new worker use after creation in dynamic pool given the current worker choice strategy. | |
716 | ||
4368a898 JB |
717 | ## [2.6.1] - 2023-06-10 |
718 | ||
931d43e2 JB |
719 | ### Added |
720 | ||
13ab5b87 | 721 | - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md). |
931d43e2 | 722 | |
f1c06930 JB |
723 | ### Fixed |
724 | ||
725 | - Fix average statistics computation: ensure failed tasks are not accounted. | |
726 | ||
16671b07 JB |
727 | ## [2.6.0] - 2023-06-09 |
728 | ||
a1347286 JB |
729 | ### Added |
730 | ||
5af9c0f7 | 731 | - Add `LEAST_ELU` worker choice strategy (experimental). |
9adcefab | 732 | - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy. |
a1347286 | 733 | |
1c6fe997 JB |
734 | ### Changed |
735 | ||
736 | - Refactor pool worker node usage internals. | |
477f48e7 | 737 | - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed. |
f63a9dda | 738 | - Breaking change: pool information `info` property object fields have been renamed. |
1c6fe997 JB |
739 | |
740 | ### Fixed | |
741 | ||
742 | - Fix wait time accounting. | |
743 | - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time. | |
744 | - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks. | |
745 | ||
aa07d6ee JB |
746 | ## [2.5.4] - 2023-06-07 |
747 | ||
b6b32453 JB |
748 | ### Added |
749 | ||
750 | - Add Event Loop Utilization (ELU) statistics to worker tasks usage. | |
751 | ||
752 | ### Changed | |
753 | ||
754 | - Compute statistics at the worker level only if needed. | |
2fbe1783 | 755 | - Add `worker_threads` options to thread pool options. |
b6b32453 | 756 | |
272d4d8f JB |
757 | ### Fixed |
758 | ||
759 | - Make the `LEAST_BUSY` strategy only relies on task runtime. | |
760 | ||
ed47fb3d JB |
761 | ## [2.5.3] - 2023-06-04 |
762 | ||
89a4abfd JB |
763 | ### Changed |
764 | ||
765 | - Refine pool information content. | |
b4213b7f | 766 | - Limit pool internals public exposure. |
89a4abfd | 767 | |
8a9febf5 JB |
768 | ## [2.5.2] - 2023-06-02 |
769 | ||
91ee39ed JB |
770 | ### Added |
771 | ||
772 | - Add `taskError` pool event for task execution error. | |
6b27d407 | 773 | - Add pool information `info` property to pool. |
91ee39ed JB |
774 | - Emit pool information on `busy` and `full` pool events. |
775 | ||
8babb151 JB |
776 | ## [2.5.1] - 2023-06-01 |
777 | ||
0e05c4dc JB |
778 | ### Added |
779 | ||
1f68cede | 780 | - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`. |
91ee39ed | 781 | - Add `error` pool event for uncaught worker error. |
0e05c4dc | 782 | |
a8766181 JB |
783 | ## [2.5.0] - 2023-05-31 |
784 | ||
e4543b14 JB |
785 | ### Added |
786 | ||
787 | - Switch pool event emitter to `EventEmitterAsyncResource`. | |
6da80d38 | 788 | - Add tasks wait time accounting in per worker tasks usage. |
5af9c0f7 | 789 | - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental). |
e4543b14 JB |
790 | |
791 | ### Changed | |
792 | ||
793 | - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`. | |
794 | ||
570efb11 JB |
795 | ## [2.4.14] - 2023-05-09 |
796 | ||
b0f28bad JB |
797 | ### Fixed |
798 | ||
799 | - Ensure no undefined task runtime can land in the tasks history. | |
800 | - Fix median computation implementation once again. | |
801 | ||
110b6d13 JB |
802 | ### Added |
803 | ||
804 | - Unit tests for median and queue implementations. | |
805 | ||
72584880 JB |
806 | ## [2.4.13] - 2023-05-08 |
807 | ||
b0d6ed8f JB |
808 | ### Fixed |
809 | ||
e3058615 | 810 | - Fix worker choice strategy options validation. |
b0d6ed8f JB |
811 | - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission. |
812 | ||
06140c32 JB |
813 | ## [2.4.12] - 2023-05-06 |
814 | ||
a86b6df1 JB |
815 | ### Added |
816 | ||
817 | - Support multiple task functions per worker. | |
08f3f44c | 818 | - Add custom worker weights support to worker choice strategies options. |
a86b6df1 | 819 | |
29ee7e9a JB |
820 | ### Changed |
821 | ||
822 | - Use O(1) queue implementation for tasks queueing. | |
823 | ||
0682ba15 JB |
824 | ### Fixed |
825 | ||
826 | - Fix median computation implementation. | |
827 | - Fix fair share worker choice strategy internals update. | |
828 | ||
936d53ec JB |
829 | ## [2.4.11] - 2023-04-23 |
830 | ||
cb70b19d JB |
831 | ### Changed |
832 | ||
833 | - Optimize free worker finding in worker choice strategies. | |
834 | ||
15bb637a JB |
835 | ## [2.4.10] - 2023-04-15 |
836 | ||
ef41a6e6 JB |
837 | ### Fixed |
838 | ||
82ea6492 | 839 | - Fix typescript type definition for task function: ensure the input data is optional. |
ef41a6e6 JB |
840 | - Fix typescript type definition for pool execute(): ensure the input data is optional. |
841 | ||
181eb2b4 JB |
842 | ## [2.4.9] - 2023-04-15 |
843 | ||
a20f0ba5 JB |
844 | ### Added |
845 | ||
846 | - Add tasks queue enablement runtime setter to pool. | |
847 | - Add tasks queue options runtime setter to pool. | |
848 | - Add worker choice strategy options runtime setter to pool. | |
849 | ||
850 | ### Changed | |
851 | ||
852 | - Remove the tasks queuing experimental status. | |
853 | ||
d4aeae5a JB |
854 | ### Fixed |
855 | ||
82ea6492 | 856 | - Fix task function type definition and validation. |
2fc5cae3 | 857 | - Fix worker choice strategy options handling. |
d4aeae5a | 858 | |
1d9e7023 JB |
859 | ## [2.4.8] - 2023-04-12 |
860 | ||
f9b4bbf8 JB |
861 | ### Fixed |
862 | ||
863 | - Fix message between main worker and worker type definition for tasks. | |
864 | - Fix code documentation. | |
865 | ||
12ae3210 JB |
866 | ## [2.4.7] - 2023-04-11 |
867 | ||
7171d33f JB |
868 | ### Added |
869 | ||
870 | - Add worker tasks queue options to pool options. | |
871 | ||
e8bd29ce JB |
872 | ### Fixed |
873 | ||
874 | - Fix missing documentation. | |
875 | ||
42c7bc10 JB |
876 | ## [2.4.6] - 2023-04-10 |
877 | ||
681196cc JB |
878 | ### Fixed |
879 | ||
880 | - Ensure one task at a time is executed per worker with tasks queueing enabled. | |
1c6fe997 | 881 | - Properly count worker executing tasks with tasks queueing enabled. |
681196cc | 882 | |
54d360e3 JB |
883 | ## [2.4.5] - 2023-04-09 |
884 | ||
3fafb1b2 JB |
885 | ### Added |
886 | ||
9e775f96 JB |
887 | - Use monotonic high resolution timer for worker tasks runtime. |
888 | - Add worker tasks median runtime to statistics. | |
ff733df7 | 889 | - Add worker tasks queue (experimental). |
3fafb1b2 | 890 | |
92fa3eb6 JB |
891 | ## [2.4.4] - 2023-04-07 |
892 | ||
aee46736 JB |
893 | ### Added |
894 | ||
895 | - Add `PoolEvents` enumeration and `PoolEvent` type. | |
896 | ||
36b5e78f JB |
897 | ### Fixed |
898 | ||
ff0c2b3e | 899 | - Destroy worker only on alive check. |
36b5e78f | 900 | |
9fb0f324 JB |
901 | ## [2.4.3] - 2023-04-07 |
902 | ||
28cf3617 JB |
903 | ### Fixed |
904 | ||
905 | - Fix typedoc generation with inheritance. | |
906 | ||
848f0f27 JB |
907 | ## [2.4.2] - 2023-04-06 |
908 | ||
164d950a JB |
909 | ### Added |
910 | ||
911 | - Add `full` event to dynamic pool. | |
32417142 | 912 | - Keep worker choice strategy in memory for conditional reuse. |
164d950a | 913 | |
78ab2555 JB |
914 | ### Fixed |
915 | ||
916 | - Fix possible negative worker key at worker removal in worker choice strategies. | |
917 | ||
79aafe9f JB |
918 | ## [2.4.1] - 2023-04-05 |
919 | ||
9cd39dd4 JB |
920 | ### Changed |
921 | ||
922 | - Optimize worker choice strategy for dynamic pool. | |
923 | ||
965415bb JB |
924 | ### Fixed |
925 | ||
926 | - Ensure dynamic pool does not alter worker choice strategy expected behavior. | |
927 | ||
d8b60b1c JB |
928 | ## [2.4.0] - 2023-04-04 |
929 | ||
c6bd2650 JB |
930 | ### Added |
931 | ||
932 | - Add `LESS_BUSY` worker choice strategy. | |
933 | ||
934 | ### Changed | |
935 | ||
936 | - Optimize worker storage in pool. | |
937 | - Optimize worker alive status check. | |
938 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
939 | - Optimize `LESS_USED` worker choice strategy. | |
2a87030e | 940 | - Update benchmark versus external threads pools. |
c6bd2650 JB |
941 | - Optimize tasks usage statistics requirements for worker choice strategy. |
942 | ||
943 | ### Fixed | |
944 | ||
945 | - Ensure trimmable characters are checked at pool initialization. | |
946 | - Fix message id integer overflow. | |
947 | - Fix pool worker removal in worker choice strategy internals. | |
948 | - Fix package publication with pnpm. | |
949 | ||
d0a3f018 JB |
950 | ## [2.4.0-3] - 2023-04-04 |
951 | ||
b2ede285 JB |
952 | ### Added |
953 | ||
954 | - Add `LESS_BUSY` worker choice strategy. | |
955 | ||
956 | ### Changed | |
957 | ||
958 | - Optimize worker storage in pool. | |
959 | - Optimize worker alive status check. | |
960 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
961 | - Optimize `LESS_USED` worker choice strategy. | |
2a87030e | 962 | - Update benchmark versus external threads pools. |
b2ede285 JB |
963 | |
964 | ### Fixed | |
965 | ||
966 | - Ensure trimmable characters are checked at pool initialization. | |
967 | - Fix message id integer overflow. | |
968 | - Fix pool worker removal in worker choice strategy internals. | |
969 | - Fix package publication with pnpm. | |
970 | ||
a015ea40 JB |
971 | ## [2.4.0-2] - 2023-04-03 |
972 | ||
698f4bbc JB |
973 | ### Added |
974 | ||
975 | - Add `LESS_BUSY` worker choice strategy. | |
976 | ||
977 | ### Changed | |
978 | ||
979 | - Optimize worker storage in pool. | |
980 | - Optimize worker alive status check. | |
981 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
982 | - Optimize `LESS_USED` worker choice strategy. | |
983 | ||
984 | ### Fixed | |
985 | ||
986 | - Ensure trimmable characters are checked at pool initialization. | |
987 | - Fix message id integer overflow. | |
988 | - Fix pool worker removal in worker choice strategy internals. | |
989 | - Fix package publication with pnpm. | |
990 | ||
8fe15920 JB |
991 | ## [2.4.0-1] - 2023-04-03 |
992 | ||
5b301c28 JB |
993 | ### Added |
994 | ||
995 | - Add `LESS_BUSY` worker choice strategy. | |
996 | ||
997 | ### Changed | |
998 | ||
999 | - Optimize worker storage in pool. | |
1000 | - Optimize worker alive status check. | |
1001 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
1002 | - Optimize `LESS_USED` worker choice strategy. | |
1003 | ||
1004 | ### Fixed | |
1005 | ||
1006 | - Ensure trimmable characters are checked at pool initialization. | |
1007 | - Fix message id integer overflow. | |
1008 | - Fix pool worker removal in worker choice strategy internals. | |
1009 | ||
2fb9ca9c JB |
1010 | ## [2.4.0-0] - 2023-04-03 |
1011 | ||
168c526f JB |
1012 | ### Added |
1013 | ||
1014 | - Add `LESS_BUSY` worker choice strategy. | |
1015 | ||
1d71a908 JB |
1016 | ### Changed |
1017 | ||
ffcbbad8 | 1018 | - Optimize worker storage in pool. |
1d71a908 | 1019 | - Optimize worker alive status check. |
65a60b3b | 1020 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 1021 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 1022 | |
ffcbbad8 JB |
1023 | ### Fixed |
1024 | ||
1025 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 1026 | - Fix message id integer overflow. |
97a2abc3 | 1027 | - Fix pool worker removal in worker choice strategy internals. |
ffcbbad8 | 1028 | |
08372738 JB |
1029 | ## [2.3.10] - 2023-03-18 |
1030 | ||
710826bc JB |
1031 | ### Fixed |
1032 | ||
9606b474 | 1033 | - Fix package.json `exports` syntax for ESM and CommonJS. |
710826bc JB |
1034 | |
1035 | ### Changed | |
1036 | ||
1037 | - Permit SemVer pre-release publication. | |
76e5ac6f | 1038 | |
e4796ecd JB |
1039 | ## [2.3.10-2] - 2023-03-18 |
1040 | ||
6abad580 JB |
1041 | ### Fixed |
1042 | ||
9606b474 | 1043 | - Fix package.json `exports` syntax for ESM and CommonJS. |
6abad580 | 1044 | |
a2ee98cc JB |
1045 | ## [2.3.10-1] - 2023-03-18 |
1046 | ||
7e060cee JB |
1047 | ### Changed |
1048 | ||
90483887 | 1049 | - Permit SemVer pre-release publication. |
7e060cee | 1050 | |
c81bfafb JB |
1051 | ## [2.3.10-0] - 2023-03-18 |
1052 | ||
fe18768d JB |
1053 | ### Fixed |
1054 | ||
9606b474 | 1055 | - Fix package.json `exports` syntax for ESM and CommonJS. |
fe18768d | 1056 | |
d7b78217 JB |
1057 | ## [2.3.9] - 2023-03-18 |
1058 | ||
ed6dd37f JB |
1059 | ### Changed |
1060 | ||
1061 | - Introduce ESM module support along with CommonJS one. | |
1062 | ||
1063 | ### Fixed | |
1064 | ||
1065 | - Fix brown paper bag bug referencing the same object literal. | |
1066 | ||
68e2ad86 JB |
1067 | ## [2.3.8] - 2023-03-18 |
1068 | ||
ca6c7d70 JB |
1069 | ### Changed |
1070 | ||
1071 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
1072 | - Switch to TypeScript 5.x.x. |
1073 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 1074 | - Switch to TSDoc syntax. |
fbdedeb9 | 1075 | - Enforce conventional commits. |
ca6c7d70 | 1076 | |
d15211d4 JB |
1077 | ### Fixed |
1078 | ||
1079 | - Fix random integer generator. | |
fbdedeb9 | 1080 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 1081 | |
995705ea JB |
1082 | ## [2.3.7] - 2022-10-23 |
1083 | ||
b953022b JB |
1084 | ### Changed |
1085 | ||
1086 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
1087 | - Switch to ts-standard linter configuration on TypeScript code. |
1088 | ||
1089 | ### Fixed | |
1090 | ||
1091 | - Fixed missing async on pool execute method. | |
1092 | - Fixed typing in TypeScript example. | |
1093 | - Fixed types in unit tests. | |
b953022b | 1094 | |
3b9f6953 JB |
1095 | ## [2.3.6] - 2022-10-22 |
1096 | ||
f80cead4 JB |
1097 | ### Changed |
1098 | ||
1099 | - Cleanup pool attributes and methods. | |
1100 | - Refine error types thrown. | |
1101 | ||
1102 | ### Fixed | |
1103 | ||
1104 | - Fix continuous integration build on windows. | |
1105 | - Fix code coverage reporting by using c8 instead of nyc. | |
1106 | ||
efc22107 JB |
1107 | ## [2.3.5] - 2022-10-21 |
1108 | ||
7a6a0a96 JB |
1109 | ### Changed |
1110 | ||
a05c10de JB |
1111 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
1112 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 1113 | |
b4904890 JB |
1114 | ### Fixed |
1115 | ||
1116 | - Fix missed pool event emitter type export. | |
1117 | - Fix typedoc documentation generation. | |
1118 | ||
a875f8d1 JB |
1119 | ## [2.3.4] - 2022-10-17 |
1120 | ||
73cda448 JB |
1121 | ### Added |
1122 | ||
1123 | - Fully automate release process with release-it. | |
1124 | ||
45a5a54c JB |
1125 | ### Changed |
1126 | ||
73cda448 | 1127 | - Optimize fair share task scheduling algorithm implementation. |
2a87030e | 1128 | - Update benchmark versus external pools results with latest version. |
45a5a54c | 1129 | |
90ee1b18 | 1130 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
1131 | |
1132 | ### Added | |
1133 | ||
1134 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
1135 | ||
90ee1b18 | 1136 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
1137 | |
1138 | ### Changed | |
1139 | ||
1140 | - Optimize fair share worker selection strategy implementation. | |
1141 | ||
1142 | ### Fixed | |
1143 | ||
1144 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
1145 | ||
90ee1b18 | 1146 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
1147 | |
1148 | ### Added | |
1149 | ||
1150 | - Pool worker choice strategies: | |
1151 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
1152 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
1153 | ||
90ee1b18 | 1154 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
1155 | |
1156 | ### Fixed | |
1157 | ||
1158 | - Fixed `README.md` file. | |
1159 | ||
90ee1b18 | 1160 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 1161 | |
bdaf31cd JB |
1162 | ### Added |
1163 | ||
1164 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 1165 | |
90ee1b18 | 1166 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
1167 | |
1168 | ### Breaking Changes | |
1169 | ||
9606b474 | 1170 | - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version. |
7e0d447f | 1171 | |
90ee1b18 | 1172 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
1173 | |
1174 | ### Added | |
1175 | ||
1176 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
1177 | |
1178 | ### Breaking Changes | |
1179 | ||
1180 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
1181 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
1182 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 1183 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 1184 | |
90ee1b18 | 1185 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
1186 | |
1187 | ### Bug fixes | |
1188 | ||
1189 | - Fix `busy` event emission on fixed pool type | |
1190 | ||
90ee1b18 | 1191 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
1192 | |
1193 | ### Bug fixes | |
1194 | ||
1195 | - Check if pool options are properly set. | |
1196 | - `busy` event is emitted on all pool types. | |
1197 | ||
90ee1b18 | 1198 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 1199 | |
f3f833ab | 1200 | ### Bug fixes |
d63d3be3 | 1201 | |
ddbeaffd | 1202 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 1203 | |
fa0f5b28 S |
1204 | ### Breaking Changes |
1205 | ||
7f685093 | 1206 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 1207 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 1208 | _Find more details on our JSDoc._ |
ddbeaffd | 1209 | |
1927ee67 APA |
1210 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
1211 | ||
ddbeaffd | 1212 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 1213 | |
ec2ccfc8 JB |
1214 | ### Pool options types declaration merge |
1215 | ||
1216 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
1217 | ||
fa0f5b28 S |
1218 | #### New `export` strategy |
1219 | ||
1220 | ```js | |
1221 | // Before | |
0eee77cb | 1222 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 1223 | // After |
0eee77cb | 1224 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
1225 | ``` |
1226 | ||
1227 | But you should always prefer just using | |
1228 | ||
1229 | ```js | |
0eee77cb | 1230 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
1231 | ``` |
1232 | ||
d3c8a1a8 S |
1233 | #### New type definitions for input data and response |
1234 | ||
6677a3d3 | 1235 | For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data. |
9606b474 | 1236 | _This is not a limitation by poolifier but Node.js._ |
d3c8a1a8 | 1237 | |
3a4b605f | 1238 | #### Public property replacements |
5c5a1fb7 | 1239 | |
3a4b605f | 1240 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 1241 | |
280c2a77 | 1242 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 1243 | |
280c2a77 S |
1244 | These properties are not intended for end users |
1245 | ||
1246 | - `id` => `nextMessageId` | |
1247 | ||
1248 | These methods are not intended for end users | |
fa0f5b28 S |
1249 | |
1250 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 1251 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
1252 | - `_execute` => `internalExecute` |
1253 | - `_chooseWorker` => `chooseWorker` | |
1254 | - `_checkAlive` => `checkAlive` | |
1255 | - `_run` => `run` | |
1256 | - `_runAsync` => `runAsync` | |
1257 | ||
90ee1b18 | 1258 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
1259 | |
1260 | ### Added | |
1261 | ||
1262 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 1263 | - Various external library patches |
0312f71a | 1264 | |
90ee1b18 | 1265 | ## [1.0.0] - 2020-01-24 |
522eea03 | 1266 | |
1267 | ### Added | |
1268 | ||
1269 | - FixedThreadPool implementation | |
1270 | - DynamicThreadPool implementation | |
0312f71a | 1271 | - WorkerThread implementation to improve developer experience |