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).
12 - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter.
13 - Optimize tasks usage lookup implementation.
15 ## [2.3.4] - 2022-10-17
19 - Fully automate release process with release-it.
23 - Optimize fair share task scheduling algorithm implementation.
24 - Update benchmarks versus external pools results with latest version.
26 ## [2.3.3] - 2022-10-15
30 - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options.
32 ## [2.3.2] - 2022-10-14
36 - Optimize fair share worker selection strategy implementation.
40 - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled.
42 ## [2.3.1] - 2022-10-13
46 - Pool worker choice strategies:
47 - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now.
48 - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now.
50 ## [2.2.2] - 2022-10-09
54 - Fixed `README.md` file.
56 ## [2.2.1] - 2022-10-08
60 - Dynamic worker choice strategy change at runtime.
62 ## [2.2.0] - 2022-01-05
66 - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version.
68 ## [2.1.0] - 2021-08-29
72 - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker.
76 - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute.
77 - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`.
78 - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`.
79 - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker.
81 ## [2.0.2] - 2021-05-12
85 - Fix `busy` event emission on fixed pool type
87 ## [2.0.1] - 2021-03-16
91 - Check if pool options are properly set.
92 - `busy` event is emitted on all pool types.
94 ## [2.0.0] - 2021-03-01
98 - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70).
102 - `FullPool` event is now renamed to `busy`.
103 - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`.
104 _Find more details on our JSDoc._
106 - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed.
108 - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes.
110 ### Pool options types declaration merge
112 `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`.
114 #### New `export` strategy
118 const DynamicThreadPool = require('poolifier/lib/dynamic')
120 const { DynamicThreadPool } = require('poolifier/lib/dynamic')
123 But you should always prefer just using
126 const { DynamicThreadPool } = require('poolifier')
129 #### New type definitions for input data and response
131 For cluster worker and worker-thread pools, you can now only send and receive serializable data.
132 _This is not a limitation by poolifier but NodeJS._
134 #### Public property replacements
136 `numWorkers` property is now `numberOfWorkers`
138 #### Internal (protected) properties and methods renaming
140 These properties are not intended for end users
142 - `id` => `nextMessageId`
144 These methods are not intended for end users
146 - `_chooseWorker` => `chooseWorker`
147 - `_newWorker` => `createWorker`
148 - `_execute` => `internalExecute`
149 - `_chooseWorker` => `chooseWorker`
150 - `_checkAlive` => `checkAlive`
152 - `_runAsync` => `runAsync`
154 ## [1.1.0] - 2020-05-21
158 - ThreadWorker support async functions as option
159 - Various external library patches
161 ## [1.0.0] - 2020-01-24
165 - FixedThreadPool implementation
166 - DynamicThreadPool implementation
167 - WorkerThread implementation to improve developer experience