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