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