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