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