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