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