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