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