@tracepanel/js 0.3.3 → 0.4.0

package/dist/profile.d.ts

@@ -0,0 +1,63 @@
+import type { Config } from "./config.js";
+import type { Profile } from "./model.js";
+import { type RequestHeaders } from "./request.js";
+export declare const HEADER = "x-tracepanel-profile";
+export declare const COOKIE = "tracepanel_profile";
+/** On a request's root span: the request asked to be profiled. */
+export declare const ATTRIBUTE = "tracepanel.profile";
+/** In the context a framework starts the request's root span in (Next.js's): the request asked to be profiled. */
+export declare const ASKED: symbol;
+/** Whether a request asks to be profiled: the X-Tracepanel-Profile header, or the cookie the panel's toggle sets. */
+export declare function requested(headers: RequestHeaders): boolean;
+/** Whether to profile a trace: the setting profiles every one, a request may ask; nothing when profiling is off. */
+export declare function wanted(config: Config, asked: boolean): boolean;
+/** Whether this runtime can profile: Node, with its inspector. */
+export declare function available(): boolean;
+/** One trace's profile while it runs: its console profile's title, and when it started (performance.now()). */
+export interface Recording {
+    title: string;
+    startedMs: number;
+    /** The trace it profiles, as the profiler knows every trace of the process (see enter()). */
+    trace: object;
+}
+/** The trace's profile and the samples left out because another trace ran at the same time. */
+export interface Result {
+    profile: Profile | undefined;
+    dropped: number;
+}
+/** The app's profiler: the profile that runs while traces are profiled, and when each trace of the process ran. */
+export declare class Profiler {
+    private readonly root;
+    private readonly intervalMs;
+    private session;
+    private running;
+    private runningSince;
+    private idle;
+    private readonly recordings;
+    /** Every trace of the process running now, and when it started. */
+    private readonly open;
+    /** Traces that ended while one was profiled: when each started and ended. */
+    private ended;
+    /** The console profiles stopped, by title, as the inspector hands them over. */
+    private readonly finished;
+    constructor(root: string, intervalMs: number);
+    /** A trace started (each one, profiled or not): a sample taken while it runs may be its. */
+    enter(trace: object): void;
+    /** A trace ended. */
+    leave(trace: object): void;
+    /** Begins profiling a trace that started (enter() first); undefined when the inspector can't. */
+    start(trace: object): Recording | undefined;
+    /** Ends a trace's profile, before it leaves: what was sampled while it alone ran. */
+    stop(recording: Recording): Result;
+    /** The profile that runs under the traces' own: started with the first profiled trace. */
+    private ensure;
+    /** No trace is profiled: the profile under them stops after a while, or now when it ran long. */
+    private rest;
+    private halt;
+    /** Whether another trace than the recording's ran at `at` (performance.now()). */
+    private shared;
+    /** The trace's `profile`: the functions its stacks name, each once, and each stack as indexes into them. */
+    private document;
+    /** A function as the profile names it; null for this package's own. */
+    private frame;
+}

package/dist/profile.js

