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