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