@@ -0,0 +1,300 @@
+// Where a trace's time goes in code: V8's sampling profiler, through Node's inspector (the trace's `profile`, a flame
+// graph in the console). Nothing runs until a trace is profiled: the setting profiles every one, a request asks with
+// the X-Tracepanel-Profile: 1 header or the panel's tracepanel_profile=1 cookie.
+//
+// The profiler samples the whole thread, and one event loop runs every request of the process at once: a sample
+// can't tell which request a frame belongs to. So a profiled trace keeps the samples taken while it was the only trace
+// running here, as the Python SDK keeps a thread's samples only while it runs one trace; those taken while another
+// ran too are dropped and counted (`tracepanel.dropped_samples`). What the process did meanwhile outside any request
+// (a timer, the garbage collector) is in the profile too. Samples of an idle loop, the request waiting on I/O, are
+// left out: the profile is where the time went in code, on the CPU.
+//
+// One profile runs for as long as traces are profiled, so starting the next one costs next to nothing (the first
+// start reads every function V8 has compiled: tens of milliseconds); each trace's own profile is a console.profile()
+// under it, from its start to its end. It stops IDLE_MS after the last one.
+import { relative } from "node:path";
+import { createContextKey } from "@opentelemetry/api";
+import { call, connect, inspector } from "./inspector.js";
+import { headerValue, parseCookies } from "./request.js";
+import { inApp, libraryPath, ownFile, place } from "./stack.js";
+export const HEADER = "x-tracepanel-profile";
+export const COOKIE = "tracepanel_profile";
+/** On a request's root span: the request asked to be profiled. */
+export const ATTRIBUTE = "tracepanel.profile";
+/** In the context a framework starts the request's root span in (Next.js's): the request asked to be profiled. */
+export const ASKED = createContextKey("tracepanel.profile");
+// How deep a stack is kept: a recursion beyond it is cut, outermost frames kept.
+const MAX_DEPTH = 128;
+// Distinct stacks one trace keeps; the rest are counted as one "(other)" frame, so a profile stays small.
+const MAX_STACKS = 2000;
+// How long the profiler runs on with no trace profiled, ready for the next one.
+const IDLE_MS = 30_000;
+// A profiler running this long is started anew once no trace is profiled: its own samples pile up meanwhile.
+const RENEW_MS = 60_000;
+// V8's own entries: the loop waiting (no work to profile), and the root every stack starts from.
+const IDLE = "(idle)";
+const ROOT = "(root)";
+const OTHER = { function: "(other)", module: null, file: "", line: 0, in_app: false };
+/** Whether a request asks to be profiled: the X-Tracepanel-Profile header, or the cookie the panel's toggle sets. */
+export function requested(headers) {
+    if (headerValue(headers[HEADER])?.trim() === "1")
+        return true;
+    const cookies = headerValue(headers.cookie);
+    return (cookies?.includes(COOKIE) === true &&
+        parseCookies(cookies).some(([name, value]) => name === COOKIE && value === "1"));
+}
+/** Whether to profile a trace: the setting profiles every one, a request may ask; nothing when profiling is off. */
+export function wanted(config, asked) {
+    return config.profileEnabled && (config.profile || asked) && available();
+}
+/** Whether this runtime can profile: Node, with its inspector. */
+export function available() {
+    return inspector() !== null;
+}
+let next = 0;
+/** The app's profiler: the profile that runs while traces are profiled, and when each trace of the process ran. */
+export class Profiler {
+    root;
+    intervalMs;
+    session;
+    running = false;
+    runningSince = 0;
+    idle;
+    recordings = new Set();
+    /** Every trace of the process running now, and when it started. */
+    open = new Map();
+    /** Traces that ended while one was profiled: when each started and ended. */
+    ended = [];
+    /** The console profiles stopped, by title, as the inspector hands them over. */
+    finished = new Map();
+    constructor(root, intervalMs) {
+        this.root = root;
+        this.intervalMs = intervalMs;
+    }
+    /** A trace started (each one, profiled or not): a sample taken while it runs may be its. */
+    enter(trace) {
+        this.open.set(trace, performance.now());
+    }
+    /** A trace ended. */
+    leave(trace) {
+        const started = this.open.get(trace);
+        if (started === undefined)
+            return;
+        this.open.delete(trace);
+        if (this.recordings.size > 0)
+            this.ended.push([started, performance.now()]);
+    }
+    /** Begins profiling a trace that started (enter() first); undefined when the inspector can't. */
+    start(trace) {
+        const console = inspector()?.console;
+        if (!console || !this.ensure())
+            return undefined;
+        clearTimeout(this.idle);
+        next += 1;
+        const recording = { title: `tracepanel:${next}`, startedMs: performance.now(), trace };
+        console.profile(recording.title);
+        this.recordings.add(recording);
+        return recording;
+    }
+    /** Ends a trace's profile, before it leaves: what was sampled while it alone ran. */
+    stop(recording) {
+        if (!this.recordings.has(recording))
+            return { profile: undefined, dropped: 0 };
+        inspector()?.console.profileEnd(recording.title);
+        this.recordings.delete(recording);
+        const profile = this.finished.get(recording.title);
+        this.finished.delete(recording.title);
+        const result = profile ? this.document(recording, profile) : { profile: undefined, dropped: 0 };
+        if (this.recordings.size === 0)
+            this.rest();
+        else {
+            const oldest = Math.min(...[...this.recordings].map((other) => other.startedMs));
+            this.ended = this.ended.filter(([, end]) => end >= oldest);
+        }
+        return result;
+    }
+    /** The profile that runs under the traces' own: started with the first profiled trace. */
+    ensure() {
+        if (!this.session) {
+            const session = connect();
+            if (!session)
+                return false;
+            try {
+                call(session, "Profiler.enable");
+                call(session, "Profiler.setSamplingInterval", { interval: Math.round(this.intervalMs * 1000) });
+            }
+            catch {
+                session.disconnect();
+                return false;
+            }
+            session.on("Profiler.consoleProfileFinished", (message) => {
+                const { title, profile } = message.params;
+                // Only this profiler's: another session's console.profile() reaches every session.
+                if ([...this.recordings].some((recording) => recording.title === title))
+                    this.finished.set(title ?? "", profile);
+            });
+            this.session = session;
+        }
+        if (!this.running) {
+            try {
+                call(this.session, "Profiler.start");
+            }
+            catch {
+                return false;
+            }
+            this.running = true;
+            this.runningSince = performance.now();
+        }
+        return true;
+    }
+    /** No trace is profiled: the profile under them stops after a while, or now when it ran long. */
+    rest() {
+        this.ended = [];
+        if (performance.now() - this.runningSince > RENEW_MS) {
+            this.halt();
+            return;
+        }
+        clearTimeout(this.idle);
+        this.idle = setTimeout(() => this.halt(), IDLE_MS);
+        this.idle.unref();
+    }
+    halt() {
+        if (!this.session || !this.running || this.recordings.size > 0)
+            return;
+        this.running = false;
+        try {
+            call(this.session, "Profiler.stop");
+        }
+        catch {
+            // Stopped already.
+        }
+    }
+    /** Whether another trace than the recording's ran at `at` (performance.now()). */
+    shared(recording, at) {
+        for (const [trace, started] of this.open) {
+            if (trace !== recording.trace && started <= at)
+                return true;
+        }
+        return this.ended.some(([started, end]) => started <= at && at <= end);
+    }
+    /** The trace's `profile`: the functions its stacks name, each once, and each stack as indexes into them. */
+    document(recording, profile) {
+        const nodes = new Map(profile.nodes.map((node) => [node.id, node]));
+        const parents = new Map();
+        for (const node of profile.nodes)
+            for (const child of node.children ?? [])
+                parents.set(child, node.id);
+        const index = new Map();
+        const frames = [];
+        /** A node's stack as indexes into frames, outermost first; null for the idle loop. */
+        const stackOf = new Map();
+        const frameIndex = (callFrame) => {
+            const key = `${callFrame.url}:${callFrame.lineNumber}:${callFrame.columnNumber}:${callFrame.functionName}`;
+            const known = index.get(key);
+            if (known !== undefined)
+                return known;
+            const frame = this.frame(callFrame);
+            if (!frame)
+                return null;
+            index.set(key, frames.length);
+            frames.push(frame);
+            return frames.length - 1;
+        };
+        const stack = (id) => {
+            const known = stackOf.get(id);
+            if (known !== undefined)
+                return known;
+            const chain = [];
+            for (let at = id; at !== undefined; at = parents.get(at)) {
+                const node = nodes.get(at);
+                if (node && node.callFrame.functionName !== ROOT)
+                    chain.push(node.callFrame);
+            }
+            let found = null;
+            if (chain[0]?.functionName !== IDLE) {
+                found = [];
+                for (const callFrame of chain.reverse()) {
+                    if (found.length >= MAX_DEPTH)
+                        break;
+                    const at = frameIndex(callFrame);
+                    if (at !== null)
+                        found.push(at);
+                }
+            }
+            stackOf.set(id, found);
+            return found;
+        };
+        const counts = new Map();
+        let samples = 0;
+        let dropped = 0;
+        let time = profile.startTime;
+        const deltas = profile.timeDeltas ?? [];
+        (profile.samples ?? []).forEach((id, at) => {
+            time += deltas[at] ?? 0;
+            let keys = stack(id);
+            if (keys === null || keys.length === 0)
+                return;
+            // The profile's clock is V8's; it started as the recording did.
+            if (this.shared(recording, recording.startedMs + (time - profile.startTime) / 1000)) {
+                dropped += 1;
+                return;
+            }
+            let key = keys.join(",");
+            if (!counts.has(key) && counts.size >= MAX_STACKS) {
+                let other = index.get(OTHER.function);
+                if (other === undefined) {
+                    other = frames.length;
+                    index.set(OTHER.function, other);
+                    frames.push(OTHER);
+                }
+                keys = [other];
+                key = String(other);
+            }
+            const counted = counts.get(key);
+            if (counted)
+                counted.count += 1;
+            else
+                counts.set(key, { frames: keys, count: 1 });
+            samples += 1;
+        });
+        if (samples === 0)
+            return { profile: undefined, dropped };
+        // Only the frames the kept stacks name, in the order the most frequent stacks name them.
+        const stacks = [...counts.values()].sort((a, b) => b.count - a.count);
+        const kept = [];
+        const renumber = new Map();
+        for (const counted of stacks) {
+            counted.frames = counted.frames.map((frame) => {
+                let to = renumber.get(frame);
+                if (to === undefined) {
+                    to = kept.length;
+                    renumber.set(frame, to);
+                    kept.push(frames[frame]);
+                }
+                return to;
+            });
+        }
+        return {
+            profile: { interval_us: Math.round(this.intervalMs * 1000), samples, frames: kept, stacks },
+            dropped,
+        };
+    }
+    /** A function as the profile names it; null for this package's own. */
+    frame(callFrame) {
+        const name = callFrame.functionName || "(anonymous)";
+        if (!callFrame.url)
+            return { function: name, module: null, file: "", line: 0, in_app: false };
+        const found = place(callFrame.url, callFrame.lineNumber + 1, callFrame.columnNumber + 1);
+        if (ownFile(found.file))
+            return null;
+        const own = inApp(found.file, this.root);
+        return {
+            function: name,
+            module: null,
+            file: own ? relative(this.root, found.file) : libraryPath(found.file),
+            line: found.line,
+            in_app: own,
+        };
+    }
+}
+//# sourceMappingURL=profile.js.map

