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