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