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