CHANGELOG.md

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