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