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