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