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