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