CHANGELOG.md

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