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