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