openclaw/extensions/github-copilot/connection-bound-ids.live.test.ts

// Github Copilot tests cover connection bound ids plugin behavior.
import {
  stream as streamModel,
  type AssistantMessage,
  type Context,
  type Model,
  type Tool,
} from "openclaw/plugin-sdk/llm";
import { Type } from "typebox";
import { describe, expect, it } from "vitest";
import { resolveFirstGithubToken } from "./auth.js";
import { wrapCopilotProviderStream } from "./stream.js";
import { resolveCopilotApiToken } from "./token.js";

const LIVE =
  process.env.OPENCLAW_LIVE_TEST === "1" ||
  process.env.LIVE === "1" ||
  process.env.GITHUB_COPILOT_LIVE_TEST === "1";
const ENV_GITHUB_TOKEN =
  process.env.OPENCLAW_LIVE_GITHUB_COPILOT_TOKEN ??
  process.env.COPILOT_GITHUB_TOKEN ??
  process.env.GH_TOKEN ??
  process.env.GITHUB_TOKEN ??
  "";
const LIVE_MODEL_ID = process.env.OPENCLAW_LIVE_GITHUB_COPILOT_MODEL?.trim() || "gpt-5.4";
const describeLive = LIVE ? describe : describe.skip;
const TOOL_ARGUMENT_MARKER = `copilot-stream-arguments-${"x".repeat(128)}`;

type CopilotApiToken = {
  token: string;
  expiresAt: number;
  source: string;
  baseUrl: string;
};

const ZERO_USAGE = {
  input: 0,
  output: 0,
  cacheRead: 0,
  cacheWrite: 0,
  totalTokens: 0,
  cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0, total: 0 },
} as const;

function logProgress(message: string): void {
  process.stderr.write(`[github-copilot-live] ${message}\n`);
}

async function withTimeout<T>(label: string, promise: Promise<T>, timeoutMs: number): Promise<T> {
  let timer: NodeJS.Timeout | undefined;
  try {
    return await Promise.race([
      promise,
      new Promise<never>((_, reject) => {
        timer = setTimeout(
          () => reject(new Error(`${label} timed out after ${timeoutMs}ms`)),
          timeoutMs,
        );
        timer.unref?.();
      }),
    ]);
  } finally {
    if (timer) {
      clearTimeout(timer);
    }
  }
}

const fetchWithTimeout: typeof fetch = async (input, init) => {
  const controller = new AbortController();
  const timer = setTimeout(() => controller.abort(), 10_000);
  timer.unref?.();
  try {
    return await fetch(input, {
      ...init,
      signal: controller.signal,
    });
  } finally {
    clearTimeout(timer);
  }
};

function buildModel(baseUrl: string): Model<"openai-responses"> {
  return {
    id: LIVE_MODEL_ID,
    name: LIVE_MODEL_ID,
    provider: "github-copilot",
    api: "openai-responses",
    baseUrl,
    headers: {},
    reasoning: false,
    input: ["text"],
    cost: { input: 0, output: 0, cacheRead: 0, cacheWrite: 0 },
    contextWindow: 128_000,
    maxTokens: 256,
  };
}

function buildReplayAssistantMessage(connectionBoundId: string): AssistantMessage {
  return {
    role: "assistant",
    api: "openai-responses",
    provider: "github-copilot",
    model: LIVE_MODEL_ID,
    usage: ZERO_USAGE,
    stopReason: "stop",
    timestamp: Date.now() - 1,
    content: [
      {
        type: "text",
        text: "Earlier assistant text.",
        textSignature: JSON.stringify({ v: 1, id: connectionBoundId }),
      },
    ],
  };
}

async function resolveGithubTokenCandidates(): Promise<Array<{ source: string; token: string }>> {
  const candidates: Array<{ source: string; token: string }> = [];
  const envToken = ENV_GITHUB_TOKEN.trim();
  if (envToken) {
    candidates.push({ source: "env", token: envToken });
  }

  const profileEnv = {
    ...process.env,
    COPILOT_GITHUB_TOKEN: "",
    GH_TOKEN: "",
    GITHUB_TOKEN: "",
  };
  const profile = await resolveFirstGithubToken({ env: profileEnv });
  const profileToken = profile.githubToken.trim();
  if (profileToken && !candidates.some((candidate) => candidate.token === profileToken)) {
    candidates.push({ source: "auth-profile", token: profileToken });
  }
  return candidates;
}

