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