package/dist/profile.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"profile.js","sourceRoot":"","sources":["../src/profile.ts"],"names":[],"mappings":"AAAA,sHAAsH;AACtH,qHAAqH;AACrH,iFAAiF;AACjF,EAAE;AACF,gHAAgH;AAChH,uHAAuH;AACvH,mHAAmH;AACnH,qHAAqH;AACrH,mHAAmH;AACnH,oEAAoE;AACpE,EAAE;AACF,iHAAiH;AACjH,qHAAqH;AACrH,4EAA4E;AAE5E,OAAO,EAAE,QAAQ,EAAE,MAAM,WAAW,CAAC;AACrC,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AAEtD,OAAO,EAAE,IAAI,EAAE,OAAO,EAAE,SAAS,EAAgB,MAAM,gBAAgB,CAAC;AAExE,OAAO,EAAE,WAAW,EAAE,YAAY,EAAuB,MAAM,cAAc,CAAC;AAC9E,OAAO,EAAE,KAAK,EAAE,WAAW,EAAE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AAEhE,MAAM,CAAC,MAAM,MAAM,GAAG,sBAAsB,CAAC;AAC7C,MAAM,CAAC,MAAM,MAAM,GAAG,oBAAoB,CAAC;AAC3C,kEAAkE;AAClE,MAAM,CAAC,MAAM,SAAS,GAAG,oBAAoB,CAAC;AAC9C,kHAAkH;AAClH,MAAM,CAAC,MAAM,KAAK,GAAG,gBAAgB,CAAC,oBAAoB,CAAC,CAAC;AAE5D,iFAAiF;AACjF,MAAM,SAAS,GAAG,GAAG,CAAC;AACtB,0GAA0G;AAC1G,MAAM,UAAU,GAAG,IAAI,CAAC;AACxB,gFAAgF;AAChF,MAAM,OAAO,GAAG,MAAM,CAAC;AACvB,6GAA6G;AAC7G,MAAM,QAAQ,GAAG,MAAM,CAAC;AACxB,iGAAiG;AACjG,MAAM,IAAI,GAAG,QAAQ,CAAC;AACtB,MAAM,IAAI,GAAG,QAAQ,CAAC;AACtB,MAAM,KAAK,GAAiB,EAAE,QAAQ,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;AAEpG,qHAAqH;AACrH,MAAM,UAAU,SAAS,CAAC,OAAuB;IAC/C,IAAI,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC,EAAE,IAAI,EAAE,KAAK,GAAG;QAAE,OAAO,IAAI,CAAC;IAC9D,MAAM,OAAO,GAAG,WAAW,CAAC,OAAO,CAAC,MAAM,CAAC,CAAC;IAC5C,OAAO,CACL,OAAO,EAAE,QAAQ,CAAC,MAAM,CAAC,KAAK,IAAI;QAClC,YAAY,CAAC,OAAO,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,MAAM,IAAI,KAAK,KAAK,GAAG,CAAC,CAChF,CAAC;AACJ,CAAC;AAED,oHAAoH;AACpH,MAAM,UAAU,MAAM,CAAC,MAAc,EAAE,KAAc;IACnD,OAAO,MAAM,CAAC,cAAc,IAAI,CAAC,MAAM,CAAC,OAAO,IAAI,KAAK,CAAC,IAAI,SAAS,EAAE,CAAC;AAC3E,CAAC;AAED,kEAAkE;AAClE,MAAM,UAAU,SAAS;IACvB,OAAO,SAAS,EAAE,KAAK,IAAI,CAAC;AAC9B,CAAC;AA8BD,IAAI,IAAI,GAAG,CAAC,CAAC;AAEb,mHAAmH;AACnH,MAAM,OAAO,QAAQ;IAcA,IAAI;IACJ,UAAU;IAdrB,OAAO,CAAsB;IAC7B,OAAO,GAAG,KAAK,CAAC;IAChB,YAAY,GAAG,CAAC,CAAC;IACjB,IAAI,CAA6B;IACxB,UAAU,GAAG,IAAI,GAAG,EAAa,CAAC;IACnD,mEAAmE;IAClD,IAAI,GAAG,IAAI,GAAG,EAAkB,CAAC;IAClD,6EAA6E;IACrE,KAAK,GAAuB,EAAE,CAAC;IACvC,gFAAgF;IAC/D,QAAQ,GAAG,IAAI,GAAG,EAAsB,CAAC;IAE1D,YACmB,IAAY,EACZ,UAAkB;oBADlB,IAAI;0BACJ,UAAU;IAC1B,CAAC;IAEJ,4FAA4F;IAC5F,KAAK,CAAC,KAAa;QACjB,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC;IAC1C,CAAC;IAED,qBAAqB;IACrB,KAAK,CAAC,KAAa;QACjB,MAAM,OAAO,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;QACrC,IAAI,OAAO,KAAK,SAAS;YAAE,OAAO;QAClC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;QACxB,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC;YAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,OAAO,EAAE,WAAW,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC;IAC9E,CAAC;IAED,iGAAiG;IACjG,KAAK,CAAC,KAAa;QACjB,MAAM,OAAO,GAAG,SAAS,EAAE,EAAE,OAAO,CAAC;QACrC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE;YAAE,OAAO,SAAS,CAAC;QACjD,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,IAAI,CAAC,CAAC;QACV,MAAM,SAAS,GAAG,EAAE,KAAK,EAAE,cAAc,IAAI,EAAE,EAAE,SAAS,EAAE,WAAW,CAAC,GAAG,EAAE,EAAE,KAAK,EAAE,CAAC;QACvF,OAAO,CAAC,OAAO,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC,CAAC;QAC/B,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,qFAAqF;IACrF,IAAI,CAAC,SAAoB;QACvB,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,SAAS,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAC/E,SAAS,EAAE,EAAE,OAAO,CAAC,UAAU,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACjD,IAAI,CAAC,UAAU,CAAC,MAAM,CAAC,SAAS,CAAC,CAAC;QAClC,MAAM,OAAO,GAAG,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACnD,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC;QACtC,MAAM,MAAM,GAAG,OAAO,CAAC,CAAC,CAAC,IAAI,CAAC,QAAQ,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC,CAAC,CAAC,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,EAAE,CAAC;QAChG,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,KAAK,CAAC;YAAE,IAAI,CAAC,IAAI,EAAE,CAAC;aACvC,CAAC;YACJ,MAAM,MAAM,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC,CAAC;YACjF,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,GAAG,IAAI,MAAM,CAAC,CAAC;QAC7D,CAAC;QACD,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,0FAA0F;IAClF,MAAM;QACZ,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,MAAM,OAAO,GAAG,OAAO,EAAE,CAAC;YAC1B,IAAI,CAAC,OAAO;gBAAE,OAAO,KAAK,CAAC;YAC3B,IAAI,CAAC;gBACH,IAAI,CAAC,OAAO,EAAE,iBAAiB,CAAC,CAAC;gBACjC,IAAI,CAAC,OAAO,EAAE,8BAA8B,EAAE,EAAE,QAAQ,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,CAAC,CAAC;YAClG,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,CAAC,UAAU,EAAE,CAAC;gBACrB,OAAO,KAAK,CAAC;YACf,CAAC;YACD,OAAO,CAAC,EAAE,CAAC,iCAAiC,EAAE,CAAC,OAA4D,EAAE,EAAE;gBAC7G,MAAM,EAAE,KAAK,EAAE,OAAO,EAAE,GAAG,OAAO,CAAC,MAAM,CAAC;gBAC1C,mFAAmF;gBACnF,IAAI,CAAC,GAAG,IAAI,CAAC,UAAU,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,KAAK,KAAK,KAAK,CAAC;oBACrE,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,KAAK,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;YAC5C,CAAC,CAAC,CAAC;YACH,IAAI,CAAC,OAAO,GAAG,OAAO,CAAC;QACzB,CAAC;QACD,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,CAAC;YAClB,IAAI,CAAC;gBACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,gBAAgB,CAAC,CAAC;YACvC,CAAC;YAAC,MAAM,CAAC;gBACP,OAAO,KAAK,CAAC;YACf,CAAC;YACD,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC;YACpB,IAAI,CAAC,YAAY,GAAG,WAAW,CAAC,GAAG,EAAE,CAAC;QACxC,CAAC;QACD,OAAO,IAAI,CAAC;IACd,CAAC;IAED,iGAAiG;IACzF,IAAI;QACV,IAAI,CAAC,KAAK,GAAG,EAAE,CAAC;QAChB,IAAI,WAAW,CAAC,GAAG,EAAE,GAAG,IAAI,CAAC,YAAY,GAAG,QAAQ,EAAE,CAAC;YACrD,IAAI,CAAC,IAAI,EAAE,CAAC;YACZ,OAAO;QACT,CAAC;QACD,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACxB,IAAI,CAAC,IAAI,GAAG,UAAU,CAAC,GAAG,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,EAAE,OAAO,CAAC,CAAC;QACnD,IAAI,CAAC,IAAI,CAAC,KAAK,EAAE,CAAC;IACpB,CAAC;IAEO,IAAI;QACV,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,CAAC,IAAI,CAAC,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,IAAI,GAAG,CAAC;YAAE,OAAO;QACvE,IAAI,CAAC,OAAO,GAAG,KAAK,CAAC;QACrB,IAAI,CAAC;YACH,IAAI,CAAC,IAAI,CAAC,OAAO,EAAE,eAAe,CAAC,CAAC;QACtC,CAAC;QAAC,MAAM,CAAC;YACP,mBAAmB;QACrB,CAAC;IACH,CAAC;IAED,kFAAkF;IAC1E,MAAM,CAAC,SAAoB,EAAE,EAAU;QAC7C,KAAK,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACzC,IAAI,KAAK,KAAK,SAAS,CAAC,KAAK,IAAI,OAAO,IAAI,EAAE;gBAAE,OAAO,IAAI,CAAC;QAC9D,CAAC;QACD,OAAO,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,OAAO,EAAE,GAAG,CAAC,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,IAAI,EAAE,IAAI,GAAG,CAAC,CAAC;IACzE,CAAC;IAED,4GAA4G;IACpG,QAAQ,CAAC,SAAoB,EAAE,OAAmB;QACxD,MAAM,KAAK,GAAG,IAAI,GAAG,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;QACpE,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC1C,KAAK,MAAM,IAAI,IAAI,OAAO,CAAC,KAAK;YAAE,KAAK,MAAM,KAAK,IAAI,IAAI,CAAC,QAAQ,IAAI,EAAE;gBAAE,OAAO,CAAC,GAAG,CAAC,KAAK,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC;QACvG,MAAM,KAAK,GAAG,IAAI,GAAG,EAAkB,CAAC;QACxC,MAAM,MAAM,GAAmB,EAAE,CAAC;QAClC,sFAAsF;QACtF,MAAM,OAAO,GAAG,IAAI,GAAG,EAA2B,CAAC;QACnD,MAAM,UAAU,GAAG,CAAC,SAAoB,EAAiB,EAAE;YACzD,MAAM,GAAG,GAAG,GAAG,SAAS,CAAC,GAAG,IAAI,SAAS,CAAC,UAAU,IAAI,SAAS,CAAC,YAAY,IAAI,SAAS,CAAC,YAAY,EAAE,CAAC;YAC3G,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAC7B,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC;YACtC,MAAM,KAAK,GAAG,IAAI,CAAC,KAAK,CAAC,SAAS,CAAC,CAAC;YACpC,IAAI,CAAC,KAAK;gBAAE,OAAO,IAAI,CAAC;YACxB,KAAK,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YAC9B,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACnB,OAAO,MAAM,CAAC,MAAM,GAAG,CAAC,CAAC;QAC3B,CAAC,CAAC;QACF,MAAM,KAAK,GAAG,CAAC,EAAU,EAAmB,EAAE;YAC5C,MAAM,KAAK,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;YAC9B,IAAI,KAAK,KAAK,SAAS;gBAAE,OAAO,KAAK,CAAC;YACtC,MAAM,KAAK,GAAgB,EAAE,CAAC;YAC9B,KAAK,IAAI,EAAE,GAAuB,EAAE,EAAE,EAAE,KAAK,SAAS,EAAE,EAAE,GAAG,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC,EAAE,CAAC;gBAC7E,MAAM,IAAI,GAAG,KAAK,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC;gBAC3B,IAAI,IAAI,IAAI,IAAI,CAAC,SAAS,CAAC,YAAY,KAAK,IAAI;oBAAE,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;YAC/E,CAAC;YACD,IAAI,KAAK,GAAoB,IAAI,CAAC;YAClC,IAAI,KAAK,CAAC,CAAC,CAAC,EAAE,YAAY,KAAK,IAAI,EAAE,CAAC;gBACpC,KAAK,GAAG,EAAE,CAAC;gBACX,KAAK,MAAM,SAAS,IAAI,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC;oBACxC,IAAI,KAAK,CAAC,MAAM,IAAI,SAAS;wBAAE,MAAM;oBACrC,MAAM,EAAE,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;oBACjC,IAAI,EAAE,KAAK,IAAI;wBAAE,KAAK,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC;gBAClC,CAAC;YACH,CAAC;YACD,OAAO,CAAC,GAAG,CAAC,EAAE,EAAE,KAAK,CAAC,CAAC;YACvB,OAAO,KAAK,CAAC;QACf,CAAC,CAAC;QAEF,MAAM,MAAM,GAAG,IAAI,GAAG,EAA+C,CAAC;QACtE,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,OAAO,GAAG,CAAC,CAAC;QAChB,IAAI,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC;QAC7B,MAAM,MAAM,GAAG,OAAO,CAAC,UAAU,IAAI,EAAE,CAAC;QACxC,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,EAAE;YACzC,IAAI,IAAI,MAAM,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC;YACxB,IAAI,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC;YACrB,IAAI,IAAI,KAAK,IAAI,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC;gBAAE,OAAO;YAC/C,gEAAgE;YAChE,IAAI,IAAI,CAAC,MAAM,CAAC,SAAS,EAAE,SAAS,CAAC,SAAS,GAAG,CAAC,IAAI,GAAG,OAAO,CAAC,SAAS,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC;gBACpF,OAAO,IAAI,CAAC,CAAC;gBACb,OAAO;YACT,CAAC;YACD,IAAI,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;YACzB,IAAI,CAAC,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,MAAM,CAAC,IAAI,IAAI,UAAU,EAAE,CAAC;gBAClD,IAAI,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;gBACtC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;oBACxB,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC;oBACtB,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;oBACjC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBACrB,CAAC;gBACD,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC;gBACf,GAAG,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC;YACtB,CAAC;YACD,MAAM,OAAO,GAAG,MAAM,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC;YAChC,IAAI,OAAO;gBAAE,OAAO,CAAC,KAAK,IAAI,CAAC,CAAC;;gBAC3B,MAAM,CAAC,GAAG,CAAC,GAAG,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;YACjD,OAAO,IAAI,CAAC,CAAC;QACf,CAAC,CAAC,CAAC;QACH,IAAI,OAAO,KAAK,CAAC;YAAE,OAAO,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC;QAC1D,yFAAyF;QACzF,MAAM,MAAM,GAAG,CAAC,GAAG,MAAM,CAAC,MAAM,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,KAAK,GAAG,CAAC,CAAC,KAAK,CAAC,CAAC;QACtE,MAAM,IAAI,GAAmB,EAAE,CAAC;QAChC,MAAM,QAAQ,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC3C,KAAK,MAAM,OAAO,IAAI,MAAM,EAAE,CAAC;YAC7B,OAAO,CAAC,MAAM,GAAG,OAAO,CAAC,MAAM,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE;gBAC5C,IAAI,EAAE,GAAG,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;gBAC7B,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;oBACrB,EAAE,GAAG,IAAI,CAAC,MAAM,CAAC;oBACjB,QAAQ,CAAC,GAAG,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC;oBACxB,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,KAAK,CAAiB,CAAC,CAAC;gBAC3C,CAAC;gBACD,OAAO,EAAE,CAAC;YACZ,CAAC,CAAC,CAAC;QACL,CAAC;QACD,OAAO;YACL,OAAO,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,UAAU,GAAG,IAAI,CAAC,EAAE,OAAO,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,EAAE;YAC3F,OAAO;SACR,CAAC;IACJ,CAAC;IAED,uEAAuE;IAC/D,KAAK,CAAC,SAAoB;QAChC,MAAM,IAAI,GAAG,SAAS,CAAC,YAAY,IAAI,aAAa,CAAC;QACrD,IAAI,CAAC,SAAS,CAAC,GAAG;YAAE,OAAO,EAAE,QAAQ,EAAE,IAAI,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,EAAE,IAAI,EAAE,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,CAAC;QAC9F,MAAM,KAAK,GAAG,KAAK,CAAC,SAAS,CAAC,GAAG,EAAE,SAAS,CAAC,UAAU,GAAG,CAAC,EAAE,SAAS,CAAC,YAAY,GAAG,CAAC,CAAC,CAAC;QACzF,IAAI,OAAO,CAAC,KAAK,CAAC,IAAI,CAAC;YAAE,OAAO,IAAI,CAAC;QACrC,MAAM,GAAG,GAAG,KAAK,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;QACzC,OAAO;YACL,QAAQ,EAAE,IAAI;YACd,MAAM,EAAE,IAAI;YACZ,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,WAAW,CAAC,KAAK,CAAC,IAAI,CAAC;YACrE,IAAI,EAAE,KAAK,CAAC,IAAI;YAChB,MAAM,EAAE,GAAG;SACZ,CAAC;IACJ,CAAC;CACF"}

