CHANGELOG.md

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