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