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