@copilotkit/react-core 1.52.2-next.2 → 1.52.2-next.3

package/package.json

@@ -10,7 +10,7 @@
   "publishConfig": {
     "access": "public"
   },
-  "version": "1.52.2-next.2",
+  "version": "1.52.2-next.3",
   "sideEffects": [
     "**/*.css"
   ],
@@ -55,14 +55,14 @@
     "tsconfig": "1.4.10"
   },
   "dependencies": {
-    "@ag-ui/client": "^0.0.46",
+    "@ag-ui/client": "^0.0.47",
     "@scarf/scarf": "^1.3.0",
     "react-markdown": "^8.0.7",
     "untruncate-json": "^0.0.1",
-    "@copilotkit/runtime-client-gql": "1.52.2-next.2",
-    "@copilotkit/shared": "1.52.2-next.2",
-    "@copilotkitnext/core": "1.52.2-next.2",
-    "@copilotkitnext/react": "1.52.2-next.2"
+    "@copilotkit/runtime-client-gql": "1.52.2-next.3",
+    "@copilotkit/shared": "1.52.2-next.3",
+    "@copilotkitnext/core": "1.52.2-next.3",
+    "@copilotkitnext/react": "1.52.2-next.3"
   },
   "keywords": [
     "copilotkit",

package/src/components/copilot-provider/copilotkit.tsx

@@ -637,6 +637,117 @@ export function CopilotKitInternal(cpkProps: CopilotKitProps) {
     );
   }, [registeredActionConfigs]);
 
