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