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