+  const copilotContextValue = useMemo(
+    () => ({
+      actions,
+      chatComponentsCache,
+      getFunctionCallHandler,
+      setAction,
+      removeAction,
+      setRegisteredActions: handleSetRegisteredActions,
+      removeRegisteredAction: handleRemoveRegisteredAction,
+      getContextString,
+      addContext,
+      removeContext,
+      getAllContext,
+      getDocumentsContext,
+      addDocumentContext,
+      removeDocumentContext,
+      copilotApiConfig: copilotApiConfig,
+      isLoading,
+      setIsLoading,
+      chatSuggestionConfiguration,
+      addChatSuggestionConfiguration,
+      removeChatSuggestionConfiguration,
+      chatInstructions,
+      setChatInstructions,
+      additionalInstructions,
+      setAdditionalInstructions,
+      showDevConsole,
+      coagentStates,
+      setCoagentStates,
+      coagentStatesRef,
+      setCoagentStatesWithRef,
+      agentSession,
+      setAgentSession,
+      forwardedParameters,
+      agentLock,
+      threadId,
+      setThreadId,
+      runId,
+      setRunId,
+      chatAbortControllerRef,
+      availableAgents,
+      authConfig_c: props.authConfig_c,
+      authStates_c: authStates,
+      setAuthStates_c: updateAuthStates,
+      extensions,
+      setExtensions: updateExtensions,
+      interruptActions,
+      setInterruptAction,
+      removeInterruptAction,
+      interruptEventQueue,
+      addInterruptEvent,
+      resolveInterruptEvent,
+      bannerError,
+      setBannerError,
+      onError: handleErrors,
+      internalErrorHandlers,
+      setInternalErrorHandler,
+      removeInternalErrorHandler,
+    }),
+    [
+      actions,
+      chatComponentsCache,
+      getFunctionCallHandler,
+      setAction,
+      removeAction,
+      handleSetRegisteredActions,
+      handleRemoveRegisteredAction,
+      getContextString,
+      addContext,
+      removeContext,
+      getAllContext,
+      getDocumentsContext,
+      addDocumentContext,
+      removeDocumentContext,
+      copilotApiConfig,
+      isLoading,
+      chatSuggestionConfiguration,
+      addChatSuggestionConfiguration,
+      removeChatSuggestionConfiguration,
+      chatInstructions,
+      additionalInstructions,
+      showDevConsole,
+      coagentStates,
+      setCoagentStatesWithRef,
+      agentSession,
+      setAgentSession,
+      forwardedParameters,
+      agentLock,
+      threadId,
+      setThreadId,
+      runId,
+      availableAgents,
+      props.authConfig_c,
+      authStates,
+      updateAuthStates,
+      extensions,
+      updateExtensions,
+      interruptActions,
+      setInterruptAction,
+      removeInterruptAction,
+      interruptEventQueue,
+      addInterruptEvent,
+      resolveInterruptEvent,
+      bannerError,
+      handleErrors,
+      internalErrorHandlers,
+      setInternalErrorHandler,
+      removeInternalErrorHandler,
+    ],
+  );
+
   return (
     <CopilotChatConfigurationProvider
       // labels={labels}
@@ -644,66 +755,7 @@ export function CopilotKitInternal(cpkProps: CopilotKitProps) {
       agentId={props.agent ?? "default"}
       threadId={threadId}
     >
-      <CopilotContext.Provider
-        value={{
-          actions,
-          chatComponentsCache,
-          getFunctionCallHandler,
-          setAction,
-          removeAction,
-          setRegisteredActions: handleSetRegisteredActions,
-          removeRegisteredAction: handleRemoveRegisteredAction,
-          getContextString,
-          addContext,
-          removeContext,
-          getAllContext,
-          getDocumentsContext,
-          addDocumentContext,
-          removeDocumentContext,
-          copilotApiConfig: copilotApiConfig,
-          isLoading,
-          setIsLoading,
-          chatSuggestionConfiguration,
-          addChatSuggestionConfiguration,
-          removeChatSuggestionConfiguration,
-          chatInstructions,
-          setChatInstructions,
-          additionalInstructions,
-          setAdditionalInstructions,
-          showDevConsole,
-          coagentStates,
-          setCoagentStates,
-          coagentStatesRef,
-          setCoagentStatesWithRef,
-          agentSession,
-          setAgentSession,
-          forwardedParameters,
-          agentLock,
-          threadId,
-          setThreadId,
-          runId,
-          setRunId,
-          chatAbortControllerRef,
-          availableAgents,
-          authConfig_c: props.authConfig_c,
-          authStates_c: authStates,
-          setAuthStates_c: updateAuthStates,
-          extensions,
-          setExtensions: updateExtensions,
-          interruptActions,
-          setInterruptAction,
-          removeInterruptAction,
-          interruptEventQueue,
-          addInterruptEvent,
-          resolveInterruptEvent,
-          bannerError,
-          setBannerError,
-          onError: handleErrors,
-          internalErrorHandlers,
-          setInternalErrorHandler,
-          removeInternalErrorHandler,
-        }}
-      >
+      <CopilotContext.Provider value={copilotContextValue}>
         <CopilotListeners />
         <CopilotKitErrorBridge />
         <CoAgentStateRendersProvider>

package/src/hooks/__tests__/use-copilot-chat-internal-connect.test.tsx

@@ -0,0 +1,234 @@
+import { vi, describe, it, expect, beforeEach } from "vitest";
+import React from "react";
+import { renderHook, act } from "@testing-library/react";
+import { useCopilotChatInternal } from "../use-copilot-chat_internal";
+import { CoAgentStateRendersProvider, CopilotContext } from "../../context";
+import { createTestCopilotContext } from "../../test-helpers/copilot-context";
+import {
+  useAgent,
+  useCopilotKit,
+  useCopilotChatConfiguration,
+} from "@copilotkitnext/react";
+import { CopilotKitCoreRuntimeConnectionStatus } from "@copilotkitnext/core";
+
+// ---------------------------------------------------------------------------
+// Mutable state that tests can tweak between renders
+// ---------------------------------------------------------------------------
+let mockRuntimeConnectionStatus: CopilotKitCoreRuntimeConnectionStatus =
+  CopilotKitCoreRuntimeConnectionStatus.Disconnected;
+const mockConnectAgent = vi.fn().mockResolvedValue(undefined);
+
+const mockAgent: Record<string, unknown> = {
+  messages: [],
+  state: {},
+  isRunning: false,
+  subscribe: vi.fn(() => ({ unsubscribe: vi.fn() })),
+  setMessages: vi.fn(),
+  setState: vi.fn(),
+  addMessage: vi.fn(),
+  abortRun: vi.fn(),
+  runAgent: vi.fn(),
+  threadId: undefined as string | undefined,
+};
+
+let mockConfigThreadId: string | undefined = "config-thread-id";
+
+// ---------------------------------------------------------------------------
+// Module mocks
+// ---------------------------------------------------------------------------
+vi.mock("@copilotkitnext/react", () => ({
+  useAgent: vi.fn(() => ({ agent: mockAgent })),
+  useCopilotKit: vi.fn(() => ({
+    copilotkit: {
+      connectAgent: mockConnectAgent,
+      runtimeConnectionStatus: mockRuntimeConnectionStatus,
+      getRunIdForMessage: vi.fn(),
+      runAgent: vi.fn(),
+      clearSuggestions: vi.fn(),
+      addSuggestionsConfig: vi.fn(),
+      reloadSuggestions: vi.fn(),
+      subscribe: vi.fn(() => ({ unsubscribe: vi.fn() })),
+      interruptElement: null,
+    },
+  })),
+  useCopilotChatConfiguration: vi.fn(() => ({
+    agentId: "test-agent",
+    threadId: mockConfigThreadId,
+  })),
+  useRenderCustomMessages: vi.fn(() => undefined),
+  useSuggestions: vi.fn(() => ({ suggestions: [], isLoading: false })),
+}));
+
+vi.mock("../../components/toast/toast-provider", () => ({
+  useToast: () => ({
+    setBannerError: vi.fn(),
+    addToast: vi.fn(),
+  }),
+}));
+
+vi.mock("../../components/error-boundary/error-utils", () => ({
+  useAsyncCallback: <T extends (...args: unknown[]) => unknown>(fn: T) => fn,
+}));
+
+vi.mock("../use-langgraph-interrupt-render", () => ({
+  useLangGraphInterruptRender: vi.fn(() => null),
+}));
+
+vi.mock("../use-lazy-tool-renderer", () => ({
+  useLazyToolRenderer: vi.fn(() => () => null),
+}));
+
+// ---------------------------------------------------------------------------
+// Helpers
+// ---------------------------------------------------------------------------
+
+/**
+ * Re-apply the mock return values. Because `vi.mock` factory runs once at
+ * module load, we need to update the mock implementations to pick up the
+ * mutable variables that tests change.
+ */
+function applyMocks() {
+  vi.mocked(useCopilotKit).mockReturnValue({
+    copilotkit: {
+      connectAgent: mockConnectAgent,
+      runtimeConnectionStatus: mockRuntimeConnectionStatus,
+      getRunIdForMessage: vi.fn(),
+      runAgent: vi.fn(),
+      clearSuggestions: vi.fn(),
+      addSuggestionsConfig: vi.fn(),
+      reloadSuggestions: vi.fn(),
+      subscribe: vi.fn(() => ({ unsubscribe: vi.fn() })),
+      interruptElement: null,
+    },
+  } as any);
+
+  vi.mocked(useCopilotChatConfiguration).mockReturnValue({
+    agentId: "test-agent",
+    threadId: mockConfigThreadId,
+  } as any);
+
+  vi.mocked(useAgent).mockReturnValue({ agent: mockAgent } as any);
+}
+
+function createWrapper() {
+  const copilotContextValue = createTestCopilotContext();
+  return function Wrapper({ children }: { children: React.ReactNode }) {
+    return (
+      <CopilotContext.Provider value={copilotContextValue}>
+        <CoAgentStateRendersProvider>{children}</CoAgentStateRendersProvider>
+      </CopilotContext.Provider>
+    );
+  };
+}
+
+// ---------------------------------------------------------------------------
+// Tests
+// ---------------------------------------------------------------------------
+describe("useCopilotChatInternal – connectAgent guard", () => {
+  beforeEach(() => {
+    vi.clearAllMocks();
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Disconnected;
+    mockConnectAgent.mockResolvedValue(undefined);
+    mockAgent.threadId = undefined;
+    mockAgent.messages = [];
+    mockAgent.state = {};
+    mockAgent.isRunning = false;
+    mockConfigThreadId = "config-thread-id";
+  });
+
+  it("does not call connectAgent when status is Disconnected", () => {
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Disconnected;
+    applyMocks();
+
+    renderHook(() => useCopilotChatInternal(), { wrapper: createWrapper() });
+
+    expect(mockConnectAgent).not.toHaveBeenCalled();
+  });
+
+  it("does not call connectAgent when status is Connecting", () => {
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Connecting;
+    applyMocks();
+
+    renderHook(() => useCopilotChatInternal(), { wrapper: createWrapper() });
+
+    expect(mockConnectAgent).not.toHaveBeenCalled();
+  });
+
+  it("calls connectAgent once when status transitions to Connected", async () => {
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Disconnected;
+    applyMocks();
+
+    const { rerender } = renderHook(() => useCopilotChatInternal(), {
+      wrapper: createWrapper(),
+    });
+
+    expect(mockConnectAgent).not.toHaveBeenCalled();
+
+    // Transition to Connected
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Connected;
+    applyMocks();
+
+    rerender();
+
+    // Wait for the async connectAgent call
+    await vi.waitFor(() => {
+      expect(mockConnectAgent).toHaveBeenCalledTimes(1);
+    });
+  });
+
+  it("does not call connectAgent when threadId matches agent's threadId", () => {
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Connected;
+    mockAgent.threadId = "config-thread-id"; // same as mockConfigThreadId
+    applyMocks();
+
+    renderHook(() => useCopilotChatInternal(), { wrapper: createWrapper() });
+
+    expect(mockConnectAgent).not.toHaveBeenCalled();
+  });
+
+  it("does not call connectAgent when config threadId is missing", () => {
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Connected;
+    mockConfigThreadId = undefined;
+    applyMocks();
+
+    renderHook(() => useCopilotChatInternal(), { wrapper: createWrapper() });
+
+    expect(mockConnectAgent).not.toHaveBeenCalled();
+  });
+
+  it("calls connectAgent when all guard conditions are met", async () => {
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Connected;
+    mockAgent.threadId = "old-thread-id"; // differs from config
+    applyMocks();
+
+    renderHook(() => useCopilotChatInternal(), { wrapper: createWrapper() });
+
+    await vi.waitFor(() => {
+      expect(mockConnectAgent).toHaveBeenCalledTimes(1);
+      expect(mockConnectAgent).toHaveBeenCalledWith({ agent: mockAgent });
+    });
+  });
+
+  it("sets agent.threadId to config threadId before calling connectAgent", async () => {
+    mockRuntimeConnectionStatus =
+      CopilotKitCoreRuntimeConnectionStatus.Connected;
+    mockAgent.threadId = "old-thread-id";
+    applyMocks();
+
+    renderHook(() => useCopilotChatInternal(), { wrapper: createWrapper() });
+
+    await vi.waitFor(() => {
+      expect(mockConnectAgent).toHaveBeenCalledTimes(1);
+    });
+
+    expect(mockAgent.threadId).toBe("config-thread-id");
+  });
+});

package/src/hooks/use-copilot-chat_internal.ts

@@ -21,7 +21,10 @@ import {
   useRenderCustomMessages,
   useSuggestions,
 } from "@copilotkitnext/react";
-import { Suggestion } from "@copilotkitnext/core";
+import {
+  Suggestion,
+  CopilotKitCoreRuntimeConnectionStatus,
+} from "@copilotkitnext/core";
 import { useLazyToolRenderer } from "./use-lazy-tool-renderer";
 import { AbstractAgent, AGUIConnectNotImplementedError } from "@ag-ui/client";
 import {
@@ -350,13 +353,21 @@ export function useCopilotChatInternal({
     if (
       agent &&
       existingConfig?.threadId &&
-      agent.threadId !== existingConfig.threadId
+      agent.threadId !== existingConfig.threadId &&
+      copilotkit.runtimeConnectionStatus ===
+        CopilotKitCoreRuntimeConnectionStatus.Connected
     ) {
       agent.threadId = existingConfig.threadId;
       connect(agent);
     }
     return () => {};
-  }, [existingConfig?.threadId, agent, copilotkit, resolvedAgentId]);
+  }, [
+    existingConfig?.threadId,
+    agent,
+    copilotkit,
+    copilotkit.runtimeConnectionStatus,
+    resolvedAgentId,
+  ]);
 
   useEffect(() => {
     onInProgress?.(Boolean(agent?.isRunning));