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