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