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