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

package/src/lib/runtime/agent-integrations/langgraph/__tests__/run-message-filtering.test.ts

@@ -1,156 +0,0 @@
-import { of } from "rxjs";
-import { vi } from "vitest";
-import { LangGraphAgent } from "../agent";
-
-// REGRESSION: `@ag-ui/langgraph`'s message converter only handles
-// {user, assistant, system, tool} and throws "message role is not
-// supported." on anything else. Reasoning-stream agents (OpenAI
-// Responses API with `reasoning={summary:"detailed"}`) emit AG-UI
-// messages with `role:"reasoning"` that the AG-UI client persists in
-// the thread and replays on the NEXT turn's `input.messages` — which
-// crashes the converter before the model is called.
-//
-// CopilotKit's LangGraphAgent.run subclass strips those reasoning
-// messages from the inbound `input.messages` before delegating to
-// super. This file verifies that filter:
-//   - `role:"reasoning"` is dropped.
-//   - All other roles (user, assistant, system, tool, plus unknown
-//     roles we don't recognize) are preserved in order.
-//   - The pre-existing forwardedProps enrichment (`streamSubgraphs`)
-//     still applies.
-
-function createAgent() {
-  return new LangGraphAgent({
-    graphId: "test-graph",
-    url: "http://localhost:8000",
-  });
-}
-
-/**
- * Mock the parent class's `run` method for a single test so we can
- * capture the `input` it receives without actually opening a stream.
- * The harness spies on the prototype TWO levels up because the
- * CopilotKit `LangGraphAgent` extends `@ag-ui/langgraph`'s
- * `LangGraphAgent`. Mirror the pattern from
- * `dispatch-event-filtering.test.ts`'s `withMockedParentMerge`.
- */
-function withMockedParentRun(agent: LangGraphAgent) {
-  const parentProto = Object.getPrototypeOf(Object.getPrototypeOf(agent));
-  const calls: any[] = [];
-  const spy = vi.spyOn(parentProto, "run").mockImplementation(function (
-    this: unknown,
-    input: unknown,
-  ) {
-    calls.push(input);
-    // Return an empty Observable — none of our assertions consume it,
-    // we only care about what was passed in.
-    return of();
-  });
-  return { spy, calls };
-}
-
-function makeInput(messages: Array<{ role: string; id?: string }>) {
-  return {
-    runId: "run-1",
-    threadId: "thread-1",
-    messages,
-    tools: [],
-    context: [],
-    state: {},
-    forwardedProps: {},
-  } as any;
-}
-
-describe("LangGraphAgent.run reasoning-role message filtering", () => {
-  afterEach(() => {
-    vi.restoreAllMocks();
-  });
-
-  it("strips role:'reasoning' messages from input before delegating to super.run", () => {
-    const agent = createAgent();
-    const { calls } = withMockedParentRun(agent);
-
-    agent.run(
-      makeInput([
-        { role: "user", id: "u1" },
-        { role: "reasoning", id: "r1" },
-        { role: "assistant", id: "a1" },
-        { role: "tool", id: "t1" },
-        { role: "reasoning", id: "r2" },
-      ]),
-    );
-
-    expect(calls).toHaveLength(1);
-    expect(calls[0].messages.map((m: { id: string }) => m.id)).toEqual([
-      "u1",
-      "a1",
-      "t1",
-    ]);
-    expect(
-      calls[0].messages.some((m: { role: string }) => m.role === "reasoning"),
-    ).toBe(false);
-  });
-
-  it("preserves user/assistant/system/tool messages in their original order", () => {
-    const agent = createAgent();
-    const { calls } = withMockedParentRun(agent);
-
-    agent.run(
-      makeInput([
-        { role: "system", id: "s1" },
-        { role: "user", id: "u1" },
-        { role: "assistant", id: "a1" },
-        { role: "tool", id: "t1" },
-        { role: "user", id: "u2" },
-      ]),
-    );
-
-    expect(calls[0].messages.map((m: { id: string }) => m.id)).toEqual([
-      "s1",
-      "u1",
-      "a1",
-      "t1",
-      "u2",
-    ]);
-  });
-
-  it("tolerates an empty messages array without throwing", () => {
-    const agent = createAgent();
-    const { calls } = withMockedParentRun(agent);
-
-    agent.run(makeInput([]));
-
-    expect(calls[0].messages).toEqual([]);
-  });
-
-  it("tolerates omitted messages (defaults to empty array)", () => {
-    const agent = createAgent();
-    const { calls } = withMockedParentRun(agent);
-
-    const input = makeInput([{ role: "user", id: "u1" }]);
-    delete input.messages;
-    agent.run(input);
-
-    expect(calls[0].messages).toEqual([]);
-  });
-
-  it("preserves the pre-existing forwardedProps.streamSubgraphs default", () => {
-    const agent = createAgent();
-    const { calls } = withMockedParentRun(agent);
-
-    agent.run(makeInput([{ role: "user", id: "u1" }]));
-
-    expect(calls[0].forwardedProps).toMatchObject({ streamSubgraphs: true });
-  });
-
-  it("respects an explicit forwardedProps.streamSubgraphs=false", () => {
-    const agent = createAgent();
-    const { calls } = withMockedParentRun(agent);
-
-    const input = makeInput([{ role: "user", id: "u1" }]);
-    input.forwardedProps = { streamSubgraphs: false };
-    agent.run(input);
-
-    expect(calls[0].forwardedProps.streamSubgraphs).toBe(false);
-  });
-});

