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