@copilotkit/react-core 1.57.0 → 1.57.1-canary.1778272612

package/src/v2/components/intelligence-indicator/__tests__/IntelligenceIndicator.e2e.test.tsx

@@ -0,0 +1,464 @@
+import React from "react";
+import { afterEach, describe, expect, it } from "vitest";
+import { fireEvent, render, screen, waitFor } from "@testing-library/react";
+import { EventType } from "@ag-ui/client";
+import type { BaseEvent, RunAgentInput } from "@ag-ui/client";
+import type { Observable } from "rxjs";
+import type { Subject } from "rxjs";
+import { takeWhile } from "rxjs/operators";
+import {
+  MockStepwiseAgent,
+  runStartedEvent,
+  runFinishedEvent,
+  textMessageStartEvent,
+  textMessageContentEvent,
+  textMessageEndEvent,
+  toolCallChunkEvent,
+  toolCallResultEvent,
+} from "../../../__tests__/utils/test-helpers";
+import { CopilotChat } from "../../chat/CopilotChat";
+import { CopilotKitProvider } from "../../../providers/CopilotKitProvider";
+import { CopilotChatConfigurationProvider } from "../../../providers/CopilotChatConfigurationProvider";
+import { useCopilotKit } from "../../../providers/CopilotKitProvider";
+import { useAgent } from "../../../hooks/use-agent";
+
+/**
+ * Mock agent with accurate per-run `isRunning` lifecycle. The shared
+ * `MockStepwiseAgent` returns the un-terminating `subject.asObservable()`
+ * for backward compatibility, so emitting `RUN_FINISHED` on it doesn't
+ * complete the rxjs pipeline → `isRunning` never flips back. The
+ * `takeWhile(..., true)` here makes the per-run observable terminate on
+ * RUN_FINISHED / RUN_ERROR (the `true` is "inclusive" — emit the
+ * terminal event before completing). That terminates AG-UI's run
+ * pipeline like a real agent so the indicator sees the falling edge.
+ */
+class IsRunningAccurateMockAgent extends MockStepwiseAgent {
+  override run(_input: RunAgentInput): Observable<BaseEvent> {
+    return (this as unknown as { subject: Subject<BaseEvent> }).subject.pipe(
+      takeWhile(
+        (event) =>
+          event.type !== EventType.RUN_FINISHED &&
+          event.type !== EventType.RUN_ERROR,
+        true,
+      ),
+    );
+  }
+}
+
+const PILL_TESTID_RE = /^cpk-intelligence-pill-/;
+
+const expectPillCount = (n: number): void => {
+  expect(screen.queryAllByTestId(PILL_TESTID_RE).length).toBe(n);
+};
+
+const expectPillOn = (messageId: string): void => {
+  expect(
+    screen.getByTestId(`cpk-intelligence-pill-${messageId}`).textContent,
+  ).toContain("Using CopilotKit Intelligence");
+};
+
+const expectNoPillOn = (messageId: string): void => {
+  expect(screen.queryByTestId(`cpk-intelligence-pill-${messageId}`)).toBeNull();
+};
+
+const expectNoPillAnywhere = (): void => {
+  expect(screen.queryAllByTestId(PILL_TESTID_RE).length).toBe(0);
+};
+
+const emitAssistantMessageWithToolCalls = (
+  agent: MockStepwiseAgent,
+  messageId: string,
+  toolCalls: Array<{ id: string; name?: string; arg: string }>,
+): void => {
+  agent.emit(textMessageStartEvent(messageId));
+  agent.emit(textMessageEndEvent(messageId));
+  for (const tc of toolCalls) {
+    agent.emit(
+      toolCallChunkEvent({
+        toolCallId: tc.id,
+        toolCallName: tc.name ?? "copilotkit_knowledge_base_shell",
+        parentMessageId: messageId,
+        delta: tc.arg,
+      }),
+    );
+  }
+};
+
+const emitToolResult = (
+  agent: MockStepwiseAgent,
+  toolCallId: string,
+  resultMessageId: string,
+  content = "ok",
+): void => {
+  agent.emit(
+    toolCallResultEvent({ toolCallId, messageId: resultMessageId, content }),
+  );
+};
+
+const emitAssistantProse = (
+  agent: MockStepwiseAgent,
+  messageId: string,
+  text: string,
+): void => {
+  agent.emit(textMessageStartEvent(messageId));
+  agent.emit(textMessageContentEvent(messageId, text));
+  agent.emit(textMessageEndEvent(messageId));
+};
+
+const startRun = (agent: MockStepwiseAgent): void => {
+  agent.emit(runStartedEvent());
+};
+
+/**
+ * Test harness: drives `copilotkit.runAgent` from a click and force-sets
+ * `copilotkit.intelligence` on the live core. Apps observe the
+ * intelligence-set-up state via a real `/info` round trip; tests bypass
+ * that plumbing by writing directly into the registry's private slot.
+ */
+const RunAgentHarness: React.FC<{ withIntelligence: boolean }> = ({
+  withIntelligence,
+}) => {
+  const { copilotkit } = useCopilotKit();
+  const { agent } = useAgent();
+
+  React.useEffect(() => {
+    const reg = (
+      copilotkit as unknown as {
+        agentRegistry: { _intelligence?: { wsUrl: string } };
+      }
+    ).agentRegistry;
+    if (withIntelligence) {
+      reg._intelligence = { wsUrl: "wss://test/intelligence" };
+    } else {
+      reg._intelligence = undefined;
+    }
+  }, [copilotkit, withIntelligence]);
+
+  const handleClick = React.useCallback(() => {
+    if (!agent) return;
+    copilotkit.runAgent({ agent }).catch((err: unknown) => {
+      console.error("[test] copilotkit.runAgent rejected:", err);
+      throw err;
+    });
+  }, [copilotkit, agent]);
+
+  return (
+    <button data-testid="trigger-run" onClick={handleClick}>
+      run
+    </button>
+  );
+};
+
+interface RenderOptions {
+  withIntelligence?: boolean;
+}
+
+const renderForIndicator = (
+  agent: MockStepwiseAgent,
+  options: RenderOptions = {},
+): void => {
+  const { withIntelligence = true } = options;
+
+  // No `renderCustomMessages` prop is passed — the indicator
+  // auto-mounts when intelligence is configured.
+  render(
+    <CopilotKitProvider agents__unsafe_dev_only={{ default: agent }}>
+      <CopilotChatConfigurationProvider agentId="default" threadId="t">
+        <RunAgentHarness withIntelligence={withIntelligence} />
+        <div style={{ height: 400 }}>
+          <CopilotChat welcomeScreen={false} />
+        </div>
+      </CopilotChatConfigurationProvider>
+    </CopilotKitProvider>,
+  );
+};
+
+const triggerRun = async (agent: MockStepwiseAgent): Promise<void> => {
+  await waitFor(() => expect(agent.isRunning).toBe(false));
+  fireEvent.click(screen.getByTestId("trigger-run"));
+  await waitFor(() => expect(agent.isRunning).toBe(true));
+};
+
+/** Phase machine fades over up to ~1780 ms (500 + 800 + 480). */
+const FADE_OUT_TIMEOUT_MS = 2500;
+
+describe('IntelligenceIndicator — "Using CopilotKit Intelligence" (auto-mounted)', () => {
+  const activeAgents: IsRunningAccurateMockAgent[] = [];
+  const makeAgent = (): IsRunningAccurateMockAgent => {
+    const agent = new IsRunningAccurateMockAgent();
+    activeAgents.push(agent);
+    return agent;
+  };
+  afterEach(() => {
+    while (activeAgents.length) {
+      const agent = activeAgents.pop()!;
+      try {
+        agent.complete();
+      } catch (err) {
+        console.error("[test] agent.complete() threw during cleanup:", err);
+      }
+    }
+  });
+
+  /**
+   * Walks through the canonical scenario:
+   *
+   *   RUN A
+   *     m_a1 (assistant) → toolCall bash#1, bash#2
+   *   RUN B
+   *     m_b1 (assistant) → toolCall bash
+   *     m_b2 (assistant) → toolCall bash#1, bash#2
+   *
+   * The pill must render only on the last message of the latest
+   * in-flight run — never on multiple messages, never on stale runs,
+   * never on a non-last message of the current run.
+   */
+  it("renders only on the last message of the latest in-flight run", async () => {
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    expectNoPillAnywhere();
+
+    // ─── Run A: m_a1 with two tool calls → pill on m_a1 ───────────────
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_a1", [
+      { id: "tc_a1_1", arg: '{"cmd":"ls"}' },
+      { id: "tc_a1_2", arg: '{"cmd":"pwd"}' },
+    ]);
+    await waitFor(() => expectPillOn("m_a1"));
+    expectPillCount(1);
+
+    agent.emit(runFinishedEvent());
+
+    // ─── Run B: m_b1 (one bash) ──────────────────────────────────────
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_b1", [
+      { id: "tc_b1", arg: '{"cmd":"echo b1"}' },
+    ]);
+    await waitFor(() => expectPillOn("m_b1"));
+    // m_a1's pill may briefly remain in fade-out; lock the post-debounce
+    // state.
+    await waitFor(() => expectNoPillOn("m_a1"), {
+      timeout: FADE_OUT_TIMEOUT_MS,
+    });
+    expectPillCount(1);
+
+    // ─── m_b2 streams in — pill moves to m_b2, m_b1 loses pill ────────
+    emitAssistantMessageWithToolCalls(agent, "m_b2", [
+      { id: "tc_b2_1", arg: '{"cmd":"echo b2-1"}' },
+      { id: "tc_b2_2", arg: '{"cmd":"echo b2-2"}' },
+    ]);
+    await waitFor(() => expectPillOn("m_b2"));
+    expectNoPillOn("m_b1");
+    expectNoPillOn("m_a1");
+    expectPillCount(1);
+
+    // ─── Run B finishes — pill fades, eventually no pill anywhere ─────
+    agent.emit(runFinishedEvent());
+    await waitFor(() => expectNoPillAnywhere(), {
+      timeout: FADE_OUT_TIMEOUT_MS,
+    });
+  });
+
+  // ─── Per-condition focused tests ────────────────────────────────────
+
+  it("condition (last-in-run): never renders on a non-last message of the run", async () => {
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_first", [
+      { id: "tc_first", arg: "{}" },
+    ]);
+    // Wait for m_first to render the pill while it is still the last
+    // message in the run. Without this gate, both messages would land
+    // synchronously and m_first's renderer would never have been
+    // invoked while it was the last — turning a reactive assertion
+    // into a first-render correctness test by accident.
+    await waitFor(() => expectPillOn("m_first"));
+
+    emitAssistantMessageWithToolCalls(agent, "m_second", [
+      { id: "tc_second", arg: "{}" },
+    ]);
+
+    await waitFor(() => expectPillOn("m_second"));
+    expectNoPillOn("m_first");
+    expectPillCount(1);
+  });
+
+  it("condition (in-flight): pill clears after the run finishes", async () => {
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_only", [
+      { id: "tc", arg: "{}" },
+    ]);
+    await waitFor(() => expectPillOn("m_only"));
+
+    agent.emit(runFinishedEvent());
+    await waitFor(() => expectNoPillOn("m_only"), {
+      timeout: FADE_OUT_TIMEOUT_MS,
+    });
+  });
+
+  it("condition (latest-run): never renders on a stale run after a newer run starts", async () => {
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_run1", [
+      { id: "tc_run1", arg: "{}" },
+    ]);
+    await waitFor(() => expectPillOn("m_run1"));
+    agent.emit(runFinishedEvent());
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_run2", [
+      { id: "tc_run2", arg: "{}" },
+    ]);
+    await waitFor(() => expectPillOn("m_run2"));
+    expectNoPillOn("m_run1");
+  });
+
+  it("condition (tool-match): only renders when a configured tool name matches", async () => {
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    // First message has only a non-matching tool call; no pill.
+    emitAssistantMessageWithToolCalls(agent, "m_no_match", [
+      { id: "tc_no_match", name: "fetch", arg: "{}" },
+    ]);
+    await new Promise((r) => setTimeout(r, 80));
+    expectNoPillOn("m_no_match");
+
+    // Second message has a bash call — pill should appear on it.
+    emitAssistantMessageWithToolCalls(agent, "m_match", [
+      { id: "tc_match", name: "copilotkit_knowledge_base_shell", arg: "{}" },
+    ]);
+    await waitFor(() => expectPillOn("m_match"));
+    expectPillCount(1);
+  });
+
+  it("intelligence gate: does not render when copilotkit.intelligence is undefined", async () => {
+    const agent = makeAgent();
+    renderForIndicator(agent, { withIntelligence: false });
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m1", [{ id: "tc1", arg: "{}" }]);
+
+    // Without the gate, the pill would be visible by now.
+    await new Promise((r) => setTimeout(r, 80));
+    expectNoPillAnywhere();
+  });
+
+  it("auto-registration: no renderCustomMessages prop is required", async () => {
+    // This is the explicit assertion that the indicator auto-mounts.
+    // `renderForIndicator` does not pass `renderCustomMessages`, yet
+    // the pill renders solely because intelligence is configured.
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m1", [{ id: "tc1", arg: "{}" }]);
+
+    await waitFor(() => expectPillOn("m1"));
+    expectPillCount(1);
+  });
+
+  // ─── New gate: tool-call pending past grace window ──────────────────
+
+  it("replay-flash suppression: no pill when tool result arrives within the grace window", async () => {
+    // Models a `connectAgent` history replay: the tool call and its
+    // matching `tool`-role result arrive in the same tick, well below
+    // PENDING_THRESHOLD_MS. The pill timer should be cancelled before
+    // it fires, so nothing renders.
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_replay", [
+      { id: "tc_replay", arg: '{"cmd":"ls"}' },
+    ]);
+    emitToolResult(agent, "tc_replay", "tr_replay");
+
+    // Wait past the grace window — pill should never appear.
+    await new Promise((r) => setTimeout(r, 200));
+    expectNoPillAnywhere();
+  });
+
+  it("multi-step: pill stays continuously across tool-result interleaving", async () => {
+    // Tool result arrives, then a second assistant message with bash.
+    // The pill must not show the completed/fade animation between
+    // calls — it stays on m_step1 until m_step2 takes over the slot.
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_step1", [
+      { id: "tc_step1", arg: '{"cmd":"ls"}' },
+    ]);
+    await waitFor(() => expectPillOn("m_step1"));
+
+    // Tool result lands. agent.isRunning is still true, no real
+    // follow-up yet → pill stays on m_step1 in spinner.
+    emitToolResult(agent, "tc_step1", "tr_step1");
+    await new Promise((r) => setTimeout(r, 150));
+    expectPillOn("m_step1");
+    expectPillCount(1);
+
+    // Second assistant message with bash arrives. Slot moves; old
+    // instance returns null without a fade animation.
+    emitAssistantMessageWithToolCalls(agent, "m_step2", [
+      { id: "tc_step2", arg: '{"cmd":"pwd"}' },
+    ]);
+    await waitFor(() => expectPillOn("m_step2"));
+    expectNoPillOn("m_step1");
+    expectPillCount(1);
+  });
+
+  it("real-followup exit: prose assistant message after the tool flow clears the pill", async () => {
+    // After the tool result the agent emits a final prose message —
+    // that's a "real follow-up" and should immediately exit the
+    // spinner (without waiting on isRunning), advancing to check
+    // → fading → hidden.
+    const agent = makeAgent();
+    renderForIndicator(agent);
+    await screen.findByTestId("trigger-run");
+
+    await triggerRun(agent);
+    startRun(agent);
+    emitAssistantMessageWithToolCalls(agent, "m_tool", [
+      { id: "tc_only", arg: '{"cmd":"ls"}' },
+    ]);
+    await waitFor(() => expectPillOn("m_tool"));
+
+    emitToolResult(agent, "tc_only", "tr_only");
+    emitAssistantProse(agent, "m_prose", "All done.");
+
+    await waitFor(() => expectNoPillAnywhere(), {
+      timeout: FADE_OUT_TIMEOUT_MS,
+    });
+  });
+});

