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