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 | ||
093af25b JB |
10 | ### Changed |
11 | ||
12 | - Disable publication on GitHub packages registry on release until authentication issue is fixed. | |
13 | ||
bce9ffdf JB |
14 | ## [2.6.44] - 2023-09-08 |
15 | ||
4cb259d3 JB |
16 | ### Fixed |
17 | ||
18 | - Use a dedicated PAT to publish on GitHub packages registry. | |
19 | ||
20 | ### Added | |
21 | ||
22 | - Publish on GitHub packages registry on release. | |
23 | ||
24 | ### Changed | |
25 | ||
26 | - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128). | |
27 | ||
fbda1e26 JB |
28 | ## [2.6.43] - 2023-09-08 |
29 | ||
15fc82ba JB |
30 | ### Added |
31 | ||
4cb259d3 | 32 | - Publish on GitHub packages registry on release. |
15fc82ba JB |
33 | |
34 | ### Changed | |
35 | ||
4cb259d3 | 36 | - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128). |
15fc82ba | 37 | |
b47306a3 JB |
38 | ## [2.6.42] - 2023-09-06 |
39 | ||
ad11ca81 JB |
40 | ### Changed |
41 | ||
42 | - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ... | |
43 | ||
1b37751d JB |
44 | ## [2.6.41] - 2023-09-03 |
45 | ||
f3a91bac JB |
46 | ### Changed |
47 | ||
48 | - Optimize worker choice strategies implementation. | |
49 | ||
7790a494 JB |
50 | ## [2.6.40] - 2023-09-01 |
51 | ||
6fe200b4 JB |
52 | ### Fixed |
53 | ||
54 | - Do not pre-choose in WRR worker choice strategy to avoid bias. | |
68738842 | 55 | - Avoid array out of bound in worker choice strategies after worker node removal. |
6fe200b4 | 56 | |
766c7f84 JB |
57 | ## [2.6.39] - 2023-08-30 |
58 | ||
edf8ce4e JB |
59 | ### Fixed |
60 | ||
4cb259d3 | 61 | - Fix race condition in worker choice strategies at worker node info querying while not yet initialized. |
edf8ce4e | 62 | |
904a5689 JB |
63 | ## [2.6.38] - 2023-08-30 |
64 | ||
b40c4b06 JB |
65 | ### Added |
66 | ||
67 | - Bundle typescript types declaration into one file. | |
68 | ||
619f403b JB |
69 | ### Changed |
70 | ||
71 | - Improve interleaved weighted round robin worker choice strategy implementation. | |
72 | ||
5a24d71c JB |
73 | ## [2.6.37] - 2023-08-28 |
74 | ||
bdb9d712 JB |
75 | ### Fixed |
76 | ||
77 | - Ensure unused worker usage statistics are deleted at runtime. | |
78 | ||
8c0b113f JB |
79 | ### Changed |
80 | ||
81 | - Rename worker choice strategy options `choiceRetries` to `retries`. | |
574c5c8d | 82 | - Avoid unnecessary branching in worker choice strategies. |
8c0b113f | 83 | |
ba821940 JB |
84 | ## [2.6.36] - 2023-08-27 |
85 | ||
9d2d0da1 JB |
86 | ### Fixed |
87 | ||
88 | - Fix pool `execute()` arguments check. | |
89 | ||
1f0766e7 JB |
90 | ### Changed |
91 | ||
92 | - Make continuous tasks stealing algorithm less aggressive. | |
8780236f | 93 | - Fine tune tasks stealing algorithm under back pressure. |
1f0766e7 | 94 | |
ffd2c1ff JB |
95 | ## [2.6.35] - 2023-08-25 |
96 | ||
dc021bcc JB |
97 | ### Fixed |
98 | ||
99 | - Don't account worker usage statistics for tasks that have failed. | |
3baa0837 | 100 | - Fix pool information runtime and wait time median computation. |
dc021bcc JB |
101 | |
102 | ### Changed | |
103 | ||
104 | - Update simple moving average implementation to use a circular buffer. | |
105 | - Update simple moving median implementation to use a circular buffer. | |
68cbdc84 JB |
106 | - Account for stolen tasks in worker usage statistics and pool information. |
107 | ||
108 | ### Added | |
109 | ||
110 | - Continuous tasks stealing algorithm. | |
dc021bcc | 111 | |
c58bc2a1 JB |
112 | ## [2.6.34] - 2023-08-24 |
113 | ||
0bc68267 JB |
114 | ### Fixes |
115 | ||
116 | - Avoid cascading tasks stealing under back pressure. | |
117 | ||
118 | ### Changed | |
119 | ||
120 | - Add fastpath to queued tasks rescheduling. | |
121 | ||
39fb7ad0 JB |
122 | ## [2.6.33] - 2023-08-24 |
123 | ||
dd951876 JB |
124 | ### Fixed |
125 | ||
126 | - Fix queued tasks rescheduling. | |
127 | ||
ff3f866a JB |
128 | ### Changed |
129 | ||
130 | - Rename tasks queue options `queueMaxSize` to `size`. | |
131 | ||
a6b3272b | 132 | ### Added |
dd951876 | 133 | |
a6b3272b | 134 | - Task stealing scheduling algorithm if tasks queueing is enabled. |
dd951876 | 135 | |
c55c9b5d JB |
136 | ## [2.6.32] - 2023-08-23 |
137 | ||
15b176e0 JB |
138 | ### Fixed |
139 | ||
140 | - Ensure no task can be executed when the pool is destroyed. | |
141 | ||
20c6f652 JB |
142 | ### Added |
143 | ||
144 | - Add `queueMaxSize` option to tasks queue options. | |
574b351d | 145 | - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing. |
72695f86 | 146 | - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled. |
20c6f652 | 147 | |
e560a9f2 JB |
148 | ## [2.6.31] - 2023-08-20 |
149 | ||
b1aae695 JB |
150 | ### Fixed |
151 | ||
3e8611a8 | 152 | - Fix worker choice strategy retries mechanism in some edge cases. |
b1aae695 | 153 | |
94407def JB |
154 | ### Changed |
155 | ||
e695d66f | 156 | - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage. |
a71b05bc | 157 | - Remove the experimental status of the `LEAST_ELU` worker choice strategy. |
94407def | 158 | |
962b9863 JB |
159 | ## [2.6.30] - 2023-08-19 |
160 | ||
33e6bb4c JB |
161 | ### Fixed |
162 | ||
163 | - Ensure pool event `backPressure` is emitted. | |
164 | - Ensure pool event `full` is emitted only once. | |
8735b4e5 | 165 | - Ensure worker node cannot be instantiated without proper arguments. |
33e6bb4c | 166 | |
8cc4ea81 JB |
167 | ## [2.6.29] - 2023-08-18 |
168 | ||
6169563b JB |
169 | ### Fixed |
170 | ||
171 | - Fix race condition between ready and task functions worker message handling at startup. | |
5dd4043c | 172 | - Fix duplicate task function worker usage statistics computation per task function. |
db0e38ee | 173 | - Update task function worker usage statistics if and only if there's at least two different task functions. |
5bb5be17 | 174 | - Fix race condition at task function worker usage executing task computation leading to negative value. |
6169563b | 175 | |
8990357d JB |
176 | ### Added |
177 | ||
445264e8 | 178 | - 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 |
179 | - Use back pressure detection in worker choice strategies. |
180 | - Add worker choice strategies retries mechanism if no worker is eligible. | |
181 | ||
21157987 JB |
182 | ## [2.6.28] - 2023-08-16 |
183 | ||
f05ed93c JB |
184 | ### Fixed |
185 | ||
186 | - Ensure pool workers are properly initialized. | |
187 | ||
12d67776 JB |
188 | ### Added |
189 | ||
190 | - HTTP server pool examples: express-cluster, express-hybrid. | |
191 | ||
d18fccb1 JB |
192 | ### Changed |
193 | ||
194 | - Remove now useless branching in worker hot code path. | |
195 | ||
741cdb34 JB |
196 | ## [2.6.27] - 2023-08-15 |
197 | ||
50e7f498 JB |
198 | ### Fixed |
199 | ||
200 | - Add `KillHandler` type definition to exported types. | |
201 | ||
ef3891a3 JB |
202 | ### Added |
203 | ||
204 | - Add `destroy` event to pool API. | |
205 | ||
e9dc6efa JB |
206 | ## [2.6.26] - 2023-08-15 |
207 | ||
2b099bf7 JB |
208 | ### Added |
209 | ||
210 | - Add kill handler to worker options allowing to execute custom code when worker is killed. | |
ef3891a3 | 211 | - Add `listTaskFunctions()` method to pool API. |
1f4553c6 | 212 | - SMTP client pool example: nodemailer. |
2b099bf7 | 213 | |
5b726f72 JB |
214 | ## [2.6.25] - 2023-08-13 |
215 | ||
72855e92 JB |
216 | ### Added |
217 | ||
3b311539 | 218 | - HTTP server pool examples: fastify-cluster, fastify-hybrid. |
02999424 | 219 | - WebSocket server pool examples: ws-cluster, ws-hybrid. |
72855e92 | 220 | |
7aadd6e5 JB |
221 | ## [2.6.24] - 2023-08-12 |
222 | ||
7d91a8cd JB |
223 | ### Added |
224 | ||
225 | - Add array of transferable objects to the `execute()` method arguments. | |
02999424 | 226 | - WebSocket server pool examples: ws-worker_threads. |
7d91a8cd | 227 | |
6b4263b4 JB |
228 | ## [2.6.23] - 2023-08-11 |
229 | ||
3d76750a | 230 | ### Fixed |
8e0af894 | 231 | |
3d76750a | 232 | - 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 | 233 | |
3d76750a JB |
234 | ### Added |
235 | ||
236 | - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions. | |
02999424 | 237 | - HTTP server pool examples: express-worker_threads, fastify-worker_threads. |
3d76750a JB |
238 | |
239 | ## [2.6.22] - 2023-08-10 | |
9606b474 | 240 | |
3d76750a | 241 | ### Fixed |
9606b474 JB |
242 | |
243 | - Add missing `types` field to package.json `exports`. | |
244 | ||
3d76750a JB |
245 | ### Changed |
246 | ||
247 | - Structure markdown documentation (PR #811). | |
248 | ||
d9647bdd JB |
249 | ## [2.6.21] - 2023-08-03 |
250 | ||
2111ec12 JB |
251 | ### Changed |
252 | ||
253 | - Improve code documentation. | |
254 | - Code refactoring and cleanup for better maintainability and readability. | |
255 | ||
5c30b9d9 JB |
256 | ## [2.6.20] - 2023-07-21 |
257 | ||
10ecf8fd JB |
258 | ### Fixed |
259 | ||
260 | - Fix queued tasks redistribution on error task execution starvation. | |
a1763c54 | 261 | - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic. |
10ecf8fd | 262 | |
aa9eede8 JB |
263 | ### Changed |
264 | ||
7c89e6a4 | 265 | - Drastically reduce lookups by worker in the worker nodes. |
aa9eede8 | 266 | |
62485908 JB |
267 | ## [2.6.19] - 2023-07-20 |
268 | ||
2e2ef9c3 JB |
269 | ### Added |
270 | ||
271 | - Dedicated internal communication channel for worker_threads pools. | |
272 | ||
8f4c9491 JB |
273 | ## [2.6.18] - 2023-07-19 |
274 | ||
8660b972 JB |
275 | ### Changed |
276 | ||
277 | - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller. | |
278 | ||
206a3519 JB |
279 | ## [2.6.17] - 2023-07-16 |
280 | ||
b4899fae JB |
281 | ### Added |
282 | ||
1a3e01ba | 283 | - Add `listTaskFunctions()` method to worker API. |
b4899fae | 284 | |
58a06a6c JB |
285 | ## [2.6.16] - 2023-07-12 |
286 | ||
2a69b8c5 JB |
287 | ### Fixed |
288 | ||
80520ca4 | 289 | - Fix pool startup detection. |
2a69b8c5 JB |
290 | - Fix worker task functions handling. |
291 | ||
b5900b02 JB |
292 | ## [2.6.15] - 2023-07-11 |
293 | ||
19dbc45b JB |
294 | ### Added |
295 | ||
296 | - Take into account worker node readiness in worker choice strategies. | |
297 | ||
4a0db581 JB |
298 | ## [2.6.14] - 2023-07-10 |
299 | ||
87e44747 JB |
300 | ### Fixed |
301 | ||
302 | - Fix task function statistics tracking. | |
303 | ||
0265272f JB |
304 | ## [2.6.13] - 2023-07-10 |
305 | ||
968a2e8c JB |
306 | ### Added |
307 | ||
308 | - Add per task function statistics tracking. | |
782299f8 | 309 | - Add public methods to manipulate the worker task functions at runtime. |
968a2e8c | 310 | |
44c8c00f JB |
311 | ## [2.6.12] - 2023-07-09 |
312 | ||
aa4bf4b2 JB |
313 | ### Fixed |
314 | ||
315 | - Workaround import issue with `node:os` module in node 16.x.x. | |
316 | ||
b7cfced1 JB |
317 | ## [2.6.11] - 2023-07-09 |
318 | ||
d5024c00 JB |
319 | ### Fixed |
320 | ||
321 | - Fix pool readiness semantic. | |
322 | ||
f313a208 JB |
323 | ## [2.6.10] - 2023-07-08 |
324 | ||
2431bdb4 JB |
325 | ### Fixed |
326 | ||
327 | - Ensure workers are not recreated on error at pool startup. | |
328 | ||
329 | ### Added | |
330 | ||
331 | - Add `ready` and `strategy` fields to pool information. | |
332 | - 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 | 333 | - Add dynamic pool sizing checks. |
2431bdb4 | 334 | |
369d0a51 JB |
335 | ## [2.6.9] - 2023-07-07 |
336 | ||
2845f2a5 JB |
337 | ### Fixed |
338 | ||
339 | - Recreate the right worker type on uncaught exception. | |
340 | ||
341 | ### Added | |
342 | ||
343 | - Add minimum and maximum to internal measurement statistics. | |
1dcf8b7b | 344 | - Add `runTime` and `waitTime` to pool information. |
75d3401a | 345 | - Check worker inactive time only on dynamic worker. |
2845f2a5 | 346 | |
fc97d613 JB |
347 | ## [2.6.8] - 2023-07-03 |
348 | ||
92b1feaa JB |
349 | ### Fixed |
350 | ||
351 | - Brown paper bag release to fix version handling in pool information. | |
352 | ||
52d54060 JB |
353 | ## [2.6.7] - 2023-07-03 |
354 | ||
5bc91f3e JB |
355 | ### Fixed |
356 | ||
357 | - Ensure worker queued tasks at error are reassigned to other pool workers. | |
358 | ||
afe0d5bf JB |
359 | ### Added |
360 | ||
361 | - Add pool `utilization` ratio to pool information. | |
23ccf9d7 | 362 | - Add `version` to pool information. |
e5b3047d | 363 | - Add worker information to worker nodes. |
afe0d5bf | 364 | |
f42c583f JB |
365 | ## [2.6.6] - 2023-07-01 |
366 | ||
6961ca9a JB |
367 | ### Added |
368 | ||
d5e3c4ff | 369 | - Add safe helper `availableParallelism()` to help sizing the pool. |
6961ca9a | 370 | |
3749facb JB |
371 | ### Fixed |
372 | ||
373 | - Ensure message handler is only registered in worker. | |
374 | ||
6fed2513 JB |
375 | ## [2.6.5] - 2023-06-27 |
376 | ||
c72f6987 JB |
377 | ### Known issues |
378 | ||
70726c28 | 379 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 |
c72f6987 JB |
380 | |
381 | ### Fixed | |
382 | ||
383 | - Artificial version bump to 2.6.5 to workaround publication issue. | |
d5e3c4ff | 384 | - Ensure cluster pool `destroy()` gracefully shutdowns worker's server. |
c72f6987 JB |
385 | - Ensure pool event is emitted before task error promise rejection. |
386 | - Fix queued tasks count computation. | |
387 | ||
388 | ### Removed | |
389 | ||
2fbe1783 | 390 | - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC. |
c72f6987 | 391 | |
6426631b JB |
392 | ## [2.6.4] - 2023-06-27 |
393 | ||
941f9a7c JB |
394 | ### Known issues |
395 | ||
70726c28 | 396 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 |
941f9a7c | 397 | |
2c039e43 JB |
398 | ### Fixed |
399 | ||
d5e3c4ff | 400 | - Ensure cluster pool `destroy()` gracefully shutdowns worker's server. |
2c039e43 | 401 | - Ensure pool event is emitted before task error promise rejection. |
9c16fb4b | 402 | - Fix queued tasks count computation. |
2c039e43 | 403 | |
941f9a7c JB |
404 | ### Removed |
405 | ||
2fbe1783 | 406 | - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC. |
941f9a7c | 407 | |
bc1b0765 JB |
408 | ## [2.6.3] - 2023-06-19 |
409 | ||
a6a2dc4c JB |
410 | ### Fixed |
411 | ||
412 | - Ensure no tasks are queued when trying to soft kill a dynamic worker. | |
f0d7f803 | 413 | - Update strategies internals after statistics computation. |
a6a2dc4c | 414 | |
7b56f532 JB |
415 | ### Changed |
416 | ||
417 | - Optimize O(1) queue implementation. | |
418 | ||
b628596c JB |
419 | ## [2.6.2] - 2023-06-12 |
420 | ||
a9e89d00 JB |
421 | ### Fixed |
422 | ||
423 | - Fix new worker use after creation in dynamic pool given the current worker choice strategy. | |
424 | ||
4368a898 JB |
425 | ## [2.6.1] - 2023-06-10 |
426 | ||
931d43e2 JB |
427 | ### Added |
428 | ||
13ab5b87 | 429 | - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md). |
931d43e2 | 430 | |
f1c06930 JB |
431 | ### Fixed |
432 | ||
433 | - Fix average statistics computation: ensure failed tasks are not accounted. | |
434 | ||
16671b07 JB |
435 | ## [2.6.0] - 2023-06-09 |
436 | ||
a1347286 JB |
437 | ### Added |
438 | ||
5af9c0f7 | 439 | - Add `LEAST_ELU` worker choice strategy (experimental). |
9adcefab | 440 | - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy. |
a1347286 | 441 | |
1c6fe997 JB |
442 | ### Changed |
443 | ||
444 | - Refactor pool worker node usage internals. | |
477f48e7 | 445 | - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed. |
f63a9dda | 446 | - Breaking change: pool information `info` property object fields have been renamed. |
1c6fe997 JB |
447 | |
448 | ### Fixed | |
449 | ||
450 | - Fix wait time accounting. | |
451 | - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time. | |
452 | - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks. | |
453 | ||
aa07d6ee JB |
454 | ## [2.5.4] - 2023-06-07 |
455 | ||
b6b32453 JB |
456 | ### Added |
457 | ||
458 | - Add Event Loop Utilization (ELU) statistics to worker tasks usage. | |
459 | ||
460 | ### Changed | |
461 | ||
462 | - Compute statistics at the worker level only if needed. | |
2fbe1783 | 463 | - Add `worker_threads` options to thread pool options. |
b6b32453 | 464 | |
272d4d8f JB |
465 | ### Fixed |
466 | ||
467 | - Make the `LEAST_BUSY` strategy only relies on task runtime. | |
468 | ||
ed47fb3d JB |
469 | ## [2.5.3] - 2023-06-04 |
470 | ||
89a4abfd JB |
471 | ### Changed |
472 | ||
473 | - Refine pool information content. | |
b4213b7f | 474 | - Limit pool internals public exposure. |
89a4abfd | 475 | |
8a9febf5 JB |
476 | ## [2.5.2] - 2023-06-02 |
477 | ||
91ee39ed JB |
478 | ### Added |
479 | ||
480 | - Add `taskError` pool event for task execution error. | |
6b27d407 | 481 | - Add pool information `info` property to pool. |
91ee39ed JB |
482 | - Emit pool information on `busy` and `full` pool events. |
483 | ||
8babb151 JB |
484 | ## [2.5.1] - 2023-06-01 |
485 | ||
0e05c4dc JB |
486 | ### Added |
487 | ||
1f68cede | 488 | - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`. |
91ee39ed | 489 | - Add `error` pool event for uncaught worker error. |
0e05c4dc | 490 | |
a8766181 JB |
491 | ## [2.5.0] - 2023-05-31 |
492 | ||
e4543b14 JB |
493 | ### Added |
494 | ||
495 | - Switch pool event emitter to `EventEmitterAsyncResource`. | |
6da80d38 | 496 | - Add tasks wait time accounting in per worker tasks usage. |
5af9c0f7 | 497 | - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental). |
e4543b14 JB |
498 | |
499 | ### Changed | |
500 | ||
501 | - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`. | |
502 | ||
570efb11 JB |
503 | ## [2.4.14] - 2023-05-09 |
504 | ||
b0f28bad JB |
505 | ### Fixed |
506 | ||
507 | - Ensure no undefined task runtime can land in the tasks history. | |
508 | - Fix median computation implementation once again. | |
509 | ||
110b6d13 JB |
510 | ### Added |
511 | ||
512 | - Unit tests for median and queue implementations. | |
513 | ||
72584880 JB |
514 | ## [2.4.13] - 2023-05-08 |
515 | ||
b0d6ed8f JB |
516 | ### Fixed |
517 | ||
e3058615 | 518 | - Fix worker choice strategy options validation. |
b0d6ed8f JB |
519 | - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission. |
520 | ||
06140c32 JB |
521 | ## [2.4.12] - 2023-05-06 |
522 | ||
a86b6df1 JB |
523 | ### Added |
524 | ||
525 | - Support multiple task functions per worker. | |
08f3f44c | 526 | - Add custom worker weights support to worker choice strategies options. |
a86b6df1 | 527 | |
29ee7e9a JB |
528 | ### Changed |
529 | ||
530 | - Use O(1) queue implementation for tasks queueing. | |
531 | ||
0682ba15 JB |
532 | ### Fixed |
533 | ||
534 | - Fix median computation implementation. | |
535 | - Fix fair share worker choice strategy internals update. | |
536 | ||
936d53ec JB |
537 | ## [2.4.11] - 2023-04-23 |
538 | ||
cb70b19d JB |
539 | ### Changed |
540 | ||
541 | - Optimize free worker finding in worker choice strategies. | |
542 | ||
15bb637a JB |
543 | ## [2.4.10] - 2023-04-15 |
544 | ||
ef41a6e6 JB |
545 | ### Fixed |
546 | ||
82ea6492 | 547 | - Fix typescript type definition for task function: ensure the input data is optional. |
ef41a6e6 JB |
548 | - Fix typescript type definition for pool execute(): ensure the input data is optional. |
549 | ||
181eb2b4 JB |
550 | ## [2.4.9] - 2023-04-15 |
551 | ||
a20f0ba5 JB |
552 | ### Added |
553 | ||
554 | - Add tasks queue enablement runtime setter to pool. | |
555 | - Add tasks queue options runtime setter to pool. | |
556 | - Add worker choice strategy options runtime setter to pool. | |
557 | ||
558 | ### Changed | |
559 | ||
560 | - Remove the tasks queuing experimental status. | |
561 | ||
d4aeae5a JB |
562 | ### Fixed |
563 | ||
82ea6492 | 564 | - Fix task function type definition and validation. |
2fc5cae3 | 565 | - Fix worker choice strategy options handling. |
d4aeae5a | 566 | |
1d9e7023 JB |
567 | ## [2.4.8] - 2023-04-12 |
568 | ||
f9b4bbf8 JB |
569 | ### Fixed |
570 | ||
571 | - Fix message between main worker and worker type definition for tasks. | |
572 | - Fix code documentation. | |
573 | ||
12ae3210 JB |
574 | ## [2.4.7] - 2023-04-11 |
575 | ||
7171d33f JB |
576 | ### Added |
577 | ||
578 | - Add worker tasks queue options to pool options. | |
579 | ||
e8bd29ce JB |
580 | ### Fixed |
581 | ||
582 | - Fix missing documentation. | |
583 | ||
42c7bc10 JB |
584 | ## [2.4.6] - 2023-04-10 |
585 | ||
681196cc JB |
586 | ### Fixed |
587 | ||
588 | - Ensure one task at a time is executed per worker with tasks queueing enabled. | |
1c6fe997 | 589 | - Properly count worker executing tasks with tasks queueing enabled. |
681196cc | 590 | |
54d360e3 JB |
591 | ## [2.4.5] - 2023-04-09 |
592 | ||
3fafb1b2 JB |
593 | ### Added |
594 | ||
9e775f96 JB |
595 | - Use monotonic high resolution timer for worker tasks runtime. |
596 | - Add worker tasks median runtime to statistics. | |
ff733df7 | 597 | - Add worker tasks queue (experimental). |
3fafb1b2 | 598 | |
92fa3eb6 JB |
599 | ## [2.4.4] - 2023-04-07 |
600 | ||
aee46736 JB |
601 | ### Added |
602 | ||
603 | - Add `PoolEvents` enumeration and `PoolEvent` type. | |
604 | ||
36b5e78f JB |
605 | ### Fixed |
606 | ||
ff0c2b3e | 607 | - Destroy worker only on alive check. |
36b5e78f | 608 | |
9fb0f324 JB |
609 | ## [2.4.3] - 2023-04-07 |
610 | ||
28cf3617 JB |
611 | ### Fixed |
612 | ||
613 | - Fix typedoc generation with inheritance. | |
614 | ||
848f0f27 JB |
615 | ## [2.4.2] - 2023-04-06 |
616 | ||
164d950a JB |
617 | ### Added |
618 | ||
619 | - Add `full` event to dynamic pool. | |
32417142 | 620 | - Keep worker choice strategy in memory for conditional reuse. |
164d950a | 621 | |
78ab2555 JB |
622 | ### Fixed |
623 | ||
624 | - Fix possible negative worker key at worker removal in worker choice strategies. | |
625 | ||
79aafe9f JB |
626 | ## [2.4.1] - 2023-04-05 |
627 | ||
9cd39dd4 JB |
628 | ### Changed |
629 | ||
630 | - Optimize worker choice strategy for dynamic pool. | |
631 | ||
965415bb JB |
632 | ### Fixed |
633 | ||
634 | - Ensure dynamic pool does not alter worker choice strategy expected behavior. | |
635 | ||
d8b60b1c JB |
636 | ## [2.4.0] - 2023-04-04 |
637 | ||
c6bd2650 JB |
638 | ### Added |
639 | ||
640 | - Add `LESS_BUSY` worker choice strategy. | |
641 | ||
642 | ### Changed | |
643 | ||
644 | - Optimize worker storage in pool. | |
645 | - Optimize worker alive status check. | |
646 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
647 | - Optimize `LESS_USED` worker choice strategy. | |
648 | - Update benchmarks versus external threads pools. | |
649 | - Optimize tasks usage statistics requirements for worker choice strategy. | |
650 | ||
651 | ### Fixed | |
652 | ||
653 | - Ensure trimmable characters are checked at pool initialization. | |
654 | - Fix message id integer overflow. | |
655 | - Fix pool worker removal in worker choice strategy internals. | |
656 | - Fix package publication with pnpm. | |
657 | ||
d0a3f018 JB |
658 | ## [2.4.0-3] - 2023-04-04 |
659 | ||
b2ede285 JB |
660 | ### Added |
661 | ||
662 | - Add `LESS_BUSY` worker choice strategy. | |
663 | ||
664 | ### Changed | |
665 | ||
666 | - Optimize worker storage in pool. | |
667 | - Optimize worker alive status check. | |
668 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
669 | - Optimize `LESS_USED` worker choice strategy. | |
670 | - Update benchmarks versus external threads pools. | |
671 | ||
672 | ### Fixed | |
673 | ||
674 | - Ensure trimmable characters are checked at pool initialization. | |
675 | - Fix message id integer overflow. | |
676 | - Fix pool worker removal in worker choice strategy internals. | |
677 | - Fix package publication with pnpm. | |
678 | ||
a015ea40 JB |
679 | ## [2.4.0-2] - 2023-04-03 |
680 | ||
698f4bbc JB |
681 | ### Added |
682 | ||
683 | - Add `LESS_BUSY` worker choice strategy. | |
684 | ||
685 | ### Changed | |
686 | ||
687 | - Optimize worker storage in pool. | |
688 | - Optimize worker alive status check. | |
689 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
690 | - Optimize `LESS_USED` worker choice strategy. | |
691 | ||
692 | ### Fixed | |
693 | ||
694 | - Ensure trimmable characters are checked at pool initialization. | |
695 | - Fix message id integer overflow. | |
696 | - Fix pool worker removal in worker choice strategy internals. | |
697 | - Fix package publication with pnpm. | |
698 | ||
8fe15920 JB |
699 | ## [2.4.0-1] - 2023-04-03 |
700 | ||
5b301c28 JB |
701 | ### Added |
702 | ||
703 | - Add `LESS_BUSY` worker choice strategy. | |
704 | ||
705 | ### Changed | |
706 | ||
707 | - Optimize worker storage in pool. | |
708 | - Optimize worker alive status check. | |
709 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
710 | - Optimize `LESS_USED` worker choice strategy. | |
711 | ||
712 | ### Fixed | |
713 | ||
714 | - Ensure trimmable characters are checked at pool initialization. | |
715 | - Fix message id integer overflow. | |
716 | - Fix pool worker removal in worker choice strategy internals. | |
717 | ||
2fb9ca9c JB |
718 | ## [2.4.0-0] - 2023-04-03 |
719 | ||
168c526f JB |
720 | ### Added |
721 | ||
722 | - Add `LESS_BUSY` worker choice strategy. | |
723 | ||
1d71a908 JB |
724 | ### Changed |
725 | ||
ffcbbad8 | 726 | - Optimize worker storage in pool. |
1d71a908 | 727 | - Optimize worker alive status check. |
65a60b3b | 728 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 729 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 730 | |
ffcbbad8 JB |
731 | ### Fixed |
732 | ||
733 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 734 | - Fix message id integer overflow. |
97a2abc3 | 735 | - Fix pool worker removal in worker choice strategy internals. |
ffcbbad8 | 736 | |
08372738 JB |
737 | ## [2.3.10] - 2023-03-18 |
738 | ||
710826bc JB |
739 | ### Fixed |
740 | ||
9606b474 | 741 | - Fix package.json `exports` syntax for ESM and CommonJS. |
710826bc JB |
742 | |
743 | ### Changed | |
744 | ||
745 | - Permit SemVer pre-release publication. | |
76e5ac6f | 746 | |
e4796ecd JB |
747 | ## [2.3.10-2] - 2023-03-18 |
748 | ||
6abad580 JB |
749 | ### Fixed |
750 | ||
9606b474 | 751 | - Fix package.json `exports` syntax for ESM and CommonJS. |
6abad580 | 752 | |
a2ee98cc JB |
753 | ## [2.3.10-1] - 2023-03-18 |
754 | ||
7e060cee JB |
755 | ### Changed |
756 | ||
90483887 | 757 | - Permit SemVer pre-release publication. |
7e060cee | 758 | |
c81bfafb JB |
759 | ## [2.3.10-0] - 2023-03-18 |
760 | ||
fe18768d JB |
761 | ### Fixed |
762 | ||
9606b474 | 763 | - Fix package.json `exports` syntax for ESM and CommonJS. |
fe18768d | 764 | |
d7b78217 JB |
765 | ## [2.3.9] - 2023-03-18 |
766 | ||
ed6dd37f JB |
767 | ### Changed |
768 | ||
769 | - Introduce ESM module support along with CommonJS one. | |
770 | ||
771 | ### Fixed | |
772 | ||
773 | - Fix brown paper bag bug referencing the same object literal. | |
774 | ||
68e2ad86 JB |
775 | ## [2.3.8] - 2023-03-18 |
776 | ||
ca6c7d70 JB |
777 | ### Changed |
778 | ||
779 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
780 | - Switch to TypeScript 5.x.x. |
781 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 782 | - Switch to TSDoc syntax. |
fbdedeb9 | 783 | - Enforce conventional commits. |
ca6c7d70 | 784 | |
d15211d4 JB |
785 | ### Fixed |
786 | ||
787 | - Fix random integer generator. | |
fbdedeb9 | 788 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 789 | |
995705ea JB |
790 | ## [2.3.7] - 2022-10-23 |
791 | ||
b953022b JB |
792 | ### Changed |
793 | ||
794 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
795 | - Switch to ts-standard linter configuration on TypeScript code. |
796 | ||
797 | ### Fixed | |
798 | ||
799 | - Fixed missing async on pool execute method. | |
800 | - Fixed typing in TypeScript example. | |
801 | - Fixed types in unit tests. | |
b953022b | 802 | |
3b9f6953 JB |
803 | ## [2.3.6] - 2022-10-22 |
804 | ||
f80cead4 JB |
805 | ### Changed |
806 | ||
807 | - Cleanup pool attributes and methods. | |
808 | - Refine error types thrown. | |
809 | ||
810 | ### Fixed | |
811 | ||
812 | - Fix continuous integration build on windows. | |
813 | - Fix code coverage reporting by using c8 instead of nyc. | |
814 | ||
efc22107 JB |
815 | ## [2.3.5] - 2022-10-21 |
816 | ||
7a6a0a96 JB |
817 | ### Changed |
818 | ||
a05c10de JB |
819 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
820 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 821 | |
b4904890 JB |
822 | ### Fixed |
823 | ||
824 | - Fix missed pool event emitter type export. | |
825 | - Fix typedoc documentation generation. | |
826 | ||
a875f8d1 JB |
827 | ## [2.3.4] - 2022-10-17 |
828 | ||
73cda448 JB |
829 | ### Added |
830 | ||
831 | - Fully automate release process with release-it. | |
832 | ||
45a5a54c JB |
833 | ### Changed |
834 | ||
73cda448 | 835 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 836 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 837 | |
90ee1b18 | 838 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
839 | |
840 | ### Added | |
841 | ||
842 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
843 | ||
90ee1b18 | 844 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
845 | |
846 | ### Changed | |
847 | ||
848 | - Optimize fair share worker selection strategy implementation. | |
849 | ||
850 | ### Fixed | |
851 | ||
852 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
853 | ||
90ee1b18 | 854 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
855 | |
856 | ### Added | |
857 | ||
858 | - Pool worker choice strategies: | |
859 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
860 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
861 | ||
90ee1b18 | 862 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
863 | |
864 | ### Fixed | |
865 | ||
866 | - Fixed `README.md` file. | |
867 | ||
90ee1b18 | 868 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 869 | |
bdaf31cd JB |
870 | ### Added |
871 | ||
872 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 873 | |
90ee1b18 | 874 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
875 | |
876 | ### Breaking Changes | |
877 | ||
9606b474 | 878 | - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version. |
7e0d447f | 879 | |
90ee1b18 | 880 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
881 | |
882 | ### Added | |
883 | ||
884 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
885 | |
886 | ### Breaking Changes | |
887 | ||
888 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
889 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
890 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 891 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 892 | |
90ee1b18 | 893 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
894 | |
895 | ### Bug fixes | |
896 | ||
897 | - Fix `busy` event emission on fixed pool type | |
898 | ||
90ee1b18 | 899 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
900 | |
901 | ### Bug fixes | |
902 | ||
903 | - Check if pool options are properly set. | |
904 | - `busy` event is emitted on all pool types. | |
905 | ||
90ee1b18 | 906 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 907 | |
f3f833ab | 908 | ### Bug fixes |
d63d3be3 | 909 | |
ddbeaffd | 910 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 911 | |
fa0f5b28 S |
912 | ### Breaking Changes |
913 | ||
7f685093 | 914 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 915 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 916 | _Find more details on our JSDoc._ |
ddbeaffd | 917 | |
1927ee67 APA |
918 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
919 | ||
ddbeaffd | 920 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 921 | |
ec2ccfc8 JB |
922 | ### Pool options types declaration merge |
923 | ||
924 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
925 | ||
fa0f5b28 S |
926 | #### New `export` strategy |
927 | ||
928 | ```js | |
929 | // Before | |
0eee77cb | 930 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 931 | // After |
0eee77cb | 932 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
933 | ``` |
934 | ||
935 | But you should always prefer just using | |
936 | ||
937 | ```js | |
0eee77cb | 938 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
939 | ``` |
940 | ||
d3c8a1a8 S |
941 | #### New type definitions for input data and response |
942 | ||
6677a3d3 | 943 | For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data. |
9606b474 | 944 | _This is not a limitation by poolifier but Node.js._ |
d3c8a1a8 | 945 | |
3a4b605f | 946 | #### Public property replacements |
5c5a1fb7 | 947 | |
3a4b605f | 948 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 949 | |
280c2a77 | 950 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 951 | |
280c2a77 S |
952 | These properties are not intended for end users |
953 | ||
954 | - `id` => `nextMessageId` | |
955 | ||
956 | These methods are not intended for end users | |
fa0f5b28 S |
957 | |
958 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 959 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
960 | - `_execute` => `internalExecute` |
961 | - `_chooseWorker` => `chooseWorker` | |
962 | - `_checkAlive` => `checkAlive` | |
963 | - `_run` => `run` | |
964 | - `_runAsync` => `runAsync` | |
965 | ||
90ee1b18 | 966 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
967 | |
968 | ### Added | |
969 | ||
970 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 971 | - Various external library patches |
0312f71a | 972 | |
90ee1b18 | 973 | ## [1.0.0] - 2020-01-24 |
522eea03 | 974 | |
975 | ### Added | |
976 | ||
977 | - FixedThreadPool implementation | |
978 | - DynamicThreadPool implementation | |
0312f71a | 979 | - WorkerThread implementation to improve developer experience |