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