CHANGELOG.md

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