FazBrowse GitHub Viewer | Trending |
URL:
| Home
Tools: [Download Repo ZIP]   [Original HTTPS Page]

quic: add listEndpoints API · nodejs/node@147150c · GitHub

/ node Public

Commit 147150c

Browse files
jasnell
authored and
aduh95
committed
quic: add listEndpoints API
Signed-off-by: James M Snell <jasnell@gmail.com> PR-URL: #63536 Backport-PR-URL: #64675 Reviewed-By: Stephen Belanger <admin@stephenbelanger.com> Reviewed-By: Matteo Collina <matteo.collina@gmail.com> Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
1 parent 3b59d12 commit 147150c

5 files changed

Lines changed: 161 additions & 43 deletions

File tree

‎doc/api/quic.md‎

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -511,6 +511,21 @@ with either a `QuicEndpoint` or `EndpointOptions` as the argument.
511511
At most, any single `QuicEndpoint` can only be configured to listen as
512512
a server once.
513513

514+
## `quic.listEndpoints([options])`
515+
516+
<!-- YAML
517+
added: REPLACEME
518+
-->
519+
520+
* `options` {object}
521+
* `active` {boolean} If `true` (the default), only returns endpoints that are
522+
active (not destroyed, not closing, and not busy). If `false` returns all
523+
endpoints.
524+
* Returns: {quic.QuicEndpoint\[]}
525+
526+
Returns the list of all `QuicEndpoint` instances. By default, only active
527+
endpoints are returned.
528+
514529
## `quic.constants`
515530

516531
<!-- YAML

‎lib/internal/quic/quic.js‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
/* c8 ignore start */
66

