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