@tracepanel/js 0.3.4 → 0.4.1

package/dist/body.js

@@ -0,0 +1,314 @@
+// A request's body as the app reads it, for the frameworks that read it from the stream themselves (Next.js, Nuxt,
+// Bun.serve and the handlers under `withTracepanel()`): a tap sees each piece on its way to the app and keeps a copy
+// of the start, up to the most a trace keeps. It never reads the stream itself: a body the app doesn't read is not
+// recorded, and nothing waits for it. The app gets every byte as it came, at the pace it reads them, so an upload
+// still streams; the tap never holds more than MAX_BODY bytes of it.
+//
+// A multipart form is read as it passes: its fields' values (up to MAX_BODY in all), and its files by name and size,
+// counted, never kept. JSON or a URL-encoded form past MAX_BODY isn't recorded: its secrets can't be masked from a
+// part of it. Text past it is cut.
+import { cut, formText, headerValue, kindOf, MAX_BODY, readBody } from "./request.js";
+const TAP = Symbol.for("tracepanel.body");
+/** How long a part's headers may be before a form isn't read as one. */
+const MAX_PART_HEADERS = 16_384;
+const HEADERS_END = Buffer.from("\r\n\r\n");
+/** A multipart form's fields and files, read from its pieces as they pass, the files' contents counted, not kept. */
+class Multipart {
+    fields = [];
+    files = [];
+    /** Some of the form was left out: past MAX_BODY. */
+    overflow = false;
+    done = false;
+    broken = false;
+    delimiter;
+    // The first boundary comes without the line break before it: one goes in front, so every boundary looks alike.
+    pending = Buffer.from("\r\n");
+    state = "body";
+    part;
+    budget = MAX_BODY + 1;
+    constructor(boundary) {
+        this.delimiter = Buffer.from(`\r\n--${boundary}`);
+    }
+    feed(chunk) {
+        if (this.done || this.broken)
+            return;
+        this.pending = this.pending.length > 0 ? Buffer.concat([this.pending, chunk]) : chunk;
+        for (;;) {
+            if (this.state === "body") {
+                const at = this.pending.indexOf(this.delimiter);
+                if (at < 0) {
+                    // All but what could be the start of a boundary is the part's.
+                    const safe = Math.max(0, this.pending.length - this.delimiter.length + 1);
+                    this.take(this.pending.subarray(0, safe));
+                    this.pending = this.pending.subarray(safe);
+                    return;
+                }
+                this.take(this.pending.subarray(0, at));
+                this.close();
+                this.pending = this.pending.subarray(at + this.delimiter.length);
+                this.state = "after";
+            }
+            if (this.state === "after") {
+                if (this.pending.length < 2)
+                    return;
+                if (this.pending[0] === 0x2d && this.pending[1] === 0x2d) {
+                    this.done = true;
+                    this.pending = Buffer.alloc(0);
+                    return;
+                }
+                this.state = "headers";
+            }
+            const end = this.pending.indexOf(HEADERS_END);
+            if (end < 0) {
+                if (this.pending.length > MAX_PART_HEADERS)
+                    this.broken = true;
+                return;
+            }
+            this.open(this.pending.subarray(0, end).toString("utf8"));
+            this.pending = this.pending.subarray(end + HEADERS_END.length);
+            this.state = "body";
+        }
+    }
+    /** The part's headers, the rest of the boundary's line before them. */
+    open(block) {
+        const disposition = block
+            .split("\r\n")
+            .slice(1)
+            .find((line) => line.toLowerCase().startsWith("content-disposition:"));
+        const params = parameters(disposition?.slice(disposition.indexOf(":") + 1) ?? "");
+        const { name, filename } = params;
+        this.part = undefined;
+        if (name === undefined)
+            return;
+        // Its names count toward what the form keeps, as its values do.
+        const cost = name.length + (filename?.length ?? 0);
+        if (cost > this.budget) {
+            this.overflow = true;
+            return;
+        }
+        this.budget -= cost;
+        this.part = { name, filename, size: 0, value: [] };
+    }
+    take(bytes) {
+        const part = this.part;
+        if (!part || bytes.length === 0)
+            return;
+        part.size += bytes.length;
+        if (part.filename !== undefined)
+            return;
+        const kept = bytes.subarray(0, Math.max(0, this.budget));
+        if (kept.length < bytes.length)
+            this.overflow = true;
+        // A copy: the piece is the app's, and it may reuse its memory.
+        if (kept.length > 0)
+            part.value.push(Buffer.from(kept));
+        this.budget -= kept.length;
+    }
+    close() {
+        const part = this.part;
+        this.part = undefined;
+        if (!part)
+            return;
+        if (part.filename !== undefined)
+            this.files.push([part.name, part.filename, part.size]);
+        else
+            this.fields.push([part.name, Buffer.concat(part.value).toString("utf8")]);
+    }
+}
+/** A header's parameters (`form-data; name="a"; filename="b.png"`), `filename*` decoded and preferred. */
+function parameters(header) {
+    const found = {};
+    for (const match of header.matchAll(/;\s*([^=;\s]+)\s*=\s*(?:"((?:[^"\\]|\\.)*)"|([^;]*))/g)) {
+        const name = (match[1] ?? "").toLowerCase();
+        const value = match[2] !== undefined ? match[2].replace(/\\(.)/g, "$1") : (match[3] ?? "").trim();
+        if (name === "filename*") {
+            const encoded = value.replace(/^[^']*'[^']*'/, "");
+            try {
+                found.filename = decodeURIComponent(encoded);
+            }
+            catch {
+                found.filename = encoded;
+            }
+        }
+        else if (!(name in found))
+            found[name] = value;
+    }
+    return found;
+}
+/** The boundary a multipart form's Content-Type names. */
+function boundaryOf(contentType) {
+    const match = /;\s*boundary=(?:"([^"]+)"|([^;\s]+))/i.exec(contentType);
+    return match?.[1] ?? match?.[2];
+}
+/** What the app read of a request's body, kept as it passed: its start, its size, and whether it read it all. */
+export class BodyTap {
+    contentType;
+    kept = [];
+    size = 0;
+    ended = false;
+    form;
+    constructor(contentType) {
+        this.contentType = contentType;
+        const boundary = kindOf(contentType) === "multipart/form-data" ? boundaryOf(contentType) : undefined;
+        this.form = boundary ? new Multipart(boundary) : undefined;
+    }
+    /** A piece of the body on its way to the app. */
+    feed(chunk) {
+        // Read again after it ended (Next.js hands a middleware's copy of the body to the route): counted once.
+        if (this.ended)
+            return;
+        const piece = toBuffer(chunk);
+        if (!piece || piece.length === 0)
+            return;
+        if (this.form)
+            this.form.feed(piece);
+        // Kept up to the limit, and a byte past it to know it was cut; never the rest of an upload.
+        else if (this.size <= MAX_BODY)
+            this.kept.push(Buffer.from(piece.subarray(0, MAX_BODY + 1 - this.size)));
+        this.size += piece.length;
+    }
+    /** The app read the body to its end. */
+    end() {
+        this.ended = true;
+    }
+    /** http.request.body, as far as the app read it. */
+    attrs() {
+        if (this.form) {
+            if (!this.form.done)
+                return {};
+            const text = formText(this.form.fields, this.form.files);
+            if (!text)
+                return {};
+            return this.form.overflow ? { ...cut(text), "http.request.body.truncated": true } : cut(text);
+        }
+        const data = Buffer.concat(this.kept);
+        const found = readBody(this.contentType, data, this.ended && this.size <= MAX_BODY);
+        // Its characters more than one byte each, the body was cut before MAX_BODY characters.
+        if ("http.request.body" in found && this.size > data.length)
+            found["http.request.body.truncated"] = true;
+        return found;
+    }
+}
+function toBuffer(chunk) {
+    if (Buffer.isBuffer(chunk))
+        return chunk;
+    if (chunk instanceof Uint8Array)
+        return Buffer.from(chunk.buffer, chunk.byteOffset, chunk.byteLength);
+    if (typeof chunk === "string")
+        return Buffer.from(chunk);
+    return undefined;
+}
+/**
+ * A Node request whose body pieces pass the tap on their way to the app: every reader of a stream (a `data`
+ * listener, `read()`, async iteration, `pipe()`) gets them through its `emit("data")`. The tap is the request's from
+ * then on (`tapOf`). A framework that puts another stream's `emit` on the request (Next.js does, for a body a
+ * middleware read too) gets it tapped as well.
+ */
+export function tapIncoming(req) {
+    const tap = new BodyTap(headerValue(req.headers["content-type"]) ?? "");
+    let emit = req.emit;
+    const tapped = function (event, ...args) {
+        try {
+            if (event === "data")
+                tap.feed(args[0]);
+            else if (event === "end")
+                tap.end();
+        }
+        catch {
+            // The app's body goes on whatever the tap makes of it.
+        }
+        return emit.call(this, event, ...args);
+    };
+    Object.defineProperty(req, "emit", {
+        configurable: true,
+        get: () => tapped,
+        set: (value) => {
+            emit = value;
+        },
+    });
+    req[TAP] = tap;
+    return tap;
+}
+/** The tap on a Node request's body, if it has one. */
+export function tapOf(req) {
+    return req?.[TAP];
+}
+const READERS = ["arrayBuffer", "blob", "bytes", "formData", "json", "text"];
+/** The getter a property has on an object's prototypes: the Request's own `body`, under the tap's. */
+function inherited(target, name) {
+    for (let proto = Object.getPrototypeOf(target); proto; proto = Object.getPrototypeOf(proto)) {
+        const found = Object.getOwnPropertyDescriptor(proto, name);
+        if (found)
+            return found.get;
+    }
+    return undefined;
+}
+/**
+ * A fetch Request whose body passes the tap on its way to the handler: `request.body` and its readers (`text()`,
+ * `json()`, `formData()`, ...) read through it, piece by piece as the handler pulls them. The request stays the one
+ * the server made (Bun's `params` and `cookies` with it); `clone()` is its own, untapped.
+ */
+export function tapRequest(request) {
+    // Tapped already, by a withTracepanel() around this one: the same tap.
+    const before = request[TAP];
+    if (before)
+        return before;
+    const original = inherited(request, "body");
+    // A request without a body (a GET) keeps its null; a fetch Request's headers have no Content-Length to tell.
+    if (!original || original.call(request) === null)
+        return undefined;
+    const tap = new BodyTap(request.headers.get("content-type") ?? "");
+    let through;
+    const body = () => {
+        if (through)
+            return through;
+        let reader;
+        // The request's own stream, taken at the first read: until then it is the app's to clone.
+        const source = () => {
+            if (reader)
+                return reader;
+            const stream = original.call(request);
+            reader = stream?.getReader();
+            return reader;
+        };
+        through = new ReadableStream({
+            async pull(controller) {
+                const from = source();
+                const { done, value } = from ? await from.read() : { done: true, value: undefined };
+                if (done || !value) {
+                    tap.end();
+                    controller.close();
+                    return;
+                }
+                try {
+                    tap.feed(value);
+                }
+                catch {
+                    // The handler's body goes on whatever the tap makes of it.
+                }
+                controller.enqueue(value);
+            },
+            async cancel(reason) {
+                await source()?.cancel(reason);
+            },
+        }, 
+        // Nothing read ahead of the handler: a piece is taken when it asks for one.
+        { highWaterMark: 0 });
+        return through;
+    };
+    request[TAP] = tap;
+    const headers = { "content-type": request.headers.get("content-type") ?? "" };
+    Object.defineProperty(request, "body", { configurable: true, get: body });
+    for (const name of READERS) {
+        if (typeof request[name] !== "function")
+            continue;
+        Object.defineProperty(request, name, {
+            configurable: true,
+            writable: true,
+            // A promise either way, as the request's own: a body already read rejects it.
+            value: async () => new Response(body(), { headers })[name]?.(),
+        });
+    }
+    return tap;
+}
+//# sourceMappingURL=body.js.map

