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

package/src/v2/runtime/__tests__/express-single-sse.test.ts

@@ -1,122 +0,0 @@
-import express from "express";
-import type { AddressInfo } from "node:net";
-import { afterEach, describe, expect, it } from "vitest";
-
-import { createCopilotEndpointSingleRouteExpress } from "../express";
-import { CopilotRuntime } from "../core/runtime";
-import { InMemoryAgentRunner } from "../runner/in-memory";
-
-const buildRuntime = () => {
-  const fakeAgent = {
-    clone: () => ({
-      setMessages: () => undefined,
-      setState: () => undefined,
-      threadId: "thread",
-      runAgent: async (
-        input: { runId: string },
-        { onEvent }: { onEvent: (payload: { event: unknown }) => void },
-      ) => {
-        onEvent({
-          event: {
-            type: "RUN_STARTED",
-            runId: input.runId,
-            input: { runId: input.runId },
-          },
-        });
-        onEvent({ event: { type: "TEXT_MESSAGE_START", messageId: "m1" } });
-        onEvent({
-          event: {
-            type: "TEXT_MESSAGE_CONTENT",
-            messageId: "m1",
-            delta: "hello",
-          },
-        });
-        onEvent({ event: { type: "TEXT_MESSAGE_END", messageId: "m1" } });
-        onEvent({ event: { type: "RUN_FINISHED", runId: input.runId } });
-      },
-    }),
-  };
-
-  return new CopilotRuntime({
-    agents: { default: fakeAgent },
-    runner: new InMemoryAgentRunner(),
-  });
-};
-
-async function readStreamText(
-  stream: ReadableStream<Uint8Array>,
-): Promise<string> {
-  const reader = stream.getReader();
-  const decoder = new TextDecoder();
-  let output = "";
-
-  for (let i = 0; i < 20; i += 1) {
-    const { done, value } = await reader.read();
-    if (done) {
-      break;
-    }
-    if (value) {
-      output += decoder.decode(value, { stream: true });
-      if (output.includes("RUN_FINISHED")) {
-        break;
-      }
-    }
-  }
-
-  await reader.cancel();
-  output += decoder.decode();
-  return output;
-}
-
-describe("Express single-route SSE streaming", () => {
-  let server: ReturnType<express.Express["listen"]> | undefined;
-
-  afterEach(() => {
-    if (server) {
-      server.close();
-      server = undefined;
-    }
-  });
-
-  it("streams SSE events for single-route run requests", async () => {
-    const runtime = buildRuntime();
-    const app = express();
-    app.use(
-      createCopilotEndpointSingleRouteExpress({ runtime, basePath: "/" }),
-    );
-
-    server = app.listen(0);
-    const { port } = server.address() as AddressInfo;
-
-    const response = await fetch(`http://localhost:${port}/`, {
-      method: "POST",
-      headers: {
-        "Content-Type": "application/json",
-        Accept: "text/event-stream",
-      },
-      body: JSON.stringify({
-        method: "agent/run",
-        params: { agentId: "default" },
-        body: {
-          threadId: "thread",
-          runId: "run-1",
-          messages: [],
-          state: {},
-          tools: [],
-          context: [],
-          forwardedProps: {},
-        },
-      }),
-    });
-
-    expect(response.status).toBe(200);
-    expect(response.headers.get("content-type")).toContain("text/event-stream");
-    expect(response.body).toBeTruthy();
-
-    const payload = await readStreamText(response.body!);
-    expect(payload).toContain("data:");
-    expect(payload).toContain("RUN_STARTED");
-    expect(payload).toContain("TEXT_MESSAGE_CONTENT");
-    expect(payload).toContain("RUN_FINISHED");
-  });
-});

package/src/v2/runtime/__tests__/express-single-telemetry.integration.test.ts

