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