fest-gateway 0.5.1 → 0.6.0

package/dist/shared/tags.js

@@ -0,0 +1,155 @@
+/**
+ * Request tags: free-form `key=value` pairs a client declares about its own
+ * traffic (`team=platform,project=fest`), so usage can be grouped and filtered
+ * by something other than who sent it.
+ *
+ * Tags are self-declared, like `x-fest-client`. They are labels for reporting,
+ * never an input to authorisation or routing — a client that lies about its
+ * project mislabels its own usage and nothing else.
+ *
+ * Two carriers, one format:
+ *   - header  `x-fest-tags: team=platform,project=fest`
+ *   - path    `/t/<tok>/~team=platform,project=fest/v1/messages`
+ * The path form exists because Copilot on its own login can set a base URL but
+ * no headers. Both are stripped before anything reaches upstream.
+ *
+ * Shared by the server (parsing what arrives) and the CLI (building what it
+ * sends), so the two cannot disagree about what a valid tag is.
+ */
+export const MAX_TAGS = 8;
+export const MAX_TAG_VALUE_LENGTH = 64;
+const KEY = /^[a-z0-9_.-]{1,32}$/;
+/**
+ * No `,` `=` `%` or `/` survives decoding: `,` and `=` are the separators, and
+ * a `/` in a stored value would be ambiguous in the path form. Spaces are
+ * allowed for human labels ("Platform team"); the URL form percent-encodes them.
+ */
+const VALUE = /^[A-Za-z0-9 ._:@-]+$/;
+function decode(s) {
+    try {
+        return decodeURIComponent(s);
+    }
+    catch {
+        return null;
+    }
+}
+/**
+ * `team=platform,project=fest` → pairs, in order, duplicates kept (last wins
+ * when folded). Each half is URL-decoded. Invalid pairs are dropped silently:
+ * a malformed tag must never fail the request it rides on.
+ *
+ * An empty value is kept here (the CLI uses `project=` to suppress a default);
+ * {@link parseTags} drops it.
+ */
+export function parseTagPairs(raw) {
+    const pairs = [];
+    for (const part of raw.split(",")) {
+        const eq = part.indexOf("=");
+        if (eq <= 0)
+            continue;
+        const key = decode(part.slice(0, eq).trim())?.trim().toLowerCase();
+        const value = decode(part.slice(eq + 1).trim())?.trim();
+        if (key === undefined || value === undefined)
+            continue;
+        if (!KEY.test(key))
+            continue;
+        if (value !== "" && (value.length > MAX_TAG_VALUE_LENGTH || !VALUE.test(value)))
+            continue;
+        pairs.push({ key, value });
+    }
+    return pairs;
+}
+/**
+ * Fold pairs into tags: last wins per key, and an empty value removes the key.
+ * Layers merge by concatenating their pairs lowest-precedence first, so a
+ * higher layer's `project=` suppresses a lower layer's `project=fest`.
+ */
+export function tagsFromPairs(pairs) {
+    const out = {};
+    for (const { key, value } of pairs) {
+        if (value === "") {
+            delete out[key];
+            continue;
+        }
+        if (!(key in out) && Object.keys(out).length >= MAX_TAGS)
+            continue;
+        out[key] = value;
+    }
+    return out;
+}
+export function parseTags(raw) {
+    return tagsFromPairs(parseTagPairs(raw));
+}
+/**
+ * The one stored form: a JSON object with sorted keys, or `""` for no tags.
+ *
+ * Sorted, because the rollup keys on this string — `{"a":"1","b":"2"}` and
+ * `{"b":"2","a":"1"}` must land in the same bucket.
+ */
+export function canonicalTags(tags) {
+    if (tags === null || tags === undefined)
+        return "";
+    const keys = Object.keys(tags).sort();
+    if (keys.length === 0)
+        return "";
+    const sorted = {};
+    for (const k of keys)
+        sorted[k] = tags[k];
+    return JSON.stringify(sorted);
+}
+/** Inverse of {@link canonicalTags}; anything unreadable is no tags. */
+export function tagsFromCanonical(s) {
+    if (s === null || s === undefined || s === "")
+        return {};
+    try {
+        const parsed = JSON.parse(s);
+        if (parsed === null || typeof parsed !== "object" || Array.isArray(parsed))
+            return {};
+        const out = {};
+        for (const [k, v] of Object.entries(parsed))
+            if (typeof v === "string")
+                out[k] = v;
+        return out;
+    }
+    catch {
+        return {};
+    }
+}
+/** `team=platform,project=fest` with each half URL-encoded — the wire form. */
+export function formatTags(tags) {
+    return Object.keys(tags)
+        .sort()
+        .map((k) => `${encodeURIComponent(k)}=${encodeURIComponent(tags[k])}`)
+        .join(",");
+}
+/** The path segment, `~team=platform,project=fest`, or `""` for no tags. */
+export function tagPathSegment(tags) {
+    const s = formatTags(tags);
+    return s === "" ? "" : `~${s}`;
+}
+/** `["team:platform", "project:fest"]` → filter. Invalid entries dropped. */
+export function parseTagFilter(values) {
+    const out = {};
+    for (const v of values) {
+        const colon = v.indexOf(":");
+        if (colon <= 0)
+            continue;
+        const key = v.slice(0, colon).trim().toLowerCase();
+        const value = v.slice(colon + 1).trim();
+        if (!KEY.test(key) || value === "" || value.length > MAX_TAG_VALUE_LENGTH || !VALUE.test(value))
+            continue;
+        if (!(key in out) && Object.keys(out).length >= MAX_TAGS)
+            continue;
+        out[key] = value;
+    }
+    return out;
+}
+export function formatTagFilter(filter) {
+    return Object.keys(filter)
+        .sort()
+        .map((k) => `${k}:${filter[k]}`);
+}
+export function isValidTagKey(key) {
+    return KEY.test(key);
+}
+//# sourceMappingURL=tags.js.map