package/dist/proxy.d.ts

@@ -0,0 +1,22 @@
+import { type IncomingMessage, type ServerResponse } from "node:http";
+import type { BrowserOptions } from "./browser.js";
+export declare const PREFIX = "/__tracepanel__/";
+/** A client on this machine: the console's traces, and what it lets a local caller do, are for its developer only. */
+export declare function isLocal(req: IncomingMessage): boolean;
+/** The browser recording as an ES module, for `import { record } from "/__tracepanel__/browser.js"`. */
+export declare function browserModule(): string;
+/**
+ * The browser recording (its ES module) as a classic script that starts it at once: inline in the page's <head>, it
+ * wraps fetch before the app's own scripts run, and so before any of them keeps a reference to it.
+ */
+export declare function recordingScript(module: string, options: BrowserOptions): string;
+/**
+ * The request, sent on to the console as it came, and its answer back. A GET the agent doesn't answer (its address
+ * left over from one that exited) goes once more to what `restart` gives: a new agent's console.
+ */
+export declare function forward(target: URL, req: IncomingMessage, res: ServerResponse, restart?: () => string | undefined): void;
+/**
+ * What the proxy answers itself (the URL with the prefix taken off), true when it did: another machine is refused,
+ * and the browser recording comes from this package. The rest goes on to the agent.
+ */
+export declare function answeredHere(req: IncomingMessage, res: ServerResponse): boolean;

