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