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