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

package/src/v2/runtime/handlers/shared/sse-response.ts

@@ -1,215 +0,0 @@
-import { BaseEvent } from "@ag-ui/client";
-import { EventEncoder } from "@ag-ui/encoder";
-import { Observable, Subscription } from "rxjs";
-import { ResolvedDebugConfig } from "@copilotkit/shared";
-import {
-  createLogger,
-  type CopilotRuntimeLogger,
-} from "../../../../lib/logger";
-import { telemetry } from "../../telemetry";
-import { DebugEventBus } from "../../core/debug-event-bus";
-
-interface CreateSseEventResponseParams {
-  request: Request;
-  observableFactory: () =>
-    | Promise<Observable<BaseEvent>>
-    | Observable<BaseEvent>;
-  debugEventBus?: DebugEventBus;
-  agentId?: string;
-  debug?: ResolvedDebugConfig;
-  /** Pre-created logger instance to avoid creating a new pino logger per request. */
-  logger?: CopilotRuntimeLogger;
-}
-
-export function createSseEventResponse({
-  request,
-  observableFactory,
-  debugEventBus,
-  agentId,
-  debug,
-  logger,
-}: CreateSseEventResponseParams): Response {
-  const stream = new TransformStream();
-  const writer = stream.writable.getWriter();
-  const encoder = new EventEncoder();
-  let streamClosed = false;
-  let debugThreadId = "";
-  let debugRunId = "";
-
-  const debugLogger = debug?.enabled
-    ? (logger ??
-      createLogger({ level: "debug", component: "copilotkit-debug" }))
-    : undefined;
-
-  const closeStream = async () => {
-    if (!streamClosed) {
-      try {
-        await writer.close();
-        streamClosed = true;
-      } catch {
-        // Stream already closed.
-      }
-    }
-  };
-
-  const logError = (error: unknown) => {
-    console.error("Error running agent:", error);
-    console.error(
-      "Error stack:",
-      error instanceof Error ? error.stack : "No stack trace",
-    );
-    console.error("Error details:", {
-      name: error instanceof Error ? error.name : "Unknown",
-      message: error instanceof Error ? error.message : String(error),
-      cause: error instanceof Error ? error.cause : undefined,
-    });
-  };
-
-  let subscription: Subscription | undefined;
-
-  (async () => {
-    const observable = await observableFactory();
-
-    telemetry.capture("oss.runtime.agent_execution_stream_started", {});
-
-    if (debug?.lifecycle) {
-      debugLogger!.debug("SSE stream opened");
-    }
-
-    let eventCount = 0;
-    let loggedEventCount = 0;
-
-    subscription = observable.subscribe({
-      next: async (event) => {
-        // Extract threadId/runId from RUN_STARTED
-        if (event.type === "RUN_STARTED") {
-          const e = event as { threadId?: string; runId?: string };
-          debugThreadId = e.threadId ?? "";
-          debugRunId = e.runId ?? "";
-        }
-
-        // Broadcast to debug listeners BEFORE the stream-closed gate below.
-        // Intentional: debug subscribers (e.g. the VS Code Inspector panel)
-        // should still receive trailing events after the SSE client for
-        // this request closed its connection — they're independent
-        // consumers observing the underlying runtime, not the request's
-        // response stream.
-        //
-        // Wrapped in try/catch so a buggy debug subscriber can't propagate
-        // an exception into this observer — if the throw reached the
-        // `next` callback it would get routed to `error` by RxJS, closing
-        // the SSE stream for an unrelated reason. Log via `logError` and
-        // move on.
-        if (debugEventBus) {
-          try {
-            debugEventBus.broadcast(event, {
-              agentId: agentId ?? "",
-              threadId: debugThreadId,
-              runId: debugRunId,
-            });
-          } catch (broadcastError) {
-            logError(broadcastError);
-          }
-        }
-
-        if (!request.signal.aborted && !streamClosed) {
-          try {
-            eventCount++;
-            if (debug?.events) {
-              loggedEventCount++;
-              if (debug.verbose) {
-                debugLogger!.debug({ event }, "Event emitted");
-              } else {
-                debugLogger!.debug(
-                  { type: event.type, ...summarizeEvent(event) },
-                  "Event emitted",
-                );
-              }
-            }
-            await writer.write(encoder.encode(event));
-          } catch (error) {
-            if (error instanceof Error && error.name === "AbortError") {
-              streamClosed = true;
-            } else {
-              // Non-abort write failures (backpressure disconnects,
-              // transform-stream exceptions, …) were previously swallowed
-              // silently — `streamClosed` stayed `false` and the next
-              // event re-attempted a broken writer. Log and mark the
-              // stream closed so we stop trying.
-              logError(error);
-              streamClosed = true;
-            }
-          }
-        }
-      },
-      error: async (error) => {
-        telemetry.capture("oss.runtime.agent_execution_stream_errored", {
-          error: error instanceof Error ? error.message : String(error),
-        });
-        if (debug?.lifecycle) {
-          debugLogger!.debug(
-            { error: error instanceof Error ? error.message : String(error) },
-            "SSE stream errored",
-          );
-        }
-        logError(error);
-        await closeStream();
-      },
-      complete: async () => {
-        telemetry.capture("oss.runtime.agent_execution_stream_ended", {});
-        if (debug?.lifecycle) {
-          debugLogger!.debug(
-            { eventCount, loggedEventCount },
-            "SSE stream completed",
-          );
-        }
-        await closeStream();
-      },
-    });
-
-    // If the client disconnected before the subscription was created,
-    // unsubscribe immediately to avoid leaking the observable.
-    if (request.signal.aborted) {
-      subscription.unsubscribe();
-    }
-  })().catch(async (error) => {
-    logError(error);
-    await closeStream();
-  });
-
-  request.signal.addEventListener("abort", () => {
-    subscription?.unsubscribe();
-  });
-
-  return new Response(stream.readable, {
-    status: 200,
-    headers: {
-      "Content-Type": "text/event-stream",
-      "Cache-Control": "no-cache",
-      Connection: "keep-alive",
-    },
-  });
-}
-
-function summarizeEvent(event: BaseEvent): Record<string, unknown> {
-  const e = event as any;
-  const summary: Record<string, unknown> = {};
-
-  if (e.messageId) summary.messageId = e.messageId;
-  if (e.toolCallId) summary.toolCallId = e.toolCallId;
-  if (e.toolCallName) summary.toolCallName = e.toolCallName;
-  if (e.role) summary.role = e.role;
-  if (e.delta != null && typeof e.delta === "string")
-    summary.deltaLength = e.delta.length;
-  if (e.snapshot && typeof e.snapshot === "object")
-    summary.snapshotKeys = Object.keys(e.snapshot);
-  if (e.delta && Array.isArray(e.delta))
-    summary.operationCount = e.delta.length;
-  if (e.threadId) summary.threadId = e.threadId;
-  if (e.runId) summary.runId = e.runId;
-  if (e.message) summary.message = e.message;
-  if (e.code) summary.code = e.code;
-  if (e.stepName) summary.stepName = e.stepName;
-
-  return summary;
-}

