3 All notable changes to this project will be documented in this file.
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).
8 ## [2.3.3] - 2022-15-10
12 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
14 ## [2.3.2] - 2022-14-10
18 - Optimize fair share worker selection strategy implementation.
22 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
24 ## [2.3.1] - 2022-13-10
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.
32 ## [2.2.2] - 2022-09-10
36 - Fixed `README.md` file.
38 ## [2.2.1] - 2022-08-10
42 - Dynamic worker choice strategy change at runtime.
44 ## [2.2.0] - 2022-05-01
48 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
50 ## [2.1.0] - 2021-29-08
54 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
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.
63 ## [2.0.2] - 2021-12-05
67 - Fix `busy` event emission on fixed pool type
69 ## [2.0.1] - 2021-16-03
73 - Check if pool options are properly set.
74 - `busy` event is emitted on all pool types.
76 ## [2.0.0] - 2021-01-03
80 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
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._
88 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
90 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
92 ### Pool options types declaration merge
94 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
96 #### New `export` strategy
100 const DynamicThreadPool = require('poolifier/lib/dynamic')
102 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
105 But you should always prefer just using
108 const { DynamicThreadPool } = require('poolifier')
111 #### New type definitions for input data and response
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._
116 #### Public property replacements
118 `numWorkers` property is now `numberOfWorkers`
120 #### Internal (protected) properties and methods renaming
122 These properties are not intended for end users
124 - `id` => `nextMessageId`
126 These methods are not intended for end users
128 - `_chooseWorker` => `chooseWorker`
129 - `_newWorker` => `createWorker`
130 - `_execute` => `internalExecute`
131 - `_chooseWorker` => `chooseWorker`
132 - `_checkAlive` => `checkAlive`
134 - `_runAsync` => `runAsync`
136 ## [1.1.0] - 2020-21-05
140 - ThreadWorker support async functions as option
141 - Various external library patches
143 ## [1.0.0] - 2020-24-01
147 - FixedThreadPool implementation
148 - DynamicThreadPool implementation
149 - WorkerThread implementation to improve developer experience