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