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

package/src/lib/runtime/__tests__/retry-utils.test.ts

@@ -1,137 +0,0 @@
-import { afterEach, beforeEach, describe, expect, it, vi } from "vitest";
-import { fetchWithRetry, parseRetryAfter, RETRY_CONFIG } from "../retry-utils";
-
-function responseWithRetryAfter(
-  headerValue: string | null,
-  status = 429,
-): Response {
-  const headers = new Headers();
-  if (headerValue !== null) headers.set("Retry-After", headerValue);
-  return new Response(null, { status, headers });
-}
-
-describe("parseRetryAfter", () => {
-  it("returns undefined when the Retry-After header is absent", () => {
-    expect(parseRetryAfter(responseWithRetryAfter(null))).toBeUndefined();
-  });
-
-  it("parses integer seconds into milliseconds", () => {
-    expect(parseRetryAfter(responseWithRetryAfter("5"))).toBe(5000);
-  });
-
-  it("treats zero seconds as zero delay", () => {
-    expect(parseRetryAfter(responseWithRetryAfter("0"))).toBe(0);
-  });
-
-  it("clamps a negative numeric value to zero", () => {
-    // `-1` fails the `seconds >= 0` guard and falls through to Date.parse,
-    // which interprets it as a year-in-the-past timestamp; the past-date
-    // branch then clamps to 0. The behavior is lenient rather than strict.
-    expect(parseRetryAfter(responseWithRetryAfter("-1"))).toBe(0);
-  });
-
-  it("parses an HTTP-date in the future as the delta to now", () => {
-    const now = Date.parse("2026-04-22T12:00:00Z");
-    vi.useFakeTimers();
-    vi.setSystemTime(now);
-    try {
-      const future = new Date(now + 30_000).toUTCString();
-      expect(parseRetryAfter(responseWithRetryAfter(future))).toBe(30_000);
-    } finally {
-      vi.useRealTimers();
-    }
-  });
-
-  it("clamps an HTTP-date in the past to zero", () => {
-    const now = Date.parse("2026-04-22T12:00:00Z");
-    vi.useFakeTimers();
-    vi.setSystemTime(now);
-    try {
-      const past = new Date(now - 60_000).toUTCString();
-      expect(parseRetryAfter(responseWithRetryAfter(past))).toBe(0);
-    } finally {
-      vi.useRealTimers();
-    }
-  });
-
-  it("returns undefined for unparseable values", () => {
-    expect(parseRetryAfter(responseWithRetryAfter("soon"))).toBeUndefined();
-  });
-});
-
-describe("fetchWithRetry Retry-After handling (#3637)", () => {
-  let fetchMock: ReturnType<typeof vi.fn>;
-
-  beforeEach(() => {
-    vi.useFakeTimers();
-    fetchMock = vi.fn();
-    vi.stubGlobal("fetch", fetchMock);
-  });
-
-  afterEach(() => {
-    vi.useRealTimers();
-    vi.unstubAllGlobals();
-  });
-
-  it("honors Retry-After within the allowed maximum on 429", async () => {
-    fetchMock
-      .mockResolvedValueOnce(responseWithRetryAfter("2"))
-      .mockResolvedValueOnce(new Response("ok", { status: 200 }));
-
-    const promise = fetchWithRetry("https://example.com", {});
-    await vi.advanceTimersByTimeAsync(1999);
-    expect(fetchMock).toHaveBeenCalledTimes(1);
-    await vi.advanceTimersByTimeAsync(1);
-    const response = await promise;
-
-    expect(response.status).toBe(200);
-    expect(fetchMock).toHaveBeenCalledTimes(2);
-  });
-
-  it("throws when Retry-After exceeds maxRetryAfterSeconds", async () => {
-    const excessive = RETRY_CONFIG.maxRetryAfterSeconds + 1;
-    fetchMock.mockResolvedValue(responseWithRetryAfter(String(excessive)));
-
-    // The oversized-Retry-After branch throws before sleeping, and the
-    // resulting Error doesn't match any retryable pattern, so the loop
-    // breaks out without consuming the remaining attempts.
-    await expect(fetchWithRetry("https://example.com", {})).rejects.toThrow(
-      new RegExp(
-        `Retry-After of ${excessive}s.*exceeds the maximum of ${RETRY_CONFIG.maxRetryAfterSeconds}s`,
-      ),
-    );
-    expect(fetchMock).toHaveBeenCalledTimes(1);
-  });
-
-  it("falls back to exponential backoff when Retry-After is missing on 429", async () => {
-    fetchMock
-      .mockResolvedValueOnce(new Response(null, { status: 429 }))
-      .mockResolvedValueOnce(new Response("ok", { status: 200 }));
-
-    const promise = fetchWithRetry("https://example.com", {});
-    // calculateDelay(0) === RETRY_CONFIG.baseDelayMs
-    await vi.advanceTimersByTimeAsync(RETRY_CONFIG.baseDelayMs - 1);
-    expect(fetchMock).toHaveBeenCalledTimes(1);
-    await vi.advanceTimersByTimeAsync(1);
-    const response = await promise;
-
-    expect(response.status).toBe(200);
-    expect(fetchMock).toHaveBeenCalledTimes(2);
-  });
-
-  it("ignores Retry-After on non-429 retryable responses (e.g. 503)", async () => {
-    const longRetryAfter = String(RETRY_CONFIG.maxRetryAfterSeconds + 600);
-    fetchMock
-      .mockResolvedValueOnce(responseWithRetryAfter(longRetryAfter, 503))
-      .mockResolvedValueOnce(new Response("ok", { status: 200 }));
-
-    const promise = fetchWithRetry("https://example.com", {});
-    // Exponential backoff applies, not the header value — otherwise this
-    // would wait 10 minutes and the test would time out.
-    await vi.advanceTimersByTimeAsync(RETRY_CONFIG.baseDelayMs);
-    const response = await promise;
-
-    expect(response.status).toBe(200);
-    expect(fetchMock).toHaveBeenCalledTimes(2);
-  });
-});

