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