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