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