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