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

package/src/lib/runtime/utils.ts

@@ -1,93 +0,0 @@
-import { GraphQLContext } from "../integrations";
-import { Logger } from "pino";
-import { CopilotKitEndpoint, RemoteActionInfoResponse } from "./types";
-import {
-  Action,
-  CopilotKitError,
-  CopilotKitLowLevelError,
-  ResolvedCopilotKitError,
-} from "@copilotkit/shared";
-
-async function fetchRemoteInfo({
-  url,
-  onBeforeRequest,
-  graphqlContext,
-  logger,
-  frontendUrl,
-}: {
-  url: string;
-  onBeforeRequest?: CopilotKitEndpoint["onBeforeRequest"];
-  graphqlContext: GraphQLContext;
-  logger: Logger;
-  frontendUrl?: string;
-}): Promise<RemoteActionInfoResponse> {
-  logger.debug({ url }, "Fetching actions from url");
-  const headers = createHeaders(onBeforeRequest, graphqlContext);
-
-  const fetchUrl = `${url}/info`;
-  try {
-    const response = await fetch(fetchUrl, {
-      method: "POST",
-      headers,
-      body: JSON.stringify({
-        properties: graphqlContext.properties,
-        frontendUrl,
-      }),
-    });
-
-    if (!response.ok) {
-      logger.error(
-        { url, status: response.status, body: await response.text() },
-        "Failed to fetch actions from url",
-      );
-      throw new ResolvedCopilotKitError({
-        status: response.status,
-        url: fetchUrl,
-        isRemoteEndpoint: true,
-      });
-    }
-
-    const json = await response.json();
-    logger.debug({ json }, "Fetched actions from url");
-    return json;
-  } catch (error) {
-    if (error instanceof CopilotKitError) {
-      throw error;
-    }
-    throw new CopilotKitLowLevelError({ error, url: fetchUrl });
-  }
-}
-
-// Utility to determine if an error is a user configuration issue vs system error
-export function isUserConfigurationError(error: any): boolean {
-  return (
-    (error instanceof CopilotKitError ||
-      error instanceof CopilotKitLowLevelError) &&
-    (error.code === "NETWORK_ERROR" ||
-      error.code === "AUTHENTICATION_ERROR" ||
-      error.statusCode === 401 ||
-      error.statusCode === 403 ||
-      error.message?.toLowerCase().includes("authentication") ||
-      error.message?.toLowerCase().includes("api key"))
-  );
-}
-
-export function createHeaders(
-  onBeforeRequest: CopilotKitEndpoint["onBeforeRequest"],
-  graphqlContext: GraphQLContext,
-) {
-  const headers = {
-    "Content-Type": "application/json",
-  };
-
-  if (onBeforeRequest) {
-    const { headers: additionalHeaders } = onBeforeRequest({
-      ctx: graphqlContext,
-    });
-    if (additionalHeaders) {
-      Object.assign(headers, additionalHeaders);
-    }
-  }
-
-  return headers;
-}

package/src/lib/streaming.ts

