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