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