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