package/src/v2/runtime/handlers/sse/__tests__/sse-connect-agent-id.test.ts

@@ -1,71 +0,0 @@
-import { describe, it, expect, vi } from "vitest";
-import { of } from "rxjs";
-import { EventType, type BaseEvent } from "@ag-ui/client";
-
-vi.mock("pino", () => ({
-  default: vi.fn(() => ({
-    child: vi.fn(() => ({ debug: vi.fn() })),
-    debug: vi.fn(),
-  })),
-}));
-vi.mock("pino-pretty", () => ({ default: vi.fn() }));
-vi.mock("../../../telemetry", () => ({
-  telemetry: { capture: vi.fn() },
-}));
-
-import { handleSseConnect } from "../connect";
-import { DebugEventBus } from "../../../core/debug-event-bus";
-
-/**
- * Regression guard for the agentId forwarding fix. `handleSseConnect` used
- * to hardcode `agentId: "connect"` in every debug envelope emitted on
- * /agent/:agentId/connect; the fix threads the route-resolved agentId
- * through to `createSseEventResponse`. Reverting that change would make
- * this test fail — the /run-based integration coverage wouldn't catch it
- * because /run is a different code path.
- */
-describe("handleSseConnect → debug envelope agentId", () => {
-  it("forwards the real agentId into envelopes on /connect", async () => {
-    const bus = new DebugEventBus();
-    const received: Array<{ agentId: string }> = [];
-    bus.subscribe((envelope) => {
-      received.push({ agentId: envelope.agentId });
-    });
-
-    const event: BaseEvent = {
-      type: EventType.RUN_STARTED,
-      threadId: "t-1",
-      runId: "r-1",
-    } as BaseEvent;
-
-    const fakeRuntime = {
-      debugEventBus: bus,
-      runner: {
-        connect: () => of(event),
-      },
-    } as any;
-
-    const response = handleSseConnect({
-      runtime: fakeRuntime,
-      request: new Request("http://localhost/agent/weather-agent/connect", {
-        method: "POST",
-      }),
-      agentId: "weather-agent",
-      threadId: "t-1",
-    });
-
-    // Drain to let the observable subscription fire.
-    const reader = response.body!.getReader();
-    while (true) {
-      const { done } = await reader.read();
-      if (done) break;
-    }
-
-    expect(received.length).toBeGreaterThan(0);
-    for (const env of received) {
-      // A revert to the pre-fix hardcoded "connect" would fail this
-      // positive assertion — no need for a separate not-toBe guard.
-      expect(env.agentId).toBe("weather-agent");
-    }
-  });
-});

