@norskvideo/moq-net 0.1.8 → 0.2.1

package/ietf/cluster.js

@@ -1,22 +1,23 @@
 /* @ts-self-types="./cluster.d.ts" */
 /**
- * The MoQ Cluster extension (draft-lcurley-moq-cluster-00).
+ * The MoQ Cluster extension (draft-lcurley-moq-cluster-01).
  *
  * moq-transport carries no routing information, so a peer cannot tell whether an
  * advertisement already passed through us. This extension adds it:
  *
- * - each endpoint declares its own Hop ID via the RELAY_HOPS Setup Option, which is also
- *   what negotiates the extension;
+ * - each endpoint declares its own Hop ID via the HOP_ID Setup Option, which is also what
+ *   negotiates the extension;
  * - every advertisement carries the HOP_PATH it traversed and the accumulated ROUTE_COST
- *   of that path, as Key-Value-Pair message parameters on PUBLISH_NAMESPACE and NAMESPACE.
+ *   of that path, as Key-Value-Pair message parameters on PUBLISH_NAMESPACE and NAMESPACE,
+ *   and a PUBLISH_NAMESPACE is repriced with the same parameters on a REQUEST_UPDATE.
  *
  * These are the semantics moq-lite carries natively on every announcement (see
  * `lite/announce.ts`); this module is the moq-transport binding, negotiated on draft-17+
  * only, where SETUP is a Key-Value-Pair block.
  *
- * We are a leaf, never a relay: the only path we can advertise is our own, so we stamp a
- * single-entry HOP_PATH and seed the cost at 0. What we get out of declaring is the other
- * direction. A relay that knows our Hop ID withholds the advertisements that already flowed
+ * A broadcast we produce carries a single-entry HOP_PATH and a cost of 0, and a route we
+ * forward carries its own hop chain and warm cost with our id appended. What we get out of
+ * declaring is also the other direction. A relay that knows our Hop ID withholds the advertisements that already flowed
  * through us, so publishing a broadcast no longer announces it back to us, which is what
  * moq-lite has always done with its own hop chain.
  *
@@ -24,7 +25,7 @@
  * @internal
  */
 import { ProtocolViolation, reason } from "../error.js";
-import { MAX_HOPS, OriginSchema, UNKNOWN_ORIGIN } from "../origin.js";
+import { HopSchema, MAX_HOPS, UNKNOWN_HOP } from "../hop.js";
 import * as Varint from "../varint.js";
 import { Parameters, SetupOption } from "./parameters.js";
 import { Version } from "./version.js";
