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