package/src/lib/runtime/__tests__/v1-agent-factory.test.ts

@@ -1,109 +0,0 @@
-import { describe, it, expect, vi } from "vitest";
-import { HttpAgent } from "@ag-ui/client";
-import { CopilotRuntime } from "../copilot-runtime";
-import {
-  resolveAgents,
-  type AgentsConfig,
-} from "../../../v2/runtime/core/runtime";
-
-function createMockAgent(name = "test") {
-  return new HttpAgent({ url: `https://example.com/${name}` });
-}
-
-function createMockRequest(headers?: Record<string, string>) {
-  return new Request("https://example.com/agent/test/run", {
-    method: "POST",
-    headers: { "Content-Type": "application/json", ...headers },
-    body: JSON.stringify({ threadId: "thread-1", messages: [], state: {} }),
-  });
-}
-
-describe("V1 CopilotRuntime with agent factory function", () => {
-  it("preserves factory function through constructor (does not spread to {})", () => {
-    const factory = vi.fn().mockReturnValue({
-      default: createMockAgent("default"),
-    });
-
-    const runtime = new CopilotRuntime({ agents: factory });
-
-    // The V2 instance should receive a function (factory), not an empty object.
-    // Before the fix, spreading a function produced {}, losing all agents.
-    const v2Agents = runtime.instance.agents;
-    expect(typeof v2Agents).toBe("function");
-  });
-
-  it("factory function resolves agents on each request", async () => {
-    const agentA = createMockAgent("tenant-a");
-    const agentB = createMockAgent("tenant-b");
-
-    const factory: AgentsConfig = ({ request }) => {
-      const tenantId = request.headers.get("x-tenant-id");
-      if (tenantId === "a") return { default: agentA };
-      return { default: agentB };
-    };
-
-    const runtime = new CopilotRuntime({ agents: factory });
-    const v2Agents = runtime.instance.agents;
-
-    const requestA = createMockRequest({ "x-tenant-id": "a" });
-    const resolvedA = await resolveAgents(v2Agents, requestA);
-    expect(resolvedA.default).toBe(agentA);
-
-    const requestB = createMockRequest({ "x-tenant-id": "b" });
-    const resolvedB = await resolveAgents(v2Agents, requestB);
-    expect(resolvedB.default).toBe(agentB);
-  });
-
-  it("merges endpoint agents with factory-resolved agents", async () => {
-    const factoryAgent = createMockAgent("factory-agent");
-    const factory = vi.fn().mockReturnValue({
-      dynamic: factoryAgent,
-    });
-
-    // Use remoteEndpoints to generate endpoint agents that should be merged
-    const runtime = new CopilotRuntime({
-      agents: factory,
-      remoteEndpoints: [
-        {
-          url: "https://example.com/endpoint",
-          onBeforeRequest: undefined,
-        },
-      ],
-    });
-
-    const v2Agents = runtime.instance.agents;
-    expect(typeof v2Agents).toBe("function");
-
-    const request = createMockRequest();
-    const resolved = await resolveAgents(v2Agents, request);
-
-    // Factory agent should be present
-    expect(resolved.dynamic).toBe(factoryAgent);
-    // Factory should have been called with request context
-    expect(factory).toHaveBeenCalledWith({ request });
-  });
-
-  it("static agents record still works after fix", async () => {
-    const agent = createMockAgent("static");
-
-    const runtime = new CopilotRuntime({
-      agents: { myAgent: agent },
-    });
-
-    const v2Agents = runtime.instance.agents;
-    const resolved = await resolveAgents(v2Agents);
-    expect(resolved.myAgent).toBe(agent);
-  });
-
-  it("promised agents record still works after fix", async () => {
-    const agent = createMockAgent("promised");
-
-    const runtime = new CopilotRuntime({
-      agents: Promise.resolve({ myAgent: agent }),
-    });
-
-    const v2Agents = runtime.instance.agents;
-    const resolved = await resolveAgents(v2Agents);
-    expect(resolved.myAgent).toBe(agent);
-  });
-});

