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