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