package/src/v2/components/intelligence-indicator/index.ts

@@ -0,0 +1,2 @@
+export { IntelligenceIndicator } from "./IntelligenceIndicator";
+export type { IntelligenceIndicatorProps } from "./IntelligenceIndicator";

package/src/v2/context.ts

@@ -0,0 +1,62 @@
+"use client";
+
+import { createContext, useContext, useEffect, useReducer } from "react";
+import { CopilotKitCoreReact } from "./lib/react-core";
+import type { CopilotKitCoreReactConfig } from "./lib/react-core";
+import type { LicenseContextValue } from "@copilotkit/shared";
+
+// Re-export so headless.ts (and consumers) reference the same type declaration.
+export { CopilotKitCoreReact };
+export type { CopilotKitCoreReactConfig };
+
+export interface CopilotKitContextValue {
+  copilotkit: CopilotKitCoreReact;
+  /**
+   * Set of tool call IDs currently being executed.
+   * This is tracked at the provider level to ensure tool execution events
+   * are captured even before child components mount.
+   */
+  executingToolCallIds: ReadonlySet<string>;
+}
+
+export const EMPTY_SET: ReadonlySet<string> = new Set();
+
+export const CopilotKitContext = createContext<CopilotKitContextValue | null>(
+  null,
+);
+
+export const useCopilotKit = (): CopilotKitContextValue => {
+  const context = useContext(CopilotKitContext);
+  const [, forceUpdate] = useReducer((x: number) => x + 1, 0);
+
+  if (!context) {
+    throw new Error("useCopilotKit must be used within CopilotKitProvider");
+  }
+  useEffect(() => {
+    const subscription = context.copilotkit.subscribe({
+      onRuntimeConnectionStatusChanged: () => {
+        forceUpdate();
+      },
+    });
+    return () => {
+      subscription.unsubscribe();
+    };
+    // eslint-disable-next-line react-hooks/exhaustive-deps
+  }, []);
+
+  return context;
+};
+
+// License context — shared between web and RN providers.
+// Default is permissive (all features allowed) — providers override via createLicenseContextValue.
+// Inlined here to avoid a runtime import from @copilotkit/shared, which pulls in
+// Node-only deps (jose) that break React Native's Metro bundler.
+export const LicenseContext = createContext<LicenseContextValue>({
+  status: null,
+  license: null,
+  checkFeature: () => true,
+  getLimit: () => null,
+} as LicenseContextValue);
+
+export const useLicenseContext = (): LicenseContextValue =>
+  useContext(LicenseContext);

