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