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