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