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