package/dist/proxy.js

@@ -0,0 +1,72 @@
+// The console on the app's own origin, at /__tracepanel__/, in development: the Vite plugin and Next.js send what comes
+// there on to the console of the project's agent, so the widget, the page's recording and the panel share the page's
+// origin. Only this machine reaches it: the agent sees the proxy's own address, so its local-only checks (switching
+// the user) would let anyone through.
+import { readFileSync } from "node:fs";
+import { request } from "node:http";
+import { fileURLToPath } from "node:url";
+export const PREFIX = "/__tracepanel__/";
+// The browser recording, served from this package: the console doesn't have it.
+const BROWSER = fileURLToPath(new URL("./browser.js", import.meta.url));
+/** A client on this machine: the console's traces, and what it lets a local caller do, are for its developer only. */
+export function isLocal(req) {
+    const address = req.socket.remoteAddress ?? "";
+    return address === "::1" || address.startsWith("127.") || address.startsWith("::ffff:127.");
+}
+/** The browser recording as an ES module, for `import { record } from "/__tracepanel__/browser.js"`. */
+export function browserModule() {
+    return readFileSync(BROWSER, "utf8");
+}
+/**
+ * The browser recording (its ES module) as a classic script that starts it at once: inline in the page's <head>, it
+ * wraps fetch before the app's own scripts run, and so before any of them keeps a reference to it.
+ */
+export function recordingScript(module, options) {
+    // Inside a <script>: no "</script>" in the settings, whatever a service is called.
+    const settings = JSON.stringify(options).replace(/</g, "\\u003c");
+    return `(() => {\n${module.replace(/^export /gm, "")}\nrecord(${settings});\n})();`;
+}
+/**
+ * The request, sent on to the console as it came, and its answer back. A GET the agent doesn't answer (its address
+ * left over from one that exited) goes once more to what `restart` gives: a new agent's console.
+ */
+export function forward(target, req, res, restart) {
+    const upstream = request({
+        host: target.hostname,
+        port: target.port,
+        method: req.method,
+        path: `${target.pathname.replace(/\/$/, "")}${req.url ?? "/"}`,
+        headers: { ...req.headers, host: target.host },
+    }, (answer) => {
+        res.writeHead(answer.statusCode ?? 502, answer.headers);
+        answer.pipe(res);
+    });
+    upstream.on("error", () => {
+        const again = req.method === "GET" ? restart?.() : undefined;
+        if (again) {
+            forward(new URL(again), req, res);
+            return;
+        }
+        res.writeHead(502, { "Content-Type": "text/plain" });
+        res.end("Tracepanel's agent doesn't answer: is the backend running in development?");
+    });
+    req.pipe(upstream);
+}
+/**
+ * What the proxy answers itself (the URL with the prefix taken off), true when it did: another machine is refused,
+ * and the browser recording comes from this package. The rest goes on to the agent.
+ */
+export function answeredHere(req, res) {
+    if (!isLocal(req)) {
+        res.writeHead(403, { "Content-Type": "text/plain" });
+        res.end("The Tracepanel console answers on this machine only.");
+        return true;
+    }
+    if (req.url === "/browser.js") {
+        res.writeHead(200, { "Content-Type": "text/javascript", "Cache-Control": "no-store" });
+        res.end(browserModule());
+        return true;
+    }
+    return false;
+}
+//# sourceMappingURL=proxy.js.map

