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