Commit | Line | Data |
---|---|---|
522eea03 | 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 | ||
45a5a54c JB |
8 | ## [Unreleased] |
9 | ||
ca6c7d70 JB |
10 | ### Changed |
11 | ||
12 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
13 | - Switch to TypeScript 5.x.x. |
14 | - Switch rollup bundler plugins to core ones. | |
15 | - Enforce conventional commits. | |
ca6c7d70 | 16 | |
d15211d4 JB |
17 | ### Fixed |
18 | ||
19 | - Fix random integer generator. | |
fbdedeb9 | 20 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 21 | |
995705ea JB |
22 | ## [2.3.7] - 2022-10-23 |
23 | ||
b953022b JB |
24 | ### Changed |
25 | ||
26 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
27 | - Switch to ts-standard linter configuration on TypeScript code. |
28 | ||
29 | ### Fixed | |
30 | ||
31 | - Fixed missing async on pool execute method. | |
32 | - Fixed typing in TypeScript example. | |
33 | - Fixed types in unit tests. | |
b953022b | 34 | |
3b9f6953 JB |
35 | ## [2.3.6] - 2022-10-22 |
36 | ||
f80cead4 JB |
37 | ### Changed |
38 | ||
39 | - Cleanup pool attributes and methods. | |
40 | - Refine error types thrown. | |
41 | ||
42 | ### Fixed | |
43 | ||
44 | - Fix continuous integration build on windows. | |
45 | - Fix code coverage reporting by using c8 instead of nyc. | |
46 | ||
efc22107 JB |
47 | ## [2.3.5] - 2022-10-21 |
48 | ||
7a6a0a96 JB |
49 | ### Changed |
50 | ||
a05c10de JB |
51 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
52 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 53 | |
b4904890 JB |
54 | ### Fixed |
55 | ||
56 | - Fix missed pool event emitter type export. | |
57 | - Fix typedoc documentation generation. | |
58 | ||
a875f8d1 JB |
59 | ## [2.3.4] - 2022-10-17 |
60 | ||
73cda448 JB |
61 | ### Added |
62 | ||
63 | - Fully automate release process with release-it. | |
64 | ||
45a5a54c JB |
65 | ### Changed |
66 | ||
73cda448 | 67 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 68 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 69 | |
90ee1b18 | 70 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
71 | |
72 | ### Added | |
73 | ||
74 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
75 | ||
90ee1b18 | 76 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
77 | |
78 | ### Changed | |
79 | ||
80 | - Optimize fair share worker selection strategy implementation. | |
81 | ||
82 | ### Fixed | |
83 | ||
84 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
85 | ||
90ee1b18 | 86 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
87 | |
88 | ### Added | |
89 | ||
90 | - Pool worker choice strategies: | |
91 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
92 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
93 | ||
90ee1b18 | 94 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
95 | |
96 | ### Fixed | |
97 | ||
98 | - Fixed `README.md` file. | |
99 | ||
90ee1b18 | 100 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 101 | |
bdaf31cd JB |
102 | ### Added |
103 | ||
104 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 105 | |
90ee1b18 | 106 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
107 | |
108 | ### Breaking Changes | |
109 | ||
110 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
111 | ||
90ee1b18 | 112 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
113 | |
114 | ### Added | |
115 | ||
116 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
117 | |
118 | ### Breaking Changes | |
119 | ||
120 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
121 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
122 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 123 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 124 | |
90ee1b18 | 125 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
126 | |
127 | ### Bug fixes | |
128 | ||
129 | - Fix `busy` event emission on fixed pool type | |
130 | ||
90ee1b18 | 131 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
132 | |
133 | ### Bug fixes | |
134 | ||
135 | - Check if pool options are properly set. | |
136 | - `busy` event is emitted on all pool types. | |
137 | ||
90ee1b18 | 138 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 139 | |
f3f833ab | 140 | ### Bug fixes |
d63d3be3 | 141 | |
ddbeaffd | 142 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 143 | |
fa0f5b28 S |
144 | ### Breaking Changes |
145 | ||
7f685093 | 146 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 147 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 148 | _Find more details on our JSDoc._ |
ddbeaffd | 149 | |
1927ee67 APA |
150 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
151 | ||
ddbeaffd | 152 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 153 | |
ec2ccfc8 JB |
154 | ### Pool options types declaration merge |
155 | ||
156 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
157 | ||
fa0f5b28 S |
158 | #### New `export` strategy |
159 | ||
160 | ```js | |
161 | // Before | |
777b7824 | 162 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 163 | // After |
777b7824 | 164 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
165 | ``` |
166 | ||
167 | But you should always prefer just using | |
168 | ||
169 | ```js | |
777b7824 | 170 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
171 | ``` |
172 | ||
d3c8a1a8 S |
173 | #### New type definitions for input data and response |
174 | ||
ec2ccfc8 | 175 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
176 | _This is not a limitation by poolifier but NodeJS._ |
177 | ||
3a4b605f | 178 | #### Public property replacements |
5c5a1fb7 | 179 | |
3a4b605f | 180 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 181 | |
280c2a77 | 182 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 183 | |
280c2a77 S |
184 | These properties are not intended for end users |
185 | ||
186 | - `id` => `nextMessageId` | |
187 | ||
188 | These methods are not intended for end users | |
fa0f5b28 S |
189 | |
190 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 191 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
192 | - `_execute` => `internalExecute` |
193 | - `_chooseWorker` => `chooseWorker` | |
194 | - `_checkAlive` => `checkAlive` | |
195 | - `_run` => `run` | |
196 | - `_runAsync` => `runAsync` | |
197 | ||
90ee1b18 | 198 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
199 | |
200 | ### Added | |
201 | ||
202 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 203 | - Various external library patches |
0312f71a | 204 | |
90ee1b18 | 205 | ## [1.0.0] - 2020-01-24 |
522eea03 | 206 | |
207 | ### Added | |
208 | ||
209 | - FixedThreadPool implementation | |
210 | - DynamicThreadPool implementation | |
0312f71a | 211 | - WorkerThread implementation to improve developer experience |