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