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