CHANGELOG.md

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