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