@@ -48,16 +49,11 @@ export function supported(version) {
 export function fromSetup(params, version) {
     if (!supported(version))
         return undefined;
-    // RELAY_HOPS is odd, so its value is a length-prefixed byte string holding the sender's
-    // Hop ID as a single varint. 0 is legal: the peer speaks the extension but withholds
-    // its identity.
-    const value = params.getBytes(SetupOption.RelayHops);
+    // 0 is legal: the peer speaks the extension but withholds its identity.
+    const value = params.getVarint(SetupOption.HopId);
     if (value === undefined)
         return undefined;
-    const [origin, rest] = Varint.decodeLeadingOnes(value);
-    if (rest.length !== 0)
-        throw new Error("trailing bytes in RELAY_HOPS");
-    return OriginSchema.parse(origin);
+    return HopSchema.parse(value);
 }
 /**
  * Declare our own Hop ID, which is also what negotiates the extension.
@@ -67,7 +63,7 @@ export function fromSetup(params, version) {
 export function intoSetup(params, self, version) {
     if (!supported(version))
         return;
-    params.setBytes(SetupOption.RelayHops, Varint.encodeLeadingOnes(self));
+    params.setVarint(SetupOption.HopId, self);
 }
 /**
  * Whether the session negotiated the extension, which is what decides whether an
@@ -104,7 +100,7 @@ export function advertise(ids) {
  * @internal
  */
 export function loops(advert, self) {
-    return self !== UNKNOWN_ORIGIN && advert.hops.includes(self);
+    return self !== UNKNOWN_HOP && advert.hops.includes(self);
 }
 /**
  * Write an advertisement's parameters, ready to encode onto the wire.
@@ -112,23 +108,40 @@ export function loops(advert, self) {
  * @internal
  */
 export function intoParams(advert) {
-    validate(advert.hops);
     const params = new Parameters();
-    // The entries fill the value, so they are written with no count of their own and framed
-    // by the parameter's own length prefix.
-    const hops = advert.hops.map((hop) => Varint.encodeLeadingOnes(hop));
-    const value = new Uint8Array(hops.reduce((total, hop) => total + hop.length, 0));
-    let offset = 0;
-    for (const hop of hops) {
-        value.set(hop, offset);
-        offset += hop.length;
-    }
-    params.hopPath = value;
+    params.hopPath = encodeHops(advert.hops);
     // Absent means 0, so a free path sends nothing.
     if (advert.cost !== 0n)
         params.routeCost = advert.cost;
     return params;
 }
+/**
+ * Write a REQUEST_UPDATE's parameters: only what changed, and a cost of 0 explicitly,
+ * since an omitted parameter keeps its value.
+ *
+ * @internal
+ */
+export function updateIntoParams(update) {
+    const params = new Parameters();
+    if (update.hops !== undefined)
+        params.hopPath = encodeHops(update.hops);
+    if (update.cost !== undefined)
+        params.routeCost = update.cost;
+    return params;
+}
+/** Write a HOP_PATH value: the entries fill it with no count of their own, framed by the
+ * parameter's own length prefix. */
+function encodeHops(hops) {
+    validate(hops);
+    const encoded = hops.map((hop) => Varint.encodeLeadingOnes(hop));
+    const value = new Uint8Array(encoded.reduce((total, hop) => total + hop.length, 0));
+    let offset = 0;
+    for (const hop of encoded) {
+        value.set(hop, offset);
+        offset += hop.length;
+    }
+    return value;
+}
 /**
  * Read the parameters a negotiated session puts on every advertisement.
  *
@@ -163,25 +176,52 @@ export function fromParams(params) {
         const value = params.hopPath;
         if (value === undefined)
             throw new Error("advertisement is missing HOP_PATH");
-        const hops = [];
-        let rest = value;
-        while (rest.length > 0) {
-            // A short read here means the entries did not exactly fill the length.
-            const [hop, remain] = Varint.decodeLeadingOnes(rest);
-            hops.push(OriginSchema.parse(hop));
-            rest = remain;
-            // Bail before the buffer does: a hostile length would otherwise cost us one
-            // allocation per entry all the way to 64KB of parameter value.
-            if (hops.length > MAX_HOPS)
-                throw new Error(`hop count exceeds maximum ${MAX_HOPS}`);
-        }
-        validate(hops);
-        return { hops, cost: params.routeCost ?? 0n };
+        return { hops: decodeHops(value), cost: params.routeCost ?? 0n };
+    }
+    catch (err) {
+        throw new ProtocolViolation(reason(err), { cause: err });
+    }
+}
+/**
+ * Read a REQUEST_UPDATE's parameters: each is optional, and a malformed HOP_PATH is the
+ * same violation it is on an advertisement.
+ *
+ * @internal
+ */
+export function updateFromParams(params) {
+    try {
+        const value = params.hopPath;
+        return { hops: value === undefined ? undefined : decodeHops(value), cost: params.routeCost };
     }
     catch (err) {
         throw new ProtocolViolation(reason(err), { cause: err });
     }
 }
+/**
+ * The advertisement after `update` lands on `held`: an omitted parameter keeps its value.
+ *
+ * @internal
+ */
+export function apply(held, update) {
+    return { hops: update.hops ?? held.hops, cost: update.cost ?? held.cost };
+}
+/** Read a HOP_PATH value: bare varints filling the parameter, with no count of their own. */
+function decodeHops(value) {
+    const hops = [];
+    let rest = value;
+    while (rest.length > 0) {
+        // A short read here means the entries did not exactly fill the length.
+        const [hop, remain] = Varint.decodeLeadingOnes(rest);
+        hops.push(HopSchema.parse(hop));
+        rest = remain;
+        // Bail before the buffer does: a hostile length would otherwise cost us one
+        // allocation per entry all the way to 64KB of parameter value.
+        if (hops.length > MAX_HOPS)
+            throw new Error(`hop count exceeds maximum ${MAX_HOPS}`);
+    }
+    validate(hops);
+    return hops;
+}
 /**
  * Reject a path that cannot have come from a conforming sender: an empty list, one longer
  * than we accept, or a non-zero Hop ID appearing twice (a loop). Duplicate zeros are legal,
@@ -195,7 +235,7 @@ function validate(hops) {
     // MAX_HOPS is 32, so the quadratic scan is cheaper than allocating a set.
     for (let i = 0; i < hops.length; i++) {
         const hop = hops[i];
-        if (hop === UNKNOWN_ORIGIN)
+        if (hop === UNKNOWN_HOP)
             continue;
         if (hops.indexOf(hop, i + 1) !== -1)
             throw new Error(`hop ${hop} appears twice in the hop path`);

package/ietf/cluster.js.map

@@ -1 +1 @@
-{"version":3,"file":"cluster.js","sourceRoot":"","sources":["../../src/ietf/cluster.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;GAuBG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAe,YAAY,EAAE,cAAc,EAAE,MAAM,cAAc,CAAC;AAEnF,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAqB,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAoB,OAAO,EAAE,MAAM,cAAc,CAAC;AAEzD;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAC,OAAoB;IAC7C,OAAO,OAAO,KAAK,OAAO,CAAC,QAAQ,IAAI,OAAO,KAAK,OAAO,CAAC,QAAQ,IAAI,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC;AACrG,CAAC;AAwCD;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,MAAoB,EAAE,OAAoB;IACnE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;QAAE,OAAO,SAAS,CAAC;IAE1C,wFAAwF;IACxF,qFAAqF;IACrF,gBAAgB;IAChB,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,CAAC,CAAC;IACrD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAE1C,MAAM,CAAC,MAAM,EAAE,IAAI,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,KAAK,CAAC,CAAC;IACvD,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,8BAA8B,CAAC,CAAC;IACvE,OAAO,YAAY,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC;AACnC,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,MAAoB,EAAE,IAAY,EAAE,OAAoB;IACjF,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;QAAE,OAAO;IAChC,MAAM,CAAC,QAAQ,CAAC,WAAW,CAAC,SAAS,EAAE,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC,CAAC;AACxE,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAqB;IAC/C,OAAO,GAAG,EAAE,IAAI,KAAK,SAAS,CAAC;AAChC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,GAAqB;IAC9C,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAClE,OAAO,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,KAAK,CAAC,MAAc,EAAE,IAAY;IACjD,OAAO,IAAI,KAAK,cAAc,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC9D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc;IACxC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEtB,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;IAEhC,wFAAwF;IACxF,wCAAwC;IACxC,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;IACrE,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACjF,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,GAAG,IAAI,IAAI,EAAE,CAAC;QACxB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACvB,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC;IACtB,CAAC;IACD,MAAM,CAAC,OAAO,GAAG,KAAK,CAAC;IAEvB,gDAAgD;IAChD,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE;QAAE,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC;IAEvD,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,CAAS,EAAE,OAAoB;IACjE,IAAI,MAAkB,CAAC;IACvB,IAAI,CAAC;QACJ,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,UAAU,CAAC,MAAkB;IAC5C,IAAI,CAAC;QACJ,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC;QAC7B,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAE9E,MAAM,IAAI,GAAa,EAAE,CAAC;QAC1B,IAAI,IAAI,GAAG,KAAK,CAAC;QACjB,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACxB,uEAAuE;YACvE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;YACrD,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;YACnC,IAAI,GAAG,MAAM,CAAC;YAEd,4EAA4E;YAC5E,+DAA+D;YAC/D,IAAI,IAAI,CAAC,MAAM,GAAG,QAAQ;gBAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,EAAE,CAAC,CAAC;QACtF,CAAC;QAED,QAAQ,CAAC,IAAI,CAAC,CAAC;QACf,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;IAC/C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1D,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,IAAc;IAC/B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC5D,IAAI,IAAI,CAAC,MAAM,GAAG,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,CAAC,MAAM,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IAEpG,0EAA0E;IAC1E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,GAAG,KAAK,cAAc;YAAE,SAAS;QACrC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,GAAG,gCAAgC,CAAC,CAAC;IAClG,CAAC;AACF,CAAC","sourcesContent":["/**\n * The MoQ Cluster extension (draft-lcurley-moq-cluster-00).\n *\n * moq-transport carries no routing information, so a peer cannot tell whether an\n * advertisement already passed through us. This extension adds it:\n *\n * - each endpoint declares its own Hop ID via the RELAY_HOPS Setup Option, which is also\n *   what negotiates the extension;\n * - every advertisement carries the HOP_PATH it traversed and the accumulated ROUTE_COST\n *   of that path, as Key-Value-Pair message parameters on PUBLISH_NAMESPACE and NAMESPACE.\n *\n * These are the semantics moq-lite carries natively on every announcement (see\n * `lite/announce.ts`); this module is the moq-transport binding, negotiated on draft-17+\n * only, where SETUP is a Key-Value-Pair block.\n *\n * We are a leaf, never a relay: the only path we can advertise is our own, so we stamp a\n * single-entry HOP_PATH and seed the cost at 0. What we get out of declaring is the other\n * direction. A relay that knows our Hop ID withholds the advertisements that already flowed\n * through us, so publishing a broadcast no longer announces it back to us, which is what\n * moq-lite has always done with its own hop chain.\n *\n * @module\n * @internal\n */\n\nimport { ProtocolViolation, reason } from \"../error.ts\";\nimport { MAX_HOPS, type Origin, OriginSchema, UNKNOWN_ORIGIN } from \"../origin.ts\";\nimport type { Reader } from \"../stream.ts\";\nimport * as Varint from \"../varint.ts\";\nimport { Parameters, SetupOption, type SetupOptions } from \"./parameters.ts\";\nimport { type IetfVersion, Version } from \"./version.ts\";\n\n/**\n * Whether a version can negotiate the extension.\n *\n * Draft-17 is the first with the unified SETUP: a bare Key-Value-Pair block that a new\n * option slots into without touching the message shape. Earlier drafts exchange SETUP over\n * the legacy control stream, which this extension does not cover.\n *\n * @internal\n */\nexport function supported(version: IetfVersion): boolean {\n\treturn version !== Version.DRAFT_14 && version !== Version.DRAFT_15 && version !== Version.DRAFT_16;\n}\n\n/**\n * The Hop IDs this session declared, one per direction.\n *\n * @internal\n */\nexport interface Hops {\n\t/** Our own Hop ID, declared in SETUP and stamped onto every advertisement we send. */\n\tself: Origin;\n\n\t/**\n\t * The peer's Hop ID, or `undefined` when it declared no RELAY_HOPS.\n\t *\n\t * This is what decides whether advertisements carry the parameters at all, in both\n\t * directions: a peer that declared nothing has not read ours either, so sending it a\n\t * HOP_PATH would be a protocol violation and expecting one back would reject a legal\n\t * message. A peer that declared the reserved 0 negotiated the extension but withheld its\n\t * identity, so the parameters flow and there is simply nothing to exclude.\n\t */\n\tpeer?: Origin;\n}\n\n/**\n * The cluster parameters carried on one advertisement.\n *\n * Present on every PUBLISH_NAMESPACE and NAMESPACE of a session that negotiated the\n * extension, and on none of a session that did not.\n *\n * @internal\n */\nexport interface Advert {\n\t/** HOP_PATH: the path this advertisement traversed, publisher first, sender last. */\n\thops: Origin[];\n\n\t/** ROUTE_COST: the marginal cost of subscribing via this advertisement. Absent on the\n\t * wire means 0, so an endpoint that prices nothing sends nothing. */\n\tcost: bigint;\n}\n\n/**\n * Read the peer's Hop ID out of its SETUP, or `undefined` when it did not negotiate.\n *\n * @internal\n */\nexport function fromSetup(params: SetupOptions, version: IetfVersion): Origin | undefined {\n\tif (!supported(version)) return undefined;\n\n\t// RELAY_HOPS is odd, so its value is a length-prefixed byte string holding the sender's\n\t// Hop ID as a single varint. 0 is legal: the peer speaks the extension but withholds\n\t// its identity.\n\tconst value = params.getBytes(SetupOption.RelayHops);\n\tif (value === undefined) return undefined;\n\n\tconst [origin, rest] = Varint.decodeLeadingOnes(value);\n\tif (rest.length !== 0) throw new Error(\"trailing bytes in RELAY_HOPS\");\n\treturn OriginSchema.parse(origin);\n}\n\n/**\n * Declare our own Hop ID, which is also what negotiates the extension.\n *\n * @internal\n */\nexport function intoSetup(params: SetupOptions, self: Origin, version: IetfVersion) {\n\tif (!supported(version)) return;\n\tparams.setBytes(SetupOption.RelayHops, Varint.encodeLeadingOnes(self));\n}\n\n/**\n * Whether the session negotiated the extension, which is what decides whether an\n * advertisement carries the parameters in either direction.\n *\n * @internal\n */\nexport function negotiated(ids: Hops | undefined): boolean {\n\treturn ids?.peer !== undefined;\n}\n\n/**\n * The advertisement to send for one of our own broadcasts, or `undefined` on a session\n * that negotiated nothing.\n *\n * The sender's own Hop ID is always the last entry, so a receiver reconstructs the full\n * path without the sender restating it. We originate everything we advertise, so the path\n * is just us and the cost is 0: a subscription costs the peer nothing but the transfer,\n * since we are already producing the content.\n *\n * @internal\n */\nexport function advertise(ids: Hops | undefined): Advert | undefined {\n\tif (ids === undefined || ids.peer === undefined) return undefined;\n\treturn { hops: [ids.self], cost: 0n };\n}\n\n/**\n * Whether this advertisement looped back through `self`.\n *\n * A receiver discards such an advertisement: forwarding it would extend the loop, and\n * subscribing through it would route the receiver back to itself. Hop ID 0 identifies\n * nothing, so a receiver that withheld its own identity detects nothing.\n *\n * @internal\n */\nexport function loops(advert: Advert, self: Origin): boolean {\n\treturn self !== UNKNOWN_ORIGIN && advert.hops.includes(self);\n}\n\n/**\n * Write an advertisement's parameters, ready to encode onto the wire.\n *\n * @internal\n */\nexport function intoParams(advert: Advert): Parameters {\n\tvalidate(advert.hops);\n\n\tconst params = new Parameters();\n\n\t// The entries fill the value, so they are written with no count of their own and framed\n\t// by the parameter's own length prefix.\n\tconst hops = advert.hops.map((hop) => Varint.encodeLeadingOnes(hop));\n\tconst value = new Uint8Array(hops.reduce((total, hop) => total + hop.length, 0));\n\tlet offset = 0;\n\tfor (const hop of hops) {\n\t\tvalue.set(hop, offset);\n\t\toffset += hop.length;\n\t}\n\tparams.hopPath = value;\n\n\t// Absent means 0, so a free path sends nothing.\n\tif (advert.cost !== 0n) params.routeCost = advert.cost;\n\n\treturn params;\n}\n\n/**\n * Read the parameters a negotiated session puts on every advertisement.\n *\n * The parameter block is mandatory there, so a message that ends before it (the base form)\n * or one whose block does not parse is the peer's violation, same as a block that parses but\n * carries no HOP_PATH.\n *\n * @internal\n */\nexport async function decodeParams(r: Reader, version: IetfVersion): Promise<Advert> {\n\tlet params: Parameters;\n\ttry {\n\t\tparams = await Parameters.decode(r, version);\n\t} catch (err) {\n\t\tthrow new ProtocolViolation(reason(err), { cause: err });\n\t}\n\n\treturn fromParams(params);\n}\n\n/**\n * Read an advertisement out of a decoded parameter block.\n *\n * Every way this fails is one the draft says to close the session over: a negotiated session\n * that omits HOP_PATH, entries that do not exactly fill the parameter, an empty list, or a\n * non-zero Hop ID appearing twice. So they all surface as one {@link ProtocolViolation},\n * which the session dispatch acts on.\n *\n * @internal\n */\nexport function fromParams(params: Parameters): Advert {\n\ttry {\n\t\tconst value = params.hopPath;\n\t\tif (value === undefined) throw new Error(\"advertisement is missing HOP_PATH\");\n\n\t\tconst hops: Origin[] = [];\n\t\tlet rest = value;\n\t\twhile (rest.length > 0) {\n\t\t\t// A short read here means the entries did not exactly fill the length.\n\t\t\tconst [hop, remain] = Varint.decodeLeadingOnes(rest);\n\t\t\thops.push(OriginSchema.parse(hop));\n\t\t\trest = remain;\n\n\t\t\t// Bail before the buffer does: a hostile length would otherwise cost us one\n\t\t\t// allocation per entry all the way to 64KB of parameter value.\n\t\t\tif (hops.length > MAX_HOPS) throw new Error(`hop count exceeds maximum ${MAX_HOPS}`);\n\t\t}\n\n\t\tvalidate(hops);\n\t\treturn { hops, cost: params.routeCost ?? 0n };\n\t} catch (err) {\n\t\tthrow new ProtocolViolation(reason(err), { cause: err });\n\t}\n}\n\n/**\n * Reject a path that cannot have come from a conforming sender: an empty list, one longer\n * than we accept, or a non-zero Hop ID appearing twice (a loop). Duplicate zeros are legal,\n * since 0 identifies nothing.\n */\nfunction validate(hops: Origin[]) {\n\tif (hops.length === 0) throw new Error(\"hop path is empty\");\n\tif (hops.length > MAX_HOPS) throw new Error(`hop count ${hops.length} exceeds maximum ${MAX_HOPS}`);\n\n\t// MAX_HOPS is 32, so the quadratic scan is cheaper than allocating a set.\n\tfor (let i = 0; i < hops.length; i++) {\n\t\tconst hop = hops[i];\n\t\tif (hop === UNKNOWN_ORIGIN) continue;\n\t\tif (hops.indexOf(hop, i + 1) !== -1) throw new Error(`hop ${hop} appears twice in the hop path`);\n\t}\n}\n"]}
+{"version":3,"file":"cluster.js","sourceRoot":"","sources":["../../src/ietf/cluster.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;;;;;;;;GAwBG;AAEH,OAAO,EAAE,iBAAiB,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACxD,OAAO,EAAY,SAAS,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,WAAW,CAAC;AAEvE,OAAO,KAAK,MAAM,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,UAAU,EAAE,WAAW,EAAqB,MAAM,iBAAiB,CAAC;AAC7E,OAAO,EAAoB,OAAO,EAAE,MAAM,cAAc,CAAC;AAEzD;;;;;;;;GAQG;AACH,MAAM,UAAU,SAAS,CAAC,OAAoB;IAC7C,OAAO,OAAO,KAAK,OAAO,CAAC,QAAQ,IAAI,OAAO,KAAK,OAAO,CAAC,QAAQ,IAAI,OAAO,KAAK,OAAO,CAAC,QAAQ,CAAC;AACrG,CAAC;AAuDD;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,MAAoB,EAAE,OAAoB;IACnE,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;QAAE,OAAO,SAAS,CAAC;IAE1C,wEAAwE;IACxE,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,CAAC,CAAC;IAClD,IAAI,KAAK,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAC1C,OAAO,SAAS,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;AAC/B,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,SAAS,CAAC,MAAoB,EAAE,IAAS,EAAE,OAAoB;IAC9E,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC;QAAE,OAAO;IAChC,MAAM,CAAC,SAAS,CAAC,WAAW,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,UAAU,CAAC,GAAqB;IAC/C,OAAO,GAAG,EAAE,IAAI,KAAK,SAAS,CAAC;AAChC,CAAC;AAED;;;;;;;;;;GAUG;AACH,MAAM,UAAU,SAAS,CAAC,GAAqB;IAC9C,IAAI,GAAG,KAAK,SAAS,IAAI,GAAG,CAAC,IAAI,KAAK,SAAS;QAAE,OAAO,SAAS,CAAC;IAClE,OAAO,EAAE,IAAI,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,EAAE,EAAE,CAAC;AACvC,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,UAAU,KAAK,CAAC,MAAc,EAAE,IAAS;IAC9C,OAAO,IAAI,KAAK,WAAW,IAAI,MAAM,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;AAC3D,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,MAAc;IACxC,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;IAChC,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IAEzC,gDAAgD;IAChD,IAAI,MAAM,CAAC,IAAI,KAAK,EAAE;QAAE,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC;IAEvD,OAAO,MAAM,CAAC;AACf,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAc;IAC9C,MAAM,MAAM,GAAG,IAAI,UAAU,EAAE,CAAC;IAChC,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,OAAO,GAAG,UAAU,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC;IACxE,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS;QAAE,MAAM,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC;IAC9D,OAAO,MAAM,CAAC;AACf,CAAC;AAED;oCACoC;AACpC,SAAS,UAAU,CAAC,IAAW;IAC9B,QAAQ,CAAC,IAAI,CAAC,CAAC;IAEf,MAAM,OAAO,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,MAAM,CAAC,iBAAiB,CAAC,GAAG,CAAC,CAAC,CAAC;IACjE,MAAM,KAAK,GAAG,IAAI,UAAU,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,GAAG,EAAE,EAAE,CAAC,KAAK,GAAG,GAAG,CAAC,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;IACpF,IAAI,MAAM,GAAG,CAAC,CAAC;IACf,KAAK,MAAM,GAAG,IAAI,OAAO,EAAE,CAAC;QAC3B,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;QACvB,MAAM,IAAI,GAAG,CAAC,MAAM,CAAC;IACtB,CAAC;IACD,OAAO,KAAK,CAAC;AACd,CAAC;AAED;;;;;;;;GAQG;AACH,MAAM,CAAC,KAAK,UAAU,YAAY,CAAC,CAAS,EAAE,OAAoB;IACjE,IAAI,MAAkB,CAAC;IACvB,IAAI,CAAC;QACJ,MAAM,GAAG,MAAM,UAAU,CAAC,MAAM,CAAC,CAAC,EAAE,OAAO,CAAC,CAAC;IAC9C,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1D,CAAC;IAED,OAAO,UAAU,CAAC,MAAM,CAAC,CAAC;AAC3B,CAAC;AAED;;;;;;;;;GASG;AACH,MAAM,UAAU,UAAU,CAAC,MAAkB;IAC5C,IAAI,CAAC;QACJ,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC;QAC7B,IAAI,KAAK,KAAK,SAAS;YAAE,MAAM,IAAI,KAAK,CAAC,mCAAmC,CAAC,CAAC;QAC9E,OAAO,EAAE,IAAI,EAAE,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,IAAI,EAAE,EAAE,CAAC;IAClE,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1D,CAAC;AACF,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,gBAAgB,CAAC,MAAkB;IAClD,IAAI,CAAC;QACJ,MAAM,KAAK,GAAG,MAAM,CAAC,OAAO,CAAC;QAC7B,OAAO,EAAE,IAAI,EAAE,KAAK,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,UAAU,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,SAAS,EAAE,CAAC;IAC9F,CAAC;IAAC,OAAO,GAAG,EAAE,CAAC;QACd,MAAM,IAAI,iBAAiB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,EAAE,GAAG,EAAE,CAAC,CAAC;IAC1D,CAAC;AACF,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,KAAK,CAAC,IAAY,EAAE,MAAc;IACjD,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;AAC3E,CAAC;AAED,6FAA6F;AAC7F,SAAS,UAAU,CAAC,KAAiB;IACpC,MAAM,IAAI,GAAU,EAAE,CAAC;IACvB,IAAI,IAAI,GAAG,KAAK,CAAC;IACjB,OAAO,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACxB,uEAAuE;QACvE,MAAM,CAAC,GAAG,EAAE,MAAM,CAAC,GAAG,MAAM,CAAC,iBAAiB,CAAC,IAAI,CAAC,CAAC;QACrD,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,CAAC;QAChC,IAAI,GAAG,MAAM,CAAC;QAEd,4EAA4E;QAC5E,+DAA+D;QAC/D,IAAI,IAAI,CAAC,MAAM,GAAG,QAAQ;YAAE,MAAM,IAAI,KAAK,CAAC,6BAA6B,QAAQ,EAAE,CAAC,CAAC;IACtF,CAAC;IAED,QAAQ,CAAC,IAAI,CAAC,CAAC;IACf,OAAO,IAAI,CAAC;AACb,CAAC;AAED;;;;GAIG;AACH,SAAS,QAAQ,CAAC,IAAW;IAC5B,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,MAAM,IAAI,KAAK,CAAC,mBAAmB,CAAC,CAAC;IAC5D,IAAI,IAAI,CAAC,MAAM,GAAG,QAAQ;QAAE,MAAM,IAAI,KAAK,CAAC,aAAa,IAAI,CAAC,MAAM,oBAAoB,QAAQ,EAAE,CAAC,CAAC;IAEpG,0EAA0E;IAC1E,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE,CAAC;QACtC,MAAM,GAAG,GAAG,IAAI,CAAC,CAAC,CAAC,CAAC;QACpB,IAAI,GAAG,KAAK,WAAW;YAAE,SAAS;QAClC,IAAI,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,CAAC,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;YAAE,MAAM,IAAI,KAAK,CAAC,OAAO,GAAG,gCAAgC,CAAC,CAAC;IAClG,CAAC;AACF,CAAC","sourcesContent":["/**\n * The MoQ Cluster extension (draft-lcurley-moq-cluster-01).\n *\n * moq-transport carries no routing information, so a peer cannot tell whether an\n * advertisement already passed through us. This extension adds it:\n *\n * - each endpoint declares its own Hop ID via the HOP_ID Setup Option, which is also what\n *   negotiates the extension;\n * - every advertisement carries the HOP_PATH it traversed and the accumulated ROUTE_COST\n *   of that path, as Key-Value-Pair message parameters on PUBLISH_NAMESPACE and NAMESPACE,\n *   and a PUBLISH_NAMESPACE is repriced with the same parameters on a REQUEST_UPDATE.\n *\n * These are the semantics moq-lite carries natively on every announcement (see\n * `lite/announce.ts`); this module is the moq-transport binding, negotiated on draft-17+\n * only, where SETUP is a Key-Value-Pair block.\n *\n * A broadcast we produce carries a single-entry HOP_PATH and a cost of 0, and a route we\n * forward carries its own hop chain and warm cost with our id appended. What we get out of\n * declaring is also the other direction. A relay that knows our Hop ID withholds the advertisements that already flowed\n * through us, so publishing a broadcast no longer announces it back to us, which is what\n * moq-lite has always done with its own hop chain.\n *\n * @module\n * @internal\n */\n\nimport { ProtocolViolation, reason } from \"../error.ts\";\nimport { type Hop, HopSchema, MAX_HOPS, UNKNOWN_HOP } from \"../hop.ts\";\nimport type { Reader } from \"../stream.ts\";\nimport * as Varint from \"../varint.ts\";\nimport { Parameters, SetupOption, type SetupOptions } from \"./parameters.ts\";\nimport { type IetfVersion, Version } from \"./version.ts\";\n\n/**\n * Whether a version can negotiate the extension.\n *\n * Draft-17 is the first with the unified SETUP: a bare Key-Value-Pair block that a new\n * option slots into without touching the message shape. Earlier drafts exchange SETUP over\n * the legacy control stream, which this extension does not cover.\n *\n * @internal\n */\nexport function supported(version: IetfVersion): boolean {\n\treturn version !== Version.DRAFT_14 && version !== Version.DRAFT_15 && version !== Version.DRAFT_16;\n}\n\n/**\n * The Hop IDs this session declared, one per direction.\n *\n * @internal\n */\nexport interface Hops {\n\t/** Our own Hop ID, declared in SETUP and stamped onto every advertisement we send. */\n\tself: Hop;\n\n\t/**\n\t * The peer's Hop ID, or `undefined` when it declared no HOP_ID.\n\t *\n\t * This is what decides whether advertisements carry the parameters at all, in both\n\t * directions: a peer that declared nothing has not read ours either, so sending it a\n\t * HOP_PATH would be a protocol violation and expecting one back would reject a legal\n\t * message. A peer that declared the reserved 0 negotiated the extension but withheld its\n\t * identity, so the parameters flow and there is simply nothing to exclude.\n\t */\n\tpeer?: Hop;\n}\n\n/**\n * The cluster parameters carried on one advertisement.\n *\n * Present on every PUBLISH_NAMESPACE and NAMESPACE of a session that negotiated the\n * extension, and on none of a session that did not.\n *\n * @internal\n */\nexport interface Advert {\n\t/** HOP_PATH: the path this advertisement traversed, publisher first, sender last. */\n\thops: Hop[];\n\n\t/** ROUTE_COST: the marginal cost of subscribing via this advertisement. Absent on the\n\t * wire means 0, so an endpoint that prices nothing sends nothing. */\n\tcost: bigint;\n}\n\n/**\n * The cluster parameters a REQUEST_UPDATE on a PUBLISH_NAMESPACE carries: only what\n * changed, since an omitted parameter keeps its value.\n *\n * @internal\n */\nexport interface Update {\n\t/** HOP_PATH, when the route changed. */\n\thops?: Hop[];\n\n\t/** ROUTE_COST, when the cost changed. A cost that dropped to 0 arrives as an explicit\n\t * 0 here, unlike the advertisement itself where absent means 0. */\n\tcost?: bigint;\n}\n\n/**\n * Read the peer's Hop ID out of its SETUP, or `undefined` when it did not negotiate.\n *\n * @internal\n */\nexport function fromSetup(params: SetupOptions, version: IetfVersion): Hop | undefined {\n\tif (!supported(version)) return undefined;\n\n\t// 0 is legal: the peer speaks the extension but withholds its identity.\n\tconst value = params.getVarint(SetupOption.HopId);\n\tif (value === undefined) return undefined;\n\treturn HopSchema.parse(value);\n}\n\n/**\n * Declare our own Hop ID, which is also what negotiates the extension.\n *\n * @internal\n */\nexport function intoSetup(params: SetupOptions, self: Hop, version: IetfVersion) {\n\tif (!supported(version)) return;\n\tparams.setVarint(SetupOption.HopId, self);\n}\n\n/**\n * Whether the session negotiated the extension, which is what decides whether an\n * advertisement carries the parameters in either direction.\n *\n * @internal\n */\nexport function negotiated(ids: Hops | undefined): boolean {\n\treturn ids?.peer !== undefined;\n}\n\n/**\n * The advertisement to send for one of our own broadcasts, or `undefined` on a session\n * that negotiated nothing.\n *\n * The sender's own Hop ID is always the last entry, so a receiver reconstructs the full\n * path without the sender restating it. We originate everything we advertise, so the path\n * is just us and the cost is 0: a subscription costs the peer nothing but the transfer,\n * since we are already producing the content.\n *\n * @internal\n */\nexport function advertise(ids: Hops | undefined): Advert | undefined {\n\tif (ids === undefined || ids.peer === undefined) return undefined;\n\treturn { hops: [ids.self], cost: 0n };\n}\n\n/**\n * Whether this advertisement looped back through `self`.\n *\n * A receiver discards such an advertisement: forwarding it would extend the loop, and\n * subscribing through it would route the receiver back to itself. Hop ID 0 identifies\n * nothing, so a receiver that withheld its own identity detects nothing.\n *\n * @internal\n */\nexport function loops(advert: Advert, self: Hop): boolean {\n\treturn self !== UNKNOWN_HOP && advert.hops.includes(self);\n}\n\n/**\n * Write an advertisement's parameters, ready to encode onto the wire.\n *\n * @internal\n */\nexport function intoParams(advert: Advert): Parameters {\n\tconst params = new Parameters();\n\tparams.hopPath = encodeHops(advert.hops);\n\n\t// Absent means 0, so a free path sends nothing.\n\tif (advert.cost !== 0n) params.routeCost = advert.cost;\n\n\treturn params;\n}\n\n/**\n * Write a REQUEST_UPDATE's parameters: only what changed, and a cost of 0 explicitly,\n * since an omitted parameter keeps its value.\n *\n * @internal\n */\nexport function updateIntoParams(update: Update): Parameters {\n\tconst params = new Parameters();\n\tif (update.hops !== undefined) params.hopPath = encodeHops(update.hops);\n\tif (update.cost !== undefined) params.routeCost = update.cost;\n\treturn params;\n}\n\n/** Write a HOP_PATH value: the entries fill it with no count of their own, framed by the\n * parameter's own length prefix. */\nfunction encodeHops(hops: Hop[]): Uint8Array {\n\tvalidate(hops);\n\n\tconst encoded = hops.map((hop) => Varint.encodeLeadingOnes(hop));\n\tconst value = new Uint8Array(encoded.reduce((total, hop) => total + hop.length, 0));\n\tlet offset = 0;\n\tfor (const hop of encoded) {\n\t\tvalue.set(hop, offset);\n\t\toffset += hop.length;\n\t}\n\treturn value;\n}\n\n/**\n * Read the parameters a negotiated session puts on every advertisement.\n *\n * The parameter block is mandatory there, so a message that ends before it (the base form)\n * or one whose block does not parse is the peer's violation, same as a block that parses but\n * carries no HOP_PATH.\n *\n * @internal\n */\nexport async function decodeParams(r: Reader, version: IetfVersion): Promise<Advert> {\n\tlet params: Parameters;\n\ttry {\n\t\tparams = await Parameters.decode(r, version);\n\t} catch (err) {\n\t\tthrow new ProtocolViolation(reason(err), { cause: err });\n\t}\n\n\treturn fromParams(params);\n}\n\n/**\n * Read an advertisement out of a decoded parameter block.\n *\n * Every way this fails is one the draft says to close the session over: a negotiated session\n * that omits HOP_PATH, entries that do not exactly fill the parameter, an empty list, or a\n * non-zero Hop ID appearing twice. So they all surface as one {@link ProtocolViolation},\n * which the session dispatch acts on.\n *\n * @internal\n */\nexport function fromParams(params: Parameters): Advert {\n\ttry {\n\t\tconst value = params.hopPath;\n\t\tif (value === undefined) throw new Error(\"advertisement is missing HOP_PATH\");\n\t\treturn { hops: decodeHops(value), cost: params.routeCost ?? 0n };\n\t} catch (err) {\n\t\tthrow new ProtocolViolation(reason(err), { cause: err });\n\t}\n}\n\n/**\n * Read a REQUEST_UPDATE's parameters: each is optional, and a malformed HOP_PATH is the\n * same violation it is on an advertisement.\n *\n * @internal\n */\nexport function updateFromParams(params: Parameters): Update {\n\ttry {\n\t\tconst value = params.hopPath;\n\t\treturn { hops: value === undefined ? undefined : decodeHops(value), cost: params.routeCost };\n\t} catch (err) {\n\t\tthrow new ProtocolViolation(reason(err), { cause: err });\n\t}\n}\n\n/**\n * The advertisement after `update` lands on `held`: an omitted parameter keeps its value.\n *\n * @internal\n */\nexport function apply(held: Advert, update: Update): Advert {\n\treturn { hops: update.hops ?? held.hops, cost: update.cost ?? held.cost };\n}\n\n/** Read a HOP_PATH value: bare varints filling the parameter, with no count of their own. */\nfunction decodeHops(value: Uint8Array): Hop[] {\n\tconst hops: Hop[] = [];\n\tlet rest = value;\n\twhile (rest.length > 0) {\n\t\t// A short read here means the entries did not exactly fill the length.\n\t\tconst [hop, remain] = Varint.decodeLeadingOnes(rest);\n\t\thops.push(HopSchema.parse(hop));\n\t\trest = remain;\n\n\t\t// Bail before the buffer does: a hostile length would otherwise cost us one\n\t\t// allocation per entry all the way to 64KB of parameter value.\n\t\tif (hops.length > MAX_HOPS) throw new Error(`hop count exceeds maximum ${MAX_HOPS}`);\n\t}\n\n\tvalidate(hops);\n\treturn hops;\n}\n\n/**\n * Reject a path that cannot have come from a conforming sender: an empty list, one longer\n * than we accept, or a non-zero Hop ID appearing twice (a loop). Duplicate zeros are legal,\n * since 0 identifies nothing.\n */\nfunction validate(hops: Hop[]) {\n\tif (hops.length === 0) throw new Error(\"hop path is empty\");\n\tif (hops.length > MAX_HOPS) throw new Error(`hop count ${hops.length} exceeds maximum ${MAX_HOPS}`);\n\n\t// MAX_HOPS is 32, so the quadratic scan is cheaper than allocating a set.\n\tfor (let i = 0; i < hops.length; i++) {\n\t\tconst hop = hops[i];\n\t\tif (hop === UNKNOWN_HOP) continue;\n\t\tif (hops.indexOf(hop, i + 1) !== -1) throw new Error(`hop ${hop} appears twice in the hop path`);\n\t}\n}\n"]}

package/ietf/connection.d.ts

@@ -1,13 +1,9 @@
 import { type Getter } from "@norskvideo/moq-signals";
-import * as announce from "../announced";
-import type * as broadcast from "../broadcast";
+import type * as announce from "../announced";
 import type { Established } from "../connection/established";
 import { type Probe, type Stats } from "../connection/stats";
 import { type Transport } from "../connection/transport";
-import * as Path from "../path";
-import { type Stream } from "../stream";
-import * as Cluster from "./cluster";
-import { type IetfVersion } from "./version";
+import type * as Path from "../path";
 /**
  * Represents a connection to a MoQ server using moq-transport protocol.
  *
@@ -22,77 +18,15 @@ export declare class Connection implements Established {
     readonly discovery: boolean;
     /** moq-transport has no PROBE, so this stays empty; see {@link Established.probe}. */
     readonly probe: Getter<Probe>;
-    /**
-     * Creates a new Connection instance.
-     * @param url - The URL of the connection
-     * @param quic - The WebTransport session
-     * @param control - The control/setup stream
-     * @param maxRequestId - The initial max request ID
-     * @param version - The negotiated protocol version
-     * @param solicit - What the peer's SETUP declared (undefined when it declared nothing)
-     * @param cluster - The Hop IDs the SETUP exchange settled, on the versions that negotiate them
-     *
-     * @internal
-     */
-    constructor({ url, quic, control, maxRequestId, version, client, discovery, solicit, cluster, }: {
-        url: URL;
-        quic: WebTransport;
-        control: Stream;
-        maxRequestId: bigint;
-        version: IetfVersion;
-        /** Whether this peer initiated the session, selecting the even request-ID space. */
-        client: boolean;
-        discovery?: boolean;
-        /**
-         * What the peer declared about being solicited. `undefined` means it declared
-         * nothing, which is the one case where announcing at us unasked is not a bug.
-         */
-        solicit?: boolean;
-        /**
-         * The Hop IDs this session declared (MoQ Cluster). `undefined` on a version that
-         * cannot negotiate the extension, as is a `peer` the peer never declared.
-         */
-        cluster?: Cluster.Hops;
-    });
     /** Snapshot the transport's counters; see {@link Established.stats}. */
     stats(): Promise<Stats>;
     /**
      * Closes the connection.
      */
     close(): void;
-    /**
-     * Publishes a broadcast to the connection.
-     * @param name - The broadcast path to publish
-     * @param broadcast - The broadcast to publish
-     */
-    publish(path: Path.Valid, producer: broadcast.Producer): void;
-    /**
-     * Gets an announced reader for the specified prefix.
-     * @param prefix - The prefix for announcements
-     * @returns An Announced instance
-     */
-    announced(prefix?: Path.Valid): announce.Consumer;
-    /**
-     * Consumes a broadcast from the connection.
-     *
-     * @remarks
-     * If the broadcast is not found, a "not found" error will be thrown when requesting any tracks.
-     *
-     * @param broadcast - The path of the broadcast to consume
-     * @returns A Broadcast instance
-     */
-    consume(path: Path.Valid): broadcast.Consumer;
-    /**
-     * Watches a broadcast, live only while it is announced.
-     *
-     * @param path - The path of the broadcast to watch
-     * @returns A reactive handle to the broadcast
-     */
-    announcedBroadcast(path: Path.Valid): announce.Broadcast;
-    /**
-     * Returns a promise that resolves when the connection is closed.
-     * @returns A promise that resolves when closed
-     */
-    get closed(): Promise<void>;
+    /** Gets an announced reader for `scope`; see {@link Established.announced}. */
+    announced(scope?: Path.Pattern, options?: announce.Options): announce.Consumer;
+    /** Resolves when the session closes, decoding the peer's close code; see {@link Established.closed}. */
+    get closed(): Promise<Error | null>;
 }
 //# sourceMappingURL=connection.d.ts.map

