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