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