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