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