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