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