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