package/ietf/connection.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../src/ietf/connection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAU,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AAC5C,OAAO,KAAK,KAAK,SAAS,MAAM,iBAAiB,CAAC;AAClD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,KAAK,EAAkB,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,KAAK,SAAS,EAAe,MAAM,4BAA4B,CAAC;AAEzE,OAAO,KAAK,IAAI,MAAM,YAAY,CAAC;AACnC,OAAO,EAAwB,KAAK,MAAM,EAAE,MAAM,cAAc,CAAC;AAEjE,OAAO,KAAK,OAAO,MAAM,cAAc,CAAC;AAUxC,OAAO,EAAE,KAAK,WAAW,EAAwB,MAAM,cAAc,CAAC;AAEtE;;;;GAIG;AACH,qBAAa,UAAW,YAAW,WAAW;;IAE7C,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAGlB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAGzB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,yFAAyF;IACzF,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,sFAAsF;IACtF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAyB;IAuBtD;;;;;;;;;;;OAWG;IACH,YAAY,EACX,GAAG,EACH,IAAI,EACJ,OAAO,EACP,YAAY,EACZ,OAAO,EACP,MAAM,EACN,SAAgB,EAChB,OAAO,EACP,OAAO,GACP,EAAE;QACF,GAAG,EAAE,GAAG,CAAC;QACT,IAAI,EAAE,YAAY,CAAC;QACnB,OAAO,EAAE,MAAM,CAAC;QAChB,YAAY,EAAE,MAAM,CAAC;QACrB,OAAO,EAAE,WAAW,CAAC;QACrB,oFAAoF;QACpF,MAAM,EAAE,OAAO,CAAC;QAChB,SAAS,CAAC,EAAE,OAAO,CAAC;QACpB;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC;QAClB;;;WAGG;QACH,OAAO,CAAC,EAAE,OAAO,CAAC,IAAI,CAAC;KACvB,EAiCA;IAED,wEAAwE;IAClE,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,CAE5B;IAED;;OAEG;IACH,KAAK,SAaJ;IAcD;;;;OAIG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,QAAQ,EAAE,SAAS,CAAC,QAAQ,QAErD;IAED;;;;OAIG;IACH,SAAS,CAAC,MAAM,aAAe,GAAG,QAAQ,CAAC,QAAQ,CAElD;IAED;;;;;;;;OAQG;IACH,OAAO,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC,QAAQ,CAE5C;IAED;;;;;OAKG;IACH,kBAAkB,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,GAAG,QAAQ,CAAC,SAAS,CAEvD;IAuJD;;;OAGG;IACH,IAAI,MAAM,IAAI,OAAO,CAAC,IAAI,CAAC,CAE1B;CACD"}
+{"version":3,"file":"connection.d.ts","sourceRoot":"","sources":["../../src/ietf/connection.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,KAAK,MAAM,EAAU,MAAM,cAAc,CAAC;AACnD,OAAO,KAAK,KAAK,QAAQ,MAAM,iBAAiB,CAAC;AACjD,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,8BAA8B,CAAC;AAChE,OAAO,EAAE,KAAK,KAAK,EAAE,KAAK,KAAK,EAAkB,MAAM,wBAAwB,CAAC;AAChF,OAAO,EAAE,KAAK,SAAS,EAAe,MAAM,4BAA4B,CAAC;AAGzE,OAAO,KAAK,KAAK,IAAI,MAAM,YAAY,CAAC;AAoBxC;;;;GAIG;AACH,qBAAa,UAAW,YAAW,WAAW;;IAE7C,QAAQ,CAAC,GAAG,EAAE,GAAG,CAAC;IAGlB,QAAQ,CAAC,OAAO,EAAE,MAAM,CAAC;IAGzB,QAAQ,CAAC,SAAS,EAAE,SAAS,CAAC;IAE9B,yFAAyF;IACzF,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC;IAE5B,sFAAsF;IACtF,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC,KAAK,CAAC,CAAyB;IA4GtD,wEAAwE;IAClE,KAAK,IAAI,OAAO,CAAC,KAAK,CAAC,CAE5B;IAED;;OAEG;IACH,KAAK,SAEJ;IAoCD,+EAA+E;IAC/E,SAAS,CAAC,KAAK,CAAC,EAAE,IAAI,CAAC,OAAO,EAAE,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO,GAAG,QAAQ,CAAC,QAAQ,CAE7E;IAqLD,wGAAwG;IACxG,IAAI,MAAM,IAAI,OAAO,CAAC,KAAK,GAAG,IAAI,CAAC,CAElC;CACD"}

package/ietf/connection.js

@@ -1,13 +1,13 @@
 /* @ts-self-types="./connection.d.ts" */
 import { Signal } from "@norskvideo/moq-signals";
-import * as announce from "../announced.js";
 import { transportStats } from "../connection/stats.js";
 import { transportOf } from "../connection/transport.js";
-import { ProtocolViolation } from "../error.js";
-import * as Path from "../path.js";
+import { error, fromClose, ProtocolViolation, SessionCode, StreamCode, StreamError } from "../error.js";
 import { Readers } from "../stream.js";
+import { registerWire } from "../wire.js";
 import { ControlStreamAdapter, NativeSession } from "./adapter.js";
 import * as Cluster from "./cluster.js";
+import { Fetch, FetchHeader } from "./fetch.js";
 import { GoAway } from "./goaway.js";
 import { Group } from "./object.js";
 import { Publish } from "./publish.js";
@@ -18,6 +18,8 @@ import { SubscribeNamespace, SubscribeNamespaceLegacy } from "./subscribe_namesp
 import { Subscriber } from "./subscriber.js";
 import { TrackStatusRequest } from "./track.js";
 import { Version, versionName } from "./version.js";
+// The PADDING stream type (draft-18+): bytes a peer sends to probe for bandwidth.
+const PADDING = 0x132b3e28n;
 /**
  * Represents a connection to a MoQ server using moq-transport protocol.
  *
@@ -60,7 +62,7 @@ export class Connection {
      *
      * @internal
      */
-    constructor({ url, quic, control, maxRequestId, version, client, discovery = true, solicit, cluster, }) {
+    constructor({ url, quic, control, maxRequestId, version, client, discovery = true, publish, solicit, hidden = false, cluster, }) {
         this.url = url;
         this.discovery = discovery;
         this.version = versionName(version);
@@ -85,12 +87,15 @@ export class Connection {
         this.#publisher = new Publisher({
             quic: this.#quic,
             session: this.#session,
+            publish,
             requiresSolicitation: solicit ?? false,
+            hidden,
             cluster,
         });
         this.#solicit = solicit;
         this.#cluster = cluster;
-        this.#subscriber = new Subscriber({ session: this.#session, cluster });
+        this.#subscriber = new Subscriber({ session: this.#session, quic, cluster, hidden });
+        registerWire(this, { consume: (path) => this.#subscriber.consume(path) });
         void this.#run();
     }
     /** Snapshot the transport's counters; see {@link Established.stats}. */
@@ -101,17 +106,26 @@ export class Connection {
      * Closes the connection.
      */
     close() {
+        this.#close();
+    }
+    // Close with the session code the peer should see, a clean close by default.
+    #close(info) {
         if (this.#closed)
             return;
         this.#closed = true;
-        this.#publisher.close();
-        this.#session.close();
+        // Before the session, whose own close would send a clean code first.
         try {
-            this.#quic.close();
+            this.#quic.close(info);
         }
         catch {
             // ignore
         }
+        this.#session.close();
+    }
+    // The peer broke the protocol, so losing the stream is not enough: nothing stops it
+    // repeating the violation on the next one.
+    #violated(err) {
+        this.#close({ closeCode: SessionCode.ProtocolViolation, reason: err.message });
     }
     async #run() {
         try {
@@ -126,42 +140,9 @@ export class Connection {
             this.close();
         }
     }
-    /**
-     * Publishes a broadcast to the connection.
-     * @param name - The broadcast path to publish
-     * @param broadcast - The broadcast to publish
-     */
-    publish(path, producer) {
-        this.#publisher.publish(path, producer);
-    }
-    /**
-     * Gets an announced reader for the specified prefix.
-     * @param prefix - The prefix for announcements
-     * @returns An Announced instance
-     */
-    announced(prefix = Path.empty()) {
-        return this.#subscriber.announced(prefix);
-    }
-    /**
-     * Consumes a broadcast from the connection.
-     *
-     * @remarks
-     * If the broadcast is not found, a "not found" error will be thrown when requesting any tracks.
-     *
-     * @param broadcast - The path of the broadcast to consume
-     * @returns A Broadcast instance
-     */
-    consume(path) {
-        return this.#subscriber.consume(path);
-    }
-    /**
-     * Watches a broadcast, live only while it is announced.
-     *
-     * @param path - The path of the broadcast to watch
-     * @returns A reactive handle to the broadcast
-     */
-    announcedBroadcast(path) {
-        return new announce.Broadcast({ connection: this, path });
+    /** Gets an announced reader for `scope`; see {@link Established.announced}. */
+    announced(scope, options) {
+        return this.#subscriber.announced(scope, options);
     }
     /**
      * Accepts bidi streams (virtual for v14-v16, real for v17) and dispatches.
@@ -174,10 +155,8 @@ export class Connection {
             void this.#runBidi(stream).catch((err) => {
                 console.error("error processing bidi stream", err);
                 stream.abort(new Error("bidi stream error"));
-                // The peer broke the protocol, so losing the stream is not enough: nothing
-                // stops it repeating the violation on the next one.
                 if (err instanceof ProtocolViolation)
-                    this.close();
+                    this.#violated(err);
             });
         }
     }
@@ -197,7 +176,11 @@ export class Connection {
             }
             case SubscribeNamespaceLegacy.id: {
                 const legacy = await SubscribeNamespaceLegacy.decode(stream.reader, this.#session.version);
-                const msg = new SubscribeNamespace({ requestId: legacy.requestId, namespace: legacy.namespace });
+                const msg = new SubscribeNamespace({
+                    requestId: legacy.requestId,
+                    namespace: legacy.namespace,
+                    hidden: legacy.hidden,
+                });
                 await this.#publisher.runSubscribeNamespace(msg, stream);
                 break;
             }
@@ -217,6 +200,11 @@ export class Connection {
                 await this.#publisher.runTrackStatusRequest(msg, stream);
                 break;
             }
+            case Fetch.id: {
+                const msg = await Fetch.decode(stream.reader, this.#session.version);
+                await this.#publisher.runFetch(msg, stream);
+                break;
+            }
             // Subscriber handles incoming notifications
             case PublishNamespace.id: {
                 const msg = await PublishNamespace.decode(stream.reader, this.#session.version, Cluster.negotiated(this.#cluster));
@@ -260,17 +248,38 @@ export class Connection {
                 break;
             this.#runUni(stream)
                 .then(() => {
-                stream.stop(new Error("cancel"));
+                stream.stop(new StreamError(StreamCode.Cancel, { message: "cancel" }));
             })
                 .catch((err) => {
                 console.error("error processing object stream", err);
                 stream.stop(err);
+                // An unknown or invalid stream type MUST close the session, not just the stream.
+                if (err instanceof ProtocolViolation)
+                    this.#violated(err);
             });
         }
     }
     async #runUni(stream) {
-        const header = await Group.decode(stream, this.#session.version);
-        await this.#subscriber.handleGroup(header, stream);
+        const version = this.#session.version;
+        // Full width, so an unknown type past 2^53 is still classified rather than thrown.
+        const type = await stream.u62();
+        // SUBGROUP_HEADER types match 0b0XX1XXXX; Group.decode validates the bits per draft.
+        if (type <= 0xffn && (type & 0x90n) === 0x10n) {
+            const header = await Group.decode(stream, version, Number(type));
+            await this.#subscriber.handleGroup(header, stream);
+            return;
+        }
+        // The receiver MUST discard padding. We read it to the end rather than cancel,
+        // so a peer probing for bandwidth gets the throughput it is measuring.
+        if (type === PADDING && version >= Version.DRAFT_18) {
+            await stream.discard();
+            return;
+        }
+        // We never FETCH, so a fetch response answers nothing of ours.
+        if (type === BigInt(FetchHeader.type))
+            throw new Error("unexpected fetch stream");
+        // Anything else is unknown, and a second SETUP is a violation too.
+        throw new ProtocolViolation(`unknown uni stream type: 0x${type.toString(16)}`);
     }
     /**
      * v17+ only: reads GoAway from the setup/control stream.
@@ -298,12 +307,9 @@ export class Connection {
             this.close();
         }
     }
-    /**
-     * Returns a promise that resolves when the connection is closed.
-     * @returns A promise that resolves when closed
-     */
+    /** Resolves when the session closes, decoding the peer's close code; see {@link Established.closed}. */
     get closed() {
-        return this.#quic.closed.then(() => undefined);
+        return this.#quic.closed.then(fromClose, (err) => error(err));
     }
 }
 //# sourceMappingURL=connection.js.map