package/src/lib/runtime/agent-integrations/langgraph/__tests__/dispatch-event-filtering.test.ts

@@ -1,345 +0,0 @@
-import { EventType } from "@ag-ui/client";
-import { LangGraphAgent } from "../agent";
-import { CustomEventNames } from "../consts";
-import { vi } from "vitest";
-
-function createAgent() {
-  const agent = new LangGraphAgent({
-    graphId: "test-graph",
-    url: "http://localhost:8000",
-  });
-
-  const events: any[] = [];
-  (agent as any).subscriber = { next: (e: any) => events.push(e) };
-  (agent as any).activeRun = {
-    id: "run-1",
-    threadId: "thread-1",
-    hasFunctionStreaming: false,
-  };
-  (agent as any).messagesInProcess = {};
-
-  return { agent, events };
-}
-
-function makeTextEvent(
-  type: EventType,
-  metadata: Record<string, any>,
-  messageId = "msg-1",
-) {
-  return {
-    type,
-    messageId,
-    ...(type === EventType.TEXT_MESSAGE_CONTENT ? { delta: "hello" } : {}),
-    ...(type === EventType.TEXT_MESSAGE_START ? { role: "assistant" } : {}),
-    rawEvent: { metadata },
-  };
-}
-
-function makeCustomEvent(name: string, value: any) {
-  return {
-    type: EventType.CUSTOM,
-    name,
-    value,
-  } as any;
-}
-
-/**
- * Mock the parent class's langGraphDefaultMergeState for a single test,
- * using vi.spyOn for automatic cleanup.
- */
-function withMockedParentMerge(agent: LangGraphAgent, returnValue: any) {
-  const parentProto = Object.getPrototypeOf(Object.getPrototypeOf(agent));
-  return vi
-    .spyOn(parentProto, "langGraphDefaultMergeState")
-    .mockReturnValue(returnValue);
-}
-
-describe("dispatchEvent emit-messages filtering", () => {
-  it("suppresses message events when copilotkit:emit-messages is false", () => {
-    const { agent, events } = createAgent();
-
-    const result = agent.dispatchEvent(
-      makeTextEvent(EventType.TEXT_MESSAGE_START, {
-        "copilotkit:emit-messages": false,
-      }) as any,
-    );
-
-    expect(result).toBe(false);
-    expect(events).toHaveLength(0);
-  });
-
-  it("passes message events when copilotkit:emit-messages is true", () => {
-    const { agent, events } = createAgent();
-
-    const result = agent.dispatchEvent(
-      makeTextEvent(EventType.TEXT_MESSAGE_START, {
-        "copilotkit:emit-messages": true,
-      }) as any,
-    );
-
-    expect(result).toBe(true);
-    expect(events).toHaveLength(1);
-  });
-
-  it("clears messagesInProcess when suppressing message events", () => {
-    const { agent } = createAgent();
-
-    // Simulate parent class having set a stale message record
-    (agent as any).messagesInProcess["run-1"] = {
-      id: "msg-1",
-      toolCallId: null,
-      toolCallName: null,
-    };
-
-    agent.dispatchEvent(
-      makeTextEvent(EventType.TEXT_MESSAGE_START, {
-        "copilotkit:emit-messages": false,
-      }) as any,
-    );
-
-    expect((agent as any).messagesInProcess["run-1"]).toBeNull();
-  });
-
-  it("does NOT clear messagesInProcess when emit-messages is true", () => {
-    const { agent } = createAgent();
-
-    const staleRecord = {
-      id: "msg-1",
-      toolCallId: null,
-      toolCallName: null,
-    };
-    (agent as any).messagesInProcess["run-1"] = staleRecord;
-
-    agent.dispatchEvent(
-      makeTextEvent(EventType.TEXT_MESSAGE_CONTENT, {
-        "copilotkit:emit-messages": true,
-      }) as any,
-    );
-
-    // Record should still be there (not cleared)
-    expect((agent as any).messagesInProcess["run-1"]).toBe(staleRecord);
-  });
-
-  it("clears messagesInProcess on TEXT_MESSAGE_END suppression (the cross-node leak scenario)", () => {
-    const { agent } = createAgent();
-
-    // Orchestrator node set a message in progress, then its events get suppressed.
-    // The END event must also clear the tracking state.
-    (agent as any).messagesInProcess["run-1"] = {
-      id: "msg-orchestrator",
-      toolCallId: null,
-      toolCallName: null,
-    };
-
-    agent.dispatchEvent(
-      makeTextEvent(
-        EventType.TEXT_MESSAGE_END,
-        { "copilotkit:emit-messages": false },
-        "msg-orchestrator",
-      ) as any,
-    );
-
-    expect((agent as any).messagesInProcess["run-1"]).toBeNull();
-  });
-});
-
-describe("dispatchEvent emit-tool-calls filtering", () => {
-  it("suppresses tool events when copilotkit:emit-tool-calls is false", () => {
-    const { agent, events } = createAgent();
-
-    const result = agent.dispatchEvent({
-      type: EventType.TOOL_CALL_START,
-      toolCallId: "tc-1",
-      toolCallName: "search",
-      parentMessageId: "msg-1",
-      rawEvent: { metadata: { "copilotkit:emit-tool-calls": false } },
-    } as any);
-
-    expect(result).toBe(false);
-    expect(events).toHaveLength(0);
-  });
-
-  it("passes tool events when copilotkit:emit-tool-calls is true", () => {
-    const { agent, events } = createAgent();
-
-    const result = agent.dispatchEvent({
-      type: EventType.TOOL_CALL_START,
-      toolCallId: "tc-1",
-      toolCallName: "search",
-      parentMessageId: "msg-1",
-      rawEvent: { metadata: { "copilotkit:emit-tool-calls": true } },
-    } as any);
-
-    expect(result).toBe(true);
-    expect(events).toHaveLength(1);
-  });
-});
-
-// ---------- CopilotKit custom event dispatch ----------
-
-describe("dispatchEvent custom CopilotKit events", () => {
-  it("manually_emit_message produces TextMessage event sequence", () => {
-    const { agent, events } = createAgent();
-
-    const result = agent.dispatchEvent(
-      makeCustomEvent(CustomEventNames.CopilotKitManuallyEmitMessage, {
-        message_id: "msg-manual-1",
-        message: "Hello from agent",
-        role: "assistant",
-      }),
-    );
-
-    expect(result).toBe(true);
-    expect(events).toHaveLength(3);
-    expect(events[0].type).toBe(EventType.TEXT_MESSAGE_START);
-    expect(events[0].messageId).toBe("msg-manual-1");
-    expect(events[0].role).toBe("assistant");
-    expect(events[1].type).toBe(EventType.TEXT_MESSAGE_CONTENT);
-    expect(events[1].delta).toBe("Hello from agent");
-    expect(events[2].type).toBe(EventType.TEXT_MESSAGE_END);
-    expect(events[2].messageId).toBe("msg-manual-1");
-  });
-
-  it("manually_emit_tool_call produces ToolCall event sequence", () => {
-    const { agent, events } = createAgent();
-
-    const result = agent.dispatchEvent(
-      makeCustomEvent(CustomEventNames.CopilotKitManuallyEmitToolCall, {
-        id: "tc-manual-1",
-        name: "SearchTool",
-        args: { query: "test" },
-      }),
-    );
-
-    expect(result).toBe(true);
-    expect(events).toHaveLength(3);
-    expect(events[0].type).toBe(EventType.TOOL_CALL_START);
-    expect(events[0].toolCallId).toBe("tc-manual-1");
-    expect(events[0].toolCallName).toBe("SearchTool");
-    expect(events[1].type).toBe(EventType.TOOL_CALL_ARGS);
-    expect(events[1].toolCallId).toBe("tc-manual-1");
-    expect(events[1].delta).toEqual({ query: "test" });
-    expect(events[2].type).toBe(EventType.TOOL_CALL_END);
-    expect(events[2].toolCallId).toBe("tc-manual-1");
-  });
-
-  it("manually_emit_state produces StateSnapshot event", () => {
-    const { agent, events } = createAgent();
-
-    // Mock getStateSnapshot since it depends on thread state
-    (agent as any).getStateSnapshot = (state: any) => ({
-      values: state.values,
-    });
-
-    const result = agent.dispatchEvent(
-      makeCustomEvent(
-        CustomEventNames.CopilotKitManuallyEmitIntermediateState,
-        {
-          progress: 75,
-        },
-      ),
-    );
-
-    expect(result).toBe(true);
-    expect((agent as any).activeRun.manuallyEmittedState).toEqual({
-      progress: 75,
-    });
-    const snapshotEvents = events.filter(
-      (e) => e.type === EventType.STATE_SNAPSHOT,
-    );
-    expect(snapshotEvents.length).toBeGreaterThanOrEqual(1);
-  });
-
-  it("copilotkit_exit produces Exit custom event", () => {
-    const { agent, events } = createAgent();
-
-    const result = agent.dispatchEvent(
-      makeCustomEvent(CustomEventNames.CopilotKitExit, {}),
-    );
-
-    expect(result).toBe(true);
-    expect(events).toHaveLength(1);
-    expect(events[0].type).toBe(EventType.CUSTOM);
-    // "Exit" is the hardcoded downstream name in agent.ts — not a constant,
-    // because it's the value the frontend listens for, not an internal enum.
-    expect(events[0].name).toBe("Exit");
-    expect(events[0].value).toBe(true);
-  });
-
-  it("events without rawEvent pass through to subscriber", () => {
-    const { agent, events } = createAgent();
-
-    const result = agent.dispatchEvent({
-      type: EventType.TEXT_MESSAGE_START,
-      messageId: "msg-no-raw",
-      role: "assistant",
-    } as any);
-
-    expect(result).toBe(true);
-    expect(events).toHaveLength(1);
-    expect(events[0].messageId).toBe("msg-no-raw");
-  });
-});
-
-// ---------- langGraphDefaultMergeState ----------
-
-describe("langGraphDefaultMergeState", () => {
-  afterEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  it("merges copilotkit actions from ag-ui tools", () => {
-    const { agent } = createAgent();
-    const tools = [{ name: "tool1" }, { name: "tool2" }];
-
-    withMockedParentMerge(agent, {
-      "ag-ui": { tools, context: [] },
-      tools: [],
-      messages: [],
-    });
-
-    const result = agent.langGraphDefaultMergeState({} as any, [], {} as any);
-    expect(result.copilotkit).toBeDefined();
-    expect(result.copilotkit.actions).toEqual(expect.arrayContaining(tools));
-  });
-
-  it("merges copilotkit context from ag-ui", () => {
-    const { agent } = createAgent();
-    const context = [{ description: "user info", value: "test" }];
-
-    withMockedParentMerge(agent, {
-      "ag-ui": { tools: [], context },
-      tools: [],
-      messages: [],
-    });
-
-    const result = agent.langGraphDefaultMergeState({} as any, [], {} as any);
-    expect(result.copilotkit.context).toEqual(context);
-  });
-
-  it("handles missing ag-ui key without crashing", () => {
-    const { agent } = createAgent();
-
-    withMockedParentMerge(agent, { messages: [] });
-
-    const result = agent.langGraphDefaultMergeState({} as any, [], {} as any);
-    expect(result.copilotkit).toBeDefined();
-    expect(result.copilotkit.actions).toEqual([]);
-    expect(result.copilotkit.context).toEqual([]);
-  });
-
-  it("deduplicates tools from returnedTools and ag-ui tools", () => {
-    const { agent } = createAgent();
-    const tool = { name: "SharedTool", id: "shared-1" };
-
-    withMockedParentMerge(agent, {
-      "ag-ui": { tools: [tool], context: [] },
-      tools: [tool],
-      messages: [],
-    });
-
-    const result = agent.langGraphDefaultMergeState({} as any, [], {} as any);
-    expect(result.copilotkit.actions).toHaveLength(1);
-    expect(result.copilotkit.actions[0].name).toBe("SharedTool");
-  });
-});