@copilotkit/runtime 1.57.3 → 1.58.0-canary.thread-id-propagation

package/src/v2/runtime/__tests__/integration/suites/debug-events.suite.ts

@@ -1,253 +0,0 @@
-import { describe, it, expect, beforeAll, afterAll } from "vitest";
-import type { ServerHandle } from "../servers/types";
-import { readSSEStream } from "../helpers/sse-reader";
-
-/**
- * Envelope shape returned in the debug SSE stream.
- */
-interface DebugEnvelope {
-  timestamp: number;
-  agentId: string;
-  threadId: string;
-  runId: string;
-  event: { type: string; [key: string]: unknown };
-}
-
-/**
- * Parse debug envelopes from SSE payload text.
- * Each `data:` line contains a JSON DebugEventEnvelope.
- */
-function parseDebugEnvelopes(ssePayload: string): DebugEnvelope[] {
-  const envelopes: DebugEnvelope[] = [];
-  for (const line of ssePayload.split("\n")) {
-    if (!line.startsWith("data:")) continue;
-    const json = line.slice("data:".length).trim();
-    if (!json) continue;
-    try {
-      envelopes.push(JSON.parse(json));
-    } catch {
-      // skip malformed lines
-    }
-  }
-  return envelopes;
-}
-
-/**
- * Read from a long-lived debug SSE stream until we see a RUN_FINISHED envelope
- * or a timeout elapses. Returns the raw text accumulated.
- *
- * IMPORTANT: The debug SSE stream is long-lived and never closes on its own.
- * We MUST use a timeout to stop reading, and cancel the reader afterwards.
- */
-async function readDebugStream(
-  // eslint-disable-next-line @typescript-eslint/no-explicit-any
-  stream: ReadableStream<any>,
-  opts: { waitMs?: number } = {},
-): Promise<string> {
-  const waitMs = opts.waitMs ?? 4_000;
-  const reader = stream.getReader();
-  const decoder = new TextDecoder();
-  let output = "";
-  let stopped = false;
-
-  const timer = setTimeout(() => {
-    stopped = true;
-    reader.cancel().catch(() => {});
-  }, waitMs);
-
-  try {
-    while (!stopped) {
-      const result = await reader.read().catch(() => ({
-        done: true as const,
-        value: undefined,
-      }));
-      if (result.done) break;
-      if (result.value) {
-        output +=
-          typeof result.value === "string"
-            ? result.value
-            : decoder.decode(result.value as Uint8Array, { stream: true });
-        if (output.includes("RUN_FINISHED")) {
-          stopped = true;
-          break;
-        }
-      }
-    }
-  } finally {
-    clearTimeout(timer);
-    // Do NOT await reader.cancel() — on tee'd streams (created by response.clone()
-    // inside the fetch handler), awaiting cancel hangs indefinitely because the
-    // other tee branch is never consumed.
-    reader.cancel().catch(() => {});
-    output += decoder.decode();
-  }
-
-  return output;
-}
-
-/**
- * Shared debug-events integration test suite.
- *
- * @param name      Display name, e.g. "Express"
- * @param factory   Creates & starts the server; returns a handle
- */
-export function debugEventsSuite(
-  name: string,
-  factory: (opts?: {
-    capturedHeaders?: Record<string, string>[];
-  }) => Promise<ServerHandle & { handler?: (r: Request) => Promise<Response> }>,
-) {
-  describe(`[${name}] Debug Events`, () => {
-    let handle: ServerHandle & { handler?: (r: Request) => Promise<Response> };
-    let doFetch: (
-      input: RequestInfo | URL,
-      init?: RequestInit,
-    ) => Promise<Response>;
-
-    beforeAll(async () => {
-      handle = await factory();
-      doFetch = handle.handler
-        ? (input, init) =>
-            handle.handler!(
-              new Request(
-                typeof input === "string" || input instanceof URL
-                  ? input
-                  : input,
-                init,
-              ),
-            )
-        : fetch;
-    });
-
-    afterAll(async () => {
-      await handle?.close();
-    });
-
-    const url = (path: string) => `${handle.baseUrl}${handle.basePath}${path}`;
-
-    // ─── SSE Format + Events + Envelope Structure ────────────────────
-    // Combined into a single test to avoid orphaned debug-stream subscribers
-    // across tests (the debug SSE endpoint is long-lived and its cleanup
-    // depends on the request signal being aborted).
-
-    it("streams debug event envelopes with correct structure during an agent run", async () => {
-      const controller = new AbortController();
-
-      // Start the debug stream. For real HTTP servers, fetch blocks until
-      // the first chunk arrives, so we also start the agent run concurrently.
-      const debugFetchPromise = doFetch(url("/cpk-debug-events"), {
-        signal: controller.signal,
-      });
-
-      // Give the subscription a tick to register
-      await new Promise((r) => setTimeout(r, 50));
-
-      // Trigger an agent run. We start it AND begin consuming its stream
-      // concurrently with reading the debug stream.
-      const runRes = await doFetch(url("/agent/default/run"), {
-        method: "POST",
-        headers: { "Content-Type": "application/json" },
-        body: JSON.stringify({
-          threadId: "t-debug-1",
-          runId: "r-debug-1",
-          messages: [],
-          state: {},
-          tools: [],
-          context: [],
-          forwardedProps: {},
-        }),
-      });
-
-      // Consume the run stream and the debug stream concurrently.
-      // Both are needed: the debug stream blocks until events arrive,
-      // and the run stream must be consumed to avoid backpressure.
-      const [debugRes, runPayload] = await Promise.all([
-        debugFetchPromise,
-        readSSEStream(runRes.body!),
-      ]);
-
-      // ── SSE response format ──
-      expect(debugRes.status).toBe(200);
-      expect(debugRes.headers.get("content-type")).toContain(
-        "text/event-stream",
-      );
-
-      // Run completed — events should be buffered in the debug stream.
-      expect(runPayload).toContain("RUN_FINISHED");
-
-      // Read the debug stream (events are already in the buffer)
-      const debugPayload = await readDebugStream(debugRes.body!, {
-        waitMs: 4_000,
-      });
-
-      const envelopes = parseDebugEnvelopes(debugPayload);
-
-      // ── Events flow through ──
-      expect(envelopes.length).toBeGreaterThan(0);
-
-      const eventTypes = envelopes.map((e) => e.event.type);
-      expect(eventTypes).toContain("RUN_STARTED");
-      expect(eventTypes).toContain("RUN_FINISHED");
-
-      // ── Envelope structure ──
-      for (const envelope of envelopes) {
-        expect(typeof envelope.timestamp).toBe("number");
-        expect(envelope.timestamp).toBeGreaterThan(0);
-        expect(envelope.agentId).toBe("default");
-        expect(typeof envelope.threadId).toBe("string");
-        expect(typeof envelope.runId).toBe("string");
-        expect(envelope.event).toBeDefined();
-        expect(typeof envelope.event.type).toBe("string");
-      }
-
-      // Full event sequence
-      expect(eventTypes).toContain("TEXT_MESSAGE_START");
-      expect(eventTypes).toContain("TEXT_MESSAGE_CONTENT");
-      expect(eventTypes).toContain("TEXT_MESSAGE_END");
-
-      // Clean up: abort the request so the debug subscriber is removed
-      controller.abort();
-    }, 15_000);
-
-    // Regression guard for agentId forwarding on /connect lives in a
-    // dedicated unit test (sse-connect-agent-id.test.ts) — driving /connect
-    // through the integration runtime doesn't emit events in a
-    // test-friendly way, so the unit test feeds a synthetic observable
-    // into handleSseConnect and asserts the envelope carries the route
-    // agentId rather than the literal string "connect".
-
-    // ─── HTTP Method Validation ──────────────────────────────────────
-
-    it("POST /cpk-debug-events returns 405", async () => {
-      const res = await doFetch(url("/cpk-debug-events"), { method: "POST" });
-      expect(res.status).toBe(405);
-    });
-  });
-}
-
-/**
- * Production guard test -- only needs the fetch-direct handler since
- * it doesn't require a real server. Tests that NODE_ENV=production
- * returns 404 for the debug-events endpoint.
- */
-export function debugEventsProductionGuardSuite(
-  createHandler: () => { handler: (r: Request) => Promise<Response> },
-  baseUrl: string,
-  basePath: string,
-) {
-  describe("[Fetch] Debug Events – production guard", () => {
-    it("returns 404 when NODE_ENV=production", async () => {
-      const originalEnv = process.env.NODE_ENV;
-      try {
-        process.env.NODE_ENV = "production";
-        const { handler } = createHandler();
-        const res = await handler(
-          new Request(`${baseUrl}${basePath}/cpk-debug-events`),
-        );
-        expect(res.status).toBe(404);
-      } finally {
-        process.env.NODE_ENV = originalEnv;
-      }
-    });
-  });
-}