package/src/lib/runtime/agent-integrations/langgraph/agent.ts

@@ -1,263 +0,0 @@
-import type { Observable } from "rxjs";
-import { map } from "rxjs";
-import { LangGraphEventTypes } from "../../../../agents/langgraph/events";
-import type { BaseEvent, RawEvent } from "@ag-ui/core";
-import type {
-  ProcessedEvents,
-  SchemaKeys,
-  StateEnrichment,
-} from "@ag-ui/langgraph";
-import {
-  LangGraphAgent as AGUILangGraphAgent,
-  LangGraphHttpAgent,
-  type LangGraphAgentConfig,
-  type State,
-} from "@ag-ui/langgraph";
-import type { Message as LangGraphMessage } from "@langchain/langgraph-sdk/dist/types.messages";
-import type { ThreadState } from "@langchain/langgraph-sdk";
-
-interface CopilotKitStateEnrichment {
-  copilotkit: {
-    actions: StateEnrichment["ag-ui"]["tools"];
-    context: StateEnrichment["ag-ui"]["context"];
-  };
-}
-
-import type { RunAgentInput, CustomEvent } from "@ag-ui/client";
-import { EventType } from "@ag-ui/client";
-
-// Import and re-export from separate file to maintain API compatibility
-import type {
-  TextMessageEvents,
-  ToolCallEvents,
-  PredictStateTool,
-} from "./consts";
-import { CustomEventNames } from "./consts";
-export { CustomEventNames };
-
-export class LangGraphAgent extends AGUILangGraphAgent {
-  constructor(config: LangGraphAgentConfig) {
-    super(config);
-  }
-
-  dispatchEvent(event: ProcessedEvents) {
-    if (event.type === EventType.CUSTOM) {
-      // const event = processedEvent as unknown as CustomEvent;
-      const customEvent = event as unknown as CustomEvent;
-
-      if (customEvent.name === CustomEventNames.CopilotKitManuallyEmitMessage) {
-        this.subscriber.next({
-          type: EventType.TEXT_MESSAGE_START,
-          role: "assistant",
-          messageId: customEvent.value.message_id,
-          rawEvent: event,
-        });
-        this.subscriber.next({
-          type: EventType.TEXT_MESSAGE_CONTENT,
-          messageId: customEvent.value.message_id,
-          delta: customEvent.value.message,
-          rawEvent: event,
-        });
-        this.subscriber.next({
-          type: EventType.TEXT_MESSAGE_END,
-          messageId: customEvent.value.message_id,
-          rawEvent: event,
-        });
-        return true;
-      }
-
-      if (
-        customEvent.name === CustomEventNames.CopilotKitManuallyEmitToolCall
-      ) {
-        this.subscriber.next({
-          type: EventType.TOOL_CALL_START,
-          toolCallId: customEvent.value.id,
-          toolCallName: customEvent.value.name,
-          parentMessageId: customEvent.value.id,
-          rawEvent: event,
-        });
-        this.subscriber.next({
-          type: EventType.TOOL_CALL_ARGS,
-          toolCallId: customEvent.value.id,
-          delta: customEvent.value.args,
-          rawEvent: event,
-        });
-        this.subscriber.next({
-          type: EventType.TOOL_CALL_END,
-          toolCallId: customEvent.value.id,
-          rawEvent: event,
-        });
-        return true;
-      }
-
-      if (
-        customEvent.name ===
-        CustomEventNames.CopilotKitManuallyEmitIntermediateState
-      ) {
-        this.activeRun.manuallyEmittedState = customEvent.value;
-        this.dispatchEvent({
-          type: EventType.STATE_SNAPSHOT,
-          snapshot: this.getStateSnapshot({
-            values: this.activeRun.manuallyEmittedState,
-          } as ThreadState<State>),
-          rawEvent: event,
-        });
-        return true;
-      }
-
-      if (customEvent.name === CustomEventNames.CopilotKitExit) {
-        this.subscriber.next({
-          type: EventType.CUSTOM,
-          name: "Exit",
-          value: true,
-        });
-        return true;
-      }
-    }
-
-    // Intercept all text message and tool call events and check if should disable
-    const rawEvent = (event as ToolCallEvents | TextMessageEvents).rawEvent;
-    if (!rawEvent) {
-      this.subscriber.next(event);
-      return true;
-    }
-
-    const isMessageEvent =
-      event.type === EventType.TEXT_MESSAGE_START ||
-      event.type === EventType.TEXT_MESSAGE_CONTENT ||
-      event.type === EventType.TEXT_MESSAGE_END;
-    const isToolEvent =
-      event.type === EventType.TOOL_CALL_START ||
-      event.type === EventType.TOOL_CALL_ARGS ||
-      event.type === EventType.TOOL_CALL_END;
-    if ("copilotkit:emit-tool-calls" in (rawEvent.metadata || {})) {
-      if (
-        rawEvent.metadata["copilotkit:emit-tool-calls"] === false &&
-        isToolEvent
-      ) {
-        return false;
-      }
-    }
-    if ("copilotkit:emit-messages" in (rawEvent.metadata || {})) {
-      if (
-        rawEvent.metadata["copilotkit:emit-messages"] === false &&
-        isMessageEvent
-      ) {
-        // Clean up tracked message state to prevent stale records from
-        // leaking into subsequent nodes that have emit-messages enabled.
-        if (this.activeRun?.id) {
-          this.messagesInProcess[this.activeRun.id] = null;
-        }
-        return false;
-      }
-    }
-
-    this.subscriber.next(event);
-    return true;
-  }
-
-  // @ts-ignore
-  run(input: RunAgentInput): Observable<BaseEvent> {
-    // @ag-ui/langgraph's message converter throws "message role is not
-    // supported." on any role it doesn't enumerate (user|assistant|system|tool).
-    // Reasoning-stream agents (e.g. OpenAI Responses API with reasoning summaries)
-    // emit AG-UI messages with role:"reasoning" that the client then replays on
-    // subsequent turns; without this filter the second turn crashes before the
-    // model is ever called.
-    const messages = (input.messages ?? []).filter(
-      (m: { role?: string }) => m?.role !== "reasoning",
-    );
-    const enrichedInput = {
-      ...input,
-      messages,
-      forwardedProps: {
-        ...input.forwardedProps,
-        streamSubgraphs: input.forwardedProps?.streamSubgraphs ?? true,
-      },
-    };
-    return super.run(enrichedInput).pipe(
-      map((processedEvent) => {
-        // Turn raw event into emit state snapshot from tool call event
-        if (processedEvent.type === EventType.RAW) {
-          // Get the LangGraph event from the AGUI event.
-          const event =
-            (processedEvent as RawEvent).event ??
-            (processedEvent as RawEvent).rawEvent;
-
-          const eventType = event.event;
-          const toolCallData = event.data?.chunk?.tool_call_chunks?.[0];
-          const toolCallUsedToPredictState = event.metadata?.[
-            "copilotkit:emit-intermediate-state"
-          ]?.some(
-            (predictStateTool: PredictStateTool) =>
-              predictStateTool.tool === toolCallData?.name,
-          );
-
-          if (
-            eventType === LangGraphEventTypes.OnChatModelStream &&
-            toolCallUsedToPredictState
-          ) {
-            return {
-              type: EventType.CUSTOM,
-              name: "PredictState",
-              value: event.metadata["copilotkit:emit-intermediate-state"],
-            };
-          }
-        }
-
-        return processedEvent;
-      }),
-    );
-  }
-
-  langGraphDefaultMergeState(
-    state: State,
-    messages: LangGraphMessage[],
-    input: RunAgentInput,
-  ): State<StateEnrichment & CopilotKitStateEnrichment> {
-    const aguiMergedState = super.langGraphDefaultMergeState(
-      state,
-      messages,
-      input,
-    );
-    const { tools: returnedTools, "ag-ui": agui } = aguiMergedState;
-    // tolerate undefined and de-duplicate by stable key (id | name | key)
-    const rawCombinedTools = [
-      ...((returnedTools as any[]) ?? []),
-      ...((agui?.tools as any[]) ?? []),
-    ];
-    const combinedTools = Array.from(
-      new Map(
-        rawCombinedTools.map((t: any) => [
-          t?.id ?? t?.name ?? t?.key ?? JSON.stringify(t),
-          t,
-        ]),
-      ).values(),
-    );
-
-    return {
-      ...aguiMergedState,
-      copilotkit: {
-        actions: combinedTools,
-        context: agui?.context ?? [],
-      },
-    };
-  }
-
-  async getSchemaKeys(): Promise<SchemaKeys> {
-    const CONSTANT_KEYS = ["copilotkit"];
-    const schemaKeys = await super.getSchemaKeys();
-    return {
-      config: schemaKeys.config,
-      input: schemaKeys.input ? [...schemaKeys.input, ...CONSTANT_KEYS] : null,
-      output: schemaKeys.output
-        ? [...schemaKeys.output, ...CONSTANT_KEYS]
-        : null,
-      context: schemaKeys.context
-        ? [...schemaKeys.context, ...CONSTANT_KEYS]
-        : null,
-    };
-  }
-}
-
-export { LangGraphHttpAgent };

