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