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