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