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