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