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