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