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