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