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