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