77
const {
8+
ArrayFrom,
89
ArrayIsArray,
910
ArrayPrototypePush,
1011
BigInt,
@@ -4737,6 +4738,24 @@ function findSuitableEndpoint(targetAddress) {
47374738
return undefined;
47384739
}
47394740

4741+
/**
4742+
* Returns a list of all active endpoints.
4743+
* @param {object} [options]
4744+
* @param {boolean} [options.active] When true, only return endpoints that are not destroyed, closing, or busy.
4745+
* @returns {QuicEndpoint[]}
4746+
*/
4747+
function listEndpoints(options = kEmptyObject) {
4748+
validateObject(options, 'options');
4749+
const { active = true } = options;
4750+
validateBoolean(active, 'options.active');
4751+
if (!active) {
4752+
return ArrayFrom(endpointRegistry);
4753+
}
4754+
return ArrayFrom(endpointRegistry).filter((endpoint) => {
4755+
return !endpoint.destroyed && !endpoint.closing && !endpoint.busy;
4756+
});
4757+
}
4758+
47404759
/**
47414760
* @param {EndpointOptions|QuicEndpoint|undefined} endpoint
47424761
* @param {boolean} reuseEndpoint
@@ -5340,6 +5359,7 @@ module.exports = {
53405359
getQuicStreamState,
53415360
getQuicSessionState,
53425361
getQuicEndpointState,
5362+
listEndpoints,
53435363
};
53445364

53455365
/* c8 ignore stop */

‎lib/quic.js‎

Lines changed: 21 additions & 37 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,5 @@
11
'use strict';
22

3-
const {
4-
ObjectCreate,
5-
ObjectSeal,
6-
} = primordials;
7-
83
const {
94
emitExperimentalWarning,
105
} = require('internal/util');
@@ -24,43 +19,32 @@ const {
2419
DEFAULT_GROUPS,
2520
} = require('internal/quic/quic');
2621

27-
function getEnumerableConstant(value) {
28-
return {
29-
__proto__: null,
30-
value,
31-
enumerable: true,
32-
configurable: false,
33-
writable: false,
34-
};
35-
}
36-
37-
const cc = ObjectSeal(ObjectCreate(null, {
38-
__proto__: null,
39-
RENO: getEnumerableConstant(CC_ALGO_RENO),
40-
CUBIC: getEnumerableConstant(CC_ALGO_CUBIC),
41-
BBR: getEnumerableConstant(CC_ALGO_BBR),
42-
}));
22+
const cc = {
23+
get RENO() { return CC_ALGO_RENO; },
24+
get CUBIC() { return CC_ALGO_CUBIC; },
25+
get BBR() { return CC_ALGO_BBR; },
26+
};
4327

44-
const constants = ObjectSeal(ObjectCreate(null, {
45-
__proto__: null,
46-
cc: getEnumerableConstant(cc),
47-
DEFAULT_CIPHERS: getEnumerableConstant(DEFAULT_CIPHERS),
48-
DEFAULT_GROUPS: getEnumerableConstant(DEFAULT_GROUPS),
49-
}));
28+
const constants = {
29+
get cc() { return cc; },
30+
get DEFAULT_CIPHERS() { return DEFAULT_CIPHERS; },
31+
get DEFAULT_GROUPS() { return DEFAULT_GROUPS; },
32+
};
5033

51-
module.exports = ObjectSeal(ObjectCreate(null, {
52-
__proto__: null,
53-
connect: getEnumerableConstant(connect),
54-
listen: getEnumerableConstant(listen),
55-
QuicEndpoint: getEnumerableConstant(QuicEndpoint),
56-
QuicError: getEnumerableConstant(QuicError),
57-
QuicSession: getEnumerableConstant(QuicSession),
58-
QuicStream: getEnumerableConstant(QuicStream),
59-
constants: getEnumerableConstant(constants),
34+
module.exports = {
35+
connect,
36+
listen,
37+
QuicEndpoint,
38+
QuicError,
39+
QuicSession,
40+
QuicStream,
41+
get constants() {
42+
return constants;
43+
},
6044

6145
CC_ALGO_RENO,
6246
CC_ALGO_CUBIC,
6347
CC_ALGO_BBR,
6448
DEFAULT_CIPHERS,
6549
DEFAULT_GROUPS,
66-
}));
50+
};

‎test/parallel/test-quic-exports.mjs‎

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,11 +35,5 @@ strictEqual(quic.constants.DEFAULT_GROUPS, 'X25519:P-256:P-384:P-521');
3535
throws(() => { quic.constants.cc.RENO = 'foo'; }, TypeError);
3636
strictEqual(quic.constants.cc.RENO, 'reno');
3737

38-
throws(() => { quic.constants.cc.NEW_CONSTANT = 'bar'; }, TypeError);
39-
strictEqual(quic.constants.cc.NEW_CONSTANT, undefined);
40-
4138
throws(() => { quic.constants.DEFAULT_CIPHERS = 123; }, TypeError);
4239
strictEqual(typeof quic.constants.DEFAULT_CIPHERS, 'string');
43-
44-
throws(() => { quic.constants.NEW_CONSTANT = 456; }, TypeError);
45-
strictEqual(quic.constants.NEW_CONSTANT, undefined);

‎test/parallel/test-quic-list-endpoints.mjs‎

Lines changed: 105 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,105 @@
1+
// Flags: --experimental-quic --no-warnings
2+
3+
// Test: listEndpoints returns live endpoints filtered by active state.
4+
// - Returns an empty array when no endpoints exist.
5+
// - Includes all created endpoints.
6+
// - active=true (default) filters out destroyed, closing, and busy endpoints.
7+
// - active=false returns all registered endpoints regardless of state.
8+
// - Validates options argument types.
9+
10+
import { hasQuic, skip } from '../common/index.mjs';
11+
import assert from 'node:assert';
12+
13+
const { deepStrictEqual, strictEqual, throws, ok } = assert;
14+
15+
if (!hasQuic) {
16+
skip('QUIC is not enabled');
17+
}
18+
19+
const { listEndpoints, QuicEndpoint } = await import('node:quic');
20+
21+
// listEndpoints is exported as a function.
22+
strictEqual(typeof listEndpoints, 'function');
23+
24+
// Empty when no endpoints have been created.
25+
deepStrictEqual(listEndpoints(), []);
26+
deepStrictEqual(listEndpoints({ active: false }), []);
27+
28+
// Created endpoints appear in the list.
29+
{
30+
const ep1 = new QuicEndpoint();
31+
const ep2 = new QuicEndpoint();
32+
33+
const list = listEndpoints();
34+
strictEqual(list.length, 2);
35+
ok(list.includes(ep1));
36+
ok(list.includes(ep2));
37+
38+
// active=false also returns them.
39+
const all = listEndpoints({ active: false });
40+
strictEqual(all.length, 2);
41+
ok(all.includes(ep1));
42+
ok(all.includes(ep2));
43+
44+
// Returns plain QuicEndpoint instances, not wrapped in arrays.
45+
ok(list[0] instanceof QuicEndpoint);
46+
ok(list[1] instanceof QuicEndpoint);
47+
48+
await ep1.close();
49+
await ep2.close();
50+
}
51+
52+
// Destroyed endpoints are excluded by active filter.
53+
{
54+
const ep = new QuicEndpoint();
55+
strictEqual(listEndpoints().length, 1);
56+
57+
await ep.close();
58+
await ep.closed;
59+
strictEqual(ep.destroyed, true);
60+
61+
// Default (active=true) excludes destroyed endpoint.
62+
strictEqual(listEndpoints().length, 0);
63+
64+
// active=false still includes it... but destroyed endpoints are removed
65+
// from the registry entirely in kFinishClose, so it won't appear at all.
66+
strictEqual(listEndpoints({ active: false }).length, 0);
67+
}
68+
69+
// Busy endpoints are excluded by the active filter.
70+
{
71+
const ep = new QuicEndpoint();
72+
strictEqual(listEndpoints().length, 1);
73+
74+
ep.busy = true;
75+
strictEqual(ep.busy, true);
76+
77+
// active=true excludes busy endpoint.
78+
strictEqual(listEndpoints().length, 0);
79+
80+
// active=false includes it.
81+
const all = listEndpoints({ active: false });
82+
strictEqual(all.length, 1);
83+
ok(all.includes(ep));
84+
85+
ep.busy = false;
86+
87+
// After un-busying, it reappears in the active list.
88+
strictEqual(listEndpoints().length, 1);
89+
90+
await ep.close();
91+
}
92+
93+
// Options validation.
94+
throws(() => listEndpoints('bad'), {
95+
code: 'ERR_INVALID_ARG_TYPE',
96+
});
97+
throws(() => listEndpoints(null), {
98+
code: 'ERR_INVALID_ARG_TYPE',
99+
});
100+
throws(() => listEndpoints({ active: 'yes' }), {
101+
code: 'ERR_INVALID_ARG_TYPE',
102+
});
103+
throws(() => listEndpoints({ active: 1 }), {
104+
code: 'ERR_INVALID_ARG_TYPE',
105+
});

0 commit comments

Comments
 (0)
Back | FazBrowse Home | New Git URL