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