package/dist/proxy.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"proxy.js","sourceRoot":"","sources":["../src/proxy.ts"],"names":[],"mappings":"AAAA,wHAAwH;AACxH,qHAAqH;AACrH,oHAAoH;AACpH,sCAAsC;AAEtC,OAAO,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACvC,OAAO,EAAwB,OAAO,EAAuB,MAAM,WAAW,CAAC;AAC/E,OAAO,EAAE,aAAa,EAAE,MAAM,UAAU,CAAC;AAGzC,MAAM,CAAC,MAAM,MAAM,GAAG,kBAAkB,CAAC;AACzC,gFAAgF;AAChF,MAAM,OAAO,GAAG,aAAa,CAAC,IAAI,GAAG,CAAC,cAAc,EAAE,OAAO,IAAI,CAAC,GAAG,CAAC,CAAC,CAAC;AAExE,sHAAsH;AACtH,MAAM,UAAU,OAAO,CAAC,GAAoB;IAC1C,MAAM,OAAO,GAAG,GAAG,CAAC,MAAM,CAAC,aAAa,IAAI,EAAE,CAAC;IAC/C,OAAO,OAAO,KAAK,KAAK,IAAI,OAAO,CAAC,UAAU,CAAC,MAAM,CAAC,IAAI,OAAO,CAAC,UAAU,CAAC,aAAa,CAAC,CAAC;AAC9F,CAAC;AAED,wGAAwG;AACxG,MAAM,UAAU,aAAa;IAC3B,OAAO,YAAY,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;AACvC,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,eAAe,CAAC,MAAc,EAAE,OAAuB;IACrE,mFAAmF;IACnF,MAAM,QAAQ,GAAG,IAAI,CAAC,SAAS,CAAC,OAAO,CAAC,CAAC,OAAO,CAAC,IAAI,EAAE,SAAS,CAAC,CAAC;IAClE,OAAO,aAAa,MAAM,CAAC,OAAO,CAAC,YAAY,EAAE,EAAE,CAAC,YAAY,QAAQ,WAAW,CAAC;AACtF,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,OAAO,CACrB,MAAW,EACX,GAAoB,EACpB,GAAmB,EACnB,OAAkC;IAElC,MAAM,QAAQ,GAAG,OAAO,CACtB;QACE,IAAI,EAAE,MAAM,CAAC,QAAQ;QACrB,IAAI,EAAE,MAAM,CAAC,IAAI;QACjB,MAAM,EAAE,GAAG,CAAC,MAAM;QAClB,IAAI,EAAE,GAAG,MAAM,CAAC,QAAQ,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,GAAG,GAAG,CAAC,GAAG,IAAI,GAAG,EAAE;QAC9D,OAAO,EAAE,EAAE,GAAG,GAAG,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE;KAC/C,EACD,CAAC,MAAM,EAAE,EAAE;QACT,GAAG,CAAC,SAAS,CAAC,MAAM,CAAC,UAAU,IAAI,GAAG,EAAE,MAAM,CAAC,OAAO,CAAC,CAAC;QACxD,MAAM,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IACnB,CAAC,CACF,CAAC;IACF,QAAQ,CAAC,EAAE,CAAC,OAAO,EAAE,GAAG,EAAE;QACxB,MAAM,KAAK,GAAG,GAAG,CAAC,MAAM,KAAK,KAAK,CAAC,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7D,IAAI,KAAK,EAAE,CAAC;YACV,OAAO,CAAC,IAAI,GAAG,CAAC,KAAK,CAAC,EAAE,GAAG,EAAE,GAAG,CAAC,CAAC;YAClC,OAAO;QACT,CAAC;QACD,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC,CAAC;QACrD,GAAG,CAAC,GAAG,CAAC,2EAA2E,CAAC,CAAC;IACvF,CAAC,CAAC,CAAC;IACH,GAAG,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;AACrB,CAAC;AAED;;;GAGG;AACH,MAAM,UAAU,YAAY,CAAC,GAAoB,EAAE,GAAmB;IACpE,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,EAAE,CAAC;QAClB,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE,CAAC,CAAC;QACrD,GAAG,CAAC,GAAG,CAAC,sDAAsD,CAAC,CAAC;QAChE,OAAO,IAAI,CAAC;IACd,CAAC;IACD,IAAI,GAAG,CAAC,GAAG,KAAK,aAAa,EAAE,CAAC;QAC9B,GAAG,CAAC,SAAS,CAAC,GAAG,EAAE,EAAE,cAAc,EAAE,iBAAiB,EAAE,eAAe,EAAE,UAAU,EAAE,CAAC,CAAC;QACvF,GAAG,CAAC,GAAG,CAAC,aAAa,EAAE,CAAC,CAAC;QACzB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC"}

