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