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