@@ -1,65 +0,0 @@
-/**
- * Integration test: Express single-route adapter (deprecated convenience
- * wrapper) + telemetry. This adapter delegates to createCopilotExpressHandler
- * with mode: "single-route".
- */
-import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
-import type { AbstractAgent } from "@ag-ui/client";
-import { Observable, of } from "rxjs";
-
-import { telemetry } from "../telemetry";
-import { createCopilotEndpointSingleRouteExpress } from "../endpoints/express-single";
-import { CopilotRuntime } from "../core/runtime";
-
-function makeAgent(): AbstractAgent {
-  const a: unknown = { execute: async () => ({ events: [] }) };
-  (a as { clone: () => unknown }).clone = () => makeAgent();
-  return a as AbstractAgent;
-}
-
-function makeRuntime() {
-  const runner = {
-    run: () =>
-      new Observable((observer) => {
-        observer.next({});
-        observer.complete();
-        return () => undefined;
-      }),
-    connect: () => of({}),
-    stop: async () => true,
-  };
-  return new CopilotRuntime({
-    agents: { default: makeAgent() },
-    runner,
-  });
-}
-
-describe("Express single-route adapter — telemetry firing (integration)", () => {
-  let captureSpy: ReturnType<typeof vi.spyOn>;
-
-  beforeEach(() => {
-    captureSpy = vi.spyOn(telemetry, "capture").mockResolvedValue(undefined);
-  });
-
-  afterEach(() => {
-    captureSpy.mockRestore();
-  });
-
-  it("fires instance_created on handler creation", async () => {
-    const runtime = makeRuntime();
-    createCopilotEndpointSingleRouteExpress({
-      runtime,
-      basePath: "/api/copilotkit",
-    });
-
-    await vi.waitFor(() => {
-      expect(captureSpy).toHaveBeenCalledWith(
-        "oss.runtime.instance_created",
-        expect.objectContaining({
-          agentsAmount: 1,
-          "cloud.api_key_provided": false,
-        }),
-      );
-    });
-  });
-});

package/src/v2/runtime/__tests__/express-telemetry.integration.test.ts

@@ -1,101 +0,0 @@
-/**
- * Integration test: Express adapter + telemetry.
- */
-import express from "express";
-import request from "supertest";
-import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
-import type { AbstractAgent } from "@ag-ui/client";
-import { Observable, of } from "rxjs";
-
-import { telemetry } from "../telemetry";
-import { createCopilotExpressHandler } from "../endpoints/express";
-import { CopilotRuntime } from "../core/runtime";
-
-function makeAgent(): AbstractAgent {
-  const a: unknown = { execute: async () => ({ events: [] }) };
-  (a as { clone: () => unknown }).clone = () => makeAgent();
-  return a as AbstractAgent;
-}
-
-function makeRuntime() {
-  const runner = {
-    run: () =>
-      new Observable((observer) => {
-        observer.next({});
-        observer.complete();
-        return () => undefined;
-      }),
-    connect: () => of({}),
-    stop: async () => true,
-  };
-  return new CopilotRuntime({
-    agents: { default: makeAgent() },
-    runner,
-  });
-}
-
-describe("Express adapter — telemetry firing (integration)", () => {
-  let captureSpy: ReturnType<typeof vi.spyOn>;
-
-  beforeEach(() => {
-    captureSpy = vi.spyOn(telemetry, "capture").mockResolvedValue(undefined);
-  });
-
-  afterEach(() => {
-    captureSpy.mockRestore();
-  });
-
-  it("fires instance_created on handler creation (multi-route)", async () => {
-    const runtime = makeRuntime();
-    createCopilotExpressHandler({ runtime, basePath: "/" });
-
-    await vi.waitFor(() => {
-      expect(captureSpy).toHaveBeenCalledWith(
-        "oss.runtime.instance_created",
-        expect.objectContaining({
-          agentsAmount: 1,
-          "cloud.api_key_provided": false,
-        }),
-      );
-    });
-  });
-
-  it("fires copilot_request_created when a real HTTP request hits the handler", async () => {
-    const runtime = makeRuntime();
-    const app = express();
-    app.use(createCopilotExpressHandler({ runtime, basePath: "/" }));
-
-    await request(app)
-      .post("/agent/default/run")
-      .set("Content-Type", "application/json")
-      .send({ messages: [], state: {}, threadId: "t1" });
-
-    expect(captureSpy).toHaveBeenCalledWith(
-      "oss.runtime.copilot_request_created",
-      expect.objectContaining({
-        requestType: "run",
-        "cloud.api_key_provided": false,
-      }),
-    );
-  });
-
-  it("includes cloud.public_api_key on request when header is present", async () => {
-    const runtime = makeRuntime();
-    const app = express();
-    app.use(createCopilotExpressHandler({ runtime, basePath: "/" }));
-
-    await request(app)
-      .post("/agent/default/run")
-      .set("Content-Type", "application/json")
-      .set("x-copilotcloud-public-api-key", "ck_pub_test_xyz")
-      .send({ messages: [], state: {}, threadId: "t1" });
-
-    expect(captureSpy).toHaveBeenCalledWith(
-      "oss.runtime.copilot_request_created",
-      expect.objectContaining({
-        "cloud.api_key_provided": true,
-        "cloud.public_api_key": "ck_pub_test_xyz",
-      }),
-    );
-  });
-});