@@ -1,220 +0,0 @@
-import { ReplaySubject } from "rxjs";
-import {
-  CopilotKitLowLevelError,
-  CopilotKitError,
-  CopilotKitErrorCode,
-  ensureStructuredError,
-} from "@copilotkit/shared";
-import { errorConfig, getFallbackMessage } from "./error-messages";
-
-export async function writeJsonLineResponseToEventStream<T>(
-  response: ReadableStream<Uint8Array>,
-  eventStream$: ReplaySubject<T>,
-) {
-  const reader = response.getReader();
-  const decoder = new TextDecoder();
-  let buffer = [];
-
-  function flushBuffer() {
-    const currentBuffer = buffer.join("");
-    if (currentBuffer.trim().length === 0) {
-      return;
-    }
-    const parts = currentBuffer.split("\n");
-    if (parts.length === 0) {
-      return;
-    }
-
-    const lastPartIsComplete = currentBuffer.endsWith("\n");
-
-    // truncate buffer
-    buffer = [];
-
-    if (!lastPartIsComplete) {
-      // put back the last part
-      buffer.push(parts.pop());
-    }
-
-    parts
-      .map((part) => part.trim())
-      .filter((part) => part != "")
-      .forEach((part) => {
-        eventStream$.next(JSON.parse(part));
-      });
-  }
-
-  try {
-    while (true) {
-      const { done, value } = await reader.read();
-
-      if (!done) {
-        buffer.push(decoder.decode(value, { stream: true }));
-      }
-
-      flushBuffer();
-
-      if (done) {
-        break;
-      }
-    }
-  } catch (error) {
-    // Preserve already structured CopilotKit errors, only convert unstructured errors
-    const structuredError = ensureStructuredError(
-      error,
-      convertStreamingErrorToStructured,
-    );
-    eventStream$.error(structuredError);
-    return;
-  }
-  eventStream$.complete();
-}
-
-function convertStreamingErrorToStructured(error: any): CopilotKitError {
-  // Determine a more helpful error message based on context
-  let helpfulMessage = generateHelpfulErrorMessage(error);
-
-  // For network-related errors, use CopilotKitLowLevelError to preserve the original error
-  if (
-    error?.message?.includes("fetch failed") ||
-    error?.message?.includes("ECONNREFUSED") ||
-    error?.message?.includes("ENOTFOUND") ||
-    error?.message?.includes("ETIMEDOUT") ||
-    error?.message?.includes("terminated") ||
-    error?.cause?.code === "UND_ERR_SOCKET" ||
-    error?.message?.includes("other side closed") ||
-    error?.code === "UND_ERR_SOCKET"
-  ) {
-    console.log("error", error);
-    return new CopilotKitLowLevelError({
-      error: error instanceof Error ? error : new Error(String(error)),
-      url: "streaming connection",
-      message: helpfulMessage,
-    });
-  }
-
-  // For all other errors, preserve the raw error in a basic CopilotKitError
-  return new CopilotKitError({
-    message: helpfulMessage,
-    code: CopilotKitErrorCode.UNKNOWN,
-  });
-}
-
-/**
- * Generates a helpful error message based on error patterns and context
- */
-export function generateHelpfulErrorMessage(
-  error: any,
-  context: string = "connection",
-): string {
-  const baseMessage = error?.message || String(error);
-
-  // Check for preserved error information from Python agent
-  const originalErrorType =
-    error?.originalErrorType || error?.extensions?.originalErrorType;
-  const statusCode = error?.statusCode || error?.extensions?.statusCode;
-  const responseData = error?.responseData || error?.extensions?.responseData;
-
-  // First, try to match by original error type if available (more specific)
-  if (originalErrorType) {
-    const typeConfig = errorConfig.errorPatterns[originalErrorType];
-    if (typeConfig) {
-      return typeConfig.message.replace("{context}", context);
-    }
-  }
-
-  // Check for specific error patterns from configuration
-  for (const [pattern, config] of Object.entries(errorConfig.errorPatterns)) {
-    const shouldMatch =
-      baseMessage?.includes(pattern) ||
-      error?.cause?.code === pattern ||
-      error?.code === pattern ||
-      statusCode === parseInt(pattern) ||
-      (pattern === "other_side_closed" &&
-        baseMessage?.includes("other side closed")) ||
-      (pattern === "fetch_failed" && baseMessage?.includes("fetch failed")) ||
-      (responseData && JSON.stringify(responseData).includes(pattern));
-
-    if (shouldMatch) {
-      // Replace {context} placeholder with actual context
-      return config.message.replace("{context}", context);
-    }
-  }
-
-  // Try to match by category for fallback messages
-  if (isNetworkError(error)) {
-    return getFallbackMessage("network");
-  }
-
-  if (isConnectionError(error)) {
-    return getFallbackMessage("connection");
-  }
-
-  if (isAuthenticationError(error)) {
-    return getFallbackMessage("authentication");
-  }
-
-  // Default fallback
-  return getFallbackMessage("default");
-}
-
-/**
- * Determines if an error is network-related
- */
-function isNetworkError(error: any): boolean {
-  const networkPatterns = [
-    "ECONNREFUSED",
-    "ENOTFOUND",
-    "ETIMEDOUT",
-    "fetch_failed",
-  ];
-  return networkPatterns.some(
-    (pattern) =>
-      error?.message?.includes(pattern) ||
-      error?.cause?.code === pattern ||
-      error?.code === pattern,
-  );
-}
-
-/**
- * Determines if an error is connection-related
- */
-function isConnectionError(error: any): boolean {
-  const connectionPatterns = [
-    "terminated",
-    "UND_ERR_SOCKET",
-    "other side closed",
-  ];
-  return connectionPatterns.some(
-    (pattern) =>
-      error?.message?.includes(pattern) ||
-      error?.cause?.code === pattern ||
-      error?.code === pattern,
-  );
-}
-
-/**
- * Determines if an error is authentication-related
- */
-function isAuthenticationError(error: any): boolean {
-  const authPatterns = [
-    "401",
-    "api key",
-    "unauthorized",
-    "authentication",
-    "AuthenticationError",
-    "PermissionDeniedError",
-  ];
-  const baseMessage = error?.message || String(error);
-  const originalErrorType =
-    error?.originalErrorType || error?.extensions?.originalErrorType;
-  const statusCode = error?.statusCode || error?.extensions?.statusCode;
-
-  return authPatterns.some(
-    (pattern) =>
-      baseMessage?.toLowerCase().includes(pattern.toLowerCase()) ||
-      originalErrorType === pattern ||
-      statusCode === 401 ||
-      error?.status === 401 ||
-      error?.statusCode === 401,
-  );
-}

package/src/lib/telemetry-client.ts