package/dist/shared/tags.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tags.js","sourceRoot":"","sources":["../../shared/tags.ts"],"names":[],"mappings":"AAAA;;;;;;;;;;;;;;;;;GAiBG;AAIH,MAAM,CAAC,MAAM,QAAQ,GAAG,CAAC,CAAC;AAC1B,MAAM,CAAC,MAAM,oBAAoB,GAAG,EAAE,CAAC;AAEvC,MAAM,GAAG,GAAG,qBAAqB,CAAC;AAClC;;;;GAIG;AACH,MAAM,KAAK,GAAG,sBAAsB,CAAC;AAQrC,SAAS,MAAM,CAAC,CAAS;IACvB,IAAI,CAAC;QACH,OAAO,kBAAkB,CAAC,CAAC,CAAC,CAAC;IAC/B,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,IAAI,CAAC;IACd,CAAC;AACH,CAAC;AAED;;;;;;;GAOG;AACH,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,MAAM,KAAK,GAAc,EAAE,CAAC;IAC5B,KAAK,MAAM,IAAI,IAAI,GAAG,CAAC,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC;QAClC,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,EAAE,IAAI,CAAC;YAAE,SAAS;QACtB,MAAM,GAAG,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACnE,MAAM,KAAK,GAAG,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,CAAC;QACxD,IAAI,GAAG,KAAK,SAAS,IAAI,KAAK,KAAK,SAAS;YAAE,SAAS;QACvD,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC;YAAE,SAAS;QAC7B,IAAI,KAAK,KAAK,EAAE,IAAI,CAAC,KAAK,CAAC,MAAM,GAAG,oBAAoB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YAAE,SAAS;QAC1F,KAAK,CAAC,IAAI,CAAC,EAAE,GAAG,EAAE,KAAK,EAAE,CAAC,CAAC;IAC7B,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,aAAa,CAAC,KAAyB;IACrD,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,KAAK,MAAM,EAAE,GAAG,EAAE,KAAK,EAAE,IAAI,KAAK,EAAE,CAAC;QACnC,IAAI,KAAK,KAAK,EAAE,EAAE,CAAC;YACjB,OAAO,GAAG,CAAC,GAAG,CAAC,CAAC;YAChB,SAAS;QACX,CAAC;QACD,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,QAAQ;YAAE,SAAS;QACnE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,SAAS,CAAC,GAAW;IACnC,OAAO,aAAa,CAAC,aAAa,CAAC,GAAG,CAAC,CAAC,CAAC;AAC3C,CAAC;AAED;;;;;GAKG;AACH,MAAM,UAAU,aAAa,CAAC,IAA6B;IACzD,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,KAAK,SAAS;QAAE,OAAO,EAAE,CAAC;IACnD,MAAM,IAAI,GAAG,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,CAAC;IACtC,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;QAAE,OAAO,EAAE,CAAC;IACjC,MAAM,MAAM,GAA2B,EAAE,CAAC;IAC1C,KAAK,MAAM,CAAC,IAAI,IAAI;QAAE,MAAM,CAAC,CAAC,CAAC,GAAG,IAAI,CAAC,CAAC,CAAE,CAAC;IAC3C,OAAO,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;AAChC,CAAC;AAED,wEAAwE;AACxE,MAAM,UAAU,iBAAiB,CAAC,CAA4B;IAC5D,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,SAAS,IAAI,CAAC,KAAK,EAAE;QAAE,OAAO,EAAE,CAAC;IACzD,IAAI,CAAC;QACH,MAAM,MAAM,GAAY,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QACtC,IAAI,MAAM,KAAK,IAAI,IAAI,OAAO,MAAM,KAAK,QAAQ,IAAI,KAAK,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,OAAO,EAAE,CAAC;QACtF,MAAM,GAAG,GAA2B,EAAE,CAAC;QACvC,KAAK,MAAM,CAAC,CAAC,EAAE,CAAC,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,MAAM,CAAC;YAAE,IAAI,OAAO,CAAC,KAAK,QAAQ;gBAAE,GAAG,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;QACnF,OAAO,GAAG,CAAC;IACb,CAAC;IAAC,MAAM,CAAC;QACP,OAAO,EAAE,CAAC;IACZ,CAAC;AACH,CAAC;AAED,+EAA+E;AAC/E,MAAM,UAAU,UAAU,CAAC,IAAU;IACnC,OAAO,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;SACrB,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,kBAAkB,CAAC,CAAC,CAAC,IAAI,kBAAkB,CAAC,IAAI,CAAC,CAAC,CAAE,CAAC,EAAE,CAAC;SACtE,IAAI,CAAC,GAAG,CAAC,CAAC;AACf,CAAC;AAED,4EAA4E;AAC5E,MAAM,UAAU,cAAc,CAAC,IAAU;IACvC,MAAM,CAAC,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAC3B,OAAO,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,CAAC;AACjC,CAAC;AAUD,6EAA6E;AAC7E,MAAM,UAAU,cAAc,CAAC,MAAyB;IACtD,MAAM,GAAG,GAA2B,EAAE,CAAC;IACvC,KAAK,MAAM,CAAC,IAAI,MAAM,EAAE,CAAC;QACvB,MAAM,KAAK,GAAG,CAAC,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QAC7B,IAAI,KAAK,IAAI,CAAC;YAAE,SAAS;QACzB,MAAM,GAAG,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC,EAAE,KAAK,CAAC,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,CAAC;QACnD,MAAM,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QACxC,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,IAAI,KAAK,KAAK,EAAE,IAAI,KAAK,CAAC,MAAM,GAAG,oBAAoB,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC;YAAE,SAAS;QAC1G,IAAI,CAAC,CAAC,GAAG,IAAI,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,MAAM,IAAI,QAAQ;YAAE,SAAS;QACnE,GAAG,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC;IACnB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AAED,MAAM,UAAU,eAAe,CAAC,MAAiB;IAC/C,OAAO,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC;SACvB,IAAI,EAAE;SACN,GAAG,CAAC,CAAC,CAAC,EAAE,EAAE,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,CAAC,CAAE,EAAE,CAAC,CAAC;AACtC,CAAC;AAED,MAAM,UAAU,aAAa,CAAC,GAAW;IACvC,OAAO,GAAG,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AACvB,CAAC"}