package/src/v2/runtime/__tests__/fetch-cors.test.ts

@@ -1,205 +0,0 @@
-import { describe, it, expect } from "vitest";
-import { handleCors, addCorsHeaders } from "../core/fetch-cors";
-import type { CopilotCorsConfig } from "../core/fetch-cors";
-
-describe("fetch-cors", () => {
-  describe("handleCors (preflight)", () => {
-    it("returns null for non-OPTIONS requests", () => {
-      const request = new Request("http://localhost/api", { method: "GET" });
-      expect(handleCors(request, {})).toBeNull();
-    });
-
-    it("returns null for POST requests", () => {
-      const request = new Request("http://localhost/api", { method: "POST" });
-      expect(handleCors(request, {})).toBeNull();
-    });
-
-    it("returns 204 for OPTIONS requests", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-      });
-      const response = handleCors(request, {});
-      expect(response).not.toBeNull();
-      expect(response!.status).toBe(204);
-    });
-
-    it("adds permissive CORS headers with empty config (cors: true equivalent)", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-      });
-      const response = handleCors(request, {})!;
-      expect(response.headers.get("Access-Control-Allow-Origin")).toBe("*");
-      expect(response.headers.get("Access-Control-Allow-Methods")).toContain(
-        "GET",
-      );
-      expect(response.headers.get("Access-Control-Allow-Methods")).toContain(
-        "POST",
-      );
-      expect(response.headers.get("Access-Control-Allow-Headers")).toBe("*");
-    });
-
-    it("reflects custom origin string", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-        headers: { Origin: "https://myapp.com" },
-      });
-      const config: CopilotCorsConfig = { origin: "https://myapp.com" };
-      const response = handleCors(request, config)!;
-      expect(response.headers.get("Access-Control-Allow-Origin")).toBe(
-        "https://myapp.com",
-      );
-    });
-
-    it("reflects request origin when in allowed array", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-        headers: { Origin: "https://b.com" },
-      });
-      const config: CopilotCorsConfig = {
-        origin: ["https://a.com", "https://b.com"],
-      };
-      const response = handleCors(request, config)!;
-      expect(response.headers.get("Access-Control-Allow-Origin")).toBe(
-        "https://b.com",
-      );
-    });
-
-    it("does not set origin when request origin is not in allowed array", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-        headers: { Origin: "https://c.com" },
-      });
-      const config: CopilotCorsConfig = {
-        origin: ["https://a.com", "https://b.com"],
-      };
-      const response = handleCors(request, config)!;
-      expect(response.headers.get("Access-Control-Allow-Origin")).toBeNull();
-    });
-
-    it("uses origin function to resolve", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-        headers: { Origin: "https://dynamic.com" },
-      });
-      const config: CopilotCorsConfig = {
-        origin: (origin: string) => (origin.endsWith(".com") ? origin : null),
-      };
-      const response = handleCors(request, config)!;
-      expect(response.headers.get("Access-Control-Allow-Origin")).toBe(
-        "https://dynamic.com",
-      );
-    });
-
-    it("sets credentials header when configured", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-        headers: { Origin: "https://myapp.com" },
-      });
-      const config: CopilotCorsConfig = {
-        origin: "https://myapp.com",
-        credentials: true,
-      };
-      const response = handleCors(request, config)!;
-      expect(response.headers.get("Access-Control-Allow-Credentials")).toBe(
-        "true",
-      );
-    });
-
-    it("sets custom allowMethods", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-      });
-      const config: CopilotCorsConfig = { allowMethods: ["GET", "POST"] };
-      const response = handleCors(request, config)!;
-      expect(response.headers.get("Access-Control-Allow-Methods")).toBe(
-        "GET, POST",
-      );
-    });
-
-    it("sets custom allowHeaders", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-      });
-      const config: CopilotCorsConfig = {
-        allowHeaders: ["Content-Type", "Authorization"],
-      };
-      const response = handleCors(request, config)!;
-      expect(response.headers.get("Access-Control-Allow-Headers")).toBe(
-        "Content-Type, Authorization",
-      );
-    });
-
-    it("sets maxAge header", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-      });
-      const config: CopilotCorsConfig = { maxAge: 86400 };
-      const response = handleCors(request, config)!;
-      expect(response.headers.get("Access-Control-Max-Age")).toBe("86400");
-    });
-
-    it("auto-resolves wildcard to request origin when credentials enabled", () => {
-      const request = new Request("http://localhost/api", {
-        method: "OPTIONS",
-        headers: { Origin: "https://example.com" },
-      });
-      const config: CopilotCorsConfig = { origin: "*", credentials: true };
-      const response = handleCors(request, config)!;
-      // Per Fetch spec, wildcard + credentials is invalid. We auto-resolve
-      // the wildcard to the actual request origin when credentials are enabled.
-      expect(response.headers.get("Access-Control-Allow-Origin")).toBe(
-        "https://example.com",
-      );
-      expect(response.headers.get("Access-Control-Allow-Credentials")).toBe(
-        "true",
-      );
-    });
-  });
-
-  describe("addCorsHeaders (response decoration)", () => {
-    it("adds CORS headers to an existing response", () => {
-      const response = new Response(JSON.stringify({ ok: true }), {
-        status: 200,
-        headers: { "Content-Type": "application/json" },
-      });
-      const config: CopilotCorsConfig = {};
-      const result = addCorsHeaders(response, config, null);
-      expect(result.headers.get("Access-Control-Allow-Origin")).toBe("*");
-      expect(result.headers.get("Content-Type")).toBe("application/json");
-      expect(result.status).toBe(200);
-    });
-
-    it("adds CORS headers to error responses", () => {
-      const response = new Response("Not found", { status: 404 });
-      const config: CopilotCorsConfig = {};
-      const result = addCorsHeaders(response, config, null);
-      expect(result.headers.get("Access-Control-Allow-Origin")).toBe("*");
-      expect(result.status).toBe(404);
-    });
-
-    it("sets exposeHeaders", () => {
-      const response = new Response(null, { status: 200 });
-      const config: CopilotCorsConfig = {
-        exposeHeaders: ["X-Request-Id", "X-Custom"],
-      };
-      const result = addCorsHeaders(response, config, null);
-      expect(result.headers.get("Access-Control-Expose-Headers")).toBe(
-        "X-Request-Id, X-Custom",
-      );
-    });
-
-    it("adds Vary: Origin when origin is not wildcard", () => {
-      const response = new Response(null, { status: 200 });
-      const config: CopilotCorsConfig = { origin: "https://myapp.com" };
-      const result = addCorsHeaders(response, config, "https://myapp.com");
-      expect(result.headers.get("Vary")).toContain("Origin");
-    });
-
-    it("does not add Vary when origin is wildcard", () => {
-      const response = new Response(null, { status: 200 });
-      const config: CopilotCorsConfig = {};
-      const result = addCorsHeaders(response, config, null);
-      expect(result.headers.get("Vary")).toBeNull();
-    });
-  });
-});