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