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