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