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