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