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