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