package/src/v2/runtime/handlers/sse/connect.ts

@@ -1,30 +0,0 @@
-import { CopilotRuntimeLike } from "../../core/runtime";
-import { createSseEventResponse } from "../shared/sse-response";
-import { extractForwardableHeaders } from "../header-utils";
-
-interface HandleSseConnectParams {
-  runtime: CopilotRuntimeLike;
-  request: Request;
-  agentId: string;
-  threadId: string;
-}
-
-export function handleSseConnect({
-  runtime,
-  request,
-  agentId,
-  threadId,
-}: HandleSseConnectParams): Response {
-  return createSseEventResponse({
-    request,
-    debugEventBus: runtime.debugEventBus,
-    // Forward the real agentId so debug envelopes reflect the agent the
-    // route resolved to — not the literal string "connect".
-    agentId,
-    observableFactory: () =>
-      runtime.runner.connect({
-        threadId,
-        headers: extractForwardableHeaders(request),
-      }),
-  });
-}

package/src/v2/runtime/handlers/sse/run.ts

@@ -1,40 +0,0 @@
-import { AbstractAgent, RunAgentInput } from "@ag-ui/client";
-import { ResolvedDebugConfig } from "@copilotkit/shared";
-import { type CopilotRuntimeLogger } from "../../../../lib/logger";
-import { CopilotRuntimeLike } from "../../core/runtime";
-import { createSseEventResponse } from "../shared/sse-response";
-
-interface HandleSseRunParams {
-  runtime: CopilotRuntimeLike;
-  request: Request;
-  agent: AbstractAgent;
-  input: RunAgentInput;
-  agentId: string;
-  debug?: ResolvedDebugConfig;
-  /** Pre-created logger instance to avoid creating a new pino logger per request. */
-  logger?: CopilotRuntimeLogger;
-}
-
-export function handleSseRun({
-  runtime,
-  request,
-  agent,
-  input,
-  agentId,
-  debug,
-  logger,
-}: HandleSseRunParams): Response {
-  return createSseEventResponse({
-    request,
-    debugEventBus: runtime.debugEventBus,
-    agentId,
-    debug,
-    logger,
-    observableFactory: () =>
-      runtime.runner.run({
-        threadId: input.threadId,
-        agent,
-        input,
-      }),
-  });
-}

package/src/v2/runtime/hono.ts

@@ -1,2 +0,0 @@
-export * from "./endpoints/hono";
-export * from "./endpoints/hono-single";

package/src/v2/runtime/index.ts

@@ -1,51 +0,0 @@
-export * from "./core/runtime";
-export * from "./endpoints";
-
-// Export agent runners and base types
-export * from "./runner";
-
-// Export transcription services
-export * from "./transcription-service/transcription-service";
-
-// Export intelligence platform client and types
-export {
-  CopilotKitIntelligence,
-  type CopilotKitIntelligenceConfig,
-  type CreateThreadRequest,
-  type ThreadSummary,
-  type ListThreadsResponse,
-  type SubscribeToThreadsRequest,
-  type SubscribeToThreadsResponse,
-  type UpdateThreadRequest,
-} from "./intelligence-platform";
-
-// Re-export `@ai-sdk/mcp` stable types so consumers don't need to depend on
-// it directly to type their MCP wiring. `MCPClient` is the value users pass
-// into `mcpClients`; `MCPTransport` is the contract for custom transports.
-export type { MCPClient, MCPTransport } from "@ai-sdk/mcp";
-
-// Export framework-agnostic fetch handler
-export { createCopilotRuntimeHandler } from "./core/fetch-handler";
-export type {
-  CopilotRuntimeHandlerOptions,
-  CopilotRuntimeFetchHandler,
-} from "./core/fetch-handler";
-
-// Export hook types
-export type {
-  CopilotRuntimeHooks,
-  HookContext,
-  HandlerHookContext,
-  ResponseHookContext,
-  ErrorHookContext,
-  RouteInfo,
-} from "./core/hooks";
-
-// Export CORS config type
-export type { CopilotCorsConfig } from "./core/fetch-cors";
-
-// Deprecated type aliases for backward compatibility
-/** @deprecated Use `CopilotRuntimeFetchHandler` instead. Note: the new type takes `Request` directly, not `{ request: Request }`. */
-export type CopilotKitRequestHandler = (params: {
-  request: Request;
-}) => Promise<Response>;