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