package/src/v2/runtime/__tests__/integration/suites/multi-endpoint.suite.ts

@@ -1,358 +0,0 @@
-import { describe, it, expect, beforeAll, afterAll } from "vitest";
-import type { ServerHandle } from "../servers/types";
-import { readSSEStream, extractEventTypes } from "../helpers/sse-reader";
-
-/**
- * Shared multi-endpoint test suite.
- *
- * @param name      Display name, e.g. "Express"
- * @param factory   Creates & starts the server; returns a handle
- * @param requestFn Optional custom fetch function (for direct handler tests)
- */
-export function multiEndpointSuite(
-  name: string,
-  factory: (opts?: {
-    capturedHeaders?: Record<string, string>[];
-  }) => Promise<ServerHandle & { handler?: (r: Request) => Promise<Response> }>,
-  requestFn?: (
-    input: RequestInfo | URL,
-    init?: RequestInit,
-  ) => Promise<Response>,
-) {
-  describe(`[${name}] Multi-Endpoint`, () => {
-    let handle: ServerHandle & { handler?: (r: Request) => Promise<Response> };
-    let doFetch: (
-      input: RequestInfo | URL,
-      init?: RequestInit,
-    ) => Promise<Response>;
-
-    beforeAll(async () => {
-      handle = await factory();
-      doFetch =
-        requestFn ??
-        (handle.handler
-          ? (input, init) =>
-              handle.handler!(
-                new Request(
-                  typeof input === "string" || input instanceof URL
-                    ? input
-                    : input,
-                  init,
-                ),
-              )
-          : fetch);
-    });
-
-    afterAll(async () => {
-      await handle?.close();
-    });
-
-    const url = (path: string) => `${handle.baseUrl}${handle.basePath}${path}`;
-
-    // ─── Info Endpoint ───────────────────────────────────────────────
-
-    describe("Info endpoint", () => {
-      it("GET /info returns 200", async () => {
-        const res = await doFetch(url("/info"));
-        expect(res.status).toBe(200);
-      });
-
-      it("GET /info returns version, agents, and audioFileTranscriptionEnabled", async () => {
-        const res = await doFetch(url("/info"));
-        const body = await res.json();
-        expect(body).toHaveProperty("version");
-        expect(typeof body.version).toBe("string");
-        expect(body).toHaveProperty("agents");
-        expect(body.agents).toHaveProperty("default");
-        expect(body).toHaveProperty("audioFileTranscriptionEnabled", false);
-      });
-
-      it("GET /info agents.default has name field", async () => {
-        const res = await doFetch(url("/info"));
-        const body = await res.json();
-        expect(body.agents.default).toHaveProperty("name");
-      });
-    });
-
-    // ─── Agent Run ───────────────────────────────────────────────────
-
-    describe("Agent Run", () => {
-      it("POST /agent/default/run returns SSE stream", async () => {
-        const res = await doFetch(url("/agent/default/run"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({
-            threadId: "t-run-1",
-            runId: "r-run-1",
-            messages: [],
-            state: {},
-            tools: [],
-            context: [],
-            forwardedProps: {},
-          }),
-        });
-        expect(res.status).toBe(200);
-        expect(res.headers.get("content-type")).toContain("text/event-stream");
-      });
-
-      it("SSE stream contains correct event sequence", async () => {
-        const res = await doFetch(url("/agent/default/run"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({
-            threadId: "t-run-2",
-            runId: "r-run-2",
-            messages: [],
-            state: {},
-            tools: [],
-            context: [],
-            forwardedProps: {},
-          }),
-        });
-        const payload = await readSSEStream(res.body!);
-        const types = extractEventTypes(payload);
-
-        expect(types).toContain("RUN_STARTED");
-        expect(types).toContain("TEXT_MESSAGE_START");
-        expect(types).toContain("TEXT_MESSAGE_CONTENT");
-        expect(types).toContain("TEXT_MESSAGE_END");
-        expect(types).toContain("RUN_FINISHED");
-      });
-
-      it("SSE stream TEXT_MESSAGE_CONTENT contains expected delta", async () => {
-        const res = await doFetch(url("/agent/default/run"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({
-            threadId: "t-run-3",
-            runId: "r-run-3",
-            messages: [],
-            state: {},
-            tools: [],
-            context: [],
-            forwardedProps: {},
-          }),
-        });
-        const payload = await readSSEStream(res.body!);
-        expect(payload).toContain("Hello from test");
-      });
-
-      it("returns 404 for unknown agent", async () => {
-        const res = await doFetch(url("/agent/nonexistent/run"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({
-            threadId: "t-404",
-            runId: "r-404",
-            messages: [],
-            state: {},
-            tools: [],
-            context: [],
-            forwardedProps: {},
-          }),
-        });
-        expect(res.status).toBe(404);
-      });
-    });
-
-    // ─── Agent Connect ───────────────────────────────────────────────
-
-    describe("Agent Connect", () => {
-      it("POST /agent/default/connect returns SSE stream", async () => {
-        const res = await doFetch(url("/agent/default/connect"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({
-            threadId: "t-conn-1",
-            runId: "r-conn-1",
-            messages: [],
-            state: {},
-            tools: [],
-            context: [],
-            forwardedProps: {},
-          }),
-        });
-        expect(res.status).toBe(200);
-        expect(res.headers.get("content-type")).toContain("text/event-stream");
-      });
-
-      it("returns 404 for unknown agent", async () => {
-        const res = await doFetch(url("/agent/nonexistent/connect"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({
-            threadId: "t-conn-404",
-            runId: "r-conn-404",
-            messages: [],
-            state: {},
-            tools: [],
-            context: [],
-            forwardedProps: {},
-          }),
-        });
-        expect(res.status).toBe(404);
-      });
-    });
-
-    // ─── Agent Stop ──────────────────────────────────────────────────
-
-    describe("Agent Stop", () => {
-      it("POST /agent/default/stop/:threadId returns JSON", async () => {
-        const res = await doFetch(url("/agent/default/stop/thread-1"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-        });
-        expect(res.status).toBe(200);
-        const body = await res.json();
-        expect(body).toHaveProperty("stopped");
-        expect(typeof body.stopped).toBe("boolean");
-      });
-
-      it("returns 404 for unknown agent", async () => {
-        const res = await doFetch(url("/agent/nonexistent/stop/thread-1"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-        });
-        expect(res.status).toBe(404);
-      });
-    });
-
-    // ─── Transcribe ──────────────────────────────────────────────────
-
-    describe("Transcribe", () => {
-      it("POST /transcribe returns 503 without transcription service", async () => {
-        const res = await doFetch(url("/transcribe"), {
-          method: "POST",
-          headers: { "Content-Type": "application/json" },
-          body: JSON.stringify({}),
-        });
-        expect(res.status).toBe(503);
-      });
-    });
-
-    // ─── CORS ────────────────────────────────────────────────────────
-
-    describe("CORS", () => {
-      it("OPTIONS preflight returns Access-Control-Allow-Origin", async () => {
-        const res = await doFetch(url("/info"), {
-          method: "OPTIONS",
-          headers: {
-            Origin: "https://example.com",
-            "Access-Control-Request-Method": "GET",
-          },
-        });
-        expect(res.headers.get("access-control-allow-origin")).toBe("*");
-      });
-
-      it("GET /info response includes CORS headers", async () => {
-        const res = await doFetch(url("/info"), {
-          headers: { Origin: "https://example.com" },
-        });
-        expect(res.headers.get("access-control-allow-origin")).toBe("*");
-      });
-    });
-
-    // ─── HTTP Method Validation ──────────────────────────────────────
-
-    describe("HTTP Method Validation", () => {
-      it("POST /info returns 405", async () => {
-        const res = await doFetch(url("/info"), { method: "POST" });
-        expect(res.status).toBe(405);
-      });
-
-      it("GET /agent/default/run returns 405", async () => {
-        const res = await doFetch(url("/agent/default/run"));
-        expect(res.status).toBe(405);
-      });
-    });
-
-    // ─── 404 Handling ────────────────────────────────────────────────
-
-    describe("404 Handling", () => {
-      it("GET /nonexistent returns 404", async () => {
-        const res = await doFetch(url("/nonexistent"));
-        expect(res.status).toBe(404);
-      });
-    });
-
-    // ─── Header Forwarding ───────────────────────────────────────────
-
-    describe("Header Forwarding", () => {
-      it("forwards Authorization header to agent", async () => {
-        const captured: Record<string, string>[] = [];
-        const h = await factory({ capturedHeaders: captured });
-        const localFetch =
-          requestFn ??
-          ((h as any).handler
-            ? (input: any, init: any) =>
-                (h as any).handler(new Request(input, init))
-            : fetch);
-
-        try {
-          const res = await localFetch(
-            `${h.baseUrl}${h.basePath}/agent/default/run`,
-            {
-              method: "POST",
-              headers: {
-                "Content-Type": "application/json",
-                Authorization: "Bearer test-token",
-              },
-              body: JSON.stringify({
-                threadId: "t-hdr-1",
-                runId: "r-hdr-1",
-                messages: [],
-                state: {},
-                tools: [],
-                context: [],
-                forwardedProps: {},
-              }),
-            },
-          );
-          if (res.body) await readSSEStream(res.body);
-          expect(captured.length).toBeGreaterThan(0);
-          expect(captured[0]!.authorization).toBe("Bearer test-token");
-        } finally {
-          await h.close();
-        }
-      });
-
-      it("forwards x-custom headers to agent", async () => {
-        const captured: Record<string, string>[] = [];
-        const h = await factory({ capturedHeaders: captured });
-        const localFetch =
-          requestFn ??
-          ((h as any).handler
-            ? (input: any, init: any) =>
-                (h as any).handler(new Request(input, init))
-            : fetch);
-
-        try {
-          const res = await localFetch(
-            `${h.baseUrl}${h.basePath}/agent/default/run`,
-            {
-              method: "POST",
-              headers: {
-                "Content-Type": "application/json",
-                "X-Custom-Value": "my-value",
-              },
-              body: JSON.stringify({
-                threadId: "t-hdr-2",
-                runId: "r-hdr-2",
-                messages: [],
-                state: {},
-                tools: [],
-                context: [],
-                forwardedProps: {},
-              }),
-            },
-          );
-          if (res.body) await readSSEStream(res.body);
-          expect(captured.length).toBeGreaterThan(0);
-          expect(captured[0]!["x-custom-value"]).toBe("my-value");
-        } finally {
-          await h.close();
-        }
-      });
-    });
-  });
-}