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