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