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 | ||
5bc91f3e JB |
10 | ### Fixed |
11 | ||
12 | - Ensure worker queued tasks at error are reassigned to other pool workers. | |
13 | ||
afe0d5bf JB |
14 | ### Added |
15 | ||
16 | - Add pool `utilization` ratio to pool information. | |
e5b3047d | 17 | - Add worker information to worker nodes. |
afe0d5bf | 18 | |
f42c583f JB |
19 | ## [2.6.6] - 2023-07-01 |
20 | ||
6961ca9a JB |
21 | ### Added |
22 | ||
23 | - Add safe helper `availableParallelism` to help sizing the pool. | |
24 | ||
3749facb JB |
25 | ### Fixed |
26 | ||
27 | - Ensure message handler is only registered in worker. | |
28 | ||
6fed2513 JB |
29 | ## [2.6.5] - 2023-06-27 |
30 | ||
c72f6987 JB |
31 | ### Known issues |
32 | ||
70726c28 | 33 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 |
c72f6987 JB |
34 | |
35 | ### Fixed | |
36 | ||
37 | - Artificial version bump to 2.6.5 to workaround publication issue. | |
38 | - Ensure cluster pool destroy() gracefully shutdowns worker's server. | |
39 | - Ensure pool event is emitted before task error promise rejection. | |
40 | - Fix queued tasks count computation. | |
41 | ||
42 | ### Removed | |
43 | ||
44 | - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC. | |
45 | ||
6426631b JB |
46 | ## [2.6.4] - 2023-06-27 |
47 | ||
941f9a7c JB |
48 | ### Known issues |
49 | ||
70726c28 | 50 | - Cluster pools tasks execution are not working by using ESM files extension: https://github.com/poolifier/poolifier/issues/782 |
941f9a7c | 51 | |
2c039e43 JB |
52 | ### Fixed |
53 | ||
54 | - Ensure cluster pool destroy() gracefully shutdowns worker's server. | |
55 | - Ensure pool event is emitted before task error promise rejection. | |
9c16fb4b | 56 | - Fix queued tasks count computation. |
2c039e43 | 57 | |
941f9a7c JB |
58 | ### Removed |
59 | ||
60 | - Remove unneeded worker-threads worker `MessageChannel` internal usage for IPC. | |
61 | ||
bc1b0765 JB |
62 | ## [2.6.3] - 2023-06-19 |
63 | ||
a6a2dc4c JB |
64 | ### Fixed |
65 | ||
66 | - Ensure no tasks are queued when trying to soft kill a dynamic worker. | |
f0d7f803 | 67 | - Update strategies internals after statistics computation. |
a6a2dc4c | 68 | |
7b56f532 JB |
69 | ### Changed |
70 | ||
71 | - Optimize O(1) queue implementation. | |
72 | ||
b628596c JB |
73 | ## [2.6.2] - 2023-06-12 |
74 | ||
a9e89d00 JB |
75 | ### Fixed |
76 | ||
77 | - Fix new worker use after creation in dynamic pool given the current worker choice strategy. | |
78 | ||
4368a898 JB |
79 | ## [2.6.1] - 2023-06-10 |
80 | ||
931d43e2 JB |
81 | ### Added |
82 | ||
83 | - Add worker choice strategy documentation: [README.md](./src/pools/selection-strategies/README.md). | |
84 | ||
f1c06930 JB |
85 | ### Fixed |
86 | ||
87 | - Fix average statistics computation: ensure failed tasks are not accounted. | |
88 | ||
16671b07 JB |
89 | ## [2.6.0] - 2023-06-09 |
90 | ||
a1347286 JB |
91 | ### Added |
92 | ||
5af9c0f7 | 93 | - Add `LEAST_ELU` worker choice strategy (experimental). |
9adcefab | 94 | - Add tasks ELU instead of runtime support to `FAIR_SHARE` worker choice strategy. |
a1347286 | 95 | |
1c6fe997 JB |
96 | ### Changed |
97 | ||
98 | - Refactor pool worker node usage internals. | |
477f48e7 | 99 | - Breaking change: refactor worker choice strategy statistics requirements: the syntax of the worker choice strategy options has changed. |
f63a9dda | 100 | - Breaking change: pool information `info` property object fields have been renamed. |
1c6fe997 JB |
101 | |
102 | ### Fixed | |
103 | ||
104 | - Fix wait time accounting. | |
105 | - Ensure worker choice strategy `LEAST_BUSY` accounts also tasks wait time. | |
106 | - Ensure worker choice strategy `LEAST_USED` accounts also queued tasks. | |
107 | ||
aa07d6ee JB |
108 | ## [2.5.4] - 2023-06-07 |
109 | ||
b6b32453 JB |
110 | ### Added |
111 | ||
112 | - Add Event Loop Utilization (ELU) statistics to worker tasks usage. | |
113 | ||
114 | ### Changed | |
115 | ||
116 | - Compute statistics at the worker level only if needed. | |
90082c8c | 117 | - Add `worker-threads` options to thread pool options. |
b6b32453 | 118 | |
272d4d8f JB |
119 | ### Fixed |
120 | ||
121 | - Make the `LEAST_BUSY` strategy only relies on task runtime. | |
122 | ||
ed47fb3d JB |
123 | ## [2.5.3] - 2023-06-04 |
124 | ||
89a4abfd JB |
125 | ### Changed |
126 | ||
127 | - Refine pool information content. | |
b4213b7f | 128 | - Limit pool internals public exposure. |
89a4abfd | 129 | |
8a9febf5 JB |
130 | ## [2.5.2] - 2023-06-02 |
131 | ||
91ee39ed JB |
132 | ### Added |
133 | ||
134 | - Add `taskError` pool event for task execution error. | |
6b27d407 | 135 | - Add pool information `info` property to pool. |
91ee39ed JB |
136 | - Emit pool information on `busy` and `full` pool events. |
137 | ||
8babb151 JB |
138 | ## [2.5.1] - 2023-06-01 |
139 | ||
0e05c4dc JB |
140 | ### Added |
141 | ||
1f68cede | 142 | - Add pool option `restartWorkerOnError` to restart worker on uncaught error. Default to `true`. |
91ee39ed | 143 | - Add `error` pool event for uncaught worker error. |
0e05c4dc | 144 | |
a8766181 JB |
145 | ## [2.5.0] - 2023-05-31 |
146 | ||
e4543b14 JB |
147 | ### Added |
148 | ||
149 | - Switch pool event emitter to `EventEmitterAsyncResource`. | |
6da80d38 | 150 | - Add tasks wait time accounting in per worker tasks usage. |
5af9c0f7 | 151 | - Add interleaved weighted round robin `INTERLEAVED_WEIGHTED_ROUND_ROBIN` worker choice strategy (experimental). |
e4543b14 JB |
152 | |
153 | ### Changed | |
154 | ||
155 | - Renamed worker choice strategy `LESS_BUSY` to `LEAST_BUSY` and `LESS_USED` to `LEAST_USED`. | |
156 | ||
570efb11 JB |
157 | ## [2.4.14] - 2023-05-09 |
158 | ||
b0f28bad JB |
159 | ### Fixed |
160 | ||
161 | - Ensure no undefined task runtime can land in the tasks history. | |
162 | - Fix median computation implementation once again. | |
163 | ||
110b6d13 JB |
164 | ### Added |
165 | ||
166 | - Unit tests for median and queue implementations. | |
167 | ||
72584880 JB |
168 | ## [2.4.13] - 2023-05-08 |
169 | ||
b0d6ed8f JB |
170 | ### Fixed |
171 | ||
e3058615 | 172 | - Fix worker choice strategy options validation. |
b0d6ed8f JB |
173 | - Fix fair share worker choice strategy internals update: ensure virtual task end timestamp is computed at task submission. |
174 | ||
06140c32 JB |
175 | ## [2.4.12] - 2023-05-06 |
176 | ||
a86b6df1 JB |
177 | ### Added |
178 | ||
179 | - Support multiple task functions per worker. | |
08f3f44c | 180 | - Add custom worker weights support to worker choice strategies options. |
a86b6df1 | 181 | |
29ee7e9a JB |
182 | ### Changed |
183 | ||
184 | - Use O(1) queue implementation for tasks queueing. | |
185 | ||
0682ba15 JB |
186 | ### Fixed |
187 | ||
188 | - Fix median computation implementation. | |
189 | - Fix fair share worker choice strategy internals update. | |
190 | ||
936d53ec JB |
191 | ## [2.4.11] - 2023-04-23 |
192 | ||
cb70b19d JB |
193 | ### Changed |
194 | ||
195 | - Optimize free worker finding in worker choice strategies. | |
196 | ||
15bb637a JB |
197 | ## [2.4.10] - 2023-04-15 |
198 | ||
ef41a6e6 JB |
199 | ### Fixed |
200 | ||
201 | - Fix typescript type definition for worker function: ensure the input data is optional. | |
202 | - Fix typescript type definition for pool execute(): ensure the input data is optional. | |
203 | ||
181eb2b4 JB |
204 | ## [2.4.9] - 2023-04-15 |
205 | ||
a20f0ba5 JB |
206 | ### Added |
207 | ||
208 | - Add tasks queue enablement runtime setter to pool. | |
209 | - Add tasks queue options runtime setter to pool. | |
210 | - Add worker choice strategy options runtime setter to pool. | |
211 | ||
212 | ### Changed | |
213 | ||
214 | - Remove the tasks queuing experimental status. | |
215 | ||
d4aeae5a JB |
216 | ### Fixed |
217 | ||
218 | - Fix worker function type definition and validation. | |
2fc5cae3 | 219 | - Fix worker choice strategy options handling. |
d4aeae5a | 220 | |
1d9e7023 JB |
221 | ## [2.4.8] - 2023-04-12 |
222 | ||
f9b4bbf8 JB |
223 | ### Fixed |
224 | ||
225 | - Fix message between main worker and worker type definition for tasks. | |
226 | - Fix code documentation. | |
227 | ||
12ae3210 JB |
228 | ## [2.4.7] - 2023-04-11 |
229 | ||
7171d33f JB |
230 | ### Added |
231 | ||
232 | - Add worker tasks queue options to pool options. | |
233 | ||
e8bd29ce JB |
234 | ### Fixed |
235 | ||
236 | - Fix missing documentation. | |
237 | ||
42c7bc10 JB |
238 | ## [2.4.6] - 2023-04-10 |
239 | ||
681196cc JB |
240 | ### Fixed |
241 | ||
242 | - Ensure one task at a time is executed per worker with tasks queueing enabled. | |
1c6fe997 | 243 | - Properly count worker executing tasks with tasks queueing enabled. |
681196cc | 244 | |
54d360e3 JB |
245 | ## [2.4.5] - 2023-04-09 |
246 | ||
3fafb1b2 JB |
247 | ### Added |
248 | ||
9e775f96 JB |
249 | - Use monotonic high resolution timer for worker tasks runtime. |
250 | - Add worker tasks median runtime to statistics. | |
ff733df7 | 251 | - Add worker tasks queue (experimental). |
3fafb1b2 | 252 | |
92fa3eb6 JB |
253 | ## [2.4.4] - 2023-04-07 |
254 | ||
aee46736 JB |
255 | ### Added |
256 | ||
257 | - Add `PoolEvents` enumeration and `PoolEvent` type. | |
258 | ||
36b5e78f JB |
259 | ### Fixed |
260 | ||
ff0c2b3e | 261 | - Destroy worker only on alive check. |
36b5e78f | 262 | |
9fb0f324 JB |
263 | ## [2.4.3] - 2023-04-07 |
264 | ||
28cf3617 JB |
265 | ### Fixed |
266 | ||
267 | - Fix typedoc generation with inheritance. | |
268 | ||
848f0f27 JB |
269 | ## [2.4.2] - 2023-04-06 |
270 | ||
164d950a JB |
271 | ### Added |
272 | ||
273 | - Add `full` event to dynamic pool. | |
32417142 | 274 | - Keep worker choice strategy in memory for conditional reuse. |
164d950a | 275 | |
78ab2555 JB |
276 | ### Fixed |
277 | ||
278 | - Fix possible negative worker key at worker removal in worker choice strategies. | |
279 | ||
79aafe9f JB |
280 | ## [2.4.1] - 2023-04-05 |
281 | ||
9cd39dd4 JB |
282 | ### Changed |
283 | ||
284 | - Optimize worker choice strategy for dynamic pool. | |
285 | ||
965415bb JB |
286 | ### Fixed |
287 | ||
288 | - Ensure dynamic pool does not alter worker choice strategy expected behavior. | |
289 | ||
d8b60b1c JB |
290 | ## [2.4.0] - 2023-04-04 |
291 | ||
c6bd2650 JB |
292 | ### Added |
293 | ||
294 | - Add `LESS_BUSY` worker choice strategy. | |
295 | ||
296 | ### Changed | |
297 | ||
298 | - Optimize worker storage in pool. | |
299 | - Optimize worker alive status check. | |
300 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
301 | - Optimize `LESS_USED` worker choice strategy. | |
302 | - Update benchmarks versus external threads pools. | |
303 | - Optimize tasks usage statistics requirements for worker choice strategy. | |
304 | ||
305 | ### Fixed | |
306 | ||
307 | - Ensure trimmable characters are checked at pool initialization. | |
308 | - Fix message id integer overflow. | |
309 | - Fix pool worker removal in worker choice strategy internals. | |
310 | - Fix package publication with pnpm. | |
311 | ||
d0a3f018 JB |
312 | ## [2.4.0-3] - 2023-04-04 |
313 | ||
b2ede285 JB |
314 | ### Added |
315 | ||
316 | - Add `LESS_BUSY` worker choice strategy. | |
317 | ||
318 | ### Changed | |
319 | ||
320 | - Optimize worker storage in pool. | |
321 | - Optimize worker alive status check. | |
322 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
323 | - Optimize `LESS_USED` worker choice strategy. | |
324 | - Update benchmarks versus external threads pools. | |
325 | ||
326 | ### Fixed | |
327 | ||
328 | - Ensure trimmable characters are checked at pool initialization. | |
329 | - Fix message id integer overflow. | |
330 | - Fix pool worker removal in worker choice strategy internals. | |
331 | - Fix package publication with pnpm. | |
332 | ||
a015ea40 JB |
333 | ## [2.4.0-2] - 2023-04-03 |
334 | ||
698f4bbc JB |
335 | ### Added |
336 | ||
337 | - Add `LESS_BUSY` worker choice strategy. | |
338 | ||
339 | ### Changed | |
340 | ||
341 | - Optimize worker storage in pool. | |
342 | - Optimize worker alive status check. | |
343 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
344 | - Optimize `LESS_USED` worker choice strategy. | |
345 | ||
346 | ### Fixed | |
347 | ||
348 | - Ensure trimmable characters are checked at pool initialization. | |
349 | - Fix message id integer overflow. | |
350 | - Fix pool worker removal in worker choice strategy internals. | |
351 | - Fix package publication with pnpm. | |
352 | ||
8fe15920 JB |
353 | ## [2.4.0-1] - 2023-04-03 |
354 | ||
5b301c28 JB |
355 | ### Added |
356 | ||
357 | - Add `LESS_BUSY` worker choice strategy. | |
358 | ||
359 | ### Changed | |
360 | ||
361 | - Optimize worker storage in pool. | |
362 | - Optimize worker alive status check. | |
363 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. | |
364 | - Optimize `LESS_USED` worker choice strategy. | |
365 | ||
366 | ### Fixed | |
367 | ||
368 | - Ensure trimmable characters are checked at pool initialization. | |
369 | - Fix message id integer overflow. | |
370 | - Fix pool worker removal in worker choice strategy internals. | |
371 | ||
2fb9ca9c JB |
372 | ## [2.4.0-0] - 2023-04-03 |
373 | ||
168c526f JB |
374 | ### Added |
375 | ||
376 | - Add `LESS_BUSY` worker choice strategy. | |
377 | ||
1d71a908 JB |
378 | ### Changed |
379 | ||
ffcbbad8 | 380 | - Optimize worker storage in pool. |
1d71a908 | 381 | - Optimize worker alive status check. |
65a60b3b | 382 | - BREAKING CHANGE: Rename worker choice strategy `LESS_RECENTLY_USED` to `LESS_USED`. |
737c6d97 | 383 | - Optimize `LESS_USED` worker choice strategy. |
1d71a908 | 384 | |
ffcbbad8 JB |
385 | ### Fixed |
386 | ||
387 | - Ensure trimmable characters are checked at pool initialization. | |
b4e75778 | 388 | - Fix message id integer overflow. |
97a2abc3 | 389 | - Fix pool worker removal in worker choice strategy internals. |
ffcbbad8 | 390 | |
08372738 JB |
391 | ## [2.3.10] - 2023-03-18 |
392 | ||
710826bc JB |
393 | ### Fixed |
394 | ||
395 | - Fix `exports` syntax for ESM and CommonJS. | |
396 | ||
397 | ### Changed | |
398 | ||
399 | - Permit SemVer pre-release publication. | |
76e5ac6f | 400 | |
e4796ecd JB |
401 | ## [2.3.10-2] - 2023-03-18 |
402 | ||
6abad580 JB |
403 | ### Fixed |
404 | ||
405 | - Fix `exports` syntax for ESM and CommonJS. | |
406 | ||
a2ee98cc JB |
407 | ## [2.3.10-1] - 2023-03-18 |
408 | ||
7e060cee JB |
409 | ### Changed |
410 | ||
90483887 | 411 | - Permit SemVer pre-release publication. |
7e060cee | 412 | |
c81bfafb JB |
413 | ## [2.3.10-0] - 2023-03-18 |
414 | ||
fe18768d JB |
415 | ### Fixed |
416 | ||
417 | - Fix `exports` syntax for ESM and CommonJS. | |
418 | ||
d7b78217 JB |
419 | ## [2.3.9] - 2023-03-18 |
420 | ||
ed6dd37f JB |
421 | ### Changed |
422 | ||
423 | - Introduce ESM module support along with CommonJS one. | |
424 | ||
425 | ### Fixed | |
426 | ||
427 | - Fix brown paper bag bug referencing the same object literal. | |
428 | ||
68e2ad86 JB |
429 | ## [2.3.8] - 2023-03-18 |
430 | ||
ca6c7d70 JB |
431 | ### Changed |
432 | ||
433 | - Switch internal benchmarking code to benny. | |
fbdedeb9 JB |
434 | - Switch to TypeScript 5.x.x. |
435 | - Switch rollup bundler plugins to core ones. | |
ed6dd37f | 436 | - Switch to TSDoc syntax. |
fbdedeb9 | 437 | - Enforce conventional commits. |
ca6c7d70 | 438 | |
d15211d4 JB |
439 | ### Fixed |
440 | ||
441 | - Fix random integer generator. | |
fbdedeb9 | 442 | - Fix worker choice strategy pool type identification at initialization. |
d15211d4 | 443 | |
995705ea JB |
444 | ## [2.3.7] - 2022-10-23 |
445 | ||
b953022b JB |
446 | ### Changed |
447 | ||
448 | - Switch to open collective FOSS project funding platform. | |
78cea37e JB |
449 | - Switch to ts-standard linter configuration on TypeScript code. |
450 | ||
451 | ### Fixed | |
452 | ||
453 | - Fixed missing async on pool execute method. | |
454 | - Fixed typing in TypeScript example. | |
455 | - Fixed types in unit tests. | |
b953022b | 456 | |
3b9f6953 JB |
457 | ## [2.3.6] - 2022-10-22 |
458 | ||
f80cead4 JB |
459 | ### Changed |
460 | ||
461 | - Cleanup pool attributes and methods. | |
462 | - Refine error types thrown. | |
463 | ||
464 | ### Fixed | |
465 | ||
466 | - Fix continuous integration build on windows. | |
467 | - Fix code coverage reporting by using c8 instead of nyc. | |
468 | ||
efc22107 JB |
469 | ## [2.3.5] - 2022-10-21 |
470 | ||
7a6a0a96 JB |
471 | ### Changed |
472 | ||
a05c10de JB |
473 | - Improve benchmarks: add IO intensive task workload, add task size option, integrate code into linter. |
474 | - Optimize tasks usage lookup implementation. | |
7a6a0a96 | 475 | |
b4904890 JB |
476 | ### Fixed |
477 | ||
478 | - Fix missed pool event emitter type export. | |
479 | - Fix typedoc documentation generation. | |
480 | ||
a875f8d1 JB |
481 | ## [2.3.4] - 2022-10-17 |
482 | ||
73cda448 JB |
483 | ### Added |
484 | ||
485 | - Fully automate release process with release-it. | |
486 | ||
45a5a54c JB |
487 | ### Changed |
488 | ||
73cda448 | 489 | - Optimize fair share task scheduling algorithm implementation. |
eb4a8a82 | 490 | - Update benchmarks versus external pools results with latest version. |
45a5a54c | 491 | |
90ee1b18 | 492 | ## [2.3.3] - 2022-10-15 |
1a76932b JB |
493 | |
494 | ### Added | |
495 | ||
496 | - Add support for [cluster settings](https://nodejs.org/api/cluster.html#cluster_cluster_settings) in cluster pool options. | |
497 | ||
90ee1b18 | 498 | ## [2.3.2] - 2022-10-14 |
11df3590 JB |
499 | |
500 | ### Changed | |
501 | ||
502 | - Optimize fair share worker selection strategy implementation. | |
503 | ||
504 | ### Fixed | |
505 | ||
506 | - Fix WRR worker selection strategy: ensure the condition triggering the round robin can be fulfilled. | |
507 | ||
90ee1b18 | 508 | ## [2.3.1] - 2022-10-13 |
23ff945a JB |
509 | |
510 | ### Added | |
511 | ||
512 | - Pool worker choice strategies: | |
513 | - `WorkerChoiceStrategies.WEIGHTED_ROUND_ROBIN` strategy based on weighted round robin scheduling algorithm using tasks execution time for now. | |
514 | - `WorkerChoiceStrategies.FAIR_SHARE` strategy based on fair share scheduling algorithm using tasks execution time for now. | |
515 | ||
90ee1b18 | 516 | ## [2.2.2] - 2022-10-09 |
cb2b6c69 JB |
517 | |
518 | ### Fixed | |
519 | ||
520 | - Fixed `README.md` file. | |
521 | ||
90ee1b18 | 522 | ## [2.2.1] - 2022-10-08 |
bdacc2d2 | 523 | |
bdaf31cd JB |
524 | ### Added |
525 | ||
526 | - Dynamic worker choice strategy change at runtime. | |
bdacc2d2 | 527 | |
90ee1b18 | 528 | ## [2.2.0] - 2022-01-05 |
7e0d447f JB |
529 | |
530 | ### Breaking Changes | |
531 | ||
532 | - Support only NodeJS version 16.x.x for cluster pool: upstream cluster API have changed on that version. | |
533 | ||
90ee1b18 | 534 | ## [2.1.0] - 2021-08-29 |
35cf1c03 JB |
535 | |
536 | ### Added | |
537 | ||
538 | - Add an optional pool option `messageHandler` to `PoolOptions<Worker>` for registering a message handler callback on each worker. | |
e088a00c JB |
539 | |
540 | ### Breaking Changes | |
541 | ||
542 | - `AbstractWorker` class `maxInactiveTime`, `killBehavior` and `async` attributes have been removed in favour of the same ones in the worker options `opts` public attribute. | |
543 | - `AbstractWorker` class `lastTask` attribute have been renamed to `lastTaskTimestamp`. | |
544 | - `AbstractWorker` class `interval` attribute have been renamed to `aliveInterval`. | |
c365b2d3 | 545 | - `AbstractWorker` class cannot be instantiated without specifying the `mainWorker` argument referencing the main worker. |
e088a00c | 546 | |
90ee1b18 | 547 | ## [2.0.2] - 2021-05-12 |
14916bf9 JB |
548 | |
549 | ### Bug fixes | |
550 | ||
551 | - Fix `busy` event emission on fixed pool type | |
552 | ||
90ee1b18 | 553 | ## [2.0.1] - 2021-03-16 |
7f685093 JB |
554 | |
555 | ### Bug fixes | |
556 | ||
557 | - Check if pool options are properly set. | |
558 | - `busy` event is emitted on all pool types. | |
559 | ||
90ee1b18 | 560 | ## [2.0.0] - 2021-03-01 |
fa0f5b28 | 561 | |
f3f833ab | 562 | ### Bug fixes |
d63d3be3 | 563 | |
ddbeaffd | 564 | - Now a thread/process by default is not deleted when the task submitted take more time than maxInactiveTime configured (issue #70). |
d63d3be3 | 565 | |
fa0f5b28 S |
566 | ### Breaking Changes |
567 | ||
7f685093 | 568 | - `FullPool` event is now renamed to `busy`. |
1927ee67 | 569 | - `maxInactiveTime` on `ThreadWorker` default behavior is now changed, if you want to keep the old behavior set `killBehavior` to `KillBehaviors.HARD`. |
1a81f8af | 570 | _Find more details on our JSDoc._ |
ddbeaffd | 571 | |
1927ee67 APA |
572 | - `maxTasks` option on `FixedThreadPool` and `DynamicThreadPool` is now removed since is no more needed. |
573 | ||
ddbeaffd | 574 | - We changed some internal structures, but you shouldn't be too affected by them as these are internal changes. |
fa0f5b28 | 575 | |
ec2ccfc8 JB |
576 | ### Pool options types declaration merge |
577 | ||
578 | `FixedThreadPoolOptions` and `DynamicThreadPoolOptions` type declarations have been merged to `PoolOptions<Worker>`. | |
579 | ||
fa0f5b28 S |
580 | #### New `export` strategy |
581 | ||
582 | ```js | |
583 | // Before | |
777b7824 | 584 | const DynamicThreadPool = require('poolifier/lib/dynamic') |
fa0f5b28 | 585 | // After |
777b7824 | 586 | const { DynamicThreadPool } = require('poolifier/lib/dynamic') |
fa0f5b28 S |
587 | ``` |
588 | ||
589 | But you should always prefer just using | |
590 | ||
591 | ```js | |
777b7824 | 592 | const { DynamicThreadPool } = require('poolifier') |
fa0f5b28 S |
593 | ``` |
594 | ||
d3c8a1a8 S |
595 | #### New type definitions for input data and response |
596 | ||
6677a3d3 | 597 | For cluster worker and worker-thread pools, you can now only send and receive structured-cloneable data. |
d3c8a1a8 S |
598 | _This is not a limitation by poolifier but NodeJS._ |
599 | ||
3a4b605f | 600 | #### Public property replacements |
5c5a1fb7 | 601 | |
3a4b605f | 602 | `numWorkers` property is now `numberOfWorkers` |
5c5a1fb7 | 603 | |
280c2a77 | 604 | #### Internal (protected) properties and methods renaming |
fa0f5b28 | 605 | |
280c2a77 S |
606 | These properties are not intended for end users |
607 | ||
608 | - `id` => `nextMessageId` | |
609 | ||
610 | These methods are not intended for end users | |
fa0f5b28 S |
611 | |
612 | - `_chooseWorker` => `chooseWorker` | |
280c2a77 | 613 | - `_newWorker` => `createWorker` |
fa0f5b28 S |
614 | - `_execute` => `internalExecute` |
615 | - `_chooseWorker` => `chooseWorker` | |
616 | - `_checkAlive` => `checkAlive` | |
617 | - `_run` => `run` | |
618 | - `_runAsync` => `runAsync` | |
619 | ||
90ee1b18 | 620 | ## [1.1.0] - 2020-05-21 |
0312f71a APA |
621 | |
622 | ### Added | |
623 | ||
624 | - ThreadWorker support async functions as option | |
cf9aa6c3 | 625 | - Various external library patches |
0312f71a | 626 | |
90ee1b18 | 627 | ## [1.0.0] - 2020-01-24 |
522eea03 | 628 | |
629 | ### Added | |
630 | ||
631 | - FixedThreadPool implementation | |
632 | - DynamicThreadPool implementation | |
0312f71a | 633 | - WorkerThread implementation to improve developer experience |