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