package/dist/body.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"body.js","sourceRoot":"","sources":["../src/body.ts"],"names":[],"mappings":"AAAA,mHAAmH;AACnH,qHAAqH;AACrH,mHAAmH;AACnH,kHAAkH;AAClH,qEAAqE;AACrE,EAAE;AACF,qHAAqH;AACrH,mHAAmH;AACnH,mCAAmC;AAInC,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,WAAW,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,cAAc,CAAC;AAEtF,MAAM,GAAG,GAAG,MAAM,CAAC,GAAG,CAAC,iBAAiB,CAAC,CAAC;AAC1C,wEAAwE;AACxE,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAChC,MAAM,WAAW,GAAG,MAAM,CAAC,IAAI,CAAC,UAAU,CAAC,CAAC;AAE5C,qHAAqH;AACrH,MAAM,SAAS;IACJ,MAAM,GAAuB,EAAE,CAAC;IAChC,KAAK,GAA+B,EAAE,CAAC;IAChD,oDAAoD;IACpD,QAAQ,GAAG,KAAK,CAAC;IACjB,IAAI,GAAG,KAAK,CAAC;IACL,MAAM,GAAG,KAAK,CAAC;IACN,SAAS,CAAS;IACnC,+GAA+G;IACvG,OAAO,GAAW,MAAM,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACtC,KAAK,GAAiC,MAAM,CAAC;IAC7C,IAAI,CAA4F;IAChG,MAAM,GAAG,QAAQ,GAAG,CAAC,CAAC;IAE9B,YAAY,QAAgB;QAC1B,IAAI,CAAC,SAAS,GAAG,MAAM,CAAC,IAAI,CAAC,SAAS,QAAQ,EAAE,CAAC,CAAC;IACpD,CAAC;IAED,IAAI,CAAC,KAAa;QAChB,IAAI,IAAI,CAAC,IAAI,IAAI,IAAI,CAAC,MAAM;YAAE,OAAO;QACrC,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC,IAAI,CAAC,OAAO,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;QACtF,SAAS,CAAC;YACR,IAAI,IAAI,CAAC,KAAK,KAAK,MAAM,EAAE,CAAC;gBAC1B,MAAM,EAAE,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,CAAC;gBAChD,IAAI,EAAE,GAAG,CAAC,EAAE,CAAC;oBACX,+DAA+D;oBAC/D,MAAM,IAAI,GAAG,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;oBAC1E,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,CAAC,CAAC;oBAC1C,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC;oBAC3C,OAAO;gBACT,CAAC;gBACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC;gBACxC,IAAI,CAAC,KAAK,EAAE,CAAC;gBACb,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,MAAM,CAAC,CAAC;gBACjE,IAAI,CAAC,KAAK,GAAG,OAAO,CAAC;YACvB,CAAC;YACD,IAAI,IAAI,CAAC,KAAK,KAAK,OAAO,EAAE,CAAC;gBAC3B,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC;oBAAE,OAAO;gBACpC,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,IAAI,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC,KAAK,IAAI,EAAE,CAAC;oBACzD,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC;oBACjB,IAAI,CAAC,OAAO,GAAG,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;oBAC/B,OAAO;gBACT,CAAC;gBACD,IAAI,CAAC,KAAK,GAAG,SAAS,CAAC;YACzB,CAAC;YACD,MAAM,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC,CAAC;YAC9C,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC;gBACZ,IAAI,IAAI,CAAC,OAAO,CAAC,MAAM,GAAG,gBAAgB;oBAAE,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;gBAC/D,OAAO;YACT,CAAC;YACD,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,EAAE,GAAG,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC;YAC1D,IAAI,CAAC,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,CAAC;YAC/D,IAAI,CAAC,KAAK,GAAG,MAAM,CAAC;QACtB,CAAC;IACH,CAAC;IAED,uEAAuE;IAC/D,IAAI,CAAC,KAAa;QACxB,MAAM,WAAW,GAAG,KAAK;aACtB,KAAK,CAAC,MAAM,CAAC;aACb,KAAK,CAAC,CAAC,CAAC;aACR,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,UAAU,CAAC,sBAAsB,CAAC,CAAC,CAAC;QACzE,MAAM,MAAM,GAAG,UAAU,CAAC,WAAW,EAAE,KAAK,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;QAClF,MAAM,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,MAAM,CAAC;QAClC,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,IAAI,KAAK,SAAS;YAAE,OAAO;QAC/B,gEAAgE;QAChE,MAAM,IAAI,GAAG,IAAI,CAAC,MAAM,GAAG,CAAC,QAAQ,EAAE,MAAM,IAAI,CAAC,CAAC,CAAC;QACnD,IAAI,IAAI,GAAG,IAAI,CAAC,MAAM,EAAE,CAAC;YACvB,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;YACrB,OAAO;QACT,CAAC;QACD,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC;QACpB,IAAI,CAAC,IAAI,GAAG,EAAE,IAAI,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,KAAK,EAAE,EAAE,EAAE,CAAC;IACrD,CAAC;IAEO,IAAI,CAAC,KAAa;QACxB,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACxC,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC;QAC1B,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAAE,OAAO;QACxC,MAAM,IAAI,GAAG,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;QACzD,IAAI,IAAI,CAAC,MAAM,GAAG,KAAK,CAAC,MAAM;YAAE,IAAI,CAAC,QAAQ,GAAG,IAAI,CAAC;QACrD,+DAA+D;QAC/D,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC;YAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QACxD,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,MAAM,CAAC;IAC7B,CAAC;IAEO,KAAK;QACX,MAAM,IAAI,GAAG,IAAI,CAAC,IAAI,CAAC;QACvB,IAAI,CAAC,IAAI,GAAG,SAAS,CAAC;QACtB,IAAI,CAAC,IAAI;YAAE,OAAO;QAClB,IAAI,IAAI,CAAC,QAAQ,KAAK,SAAS;YAAE,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,QAAQ,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;;YACnF,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,IAAI,EAAE,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC;IACjF,CAAC;CACF;AAED,0GAA0G;AAC1G,SAAS,UAAU,CAAC,MAAc;IAChC,MAAM,KAAK,GAA2B,EAAE,CAAC;IACzC,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,uDAAuD,CAAC,EAAE,CAAC;QAC7F,MAAM,IAAI,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,WAAW,EAAE,CAAC;QAC5C,MAAM,KAAK,GAAG,KAAK,CAAC,CAAC,CAAC,KAAK,SAAS,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QAClG,IAAI,IAAI,KAAK,WAAW,EAAE,CAAC;YACzB,MAAM,OAAO,GAAG,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,EAAE,CAAC,CAAC;YACnD,IAAI,CAAC;gBACH,KAAK,CAAC,QAAQ,GAAG,kBAAkB,CAAC,OAAO,CAAC,CAAC;YAC/C,CAAC;YAAC,MAAM,CAAC;gBACP,KAAK,CAAC,QAAQ,GAAG,OAAO,CAAC;YAC3B,CAAC;QACH,CAAC;aAAM,IAAI,CAAC,CAAC,IAAI,IAAI,KAAK,CAAC;YAAE,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC;IACnD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,0DAA0D;AAC1D,SAAS,UAAU,CAAC,WAAmB;IACrC,MAAM,KAAK,GAAG,uCAAuC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IACxE,OAAO,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC,CAAC,CAAC;AAClC,CAAC;AAED,iHAAiH;AACjH,MAAM,OAAO,OAAO;IAMW,WAAW;IALvB,IAAI,GAAa,EAAE,CAAC;IAC7B,IAAI,GAAG,CAAC,CAAC;IACT,KAAK,GAAG,KAAK,CAAC;IACL,IAAI,CAAwB;IAE7C,YAA6B,WAAmB;2BAAnB,WAAW;QACtC,MAAM,QAAQ,GAAG,MAAM,CAAC,WAAW,CAAC,KAAK,qBAAqB,CAAC,CAAC,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;QACrG,IAAI,CAAC,IAAI,GAAG,QAAQ,CAAC,CAAC,CAAC,IAAI,SAAS,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;IAC7D,CAAC;IAED,iDAAiD;IACjD,IAAI,CAAC,KAAc;QACjB,wGAAwG;QACxG,IAAI,IAAI,CAAC,KAAK;YAAE,OAAO;QACvB,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,CAAC;QAC9B,IAAI,CAAC,KAAK,IAAI,KAAK,CAAC,MAAM,KAAK,CAAC;YAAE,OAAO;QACzC,IAAI,IAAI,CAAC,IAAI;YAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;QACrC,4FAA4F;aACvF,IAAI,IAAI,CAAC,IAAI,IAAI,QAAQ;YAAE,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,QAAQ,GAAG,CAAC,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC;QACzG,IAAI,CAAC,IAAI,IAAI,KAAK,CAAC,MAAM,CAAC;IAC5B,CAAC;IAED,wCAAwC;IACxC,GAAG;QACD,IAAI,CAAC,KAAK,GAAG,IAAI,CAAC;IACpB,CAAC;IAED,oDAAoD;IACpD,KAAK;QACH,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;YACd,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI;gBAAE,OAAO,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;YACzD,IAAI,CAAC,IAAI;gBAAE,OAAO,EAAE,CAAC;YACrB,OAAO,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC,CAAC,EAAE,GAAG,GAAG,CAAC,IAAI,CAAC,EAAE,6BAA6B,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAChG,CAAC;QACD,MAAM,IAAI,GAAG,MAAM,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;QACtC,MAAM,KAAK,GAAG,QAAQ,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,EAAE,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,IAAI,IAAI,QAAQ,CAAC,CAAC;QACpF,uFAAuF;QACvF,IAAI,mBAAmB,IAAI,KAAK,IAAI,IAAI,CAAC,IAAI,GAAG,IAAI,CAAC,MAAM;YAAE,KAAK,CAAC,6BAA6B,CAAC,GAAG,IAAI,CAAC;QACzG,OAAO,KAAK,CAAC;IACf,CAAC;CACF;AAED,SAAS,QAAQ,CAAC,KAAc;IAC9B,IAAI,MAAM,CAAC,QAAQ,CAAC,KAAK,CAAC;QAAE,OAAO,KAAK,CAAC;IACzC,IAAI,KAAK,YAAY,UAAU;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,UAAU,EAAE,KAAK,CAAC,UAAU,CAAC,CAAC;IACtG,IAAI,OAAO,KAAK,KAAK,QAAQ;QAAE,OAAO,MAAM,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;IACzD,OAAO,SAAS,CAAC;AACnB,CAAC;AAID;;;;;GAKG;AACH,MAAM,UAAU,WAAW,CAAC,GAAoB;IAC9C,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,WAAW,CAAC,GAAG,CAAC,OAAO,CAAC,cAAc,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC;IACxE,IAAI,IAAI,GAAS,GAAG,CAAC,IAAI,CAAC;IAC1B,MAAM,MAAM,GAAG,UAAiC,KAAsB,EAAE,GAAG,IAAe;QACxF,IAAI,CAAC;YACH,IAAI,KAAK,KAAK,MAAM;gBAAE,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,CAAC;iBACnC,IAAI,KAAK,KAAK,KAAK;gBAAE,GAAG,CAAC,GAAG,EAAE,CAAC;QACtC,CAAC;QAAC,MAAM,CAAC;YACP,uDAAuD;QACzD,CAAC;QACD,OAAO,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC;IACzC,CAAS,CAAC;IACV,MAAM,CAAC,cAAc,CAAC,GAAG,EAAE,MAAM,EAAE;QACjC,YAAY,EAAE,IAAI;QAClB,GAAG,EAAE,GAAG,EAAE,CAAC,MAAM;QACjB,GAAG,EAAE,CAAC,KAAW,EAAE,EAAE;YACnB,IAAI,GAAG,KAAK,CAAC;QACf,CAAC;KACF,CAAC,CAAC;IACF,GAA6C,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IAC1D,OAAO,GAAG,CAAC;AACb,CAAC;AAED,uDAAuD;AACvD,MAAM,UAAU,KAAK,CAAC,GAAgC;IACpD,OAAQ,GAA2D,EAAE,CAAC,GAAG,CAAC,CAAC;AAC7E,CAAC;AAED,MAAM,OAAO,GAAG,CAAC,aAAa,EAAE,MAAM,EAAE,OAAO,EAAE,UAAU,EAAE,MAAM,EAAE,MAAM,CAAU,CAAC;AAEtF,sGAAsG;AACtG,SAAS,SAAS,CAAC,MAAc,EAAE,IAAY;IAC7C,KAAK,IAAI,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,MAAM,CAAC,EAAE,KAAK,EAAE,KAAK,GAAG,MAAM,CAAC,cAAc,CAAC,KAAK,CAAC,EAAE,CAAC;QAC5F,MAAM,KAAK,GAAG,MAAM,CAAC,wBAAwB,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAC3D,IAAI,KAAK;YAAE,OAAO,KAAK,CAAC,GAAG,CAAC;IAC9B,CAAC;IACD,OAAO,SAAS,CAAC;AACnB,CAAC;AAED;;;;GAIG;AACH,MAAM,UAAU,UAAU,CAAC,OAAgB;IACzC,uEAAuE;IACvE,MAAM,MAAM,GAAI,OAAyC,CAAC,GAAG,CAAC,CAAC;IAC/D,IAAI,MAAM;QAAE,OAAO,MAAM,CAAC;IAC1B,MAAM,QAAQ,GAAG,SAAS,CAAC,OAAO,EAAE,MAAM,CAAC,CAAC;IAC5C,6GAA6G;IAC7G,IAAI,CAAC,QAAQ,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,IAAI;QAAE,OAAO,SAAS,CAAC;IACnE,MAAM,GAAG,GAAG,IAAI,OAAO,CAAC,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,CAAC,CAAC;IACnE,IAAI,OAA+C,CAAC;IACpD,MAAM,IAAI,GAAG,GAAsC,EAAE;QACnD,IAAI,OAAO;YAAE,OAAO,OAAO,CAAC;QAC5B,IAAI,MAA2D,CAAC;QAChE,0FAA0F;QAC1F,MAAM,MAAM,GAAG,GAAG,EAAE;YAClB,IAAI,MAAM;gBAAE,OAAO,MAAM,CAAC;YAC1B,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAsC,CAAC;YAC3E,MAAM,GAAG,MAAM,EAAE,SAAS,EAAE,CAAC;YAC7B,OAAO,MAAM,CAAC;QAChB,CAAC,CAAC;QACF,OAAO,GAAG,IAAI,cAAc,CAC1B;YACE,KAAK,CAAC,IAAI,CAAC,UAAU;gBACnB,MAAM,IAAI,GAAG,MAAM,EAAE,CAAC;gBACtB,MAAM,EAAE,IAAI,EAAE,KAAK,EAAE,GAAG,IAAI,CAAC,CAAC,CAAC,MAAM,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,EAAE,SAAS,EAAE,CAAC;gBACpF,IAAI,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;oBACnB,GAAG,CAAC,GAAG,EAAE,CAAC;oBACV,UAAU,CAAC,KAAK,EAAE,CAAC;oBACnB,OAAO;gBACT,CAAC;gBACD,IAAI,CAAC;oBACH,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;gBAClB,CAAC;gBAAC,MAAM,CAAC;oBACP,2DAA2D;gBAC7D,CAAC;gBACD,UAAU,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC;YAC5B,CAAC;YACD,KAAK,CAAC,MAAM,CAAC,MAAM;gBACjB,MAAM,MAAM,EAAE,EAAE,MAAM,CAAC,MAAM,CAAC,CAAC;YACjC,CAAC;SACF;QACD,4EAA4E;QAC5E,EAAE,aAAa,EAAE,CAAC,EAAE,CACrB,CAAC;QACF,OAAO,OAAO,CAAC;IACjB,CAAC,CAAC;IACD,OAAyC,CAAC,GAAG,CAAC,GAAG,GAAG,CAAC;IACtD,MAAM,OAAO,GAAG,EAAE,cAAc,EAAE,OAAO,CAAC,OAAO,CAAC,GAAG,CAAC,cAAc,CAAC,IAAI,EAAE,EAAE,CAAC;IAC9E,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,MAAM,EAAE,EAAE,YAAY,EAAE,IAAI,EAAE,GAAG,EAAE,IAAI,EAAE,CAAC,CAAC;IAC1E,KAAK,MAAM,IAAI,IAAI,OAAO,EAAE,CAAC;QAC3B,IAAI,OAAQ,OAA8C,CAAC,IAAI,CAAC,KAAK,UAAU;YAAE,SAAS;QAC1F,MAAM,CAAC,cAAc,CAAC,OAAO,EAAE,IAAI,EAAE;YACnC,YAAY,EAAE,IAAI;YAClB,QAAQ,EAAE,IAAI;YACd,8EAA8E;YAC9E,KAAK,EAAE,KAAK,IAAI,EAAE,CACf,IAAI,QAAQ,CAAC,IAAI,EAAE,EAAE,EAAE,OAAO,EAAE,CAAuD,CAAC,IAAI,CAAC,EAAE,EAAE;SACrG,CAAC,CAAC;IACL,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC"}

