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