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