package/dist/request.d.ts

@@ -0,0 +1,61 @@
+import type { Attrs } from "./model.js";
+/** How much of a body is kept, in characters. */
+export declare const MAX_BODY = 16384;
+export declare const MASK = "********";
+/** A name as one segment of an attribute's key (content-type -> content_type), as the trace format has keys. */
+export declare function key(name: string): string;
+/** Whether a secret goes under the name: x-api-key, csrftoken, sessionid, password. */
+export declare function sensitive(name: string): boolean;
+/** A header's value as one string: several values joined, as Node joins them. */
+export declare function headerValue(value: unknown): string | undefined;
+/** http.request.header.<name>, the name as a key; Cookie is read as cookies instead. */
+export declare function requestHeaders(entries: Iterable<[string, unknown]>): Attrs;
+/** http.response.header.<name>: several values joined, Set-Cookie masked. */
+export declare function responseHeaders(entries: Iterable<[string, unknown]>): Attrs;
+/** url.query: the query string, the values of sensitive parameters masked. */
+export declare function query(search: string): Attrs;
+/** The Cookie header's cookies by name, as they came. */
+export declare function parseCookies(header: string): [string, string][];
+/** http.request.cookie.<name>, from the Cookie header; a session id or a CSRF token masked. */
+export declare function cookies(header: string): Attrs;
+/** The request's headers by lower-case name, from Node's IncomingMessage or a fetch Request. */
+export type RequestHeaders = Record<string, string | string[] | undefined>;
+/** What the request carried before the app read it: its headers, query and cookies. */
+export declare function requestAttrs(requested: RequestHeaders, search: string): Attrs;
+/** The query string of a request's URL (/books?page=2 -> ?page=2). */
+export declare function searchOf(url: string): string;
+export declare function cut(text: string): Attrs;
+/** A JSON value with the values under sensitive keys masked, at any depth. */
+export declare function masked(value: unknown): unknown;
+/** A form's fields as they would have been sent, sensitive values masked, then its files by name and size. */
+export declare function formText(fields: Iterable<[string, unknown]>, files?: [string, string, number][]): string;
+export declare function kindOf(contentType: string): string;
+/**
+ * http.request.body from the bytes the app read, as far as it read them: JSON and forms with secrets masked, text as
+ * it is, binary not. `complete` is false when only the start of the body is at hand: JSON or a form can't be read
+ * (nor its secrets masked) from a part of it.
+ */
+export declare function readBody(contentType: string, data: Uint8Array, complete: boolean): Attrs;
+/** What a request's body parser left on it: `req.body`, and `req.file`/`req.files` of an upload. */
+export interface ParsedBody {
+    contentType: string;
+    body: unknown;
+    file?: unknown;
+    files?: unknown;
+}
+/**
+ * http.request.body from what the app's body parser read: JSON and forms with secrets masked, text as it is, an
+ * upload's files by name and size. Nothing when no parser read it.
+ */
+export declare function parsedBody({ contentType, body, file, files }: ParsedBody): Attrs;
+/** Whether a request came with a body: one declared by its size, or sent in chunks. */
+export declare function hasBody(requested: RequestHeaders): boolean;
+/**
+ * The requests that answered a page's navigation with a redirect, by id, on the way to the page the widget will see:
+ * its panel lists them before that page (a form's POST, then the page it redirected to).
+ */
+export declare const REDIRECTS = "tracepanel_redirect";
+/** Whether the browser asked for a page to show (a link, a form): not fetch() or an image. */
+export declare function navigated(requested: RequestHeaders): boolean;
+/** The Set-Cookie naming this request too, for a redirect that answers a page's navigation; undefined otherwise. */
+export declare function redirectCookie(id: string, status: number, requested: RequestHeaders): string | undefined;