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