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