]>
Commit | Line | Data |
---|---|---|
1 | # Changelog | |
2 | ||
3 | All notable changes to this project will be documented in this file. | |
4 | ||
5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), | |
6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). | |
7 | ||
8 | ## [Unreleased] | |
9 | ||
10 | ## [3.1.18] - 2024-01-06 | |
11 | ||
12 | ### Fixed | |
13 | ||
14 | - Fix dynamic pool with minimum number of workers set to zero: [#1748](https://github.com/poolifier/poolifier/issues/1748). | |
15 | ||
16 | ## [3.1.17] - 2024-01-05 | |
17 | ||
18 | ### Changed | |
19 | ||
20 | - Improve performance by clean up unneeded condition checks on hot code paths. | |
21 | ||
22 | ## [3.1.16] - 2024-01-03 | |
23 | ||
24 | ### Fixed | |
25 | ||
26 | - Add missing type to TS type definitions. | |
27 | ||
28 | ## [3.1.15] - 2024-01-02 | |
29 | ||
30 | ### Fixed | |
31 | ||
32 | - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821). | |
33 | ||
34 | ## [3.1.15-0] - 2024-01-02 | |
35 | ||
36 | ### Fixed | |
37 | ||
38 | - Fix CommonJS support with TypeScript: [#1821](https://github.com/poolifier/poolifier/issues/1821). | |
39 | ||
40 | ## [3.1.14] - 2024-01-01 | |
41 | ||
42 | ### Fixed | |
43 | ||
44 | - Properly handle dynamic pool with zero minimum size. | |
45 | ||
46 | ## [3.1.13] - 2023-12-30 | |
47 | ||
48 | ### Changed | |
49 | ||
50 | - Reduce branching in several hot code paths. | |
51 | - Use faster object cloning implementation. | |
52 | ||
53 | ## [3.1.12] - 2023-12-27 | |
54 | ||
55 | ### Fixed | |
56 | ||
57 | - Fix tasks redistribution triggers at pool destroying. | |
58 | ||
59 | ### Changed | |
60 | ||
61 | - Switch TypeScript module resolution to Node16. | |
62 | ||
63 | ## [3.1.12-0] - 2023-12-27 | |
64 | ||
65 | ### Fixed | |
66 | ||
67 | - Fix tasks redistribution triggers at pool destroying. | |
68 | ||
69 | ## [3.1.11] - 2023-12-24 | |
70 | ||
71 | ### Fixed | |
72 | ||
73 | - Avoid worker node cross tasks stealing. | |
74 | - Ensure only half the pool worker nodes can steal tasks. | |
75 | ||
76 | ## [3.1.10] - 2023-12-23 | |
77 | ||
78 | ### Changed | |
79 | ||
80 | - Avoid useless branching on pool type. | |
81 | ||
82 | ## [3.1.9] - 2023-12-22 | |
83 | ||
84 | ### Changed | |
85 | ||
86 | - Readd ThreadPoolOptions and ClusterPoolOptions TS type aliases to PoolOptions. | |
87 | ||
88 | ## [3.1.8] - 2023-12-21 | |
89 | ||
90 | ### Fixed | |
91 | ||
92 | - Fix default worker weight computation. | |
93 | - Fix possible null exception at pool destroying. | |
94 | ||
95 | ## [3.1.7] - 2023-12-20 | |
96 | ||
97 | ### Fixed | |
98 | ||
99 | - Ensure worker choice strategies implementation wait for worker node readiness: [#1748](https://github.com/poolifier/poolifier/issues/1748). | |
100 | ||
101 | ## [3.1.6] - 2023-12-18 | |
102 | ||
103 | ### Fixed | |
104 | ||
105 | - Fix pool destroying with tasks queuing enabled. | |
106 | ||
107 | ## [3.1.5] - 2023-12-18 | |
108 | ||
109 | ### Added | |
110 | ||
111 | - Add queued tasks end timeout support to worker node termination. | |
112 | ||
113 | ## [3.1.4] - 2023-12-18 | |
114 | ||
115 | ### Fixed | |
116 | ||
117 | - Make more robust the fix for possible null exception at handling task execution response. | |
118 | ||
119 | ## [3.1.3] - 2023-12-17 | |
120 | ||
121 | ### Fixed | |
122 | ||
123 | - Fix possible null exception at handling task execution response. | |
124 | ||
125 | ## [3.1.2] - 2023-12-17 | |
126 | ||
127 | ### Fixed | |
128 | ||
129 | - Wait for queued tasks to end at worker node termination. | |
130 | ||
131 | ## [3.1.1] - 2023-12-16 | |
132 | ||
133 | ### Fixed | |
134 | ||
135 | - Fix pool options TS type definition. | |
136 | ||
137 | ## [3.1.0] - 2023-12-16 | |
138 | ||
139 | ### Changed | |
140 | ||
141 | - TypeScript breaking change: merge ThreadPoolOptions and ClusterPoolOptions types into PoolOptions type. | |
142 | ||
143 | ## [3.0.14] - 2023-12-13 | |
144 | ||
145 | ### Fixed | |
146 | ||
147 | - Fix possible null exception with worker_threads pools. | |
148 | ||
149 | ## [3.0.13] - 2023-12-12 | |
150 | ||
151 | ### Fixed | |
152 | ||
153 | - Ensure worker choice strategy wait for worker nodes readiness. | |
154 | ||
155 | ### Changed | |
156 | ||
157 | - Remove infinite retries support in worker choice strategy to avoid configuration leading to possible infinite recursion or loop. | |
158 | ||
159 | ## [3.0.12] - 2023-12-12 | |
160 | ||
161 | ### Changed | |
162 | ||
163 | - Add infinite retries support in worker choice strategy. | |
164 | ||
165 | ## [3.0.11] - 2023-12-11 | |
166 | ||
167 | ### Fixed | |
168 | ||
169 | - Ensure pool asynchronous resource properly track tasks execution. | |
170 | ||
171 | ## [3.0.10] - 2023-12-08 | |
172 | ||
173 | ### Changed | |
174 | ||
175 | - Add a fastpath when tasks stealing or redistribution is impossible. | |
176 | ||
177 | ## [3.0.9] - 2023-11-26 | |
178 | ||
179 | ### Fixed | |
180 | ||
181 | - Remove all pool events listener at pool destroying. | |
182 | - Remove all worker node events listener at worker node destroying. | |
183 | - Fix worker node event emitter listeners handling memory leak at pool options runtime change. | |
184 | ||
185 | ## [3.0.8] - 2023-11-25 | |
186 | ||
187 | ### Fixed | |
188 | ||
189 | - Ensure continuous tasks stealing on idle start at worker node idling. | |
190 | ||
191 | ## [3.0.7] - 2023-11-24 | |
192 | ||
193 | ### Changed | |
194 | ||
195 | - Make continuous tasks stealing start at worker node idling. | |
196 | ||
197 | ## [3.0.6] - 2023-11-24 | |
198 | ||
199 | ### Fixed | |
200 | ||
201 | - Ensure pool statuses are checked at initialization, `start()` or `destroy()`. | |
202 | - Ensure pool `ready` event can be emitted after several `start()/destroy()` cycles. | |
203 | ||
204 | ## [3.0.5] - 2023-10-27 | |
205 | ||
206 | ### Fixed | |
207 | ||
208 | - Ensure pool `ready` event can be emitted only once. | |
209 | ||
210 | ## [3.0.4] - 2023-10-20 | |
211 | ||
212 | ### Changed | |
213 | ||
214 | - Switch to Bencher for benchmarking: [https://bencher.dev/perf/poolifier](https://bencher.dev/perf/poolifier). | |
215 | - Use builtin retry mechanism in worker choice strategies instead of custom one. | |
216 | ||
217 | ## [3.0.3] - 2023-10-19 | |
218 | ||
219 | ### Fixed | |
220 | ||
221 | - Avoid null exception at sending message to worker. | |
222 | - Avoid null exception at checking worker node readiness. | |
223 | ||
224 | ## [3.0.2] - 2023-10-17 | |
225 | ||
226 | ### Fixed | |
227 | ||
228 | - Fix race condition at dynamic worker node task assignment and scheduled removal. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468) and [#1496](https://github.com/poolifier/poolifier/issues/1496). | |
229 | ||
230 | ## [3.0.1] - 2023-10-16 | |
231 | ||
232 | ### Fixed | |
233 | ||
234 | - Workaround possible race condition at work nodes array element removal and querying. See issue [#1468](https://github.com/poolifier/poolifier/issues/1468). | |
235 | ||
236 | ### Changed | |
237 | ||
238 | - Switch the worker node eventing code to `EventTarget` API. | |
239 | ||
240 | ## [3.0.0] - 2023-10-08 | |
241 | ||
242 | ### Changed | |
243 | ||
244 | - Remove Node.js 16.x.x (EOL) support. | |
245 | ||
246 | ## [2.7.5] - 2023-10-03 | |
247 | ||
248 | ### Changed | |
249 | ||
250 | - Use `EventEmitterAsyncResource` type from `@types/node` for pool event emitter. TypeScript users will need to update to latest `@types/node` version. | |
251 | ||
252 | ## [2.7.4] - 2023-09-25 | |
253 | ||
254 | ### Fixed | |
255 | ||
256 | - Fix source maps (bundler issue). | |
257 | ||
258 | ## [2.7.3] - 2023-09-24 | |
259 | ||
260 | ### Changed | |
261 | ||
262 | - Convert pool event emitter to event emitter async resource. | |
263 | ||
264 | ## [2.7.2] - 2023-09-23 | |
265 | ||
266 | ### Changed | |
267 | ||
268 | - Add source maps to npm package to ease debugging. | |
269 | ||
270 | ### Added | |
271 | ||
272 | - Continuous benchmarking versus other worker pools: [https://poolifier.github.io/benchmark](https://poolifier.github.io/benchmark). | |
273 | ||
274 | ## [2.7.1] - 2023-09-20 | |
275 | ||
276 | ### Fixed | |
277 | ||
278 | - Ensure worker message listener used one time are removed after usage. | |
279 | ||
280 | ## [2.7.0] - 2023-09-19 | |
281 | ||
282 | ### Fixed | |
283 | ||
284 | - Fix task stealing related tasks queue options handling at runtime. | |
285 | ||
286 | ### Changed | |
287 | ||
288 | - Rename `listTaskFunctions()` to `listTaskFunctionNames()` in pool and worker API. | |
289 | ||
290 | ### Added | |
291 | ||
292 | - Add `hasTaskFunction()`, `addTaskFunction()`, `removeTaskFunction()`, `setDefaultTaskFunction()` methods to pool API: [PR #1148](https://github.com/poolifier/poolifier/pull/1148). | |
293 | - Stricter worker constructor arguments validation. | |
294 | ||
295 | ## [2.6.45] - 2023-09-17 | |
296 | ||
297 | ### Changed | |
298 | ||
299 | - Disable publication on GitHub packages registry on release until authentication issue is fixed. | |
300 | ||
301 | ### Added | |
302 | ||
303 | - Add `startWorkers` to pool options to whether start the minimum number of workers at pool initialization or not. | |
304 | - Add `start()` method to pool API to start the minimum number of workers. | |
305 | - Add `taskStealing` and `tasksStealingOnPressure` to tasks queue options to whether enable task stealing or not and whether enable tasks stealing under back pressure or not. | |
306 | - Continuous internal benchmarking: [https://poolifier.github.io/benchmark-results/dev/bench](https://poolifier.github.io/benchmark-results/dev/bench). | |
307 | ||
308 | ## [2.6.44] - 2023-09-08 | |
309 | ||
310 | ### Fixed | |
311 | ||
312 | - Use a dedicated PAT to publish on GitHub packages registry. | |
313 | ||
314 | ### Added | |
315 | ||
316 | - Publish on GitHub packages registry on release. | |
317 | ||
318 | ### Changed | |
319 | ||
320 | - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128). | |
321 | ||
322 | ## [2.6.43] - 2023-09-08 | |
323 | ||
324 | ### Added | |
325 | ||
326 | - Publish on GitHub packages registry on release. | |
327 | ||
328 | ### Changed | |
329 | ||
330 | - Switch from rome to biome: [PR #1128](https://github.com/poolifier/poolifier/pull/1128). | |
331 | ||
332 | ## [2.6.42] - 2023-09-06 | |
333 | ||
334 | ### Changed | |
335 | ||
336 | - Optimize hot code paths implementation: avoid unnecessary branching, add and use optimized helpers (min, max), use reduce() array helper, ... | |
337 | ||
338 | ## [2.6.41] - 2023-09-03 | |
339 | ||
340 | ### Changed | |
341 | ||
342 | - Optimize worker choice strategies implementation. | |
343 | ||
344 | ## [2.6.40] - 2023-09-01 | |
345 | ||
346 | ### Fixed | |
347 | ||
348 | - Do not pre-choose in WRR worker choice strategy to avoid bias. | |
349 | - Avoid array out of bound in worker choice strategies after worker node removal. | |
350 | ||
351 | ## [2.6.39] - 2023-08-30 | |
352 | ||
353 | ### Fixed | |
354 | ||
355 | - Fix race condition in worker choice strategies at worker node info querying while not yet initialized. | |
356 | ||
357 | ## [2.6.38] - 2023-08-30 | |
358 | ||
359 | ### Added | |
360 | ||
361 | - Bundle typescript types declaration into one file. | |
362 | ||
363 | ### Changed | |
364 | ||
365 | - Improve interleaved weighted round robin worker choice strategy implementation. | |
366 | ||
367 | ## [2.6.37] - 2023-08-28 | |
368 | ||
369 | ### Fixed | |
370 | ||
371 | - Ensure unused worker usage statistics are deleted at runtime. | |
372 | ||
373 | ### Changed | |
374 | ||
375 | - Rename worker choice strategy options `choiceRetries` to `retries`. | |
376 | - Avoid unnecessary branching in worker choice strategies. | |
377 | ||
378 | ## [2.6.36] - 2023-08-27 | |
379 | ||
380 | ### Fixed | |
381 | ||
382 | - Fix pool `execute()` arguments check. | |
383 | ||
384 | ### Changed | |
385 | ||
386 | - Make continuous tasks stealing algorithm less aggressive. | |
387 | - Fine tune tasks stealing algorithm under back pressure. | |
388 | ||
389 | ## [2.6.35] - 2023-08-25 | |
390 | ||
391 | ### Fixed | |
392 | ||
393 | - Don't account worker usage statistics for tasks that have failed. | |
394 | - Fix pool information runtime and wait time median computation. | |
395 | ||
396 | ### Changed | |
397 | ||
398 | - Update simple moving average implementation to use a circular buffer. | |
399 | - Update simple moving median implementation to use a circular buffer. | |
400 | - Account for stolen tasks in worker usage statistics and pool information. | |
401 | ||
402 | ### Added | |
403 | ||
404 | - Continuous tasks stealing algorithm. | |
405 | ||
406 | ## [2.6.34] - 2023-08-24 | |
407 | ||
408 | ### Fixes | |
409 | ||
410 | - Avoid cascading tasks stealing under back pressure. | |
411 | ||
412 | ### Changed | |
413 | ||
414 | - Add fastpath to queued tasks rescheduling. | |
415 | ||
416 | ## [2.6.33] - 2023-08-24 | |
417 | ||
418 | ### Fixed | |
419 | ||
420 | - Fix queued tasks rescheduling. | |
421 | ||
422 | ### Changed | |
423 | ||
424 | - Rename tasks queue options `queueMaxSize` to `size`. | |
425 | ||
426 | ### Added | |
427 | ||
428 | - Task stealing scheduling algorithm if tasks queueing is enabled. | |
429 | ||
430 | ## [2.6.32] - 2023-08-23 | |
431 | ||
432 | ### Fixed | |
433 | ||
434 | - Ensure no task can be executed when the pool is destroyed. | |
435 | ||
436 | ### Added | |
437 | ||
438 | - Add `queueMaxSize` option to tasks queue options. | |
439 | - Add O(1) deque implementation implemented with doubly linked list and use it for tasks queueing. | |
440 | - Add tasks stealing algorithm when a worker node queue is back pressured if tasks queueing is enabled. | |
441 | ||
442 | ## [2.6.31] - 2023-08-20 | |
443 | ||
444 | ### Fixed | |
445 | ||
446 | - Fix worker choice strategy retries mechanism in some edge cases. | |
447 | ||
448 | ### Changed | |
449 | ||
450 | - Make orthogonal worker choice strategies tasks distribution and created dynamic worker usage. | |
451 | - Remove the experimental status of the `LEAST_ELU` worker choice strategy. | |
452 | ||
453 | ## [2.6.30] - 2023-08-19 | |
454 | ||
455 | ### Fixed | |
456 | ||
457 | - Ensure pool event `backPressure` is emitted. | |
458 | - Ensure pool event `full` is emitted only once. | |
459 | - Ensure worker node cannot be instantiated without proper arguments. | |
460 | ||
461 | ## [2.6.29] - 2023-08-18 | |
462 | ||
463 | ### Fixed | |
464 | ||
465 | - Fix race condition between readiness and task functions worker message handling at startup. | |
466 | - Fix duplicate task function worker usage statistics computation per task function. | |
467 | - Update task function worker usage statistics if and only if there's at least two different task functions. | |
468 | - Fix race condition at task function worker usage executing task computation leading to negative value. | |
469 | ||
470 | ### Added | |
471 | ||
472 | - 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). | |
473 | - Use back pressure detection in worker choice strategies. | |
474 | - Add worker choice strategies retries mechanism if no worker is eligible. | |
475 | ||
476 | ## [2.6.28] - 2023-08-16 | |
477 | ||
478 | ### Fixed | |
479 | ||
480 | - Ensure pool workers are properly initialized. | |
481 | ||
482 | ### Added | |
483 | ||
484 | - HTTP server pool examples: express-cluster, express-hybrid. | |
485 | ||
486 | ### Changed | |
487 | ||
488 | - Remove now useless branching in worker hot code path. | |
489 | ||
490 | ## [2.6.27] - 2023-08-15 | |
491 | ||
492 | ### Fixed | |
493 | ||
494 | - Add `KillHandler` type definition to exported types. | |
495 | ||
496 | ### Added | |
497 | ||
498 | - Add `destroy` event to pool API. | |
499 | ||
500 | ## [2.6.26] - 2023-08-15 | |
501 | ||
502 | ### Added | |
503 | ||
504 | - Add kill handler to worker options allowing to execute custom code when worker is killed. | |
505 | - Add `listTaskFunctions()` method to pool API. | |
506 | - SMTP client pool example: nodemailer. | |
507 | ||
508 | ## [2.6.25] - 2023-08-13 | |
509 | ||
510 | ### Added | |
511 | ||
512 | - HTTP server pool examples: fastify-cluster, fastify-hybrid. | |
513 | - WebSocket server pool examples: ws-cluster, ws-hybrid. | |
514 | ||
515 | ## [2.6.24] - 2023-08-12 | |
516 | ||
517 | ### Added | |
518 | ||
519 | - Add array of transferable objects to the `execute()` method arguments. | |
520 | - WebSocket server pool examples: ws-worker_threads. | |
521 | ||
522 | ## [2.6.23] - 2023-08-11 | |
523 | ||
524 | ### Fixed | |
525 | ||
526 | - 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. | |
527 | ||
528 | ### Added | |
529 | ||
530 | - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions. | |
531 | - HTTP server pool examples: express-worker_threads, fastify-worker_threads. | |
532 | ||
533 | ## [2.6.22] - 2023-08-10 | |
534 | ||
535 | ### Fixed | |
536 | ||
537 | - Add missing `types` field to package.json `exports`. | |
538 | ||
539 | ### Changed | |
540 | ||
541 | - Structure markdown documentation (PR #811). | |
542 | ||
543 | ## [2.6.21] - 2023-08-03 | |
544 | ||
545 | ### Changed | |
546 | ||
547 | - Improve code documentation. | |
548 | - Code refactoring and cleanup for better maintainability and readability. | |
549 | ||
550 | ## [2.6.20] - 2023-07-21 | |
551 | ||
552 | ### Fixed | |
553 | ||
554 | - Fix queued tasks redistribution on error task execution starvation. | |
555 | - Ensure tasks queueing per worker condition is untangled from the pool busyness semantic. | |
556 | ||
557 | ### Changed | |
558 | ||
559 | - Drastically reduce lookups by worker in the worker nodes. | |
560 | ||
561 | ## [2.6.19] - 2023-07-20 | |
562 | ||
563 | ### Added | |
564 | ||
565 | - Dedicated internal communication channel for worker_threads pools. | |
566 | ||
567 | ## [2.6.18] - 2023-07-19 | |
568 | ||
569 | ### Changed | |
570 | ||
571 | - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller. | |
572 | ||
573 | ## [2.6.17] - 2023-07-16 | |
574 | ||
575 | ### Added | |
576 | ||
577 | - Add `listTaskFunctions()` method to worker API. | |
578 | ||
579 | ## [2.6.16] - 2023-07-12 | |
580 | ||
581 | ### Fixed | |
582 | ||
583 | - Fix pool startup detection. | |
584 | - Fix worker task functions handling. | |
585 | ||
586 | ## [2.6.15] - 2023-07-11 | |
587 | ||
588 | ### Added | |
589 | ||
590 | - Take into account worker node readiness in worker choice strategies. | |
591 | ||
592 | ## [2.6.14] - 2023-07-10 | |
593 | ||
594 | ### Fixed | |
595 | ||
596 | - Fix task function statistics tracking. | |
597 | ||
598 | ## [2.6.13] - 2023-07-10 | |
599 | ||
600 | ### Added | |
601 | ||
602 | - Add per task function statistics tracking. | |
603 | - Add public methods to manipulate the worker task functions at runtime. | |
604 | ||
605 | ## [2.6.12] - 2023-07-09 | |
606 | ||
607 | ### Fixed | |
608 | ||
609 | - Workaround import issue with `node:os` module in node 16.x.x. | |
610 | ||
611 | ## [2.6.11] - 2023-07-09 | |
612 | ||
613 | ### Fixed | |
614 | ||
615 | - Fix pool readiness semantic. | |
616 | ||
617 | ## [2.6.10] - 2023-07-08 | |
618 | ||
619 | ### Fixed | |
620 | ||
621 | - Ensure workers are not recreated on error at pool startup. | |
622 | ||
623 | ### Added | |
624 | ||
625 | - Add `ready` and `strategy` fields to pool information. | |
626 | - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready. | |
627 | - Add dynamic pool sizing checks. | |
628 | ||
629 | ## [2.6.9] - 2023-07-07 | |
630 | ||
631 | ### Fixed | |
632 | ||
633 | - Recreate the right worker type on uncaught exception. | |
634 | ||
635 | ### Added | |
636 | ||
637 | - Add minimum and maximum to internal measurement statistics. | |
638 | - Add `runTime` and `waitTime` to pool information. | |
639 | - Check worker inactive time only on dynamic worker. | |
640 | ||
641 | ## [2.6.8] - 2023-07-03 | |
642 | ||
643 | ### Fixed | |
644 | ||
645 | - Brown paper bag release to fix version handling in pool information. | |
646 | ||
647 | ## [2.6.7] - 2023-07-03 | |
648 | ||
649 | ### Fixed | |
650 | ||
651 | - Ensure worker queued tasks at error are reassigned to other pool workers. | |
652 | ||
653 | ### Added | |
654 | ||
655 | - Add pool `utilization` ratio to pool information. | |
656 | - Add `version` to pool information. | |
657 | - Add worker information to worker nodes. | |
658 | ||
659 | ## [2.6.6] - 2023-07-01 | |
660 | ||
661 | ### Added | |
662 | ||
663 | - Add safe helper `availableParallelism()` to help sizing the pool. | |
664 | ||
665 | ### Fixed | |
666 | ||
667 | - Ensure message handler is only registered in worker. | |
668 | ||
669 | ## [2.6.5] - 2023-06-27 | |
670 | ||
671 | ### Known issues | |
672 | ||
673 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 | |
674 | ||
675 | ### Fixed | |
676 | ||
677 | - Artificial version bump to 2.6.5 to workaround publication issue. | |
678 | - Ensure cluster pool `destroy()` gracefully shutdowns worker's server. | |
679 | - Ensure pool event is emitted before task error promise rejection. | |
680 | - Fix queued tasks count computation. | |
681 | ||
682 | ### Removed | |
683 | ||
684 | - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC. | |
685 | ||
686 | ## [2.6.4] - 2023-06-27 | |
687 | ||
688 | ### Known issues | |
689 | ||
690 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 | |
691 | ||
692 | ### Fixed | |
693 | ||
694 | - Ensure cluster pool `destroy()` gracefully shutdowns worker's server. | |
695 | - Ensure pool event is emitted before task error promise rejection. | |
696 | - Fix queued tasks count computation. | |
697 | ||
698 | ### Removed | |
699 | ||
700 | - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC. | |
701 | ||
702 | ## [2.6.3] - 2023-06-19 | |
703 | ||
704 | ### Fixed | |
705 | ||
706 | - Ensure no tasks are queued when trying to soft kill a dynamic worker. | |
707 | - Update strategies internals after statistics computation. | |
708 | ||
709 | ### Changed | |
710 | ||
711 | - Optimize O(1) queue implementation. | |
712 | ||
713 | ## [2.6.2] - 2023-06-12 | |
714 | ||
715 | ### Fixed | |
716 | ||
717 | - Fix new worker use after creation in dynamic pool given the current worker choice strategy. | |
718 | ||
719 | ## [2.6.1] - 2023-06-10 | |
720 | ||
721 | ### Added | |
722 | ||
723 | - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md). | |
724 | ||
725 | ### Fixed | |
726 | ||
727 | - Fix average statistics computation: ensure failed tasks are not accounted. | |
728 | ||
729 | ## [2.6.0] - 2023-06-09 | |
730 | ||
731 | ### Added | |
732 | ||
733 | - Add `LEAST_ELU` worker choice strategy (experimental). | |
734 | - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy. | |
735 | ||
736 | ### Changed | |
737 | ||
738 | - Refactor pool worker node usage internals. | |
739 | - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed. | |
740 | - Breaking change: pool information `info` property object fields have been renamed. | |
741 | ||
742 | ### Fixed | |
743 | ||
744 | - Fix wait time accounting. | |
745 | - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time. | |
746 | - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks. | |
747 | ||
748 | ## [2.5.4] - 2023-06-07 | |
749 | ||
750 | ### Added | |
751 | ||
752 | - Add Event Loop Utilization (ELU) statistics to worker tasks usage. | |
753 | ||
754 | ### Changed | |
755 | ||
756 | - Compute statistics at the worker level only if needed. | |
757 | - Add `worker_threads` options to thread pool options. | |
758 | ||
759 | ### Fixed | |
760 | ||
761 | - Make the `LEAST_BUSY` strategy only relies on task runtime. | |
762 | ||
763 | ## [2.5.3] - 2023-06-04 | |
764 | ||
765 | ### Changed | |
766 | ||
767 | - Refine pool information content. | |
768 | - Limit pool internals public exposure. | |
769 | ||
770 | ## [2.5.2] - 2023-06-02 | |
771 | ||
772 | ### Added | |
773 | ||
774 | - Add `taskError` pool event for task execution error. | |
775 | - Add pool information `info` property to pool. | |
776 | - Emit pool information on `busy` and `full` pool events. | |
777 | ||
778 | ## [2.5.1] - 2023-06-01 | |
779 | ||
780 | ### Added | |
781 | ||
782 | - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`. | |
783 | - Add `error` pool event for uncaught worker error. | |
784 | ||
785 | ## [2.5.0] - 2023-05-31 | |
786 | ||
787 | ### Added | |
788 | ||
789 | - Switch pool event emitter to `EventEmitterAsyncResource`. | |
790 | - Add tasks wait time accounting in per worker tasks usage. | |
791 | - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental). | |
792 | ||
793 | ### Changed | |
794 | ||
795 | - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`. | |
796 | ||
797 | ## [2.4.14] - 2023-05-09 | |
798 | ||
799 | ### Fixed | |
800 | ||
801 | - Ensure no undefined task runtime can land in the tasks history. | |
802 | - Fix median computation implementation once again. | |
803 | ||
804 | ### Added | |
805 | ||
806 | - Unit tests for median and queue implementations. | |
807 | ||
808 | ## [2.4.13] - 2023-05-08 | |
809 | ||
810 | ### Fixed | |
811 | ||
812 | - Fix worker choice strategy options validation. | |
813 | - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission. | |
814 | ||
815 | ## [2.4.12] - 2023-05-06 | |
816 | ||
817 | ### Added | |
818 | ||
819 | - Support multiple task functions per worker. | |
820 | - Add custom worker weights support to worker choice strategies options. | |
821 | ||
822 | ### Changed | |
823 | ||
824 | - Use O(1) queue implementation for tasks queueing. | |
825 | ||
826 | ### Fixed | |
827 | ||
828 | - Fix median computation implementation. | |
829 | - Fix fair share worker choice strategy internals update. | |
830 | ||
831 | ## [2.4.11] - 2023-04-23 | |
832 | ||
833 | ### Changed | |
834 | ||
835 | - Optimize free worker finding in worker choice strategies. | |
836 | ||
837 | ## [2.4.10] - 2023-04-15 | |
838 | ||
839 | ### Fixed | |
840 | ||
841 | - Fix typescript type definition for task function: ensure the input data is optional. | |
842 | - Fix typescript type definition for pool execute(): ensure the input data is optional. | |
843 | ||
844 | ## [2.4.9] - 2023-04-15 | |
845 | ||
846 | ### Added | |
847 | ||
848 | - Add tasks queue enablement runtime setter to pool. | |
849 | - Add tasks queue options runtime setter to pool. | |
850 | - Add worker choice strategy options runtime setter to pool. | |
851 | ||
852 | ### Changed | |
853 | ||
854 | - Remove the tasks queuing experimental status. | |
855 | ||
856 | ### Fixed | |
857 | ||
858 | - Fix task function type definition and validation. | |
859 | - Fix worker choice strategy options handling. | |
860 | ||
861 | ## [2.4.8] - 2023-04-12 | |
862 | ||
863 | ### Fixed | |
864 | ||
865 | - Fix message between main worker and worker type definition for tasks. | |
866 | - Fix code documentation. | |
867 | ||
868 | ## [2.4.7] - 2023-04-11 | |
869 | ||
870 | ### Added | |
871 | ||
872 | - Add worker tasks queue options to pool options. | |
873 | ||
874 | ### Fixed | |
875 | ||
876 | - Fix missing documentation. | |
877 | ||
878 | ## [2.4.6] - 2023-04-10 | |
879 | ||
880 | ### Fixed | |
881 | ||
882 | - Ensure one task at a time is executed per worker with tasks queueing enabled. | |
883 | - Properly count worker executing tasks with tasks queueing enabled. | |
884 | ||
885 | ## [2.4.5] - 2023-04-09 | |
886 | ||
887 | ### Added | |
888 | ||
889 | - Use monotonic high resolution timer for worker tasks runtime. | |
890 | - Add worker tasks median runtime to statistics. | |
891 | - Add worker tasks queue (experimental). | |
892 | ||
893 | ## [2.4.4] - 2023-04-07 | |
894 | ||
895 | ### Added | |
896 | ||
897 | - Add `PoolEvents` enumeration and `PoolEvent` type. | |
898 | ||
899 | ### Fixed | |
900 | ||
901 | - Destroy worker only on alive check. | |
902 | ||
903 | ## [2.4.3] - 2023-04-07 | |
904 | ||
905 | ### Fixed | |
906 | ||
907 | - Fix typedoc generation with inheritance. | |
908 | ||
909 | ## [2.4.2] - 2023-04-06 | |
910 | ||
911 | ### Added | |
912 | ||
913 | - Add `full` event to dynamic pool. | |
914 | - Keep worker choice strategy in memory for conditional reuse. | |
915 | ||
916 | ### Fixed | |
917 | ||
918 | - Fix possible negative worker key at worker removal in worker choice strategies. | |
919 | ||
920 | ## [2.4.1] - 2023-04-05 | |
921 | ||
922 | ### Changed | |
923 | ||
924 | - Optimize worker choice strategy for dynamic pool. | |
925 | ||
926 | ### Fixed | |
927 | ||
928 | - Ensure dynamic pool does not alter worker choice strategy expected behavior. | |
929 | ||
930 | ## [2.4.0] - 2023-04-04 | |
931 | ||
932 | ### Added | |
933 | ||
934 | - Add `LESS_BUSY` worker choice strategy. | |
935 | ||
936 | ### Changed | |
937 | ||
938 | - Optimize worker storage in pool. | |
939 | - Optimize worker alive status check. | |
940 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
941 | - Optimize `LESS_USED` worker choice strategy. | |
942 | - Update benchmark versus external threads pools. | |
943 | - Optimize tasks usage statistics requirements for worker choice strategy. | |
944 | ||
945 | ### Fixed | |
946 | ||
947 | - Ensure trimmable characters are checked at pool initialization. | |
948 | - Fix message id integer overflow. | |
949 | - Fix pool worker removal in worker choice strategy internals. | |
950 | - Fix package publication with pnpm. | |
951 | ||
952 | ## [2.4.0-3] - 2023-04-04 | |
953 | ||
954 | ### Added | |
955 | ||
956 | - Add `LESS_BUSY` worker choice strategy. | |
957 | ||
958 | ### Changed | |
959 | ||
960 | - Optimize worker storage in pool. | |
961 | - Optimize worker alive status check. | |
962 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
963 | - Optimize `LESS_USED` worker choice strategy. | |
964 | - Update benchmark versus external threads pools. | |
965 | ||
966 | ### Fixed | |
967 | ||
968 | - Ensure trimmable characters are checked at pool initialization. | |
969 | - Fix message id integer overflow. | |
970 | - Fix pool worker removal in worker choice strategy internals. | |
971 | - Fix package publication with pnpm. | |
972 | ||
973 | ## [2.4.0-2] - 2023-04-03 | |
974 | ||
975 | ### Added | |
976 | ||
977 | - Add `LESS_BUSY` worker choice strategy. | |
978 | ||
979 | ### Changed | |
980 | ||
981 | - Optimize worker storage in pool. | |
982 | - Optimize worker alive status check. | |
983 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
984 | - Optimize `LESS_USED` worker choice strategy. | |
985 | ||
986 | ### Fixed | |
987 | ||
988 | - Ensure trimmable characters are checked at pool initialization. | |
989 | - Fix message id integer overflow. | |
990 | - Fix pool worker removal in worker choice strategy internals. | |
991 | - Fix package publication with pnpm. | |
992 | ||
993 | ## [2.4.0-1] - 2023-04-03 | |
994 | ||
995 | ### Added | |
996 | ||
997 | - Add `LESS_BUSY` worker choice strategy. | |
998 | ||
999 | ### Changed | |
1000 | ||
1001 | - Optimize worker storage in pool. | |
1002 | - Optimize worker alive status check. | |
1003 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
1004 | - Optimize `LESS_USED` worker choice strategy. | |
1005 | ||
1006 | ### Fixed | |
1007 | ||
1008 | - Ensure trimmable characters are checked at pool initialization. | |
1009 | - Fix message id integer overflow. | |
1010 | - Fix pool worker removal in worker choice strategy internals. | |
1011 | ||
1012 | ## [2.4.0-0] - 2023-04-03 | |
1013 | ||
1014 | ### Added | |
1015 | ||
1016 | - Add `LESS_BUSY` worker choice strategy. | |
1017 | ||
1018 | ### Changed | |
1019 | ||
1020 | - Optimize worker storage in pool. | |
1021 | - Optimize worker alive status check. | |
1022 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
1023 | - Optimize `LESS_USED` worker choice strategy. | |
1024 | ||
1025 | ### Fixed | |
1026 | ||
1027 | - Ensure trimmable characters are checked at pool initialization. | |
1028 | - Fix message id integer overflow. | |
1029 | - Fix pool worker removal in worker choice strategy internals. | |
1030 | ||
1031 | ## [2.3.10] - 2023-03-18 | |
1032 | ||
1033 | ### Fixed | |
1034 | ||
1035 | - Fix package.json `exports` syntax for ESM and CommonJS. | |
1036 | ||
1037 | ### Changed | |
1038 | ||
1039 | - Permit SemVer pre-release publication. | |
1040 | ||
1041 | ## [2.3.10-2] - 2023-03-18 | |
1042 | ||
1043 | ### Fixed | |
1044 | ||
1045 | - Fix package.json `exports` syntax for ESM and CommonJS. | |
1046 | ||
1047 | ## [2.3.10-1] - 2023-03-18 | |
1048 | ||
1049 | ### Changed | |
1050 | ||
1051 | - Permit SemVer pre-release publication. | |
1052 | ||
1053 | ## [2.3.10-0] - 2023-03-18 | |
1054 | ||
1055 | ### Fixed | |
1056 | ||
1057 | - Fix package.json `exports` syntax for ESM and CommonJS. | |
1058 | ||
1059 | ## [2.3.9] - 2023-03-18 | |
1060 | ||
1061 | ### Changed | |
1062 | ||
1063 | - Introduce ESM module support along with CommonJS one. | |
1064 | ||
1065 | ### Fixed | |
1066 | ||
1067 | - Fix brown paper bag bug referencing the same object literal. | |
1068 | ||
1069 | ## [2.3.8] - 2023-03-18 | |
1070 | ||
1071 | ### Changed | |
1072 | ||
1073 | - Switch internal benchmarking code to benny. | |
1074 | - Switch to TypeScript 5.x.x. | |
1075 | - Switch rollup bundler plugins to core ones. | |
1076 | - Switch to TSDoc syntax. | |
1077 | - Enforce conventional commits. | |
1078 | ||
1079 | ### Fixed | |
1080 | ||
1081 | - Fix random integer generator. | |
1082 | - Fix worker choice strategy pool type identification at initialization. | |
1083 | ||
1084 | ## [2.3.7] - 2022-10-23 | |
1085 | ||
1086 | ### Changed | |
1087 | ||
1088 | - Switch to open collective FOSS project funding platform. | |
1089 | - Switch to ts-standard linter configuration on TypeScript code. | |
1090 | ||
1091 | ### Fixed | |
1092 | ||
1093 | - Fixed missing async on pool execute method. | |
1094 | - Fixed typing in TypeScript example. | |
1095 | - Fixed types in unit tests. | |
1096 | ||
1097 | ## [2.3.6] - 2022-10-22 | |
1098 | ||
1099 | ### Changed | |
1100 | ||
1101 | - Cleanup pool attributes and methods. | |
1102 | - Refine error types thrown. | |
1103 | ||
1104 | ### Fixed | |
1105 | ||
1106 | - Fix continuous integration build on windows. | |
1107 | - Fix code coverage reporting by using c8 instead of nyc. | |
1108 | ||
1109 | ## [2.3.5] - 2022-10-21 | |
1110 | ||
1111 | ### Changed | |
1112 | ||
1113 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. | |
1114 | - Optimize tasks usage lookup implementation. | |
1115 | ||
1116 | ### Fixed | |
1117 | ||
1118 | - Fix missed pool event emitter type export. | |
1119 | - Fix typedoc documentation generation. | |
1120 | ||
1121 | ## [2.3.4] - 2022-10-17 | |
1122 | ||
1123 | ### Added | |
1124 | ||
1125 | - Fully automate release process with release-it. | |
1126 | ||
1127 | ### Changed | |
1128 | ||
1129 | - Optimize fair share task scheduling algorithm implementation. | |
1130 | - Update benchmark versus external pools results with latest version. | |
1131 | ||
1132 | ## [2.3.3] - 2022-10-15 | |
1133 | ||
1134 | ### Added | |
1135 | ||
1136 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
1137 | ||
1138 | ## [2.3.2] - 2022-10-14 | |
1139 | ||
1140 | ### Changed | |
1141 | ||
1142 | - Optimize fair share worker selection strategy implementation. | |
1143 | ||
1144 | ### Fixed | |
1145 | ||
1146 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
1147 | ||
1148 | ## [2.3.1] - 2022-10-13 | |
1149 | ||
1150 | ### Added | |
1151 | ||
1152 | - Pool worker choice strategies: | |
1153 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
1154 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
1155 | ||
1156 | ## [2.2.2] - 2022-10-09 | |
1157 | ||
1158 | ### Fixed | |
1159 | ||
1160 | - Fixed `README.md` file. | |
1161 | ||
1162 | ## [2.2.1] - 2022-10-08 | |
1163 | ||
1164 | ### Added | |
1165 | ||
1166 | - Dynamic worker choice strategy change at runtime. | |
1167 | ||
1168 | ## [2.2.0] - 2022-01-05 | |
1169 | ||
1170 | ### Breaking Changes | |
1171 | ||
1172 | - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
1173 | ||
1174 | ## [2.1.0] - 2021-08-29 | |
1175 | ||
1176 | ### Added | |
1177 | ||
1178 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
1179 | ||
1180 | ### Breaking Changes | |
1181 | ||
1182 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
1183 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
1184 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
1185 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. | |
1186 | ||
1187 | ## [2.0.2] - 2021-05-12 | |
1188 | ||
1189 | ### Bug fixes | |
1190 | ||
1191 | - Fix `busy` event emission on fixed pool type | |
1192 | ||
1193 | ## [2.0.1] - 2021-03-16 | |
1194 | ||
1195 | ### Bug fixes | |
1196 | ||
1197 | - Check if pool options are properly set. | |
1198 | - `busy` event is emitted on all pool types. | |
1199 | ||
1200 | ## [2.0.0] - 2021-03-01 | |
1201 | ||
1202 | ### Bug fixes | |
1203 | ||
1204 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). | |
1205 | ||
1206 | ### Breaking Changes | |
1207 | ||
1208 | - `FullPool` event is now renamed to `busy`. | |
1209 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. | |
1210 | _Find more details on our JSDoc._ | |
1211 | ||
1212 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. | |
1213 | ||
1214 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. | |
1215 | ||
1216 | ### Pool options types declaration merge | |
1217 | ||
1218 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
1219 | ||
1220 | #### New `export` strategy | |
1221 | ||
1222 | ```js | |
1223 | // Before | |
1224 | const DynamicThreadPool = require('poolifier/lib/dynamic') | |
1225 | // After | |
1226 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') | |
1227 | ``` | |
1228 | ||
1229 | But you should always prefer just using | |
1230 | ||
1231 | ```js | |
1232 | const { DynamicThreadPool } = require('poolifier') | |
1233 | ``` | |
1234 | ||
1235 | #### New type definitions for input data and response | |
1236 | ||
1237 | For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data. | |
1238 | _This is not a limitation by poolifier but Node.js._ | |
1239 | ||
1240 | #### Public property replacements | |
1241 | ||
1242 | `numWorkers` property is now `numberOfWorkers` | |
1243 | ||
1244 | #### Internal (protected) properties and methods renaming | |
1245 | ||
1246 | These properties are not intended for end users | |
1247 | ||
1248 | - `id` => `nextMessageId` | |
1249 | ||
1250 | These methods are not intended for end users | |
1251 | ||
1252 | - `_chooseWorker` => `chooseWorker` | |
1253 | - `_newWorker` => `createWorker` | |
1254 | - `_execute` => `internalExecute` | |
1255 | - `_chooseWorker` => `chooseWorker` | |
1256 | - `_checkAlive` => `checkAlive` | |
1257 | - `_run` => `run` | |
1258 | - `_runAsync` => `runAsync` | |
1259 | ||
1260 | ## [1.1.0] - 2020-05-21 | |
1261 | ||
1262 | ### Added | |
1263 | ||
1264 | - ThreadWorker support async functions as option | |
1265 | - Various external library patches | |
1266 | ||
1267 | ## [1.0.0] - 2020-01-24 | |
1268 | ||
1269 | ### Added | |
1270 | ||
1271 | - FixedThreadPool implementation | |
1272 | - DynamicThreadPool implementation | |
1273 | - WorkerThread implementation to improve developer experience |