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