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