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).
10 ## [2.3.5] - 2022-10-21
14 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
15 - Optimize tasks usage lookup implementation.
19 - Fix missed pool event emitter type export.
20 - Fix typedoc documentation generation.
22 ## [2.3.4] - 2022-10-17
26 - Fully automate release process with release-it.
30 - Optimize fair share task scheduling algorithm implementation.
31 - Update benchmarks versus external pools results with latest version.
33 ## [2.3.3] - 2022-10-15
37 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
39 ## [2.3.2] - 2022-10-14
43 - Optimize fair share worker selection strategy implementation.
47 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
49 ## [2.3.1] - 2022-10-13
53 - Pool worker choice strategies:
54 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
55 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
57 ## [2.2.2] - 2022-10-09
61 - Fixed `README.md` file.
63 ## [2.2.1] - 2022-10-08
67 - Dynamic worker choice strategy change at runtime.
69 ## [2.2.0] - 2022-01-05
73 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
75 ## [2.1.0] - 2021-08-29
79 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
83 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
84 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
85 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
86 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
88 ## [2.0.2] - 2021-05-12
92 - Fix `busy` event emission on fixed pool type
94 ## [2.0.1] - 2021-03-16
98 - Check if pool options are properly set.
99 - `busy` event is emitted on all pool types.
101 ## [2.0.0] - 2021-03-01
105 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
109 - `FullPool` event is now renamed to `busy`.
110 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
111 _Find more details on our JSDoc._
113 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
115 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
117 ### Pool options types declaration merge
119 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
121 #### New `export` strategy
125 const DynamicThreadPool = require('poolifier/lib/dynamic')
127 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
130 But you should always prefer just using
133 const { DynamicThreadPool } = require('poolifier')
136 #### New type definitions for input data and response
138 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
139 _This is not a limitation by poolifier but NodeJS._
141 #### Public property replacements
143 `numWorkers` property is now `numberOfWorkers`
145 #### Internal (protected) properties and methods renaming
147 These properties are not intended for end users
149 - `id` => `nextMessageId`
151 These methods are not intended for end users
153 - `_chooseWorker` => `chooseWorker`
154 - `_newWorker` => `createWorker`
155 - `_execute` => `internalExecute`
156 - `_chooseWorker` => `chooseWorker`
157 - `_checkAlive` => `checkAlive`
159 - `_runAsync` => `runAsync`
161 ## [1.1.0] - 2020-05-21
165 - ThreadWorker support async functions as option
166 - Various external library patches
168 ## [1.0.0] - 2020-01-24
172 - FixedThreadPool implementation
173 - DynamicThreadPool implementation
174 - WorkerThread implementation to improve developer experience