@@ -1,66 +0,0 @@
-import { TelemetryClient } from "@copilotkit/shared";
-import { createHash } from "node:crypto";
-import { CopilotRuntime, resolveEndpointType } from "./runtime/copilot-runtime";
-import { RuntimeInstanceCreatedInfo } from "@copilotkit/shared/src/telemetry/events";
-import { CreateCopilotRuntimeServerOptions } from "./integrations/shared";
-import { EndpointType, LangGraphPlatformEndpoint } from "./runtime/types";
-const packageJson = require("../../package.json");
-
-const telemetryClient = new TelemetryClient({
-  packageName: packageJson.name,
-  packageVersion: packageJson.version,
-});
-
-export function getRuntimeInstanceTelemetryInfo(
-  options: CreateCopilotRuntimeServerOptions,
-): RuntimeInstanceCreatedInfo {
-  const runtime = options.runtime;
-  const remoteEndpoints = runtime.params?.remoteEndpoints ?? [];
-  const endpointsInfo = remoteEndpoints.reduce(
-    (acc, endpoint) => {
-      let info = { ...acc };
-
-      const endpointType = resolveEndpointType(endpoint);
-      if (!info.endpointTypes.includes(endpointType)) {
-        info = {
-          ...info,
-          endpointTypes: [...info.endpointTypes, endpointType],
-        };
-      }
-
-      if (endpointType === EndpointType.LangGraphPlatform) {
-        // When type is resolved, recreating a const with casting of type
-        const ep = endpoint as LangGraphPlatformEndpoint;
-        info = {
-          ...info,
-          agentsAmount: ep.agents.length,
-          hashedKey: ep.langsmithApiKey
-            ? createHash("sha256").update(ep.langsmithApiKey).digest("hex")
-            : null,
-        };
-      }
-
-      return info;
-    },
-    { endpointTypes: [], agentsAmount: null, hashedKey: null },
-  );
-
-  // Get public API key from options.cloud.publicApiKey
-  const publicApiKey = options.cloud?.publicApiKey;
-  const apiKeyProvided = !!publicApiKey && publicApiKey.trim().length > 0;
-
-  return {
-    actionsAmount: runtime.params?.actions?.length ?? 0,
-    endpointsAmount: remoteEndpoints.length,
-    endpointTypes: endpointsInfo.endpointTypes,
-    agentsAmount: Object.keys(runtime.instance.agents).length,
-    hashedLgcKey: endpointsInfo.hashedKey,
-    "cloud.api_key_provided": apiKeyProvided,
-    ...(apiKeyProvided ? { "cloud.public_api_key": publicApiKey } : {}),
-    ...(options.cloud?.baseUrl
-      ? { "cloud.base_url": options.cloud.baseUrl }
-      : {}),
-  } as RuntimeInstanceCreatedInfo;
-}
-
-export default telemetryClient;

package/src/lib/telemetry-disclosure.ts

@@ -1,53 +0,0 @@
-// Runtime-side anonymous telemetry disclosure log.
-//
-// The runtime has shipped anonymous telemetry for some time (see
-// `packages/shared/src/telemetry/telemetry-client.ts`). This file just
-// surfaces a one-line pointer to the opt-out docs on first
-// instantiation so operators don't have to dig through the docs site
-// to discover the existing behavior. Pairs with the inspector's
-// first-run console disclosure for a consistent operator-facing
-// surface.
-//
-// Fires at most once per process — runtime instances may be constructed
-// multiple times (tests, hot-reload), but the disclosure is informational
-// and a single line is enough.
-
-// Canonical telemetry docs page on main.
-// Mirror constant: packages/web-inspector/src/lib/telemetry.ts
-const TELEMETRY_DOCS_URL = "https://docs.copilotkit.ai/telemetry";
-
-function isTelemetryDisabled(): boolean {
-  const env = process.env as Record<string, string | undefined>;
-  return (
-    env.COPILOTKIT_TELEMETRY_DISABLED === "true" ||
-    env.COPILOTKIT_TELEMETRY_DISABLED === "1" ||
-    env.DO_NOT_TRACK === "true" ||
-    env.DO_NOT_TRACK === "1"
-  );
-}
-
-let disclosureLogged = false;
-
-/**
- * Logs a one-line console.info about anonymous telemetry on runtime
- * startup. No-op when telemetry is disabled via `COPILOTKIT_TELEMETRY_DISABLED`
- * or `DO_NOT_TRACK`, or when already logged once in this process.
- *
- * Idempotent — safe to call from multiple constructor paths.
- */
-export function logRuntimeTelemetryDisclosure(): void {
-  if (disclosureLogged) return;
-  if (isTelemetryDisabled()) return;
-  disclosureLogged = true;
-  // eslint-disable-next-line no-console
-  console.info(
-    `[CopilotKit Runtime] anonymous telemetry enabled — see ${TELEMETRY_DOCS_URL} to opt out (set COPILOTKIT_TELEMETRY_DISABLED=true).`,
-  );
-}
-
-// Test-only reset hook so the once-per-process guard doesn't leak between
-// test cases. Not part of the public package surface — used by the runtime
-// disclosure tests.
-export function _resetRuntimeTelemetryDisclosureForTesting(): void {
-  disclosureLogged = false;
-}