describeLive("github-copilot connection-bound Responses IDs live", () => {
  it("rewrites replayed item IDs and preserves streamed tool arguments", async () => {
    logProgress("start");
    const candidates = await resolveGithubTokenCandidates();
    if (candidates.length === 0) {
      logProgress("skip (no GitHub Copilot token found in env or auth profile)");
      return;
    }

    let token: CopilotApiToken | undefined;
    const failures: string[] = [];
    for (const candidate of candidates) {
      try {
        logProgress(`exchanging ${candidate.source} GitHub token for Copilot token`);
        token = await withTimeout(
          "Copilot token exchange",
          resolveCopilotApiToken({
            githubToken: candidate.token,
            fetchImpl: fetchWithTimeout,
          }),
          15_000,
        );
        logProgress(
          `token ok via ${candidate.source} (${token.source.startsWith("cache:") ? "cache" : "fetched"})`,
        );
        break;
      } catch (error) {
        const message = error instanceof Error ? error.message : String(error);
        failures.push(`${candidate.source}: ${message}`);
        logProgress(`token exchange failed via ${candidate.source} (${message})`);
      }
    }
    if (!token) {
      throw new Error(`Copilot token exchange failed for all candidates: ${failures.join("; ")}`);
    }

    const model = buildModel(token.baseUrl);
    const staleId = Buffer.from(`copilot-${"x".repeat(24)}`).toString("base64");
    const tool: Tool = {
      name: "capture_probe",
      description: "Capture the supplied path and marker exactly.",
      parameters: Type.Object(
        {
          path: Type.String(),
          marker: Type.String(),
        },
        { additionalProperties: false },
      ),
    };
    const context: Context = {
      messages: [
        buildReplayAssistantMessage(staleId),
        {
          role: "user" as const,
          content: `Call capture_probe with path README.md and marker ${TOOL_ARGUMENT_MARKER}. Do not answer directly.`,
          timestamp: Date.now(),
        },
      ],
      tools: [tool],
    };
    let capturedPayload: Record<string, unknown> | undefined;

    const wrappedStream = wrapCopilotProviderStream({ streamFn: streamModel } as never);
    if (!wrappedStream) {
      throw new Error("expected Copilot Responses stream wrapper");
    }
    const stream = wrappedStream(
      model as never,
      context as never,
      {
        apiKey: token.token,
        maxTokens: 256,
        onPayload: (payload: unknown) => {
          capturedPayload = {
            ...(payload as Record<string, unknown>),
            tool_choice: { type: "function", name: tool.name },
          };
          return capturedPayload;
        },
      } as never,
    ) as { result(): Promise<unknown> };

    logProgress("sending tool-call Responses request");
    const result = (await stream.result()) as AssistantMessage;
    logProgress("tool-call Responses request completed");
    const input = Array.isArray(capturedPayload?.input) ? capturedPayload.input : [];
    const replayedAssistant = input.find(
      (item): item is Record<string, unknown> =>
        Boolean(item) &&
        typeof item === "object" &&
        (item as Record<string, unknown>).type === "message",
    );

    expect(replayedAssistant?.id).toMatch(/^msg_[a-f0-9]{16}$/);
    expect(replayedAssistant?.id).not.toBe(staleId);
    const toolCall = result.content.find((block) => block.type === "toolCall");
    if (!toolCall || toolCall.type !== "toolCall") {
      throw new Error(`Copilot did not call capture_probe: ${result.stopReason}`);
    }
    expect(toolCall.name).toBe("capture_probe");
    expect(toolCall.arguments).toEqual({
      path: "README.md",
      marker: TOOL_ARGUMENT_MARKER,
    });
  }, 120_000);
});