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