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