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