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