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