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