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