package/dist/bullmq.d.ts

@@ -1,7 +1,82 @@
 import { InstrumentationBase, InstrumentationNodeModuleDefinition } from "@opentelemetry/instrumentation";
+import { type TaskEvent } from "./agent.js";
+interface Job {
+    id?: string;
+    name: string;
+    queueName: string;
+    data?: unknown;
+    timestamp: number;
+    delay?: number;
+    attemptsMade: number;
+    opts?: {
+        attempts?: number;
+    };
+}
+interface Worker {
+    opts?: {
+        name?: string;
+    };
+}
+/** Where task events go: the process's Tracepanel (its processor), which knows the active trace too. */
+export interface Events {
+    taskEvent(event: TaskEvent): void;
+    current(): {
+        building: {
+            trace: {
+                id: string;
+            };
+        };
+        spanId: string | null;
+    } | undefined;
+}
+/** How often a worker says it is alive, with the jobs it runs: the agent drops a running one after 2 minutes. */
+export declare const HEARTBEAT_MS = 30000;
+/** What becomes of a job whose run threw: run again, failed, or moved on by the job itself. */
+export declare function outcome(job: Job, error: unknown): "retry" | "failure" | "moved";
+/** The job's id in task events: unique across queues. */
+export declare function liveId(queue: string, id: string): string;
+/** A job's data at a glance: as JSON, values under sensitive keys masked, cut short. */
+export declare function eventArgs(data: unknown): string | undefined;
+/** The worker's name: the one the app gave it, or this process's. */
+export declare function workerName(worker: Worker): string;
+/**
+ * The process's workers and the jobs each runs now, with one timer for their heartbeats. Two Worker instances under
+ * one name (the default, this process's) are one worker to the console.
+ */
+export declare class Heartbeat {
+    private readonly send;
+    private readonly workers;
+    private timer;
+    constructor(send: (event: TaskEvent) => void);
+    /** A worker starts: the console lists it before it runs anything. */
+    open(worker: string): void;
+    /** A worker closed: no more heartbeats for it once no instance under its name is open, nor a job running. */
+    close(worker: string): void;
+    started(worker: string, id: string): void;
+    ended(worker: string, id: string): void;
+    beat(worker: string): void;
+    private of;
+    private forget;
+}
 export declare class BullMQInstrumentation extends InstrumentationBase {
-    constructor();
+    private readonly events?;
+    private readonly heartbeat;
+    /** `events`: where task events go; without it, none are sent. */
+    constructor(events?: Events | undefined);
     protected init(): InstrumentationNodeModuleDefinition;
+    private send;
+    /** A task event: what this step knows, undefined fields left out. */
+    private event;
+    /** The job waits in its queue (or until its delay is over), sent by the process that added it. */
+    private enqueued;
+    /** The trace and step the app is in now, for a job added there. */
+    private parent;
     private processJob;
+    /** `retried` when BullMQ runs the job again (its next attempt's count), else `finished`. */
+    private ended;
+    /** A worker runs from here until it closes: the console lists it meanwhile. */
+    private run;
     private add;
+    private addBulk;
 }
+export {};