package/src/lib/runtime/agent-integrations/langgraph/consts.ts

@@ -1,37 +0,0 @@
-/**
- * Constants for LangGraph integration.
- * This file is separate from langgraph.agent.ts to avoid pulling in @ag-ui/langgraph
- * when only these constants are needed.
- */
-
-import {
-  TextMessageStartEvent,
-  TextMessageContentEvent,
-  TextMessageEndEvent,
-  ToolCallStartEvent,
-  ToolCallArgsEvent,
-  ToolCallEndEvent,
-} from "@ag-ui/client";
-
-export type TextMessageEvents =
-  | TextMessageStartEvent
-  | TextMessageContentEvent
-  | TextMessageEndEvent;
-
-export type ToolCallEvents =
-  | ToolCallStartEvent
-  | ToolCallArgsEvent
-  | ToolCallEndEvent;
-
-export enum CustomEventNames {
-  CopilotKitManuallyEmitMessage = "copilotkit_manually_emit_message",
-  CopilotKitManuallyEmitToolCall = "copilotkit_manually_emit_tool_call",
-  CopilotKitManuallyEmitIntermediateState = "copilotkit_manually_emit_intermediate_state",
-  CopilotKitExit = "copilotkit_exit",
-}
-
-export interface PredictStateTool {
-  tool: string;
-  state_key: string;
-  tool_argument: string;
-}

package/src/lib/runtime/agent-integrations/langgraph/index.ts

@@ -1,2 +0,0 @@
-export * from "./consts";
-export * from "./agent";