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