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