package/src/v2/headless.ts

@@ -0,0 +1,42 @@
+/**
+ * Headless (platform-agnostic) exports from @copilotkit/react-core/v2.
+ *
+ * No CSS, no web UI components, no DOM dependencies.
+ * Used by @copilotkit/react-native.
+ */
+
+// Re-export from context (which is external in this build) so the .d.ts
+// references the same type declaration. This avoids a nominal type mismatch
+// caused by private class members being declared in two separate .d.ts files.
+export { CopilotKitCoreReact } from "./context";
+export type { CopilotKitCoreReactConfig } from "./context";
+
+// Chat configuration provider (no UI, just context)
+export {
+  CopilotChatConfigurationProvider,
+  useCopilotChatConfiguration,
+  CopilotChatDefaultLabels,
+  type CopilotChatLabels,
+  type CopilotChatConfigurationValue,
+  type CopilotChatConfigurationProviderProps,
+} from "./providers/CopilotChatConfigurationProvider";
+
+// Platform-agnostic hooks
+export { useAgent, type UseAgentUpdate } from "./hooks/use-agent";
+export { useFrontendTool } from "./hooks/use-frontend-tool";
+export { useComponent } from "./hooks/use-component";
+export { useHumanInTheLoop } from "./hooks/use-human-in-the-loop";
+export { useInterrupt, type UseInterruptConfig } from "./hooks/use-interrupt";
+export { useSuggestions } from "./hooks/use-suggestions";
+export { useConfigureSuggestions } from "./hooks/use-configure-suggestions";
+export {
+  useAgentContext,
+  type AgentContextInput,
+  type JsonSerializable,
+} from "./hooks/use-agent-context";
+export {
+  useThreads,
+  type Thread,
+  type UseThreadsInput,
+  type UseThreadsResult,
+} from "./hooks/use-threads";

