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