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