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