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 ## [2.6.25] - 2023-08-13
  11
  12 ### Added
  13
  14 - HTTP server pool examples: fastify-cluster, fastify-hybrid.
  15 - WebSocket server pool examples: ws-cluster, ws-hybrid.
  16
  17 ## [2.6.24] - 2023-08-12
  18
  19 ### Added
  20
  21 - Add array of transferable objects to the `execute()` method arguments.
  22 - WebSocket server pool examples: ws-worker_threads.
  23
  24 ## [2.6.23] - 2023-08-11
  25
  26 ### Fixed
  27
  28 - 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.
  29
  30 ### Added
  31
  32 - HTTP client pool examples: fetch, node-fetch and axios with multiple task functions.
  33 - HTTP server pool examples: express-worker_threads, fastify-worker_threads.
  34
  35 ## [2.6.22] - 2023-08-10
  36
  37 ### Fixed
  38
  39 - Add missing `types` field to package.json `exports`.
  40
  41 ### Changed
  42
  43 - Structure markdown documentation (PR #811).
  44
  45 ## [2.6.21] - 2023-08-03
  46
  47 ### Changed
  48
  49 - Improve code documentation.
  50 - Code refactoring and cleanup for better maintainability and readability.
  51
  52 ## [2.6.20] - 2023-07-21
  53
  54 ### Fixed
  55
  56 - Fix queued tasks redistribution on error task execution starvation.
  57 - Ensure task queueing per worker condition is untangled from the pool busyness semantic.
  58
  59 ### Changed
  60
  61 - Drastically reduce lookups by worker in the worker nodes.
  62
  63 ## [2.6.19] - 2023-07-20
  64
  65 ### Added
  66
  67 - Dedicated internal communication channel for worker_threads pools.
  68
  69 ## [2.6.18] - 2023-07-19
  70
  71 ### Changed
  72
  73 - Code refactoring and cleanup for better maintainability and readability. Bundle size is a bit smaller.
  74
  75 ## [2.6.17] - 2023-07-16
  76
  77 ### Added
  78
  79 - Add `listTaskFunctions()` method to worker class.
  80
  81 ## [2.6.16] - 2023-07-12
  82
  83 ### Fixed
  84
  85 - Fix pool startup detection.
  86 - Fix worker task functions handling.
  87
  88 ## [2.6.15] - 2023-07-11
  89
  90 ### Added
  91
  92 - Take into account worker node readiness in worker choice strategies.
  93
  94 ## [2.6.14] - 2023-07-10
  95
  96 ### Fixed
  97
  98 - Fix task function statistics tracking.
  99
 100 ## [2.6.13] - 2023-07-10
 101
 102 ### Added
 103
 104 - Add per task function statistics tracking.
 105 - Add public methods to manipulate the worker task functions at runtime.
 106
 107 ## [2.6.12] - 2023-07-09
 108
 109 ### Fixed
 110
 111 - Workaround import issue with `node:os` module in node 16.x.x.
 112
 113 ## [2.6.11] - 2023-07-09
 114
 115 ### Fixed
 116
 117 - Fix pool readiness semantic.
 118
 119 ## [2.6.10] - 2023-07-08
 120
 121 ### Fixed
 122
 123 - Ensure workers are not recreated on error at pool startup.
 124
 125 ### Added
 126
 127 - Add `ready` and `strategy` fields to pool information.
 128 - Add pool event `ready` to notify when the number of workers created in the pool has reached the maximum size expected and are ready.
 129 - Add dynamic pool sizing checks.
 130
 131 ## [2.6.9] - 2023-07-07
 132
 133 ### Fixed
 134
 135 - Recreate the right worker type on uncaught exception.
 136
 137 ### Added
 138
 139 - Add minimum and maximum to internal measurement statistics.
 140 - Add `runTime` and `waitTime` to pool information.
 141 - Check worker inactive time only on dynamic worker.
 142
 143 ## [2.6.8] - 2023-07-03
 144
 145 ### Fixed
 146
 147 - Brown paper bag release to fix version handling in pool information.
 148
 149 ## [2.6.7] - 2023-07-03
 150
 151 ### Fixed
 152
 153 - Ensure worker queued tasks at error are reassigned to other pool workers.
 154
 155 ### Added
 156
 157 - Add pool `utilization` ratio to pool information.
 158 - Add `version` to pool information.
 159 - Add worker information to worker nodes.
 160
 161 ## [2.6.6] - 2023-07-01
 162
 163 ### Added
 164
 165 - Add safe helper `availableParallelism` to help sizing the pool.
 166
 167 ### Fixed
 168
 169 - Ensure message handler is only registered in worker.
 170
 171 ## [2.6.5] - 2023-06-27
 172
 173 ### Known issues
 174
 175 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
 176
 177 ### Fixed
 178
 179 - Artificial version bump to 2.6.5 to workaround publication issue.
 180 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
 181 - Ensure pool event is emitted before task error promise rejection.
 182 - Fix queued tasks count computation.
 183
 184 ### Removed
 185
 186 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
 187
 188 ## [2.6.4] - 2023-06-27
 189
 190 ### Known issues
 191
 192 - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782
 193
 194 ### Fixed
 195
 196 - Ensure cluster pool destroy() gracefully shutdowns worker's server.
 197 - Ensure pool event is emitted before task error promise rejection.
 198 - Fix queued tasks count computation.
 199
 200 ### Removed
 201
 202 - Remove unneeded worker_threads worker `MessageChannel` internal usage for IPC.
 203
 204 ## [2.6.3] - 2023-06-19
 205
 206 ### Fixed
 207
 208 - Ensure no tasks are queued when trying to soft kill a dynamic worker.
 209 - Update strategies internals after statistics computation.
 210
 211 ### Changed
 212
 213 - Optimize O(1) queue implementation.
 214
 215 ## [2.6.2] - 2023-06-12
 216
 217 ### Fixed
 218
 219 - Fix new worker use after creation in dynamic pool given the current worker choice strategy.
 220
 221 ## [2.6.1] - 2023-06-10
 222
 223 ### Added
 224
 225 - Add worker choice strategy documentation: [README.md](./docs/worker-choice-strategies.md).
 226
 227 ### Fixed
 228
 229 - Fix average statistics computation: ensure failed tasks are not accounted.
 230
 231 ## [2.6.0] - 2023-06-09
 232
 233 ### Added
 234
 235 - Add `LEAST_ELU` worker choice strategy (experimental).
 236 - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy.
 237
 238 ### Changed
 239
 240 - Refactor pool worker node usage internals.
 241 - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed.
 242 - Breaking change: pool information `info` property object fields have been renamed.
 243
 244 ### Fixed
 245
 246 - Fix wait time accounting.
 247 - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time.
 248 - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks.
 249
 250 ## [2.5.4] - 2023-06-07
 251
 252 ### Added
 253
 254 - Add Event Loop Utilization (ELU) statistics to worker tasks usage.
 255
 256 ### Changed
 257
 258 - Compute statistics at the worker level only if needed.
 259 - Add `worker_threads` options to thread pool options.
 260
 261 ### Fixed
 262
 263 - Make the `LEAST_BUSY` strategy only relies on task runtime.
 264
 265 ## [2.5.3] - 2023-06-04
 266
 267 ### Changed
 268
 269 - Refine pool information content.
 270 - Limit pool internals public exposure.
 271
 272 ## [2.5.2] - 2023-06-02
 273
 274 ### Added
 275
 276 - Add `taskError` pool event for task execution error.
 277 - Add pool information `info` property to pool.
 278 - Emit pool information on `busy` and `full` pool events.
 279
 280 ## [2.5.1] - 2023-06-01
 281
 282 ### Added
 283
 284 - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`.
 285 - Add `error` pool event for uncaught worker error.
 286
 287 ## [2.5.0] - 2023-05-31
 288
 289 ### Added
 290
 291 - Switch pool event emitter to `EventEmitterAsyncResource`.
 292 - Add tasks wait time accounting in per worker tasks usage.
 293 - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental).
 294
 295 ### Changed
 296
 297 - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`.
 298
 299 ## [2.4.14] - 2023-05-09
 300
 301 ### Fixed
 302
 303 - Ensure no undefined task runtime can land in the tasks history.
 304 - Fix median computation implementation once again.
 305
 306 ### Added
 307
 308 - Unit tests for median and queue implementations.
 309
 310 ## [2.4.13] - 2023-05-08
 311
 312 ### Fixed
 313
 314 - Fix worker choice strategy options validation.
 315 - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission.
 316
 317 ## [2.4.12] - 2023-05-06
 318
 319 ### Added
 320
 321 - Support multiple task functions per worker.
 322 - Add custom worker weights support to worker choice strategies options.
 323
 324 ### Changed
 325
 326 - Use O(1) queue implementation for tasks queueing.
 327
 328 ### Fixed
 329
 330 - Fix median computation implementation.
 331 - Fix fair share worker choice strategy internals update.
 332
 333 ## [2.4.11] - 2023-04-23
 334
 335 ### Changed
 336
 337 - Optimize free worker finding in worker choice strategies.
 338
 339 ## [2.4.10] - 2023-04-15
 340
 341 ### Fixed
 342
 343 - Fix typescript type definition for task function: ensure the input data is optional.
 344 - Fix typescript type definition for pool execute(): ensure the input data is optional.
 345
 346 ## [2.4.9] - 2023-04-15
 347
 348 ### Added
 349
 350 - Add tasks queue enablement runtime setter to pool.
 351 - Add tasks queue options runtime setter to pool.
 352 - Add worker choice strategy options runtime setter to pool.
 353
 354 ### Changed
 355
 356 - Remove the tasks queuing experimental status.
 357
 358 ### Fixed
 359
 360 - Fix task function type definition and validation.
 361 - Fix worker choice strategy options handling.
 362
 363 ## [2.4.8] - 2023-04-12
 364
 365 ### Fixed
 366
 367 - Fix message between main worker and worker type definition for tasks.
 368 - Fix code documentation.
 369
 370 ## [2.4.7] - 2023-04-11
 371
 372 ### Added
 373
 374 - Add worker tasks queue options to pool options.
 375
 376 ### Fixed
 377
 378 - Fix missing documentation.
 379
 380 ## [2.4.6] - 2023-04-10
 381
 382 ### Fixed
 383
 384 - Ensure one task at a time is executed per worker with tasks queueing enabled.
 385 - Properly count worker executing tasks with tasks queueing enabled.
 386
 387 ## [2.4.5] - 2023-04-09
 388
 389 ### Added
 390
 391 - Use monotonic high resolution timer for worker tasks runtime.
 392 - Add worker tasks median runtime to statistics.
 393 - Add worker tasks queue (experimental).
 394
 395 ## [2.4.4] - 2023-04-07
 396
 397 ### Added
 398
 399 - Add `PoolEvents` enumeration and `PoolEvent` type.
 400
 401 ### Fixed
 402
 403 - Destroy worker only on alive check.
 404
 405 ## [2.4.3] - 2023-04-07
 406
 407 ### Fixed
 408
 409 - Fix typedoc generation with inheritance.
 410
 411 ## [2.4.2] - 2023-04-06
 412
 413 ### Added
 414
 415 - Add `full` event to dynamic pool.
 416 - Keep worker choice strategy in memory for conditional reuse.
 417
 418 ### Fixed
 419
 420 - Fix possible negative worker key at worker removal in worker choice strategies.
 421
 422 ## [2.4.1] - 2023-04-05
 423
 424 ### Changed
 425
 426 - Optimize worker choice strategy for dynamic pool.
 427
 428 ### Fixed
 429
 430 - Ensure dynamic pool does not alter worker choice strategy expected behavior.
 431
 432 ## [2.4.0] - 2023-04-04
 433
 434 ### Added
 435
 436 - Add `LESS_BUSY` worker choice strategy.
 437
 438 ### Changed
 439
 440 - Optimize worker storage in pool.
 441 - Optimize worker alive status check.
 442 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
 443 - Optimize `LESS_USED` worker choice strategy.
 444 - Update benchmarks versus external threads pools.
 445 - Optimize tasks usage statistics requirements for worker choice strategy.
 446
 447 ### Fixed
 448
 449 - Ensure trimmable characters are checked at pool initialization.
 450 - Fix message id integer overflow.
 451 - Fix pool worker removal in worker choice strategy internals.
 452 - Fix package publication with pnpm.
 453
 454 ## [2.4.0-3] - 2023-04-04
 455
 456 ### Added
 457
 458 - Add `LESS_BUSY` worker choice strategy.
 459
 460 ### Changed
 461
 462 - Optimize worker storage in pool.
 463 - Optimize worker alive status check.
 464 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
 465 - Optimize `LESS_USED` worker choice strategy.
 466 - Update benchmarks versus external threads pools.
 467
 468 ### Fixed
 469
 470 - Ensure trimmable characters are checked at pool initialization.
 471 - Fix message id integer overflow.
 472 - Fix pool worker removal in worker choice strategy internals.
 473 - Fix package publication with pnpm.
 474
 475 ## [2.4.0-2] - 2023-04-03
 476
 477 ### Added
 478
 479 - Add `LESS_BUSY` worker choice strategy.
 480
 481 ### Changed
 482
 483 - Optimize worker storage in pool.
 484 - Optimize worker alive status check.
 485 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
 486 - Optimize `LESS_USED` worker choice strategy.
 487
 488 ### Fixed
 489
 490 - Ensure trimmable characters are checked at pool initialization.
 491 - Fix message id integer overflow.
 492 - Fix pool worker removal in worker choice strategy internals.
 493 - Fix package publication with pnpm.
 494
 495 ## [2.4.0-1] - 2023-04-03
 496
 497 ### Added
 498
 499 - Add `LESS_BUSY` worker choice strategy.
 500
 501 ### Changed
 502
 503 - Optimize worker storage in pool.
 504 - Optimize worker alive status check.
 505 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
 506 - Optimize `LESS_USED` worker choice strategy.
 507
 508 ### Fixed
 509
 510 - Ensure trimmable characters are checked at pool initialization.
 511 - Fix message id integer overflow.
 512 - Fix pool worker removal in worker choice strategy internals.
 513
 514 ## [2.4.0-0] - 2023-04-03
 515
 516 ### Added
 517
 518 - Add `LESS_BUSY` worker choice strategy.
 519
 520 ### Changed
 521
 522 - Optimize worker storage in pool.
 523 - Optimize worker alive status check.
 524 - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`.
 525 - Optimize `LESS_USED` worker choice strategy.
 526
 527 ### Fixed
 528
 529 - Ensure trimmable characters are checked at pool initialization.
 530 - Fix message id integer overflow.
 531 - Fix pool worker removal in worker choice strategy internals.
 532
 533 ## [2.3.10] - 2023-03-18
 534
 535 ### Fixed
 536
 537 - Fix package.json `exports` syntax for ESM and CommonJS.
 538
 539 ### Changed
 540
 541 - Permit SemVer pre-release publication.
 542
 543 ## [2.3.10-2] - 2023-03-18
 544
 545 ### Fixed
 546
 547 - Fix package.json `exports` syntax for ESM and CommonJS.
 548
 549 ## [2.3.10-1] - 2023-03-18
 550
 551 ### Changed
 552
 553 - Permit SemVer pre-release publication.
 554
 555 ## [2.3.10-0] - 2023-03-18
 556
 557 ### Fixed
 558
 559 - Fix package.json `exports` syntax for ESM and CommonJS.
 560
 561 ## [2.3.9] - 2023-03-18
 562
 563 ### Changed
 564
 565 - Introduce ESM module support along with CommonJS one.
 566
 567 ### Fixed
 568
 569 - Fix brown paper bag bug referencing the same object literal.
 570
 571 ## [2.3.8] - 2023-03-18
 572
 573 ### Changed
 574
 575 - Switch internal benchmarking code to benny.
 576 - Switch to TypeScript 5.x.x.
 577 - Switch rollup bundler plugins to core ones.
 578 - Switch to TSDoc syntax.
 579 - Enforce conventional commits.
 580
 581 ### Fixed
 582
 583 - Fix random integer generator.
 584 - Fix worker choice strategy pool type identification at initialization.
 585
 586 ## [2.3.7] - 2022-10-23
 587
 588 ### Changed
 589
 590 - Switch to open collective FOSS project funding platform.
 591 - Switch to ts-standard linter configuration on TypeScript code.
 592
 593 ### Fixed
 594
 595 - Fixed missing async on pool execute method.
 596 - Fixed typing in TypeScript example.
 597 - Fixed types in unit tests.
 598
 599 ## [2.3.6] - 2022-10-22
 600
 601 ### Changed
 602
 603 - Cleanup pool attributes and methods.
 604 - Refine error types thrown.
 605
 606 ### Fixed
 607
 608 - Fix continuous integration build on windows.
 609 - Fix code coverage reporting by using c8 instead of nyc.
 610
 611 ## [2.3.5] - 2022-10-21
 612
 613 ### Changed
 614
 615 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
 616 - Optimize tasks usage lookup implementation.
 617
 618 ### Fixed
 619
 620 - Fix missed pool event emitter type export.
 621 - Fix typedoc documentation generation.
 622
 623 ## [2.3.4] - 2022-10-17
 624
 625 ### Added
 626
 627 - Fully automate release process with release-it.
 628
 629 ### Changed
 630
 631 - Optimize fair share task scheduling algorithm implementation.
 632 - Update benchmarks versus external pools results with latest version.
 633
 634 ## [2.3.3] - 2022-10-15
 635
 636 ### Added
 637
 638 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
 639
 640 ## [2.3.2] - 2022-10-14
 641
 642 ### Changed
 643
 644 - Optimize fair share worker selection strategy implementation.
 645
 646 ### Fixed
 647
 648 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
 649
 650 ## [2.3.1] - 2022-10-13
 651
 652 ### Added
 653
 654 - Pool worker choice strategies:
 655   - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
 656   - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
 657
 658 ## [2.2.2] - 2022-10-09
 659
 660 ### Fixed
 661
 662 - Fixed `README.md` file.
 663
 664 ## [2.2.1] - 2022-10-08
 665
 666 ### Added
 667
 668 - Dynamic worker choice strategy change at runtime.
 669
 670 ## [2.2.0] - 2022-01-05
 671
 672 ### Breaking Changes
 673
 674 - Support only Node.js version 16.x.x for cluster pool: upstream cluster API have changed on that version.
 675
 676 ## [2.1.0] - 2021-08-29
 677
 678 ### Added
 679
 680 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
 681
 682 ### Breaking Changes
 683
 684 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
 685 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
 686 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
 687 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
 688
 689 ## [2.0.2] - 2021-05-12
 690
 691 ### Bug fixes
 692
 693 - Fix `busy` event emission on fixed pool type
 694
 695 ## [2.0.1] - 2021-03-16
 696
 697 ### Bug fixes
 698
 699 - Check if pool options are properly set.
 700 - `busy` event is emitted on all pool types.
 701
 702 ## [2.0.0] - 2021-03-01
 703
 704 ### Bug fixes
 705
 706 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
 707
 708 ### Breaking Changes
 709
 710 - `FullPool` event is now renamed to `busy`.
 711 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
 712   _Find more details on our JSDoc._
 713
 714 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
 715
 716 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
 717
 718 ### Pool options types declaration merge
 719
 720 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
 721
 722 #### New `export` strategy
 723
 724 ```js
 725 // Before
 726 const DynamicThreadPool = require('poolifier/lib/dynamic')
 727 // After
 728 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
 729 ```
 730
 731 But you should always prefer just using
 732
 733 ```js
 734 const { DynamicThreadPool } = require('poolifier')
 735 ```
 736
 737 #### New type definitions for input data and response
 738
 739 For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data.
 740 _This is not a limitation by poolifier but Node.js._
 741
 742 #### Public property replacements
 743
 744 `numWorkers` property is now `numberOfWorkers`
 745
 746 #### Internal (protected) properties and methods renaming
 747
 748 These properties are not intended for end users
 749
 750 - `id` => `nextMessageId`
 751
 752 These methods are not intended for end users
 753
 754 - `_chooseWorker` => `chooseWorker`
 755 - `_newWorker` => `createWorker`
 756 - `_execute` => `internalExecute`
 757 - `_chooseWorker` => `chooseWorker`
 758 - `_checkAlive` => `checkAlive`
 759 - `_run` => `run`
 760 - `_runAsync` => `runAsync`
 761
 762 ## [1.1.0] - 2020-05-21
 763
 764 ### Added
 765
 766 - ThreadWorker support async functions as option
 767 - Various external library patches
 768
 769 ## [1.0.0] - 2020-01-24
 770
 771 ### Added
 772
 773 - FixedThreadPool implementation
 774 - DynamicThreadPool implementation
 775 - WorkerThread implementation to improve developer experience