Commit | Line | Data |
---|---|---|
522eea03 | 1 | # Changelog |
2 | ||
3 | All notable changes to this project will be documented in this file. | |
4 | ||
d4abc60a | 5 | The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/), |
522eea03 | 6 | and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). |
7 | ||
45a5a54c JB |
8 | ## [Unreleased] |
9 | ||
698f4bbc JB |
10 | ### Added |
11 | ||
12 | - Add `LESS_BUSY` worker choice strategy. | |
13 | ||
14 | ### Changed | |
15 | ||
16 | - Optimize worker storage in pool. | |
17 | - Optimize worker alive status check. | |
18 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
19 | - Optimize `LESS_USED` worker choice strategy. | |
20 | ||
21 | ### Fixed | |
22 | ||
23 | - Ensure trimmable characters are checked at pool initialization. | |
24 | - Fix message id integer overflow. | |
25 | - Fix pool worker removal in worker choice strategy internals. | |
26 | - Fix package publication with pnpm. | |
27 | ||
8fe15920 JB |
28 | ## [2.4.0-1] - 2023-04-03 |
29 | ||
5b301c28 JB |
30 | ### Added |
31 | ||
32 | - Add `LESS_BUSY` worker choice strategy. | |
33 | ||
34 | ### Changed | |
35 | ||
36 | - Optimize worker storage in pool. | |
37 | - Optimize worker alive status check. | |
38 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
39 | - Optimize `LESS_USED` worker choice strategy. | |
40 | ||
41 | ### Fixed | |
42 | ||
43 | - Ensure trimmable characters are checked at pool initialization. | |
44 | - Fix message id integer overflow. | |
45 | - Fix pool worker removal in worker choice strategy internals. | |
46 | ||
2fb9ca9c JB |
47 | ## [2.4.0-0] - 2023-04-03 |
48 | ||
168c526f JB |
49 | ### Added |
50 | ||
51 | - Add `LESS_BUSY` worker choice strategy. | |
52 | ||
1d71a908 JB |
53 | ### Changed |
54 | ||
ffcbbad8 | 55 | - Optimize worker storage in pool. |
1d71a908 | 56 | - Optimize worker alive status check. |
65a60b3b | 57 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 58 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 59 | |
ffcbbad8 JB |
60 | ### Fixed |
61 | ||
62 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 63 | - Fix message id integer overflow. |
97a2abc3 | 64 | - Fix pool worker removal in worker choice strategy internals. |
ffcbbad8 | 65 | |
08372738 JB |
66 | ## [2.3.10] - 2023-03-18 |
67 | ||
710826bc JB |
68 | ### Fixed |
69 | ||
70 | - Fix `exports` syntax for ESM and CommonJS. | |
71 | ||
72 | ### Changed | |
73 | ||
74 | - Permit SemVer pre-release publication. | |
76e5ac6f | 75 | |
e4796ecd JB |
76 | ## [2.3.10-2] - 2023-03-18 |
77 | ||
6abad580 JB |
78 | ### Fixed |
79 | ||
80 | - Fix `exports` syntax for ESM and CommonJS. | |
81 | ||
a2ee98cc JB |
82 | ## [2.3.10-1] - 2023-03-18 |
83 | ||
7e060cee JB |
84 | ### Changed |
85 | ||
90483887 | 86 | - Permit SemVer pre-release publication. |
7e060cee | 87 | |
c81bfafb JB |
88 | ## [2.3.10-0] - 2023-03-18 |
89 | ||
fe18768d JB |
90 | ### Fixed |
91 | ||
92 | - Fix `exports` syntax for ESM and CommonJS. | |
93 | ||
d7b78217 JB |
94 | ## [2.3.9] - 2023-03-18 |
95 | ||
ed6dd37f JB |
96 | ### Changed |
97 | ||
98 | - Introduce ESM module support along with CommonJS one. | |
99 | ||
100 | ### Fixed | |
101 | ||
102 | - Fix brown paper bag bug referencing the same object literal. | |
103 | ||
68e2ad86 JB |
104 | ## [2.3.8] - 2023-03-18 |
105 | ||
ca6c7d70 JB |
106 | ### Changed |
107 | ||
108 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
109 | - Switch to TypeScript 5.x.x. |
110 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 111 | - Switch to TSDoc syntax. |
fbdedeb9 | 112 | - Enforce conventional commits. |
ca6c7d70 | 113 | |
d15211d4 JB |
114 | ### Fixed |
115 | ||
116 | - Fix random integer generator. | |
fbdedeb9 | 117 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 118 | |
995705ea JB |
119 | ## [2.3.7] - 2022-10-23 |
120 | ||
b953022b JB |
121 | ### Changed |
122 | ||
123 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
124 | - Switch to ts-standard linter configuration on TypeScript code. |
125 | ||
126 | ### Fixed | |
127 | ||
128 | - Fixed missing async on pool execute method. | |
129 | - Fixed typing in TypeScript example. | |
130 | - Fixed types in unit tests. | |
b953022b | 131 | |
3b9f6953 JB |
132 | ## [2.3.6] - 2022-10-22 |
133 | ||
f80cead4 JB |
134 | ### Changed |
135 | ||
136 | - Cleanup pool attributes and methods. | |
137 | - Refine error types thrown. | |
138 | ||
139 | ### Fixed | |
140 | ||
141 | - Fix continuous integration build on windows. | |
142 | - Fix code coverage reporting by using c8 instead of nyc. | |
143 | ||
efc22107 JB |
144 | ## [2.3.5] - 2022-10-21 |
145 | ||
7a6a0a96 JB |
146 | ### Changed |
147 | ||
a05c10de JB |
148 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
149 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 150 | |
b4904890 JB |
151 | ### Fixed |
152 | ||
153 | - Fix missed pool event emitter type export. | |
154 | - Fix typedoc documentation generation. | |
155 | ||
a875f8d1 JB |
156 | ## [2.3.4] - 2022-10-17 |
157 | ||
73cda448 JB |
158 | ### Added |
159 | ||
160 | - Fully automate release process with release-it. | |
161 | ||
45a5a54c JB |
162 | ### Changed |
163 | ||
73cda448 | 164 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 165 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 166 | |
90ee1b18 | 167 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
168 | |
169 | ### Added | |
170 | ||
171 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
172 | ||
90ee1b18 | 173 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
174 | |
175 | ### Changed | |
176 | ||
177 | - Optimize fair share worker selection strategy implementation. | |
178 | ||
179 | ### Fixed | |
180 | ||
181 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
182 | ||
90ee1b18 | 183 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
184 | |
185 | ### Added | |
186 | ||
187 | - Pool worker choice strategies: | |
188 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
189 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
190 | ||
90ee1b18 | 191 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
192 | |
193 | ### Fixed | |
194 | ||
195 | - Fixed `README.md` file. | |
196 | ||
90ee1b18 | 197 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 198 | |
bdaf31cd JB |
199 | ### Added |
200 | ||
201 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 202 | |
90ee1b18 | 203 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
204 | |
205 | ### Breaking Changes | |
206 | ||
207 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
208 | ||
90ee1b18 | 209 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
210 | |
211 | ### Added | |
212 | ||
213 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
214 | |
215 | ### Breaking Changes | |
216 | ||
217 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
218 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
219 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 220 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 221 | |
90ee1b18 | 222 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
223 | |
224 | ### Bug fixes | |
225 | ||
226 | - Fix `busy` event emission on fixed pool type | |
227 | ||
90ee1b18 | 228 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
229 | |
230 | ### Bug fixes | |
231 | ||
232 | - Check if pool options are properly set. | |
233 | - `busy` event is emitted on all pool types. | |
234 | ||
90ee1b18 | 235 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 236 | |
f3f833ab | 237 | ### Bug fixes |
d63d3be3 | 238 | |
ddbeaffd | 239 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 240 | |
fa0f5b28 S |
241 | ### Breaking Changes |
242 | ||
7f685093 | 243 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 244 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 245 | _Find more details on our JSDoc._ |
ddbeaffd | 246 | |
1927ee67 APA |
247 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
248 | ||
ddbeaffd | 249 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 250 | |
ec2ccfc8 JB |
251 | ### Pool options types declaration merge |
252 | ||
253 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
254 | ||
fa0f5b28 S |
255 | #### New `export` strategy |
256 | ||
257 | ```js | |
258 | // Before | |
777b7824 | 259 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 260 | // After |
777b7824 | 261 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
262 | ``` |
263 | ||
264 | But you should always prefer just using | |
265 | ||
266 | ```js | |
777b7824 | 267 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
268 | ``` |
269 | ||
d3c8a1a8 S |
270 | #### New type definitions for input data and response |
271 | ||
ec2ccfc8 | 272 | For cluster worker and worker-thread pools, you can now only send and receive serializable data. |
d3c8a1a8 S |
273 | _This is not a limitation by poolifier but NodeJS._ |
274 | ||
3a4b605f | 275 | #### Public property replacements |
5c5a1fb7 | 276 | |
3a4b605f | 277 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 278 | |
280c2a77 | 279 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 280 | |
280c2a77 S |
281 | These properties are not intended for end users |
282 | ||
283 | - `id` => `nextMessageId` | |
284 | ||
285 | These methods are not intended for end users | |
fa0f5b28 S |
286 | |
287 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 288 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
289 | - `_execute` => `internalExecute` |
290 | - `_chooseWorker` => `chooseWorker` | |
291 | - `_checkAlive` => `checkAlive` | |
292 | - `_run` => `run` | |
293 | - `_runAsync` => `runAsync` | |
294 | ||
90ee1b18 | 295 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
296 | |
297 | ### Added | |
298 | ||
299 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 300 | - Various external library patches |
0312f71a | 301 | |
90ee1b18 | 302 | ## [1.0.0] - 2020-01-24 |
522eea03 | 303 | |
304 | ### Added | |
305 | ||
306 | - FixedThreadPool implementation | |
307 | - DynamicThreadPool implementation | |
0312f71a | 308 | - WorkerThread implementation to improve developer experience |