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