package/src/v2/hooks/__tests__/standard-schema.test.tsx

@@ -6,12 +6,12 @@ import * as v from "valibot";
 import { type } from "arktype";
 import { useRenderTool, type RenderToolProps } from "../use-render-tool";
 import { useComponent } from "../use-component";
-import { useCopilotKit } from "../../providers/CopilotKitProvider";
+import { useCopilotKit } from "../../context";
 import { useFrontendTool } from "../use-frontend-tool";
 import type { ReactToolCallRenderer } from "../../types/react-tool-call-renderer";
 import type { StandardSchemaV1 } from "@copilotkit/shared";
 
-vi.mock("../../providers/CopilotKitProvider", () => ({
+vi.mock("../../context", () => ({
   useCopilotKit: vi.fn(),
 }));
 

package/src/v2/hooks/__tests__/use-agent-context.test.tsx

@@ -2,10 +2,10 @@ import React, { useState } from "react";
 import { render, act } from "@testing-library/react";
 import { describe, it, expect, beforeEach, afterEach, vi } from "vitest";
 import { useAgentContext, type AgentContextInput } from "../use-agent-context";
-import { useCopilotKit } from "../../providers/CopilotKitProvider";
+import { useCopilotKit } from "../../context";
 
-// Mock the CopilotKitProvider
-vi.mock("../../providers/CopilotKitProvider", () => ({
+// Mock the CopilotKit context
+vi.mock("../../context", () => ({
   useCopilotKit: vi.fn(),
 }));
 

package/src/v2/hooks/__tests__/use-agent-stability.test.tsx

@@ -2,13 +2,13 @@ import React from "react";
 import { render } from "@testing-library/react";
 import { describe, it, expect, vi, beforeEach, afterEach } from "vitest";
 import { AbstractAgent } from "@ag-ui/client";
-import { useCopilotKit } from "../../providers/CopilotKitProvider";
+import { useCopilotKit } from "../../context";
 import { MockStepwiseAgent } from "../../__tests__/utils/test-helpers";
 import { useAgent } from "../use-agent";
 import { CopilotKitCoreRuntimeConnectionStatus } from "@copilotkit/core";
 
-// Mock the CopilotKitProvider to control copilotkit state directly
-vi.mock("../../providers/CopilotKitProvider", () => ({
+// Mock the CopilotKit context to control copilotkit state directly
+vi.mock("../../context", () => ({
   useCopilotKit: vi.fn(),
 }));