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