@github/copilot-sdk 1.0.13-preview.3 → 1.0.13-preview.6

package/dist/client.js

@@ -1,10 +1,8 @@
 import { spawn } from "node:child_process";
 import { randomUUID } from "node:crypto";
 import { existsSync } from "node:fs";
-import { createRequire } from "node:module";
-import { Socket } from "node:net";
-import { dirname, isAbsolute, join } from "node:path";
-import { fileURLToPath } from "node:url";
+import { isIPv6, Socket } from "node:net";
+import { dirname, isAbsolute, join, resolve } from "node:path";
 import {
   createMessageConnection,
   ErrorCodes,
@@ -20,6 +18,8 @@ import {
 } from "./generated/rpc.js";
 import { getSdkProtocolVersion } from "./sdkProtocolVersion.js";
 import { CopilotSession } from "./session.js";
+import { ensureRuntimeBundle } from "./runtimeArtifacts.js";
+import { COPILOT_CLI_VERSION } from "./cliVersion.js";
 import { createSessionFsAdapter } from "./sessionFsProvider.js";
 import { createCopilotRequestAdapter } from "./copilotRequestHandler.js";
 import { getTraceContext } from "./telemetry.js";
@@ -49,7 +49,7 @@ async function waitForChildExit(child, timeoutMs) {
   if (child.exitCode != null || child.signalCode != null) {
     return true;
   }
-  return new Promise((resolve) => {
+  return new Promise((resolve2) => {
     let timeout;
     let settled = false;
     const onExit = () => {
@@ -58,7 +58,7 @@ async function waitForChildExit(child, timeoutMs) {
       }
       settled = true;
       clearTimeout(timeout);
-      resolve(true);
+      resolve2(true);
     };
     timeout = setTimeout(() => {
       if (settled) {
@@ -66,7 +66,7 @@ async function waitForChildExit(child, timeoutMs) {
       }
       settled = true;
       child.off("exit", onExit);
-      resolve(false);
+      resolve2(false);
     }, timeoutMs);
     child.once("exit", onExit);
     if (child.exitCode != null || child.signalCode != null) {
@@ -127,6 +127,15 @@ function toWireCustomAgents(agents) {
     return { ...rest, mcpServers: toWireMcpServers(mcpServers) };
   });
 }
+function clientInfoToWire(info) {
+  if (info == null) return void 0;
+  const wire = {};
+  if (info.applicationName) wire.editorName = info.applicationName;
+  if (info.applicationVersion) wire.editorVersion = info.applicationVersion;
+  if (info.integrationName) wire.extensionName = info.integrationName;
+  if (info.integrationVersion) wire.extensionVersion = info.integrationVersion;
+  return Object.keys(wire).length > 0 ? wire : void 0;
+}
 function toWireLargeOutput(config) {
   if (!config) return void 0;
   const { outputDirectory, ...rest } = config;
@@ -184,39 +193,8 @@ function getNodeExecPath() {
   }
   return process.execPath;
 }
-function getCliPlatformPackageNames() {
-  const arch = process.arch;
-  const variants = process.platform === "linux" ? ["linux", "linuxmusl"] : [process.platform];
-  return variants.map((variant) => `@github/copilot-${variant}-${arch}`);
-}
-function getBundledCliPath() {
-  const packageNames = getCliPlatformPackageNames();
-  if (typeof import.meta.resolve === "function") {
-    for (const packageName of packageNames) {
-      try {
-        const packageEntryUrl = import.meta.resolve(packageName);
-        const packageEntryPath = fileURLToPath(packageEntryUrl);
-        return join(dirname(packageEntryPath), "index.js");
-      } catch {
-      }
-    }
-    throw new Error(
-      `Could not resolve a @github/copilot platform package (tried ${packageNames.join(", ")}). Ensure @github/copilot is installed, or pass cliPath/cliUrl to CopilotClient.`
-    );
-  }
-  const req = createRequire(__filename);
-  const searchPaths = req.resolve.paths("@github/copilot") ?? [];
-  for (const base of searchPaths) {
-    for (const packageName of packageNames) {
-      const candidate = join(base, ...packageName.split("/"), "index.js");
-      if (existsSync(candidate)) {
-        return candidate;
-      }
-    }
-  }
-  throw new Error(
-    `Could not find a @github/copilot platform package (tried ${packageNames.join(", ")}). Searched ${searchPaths.length} paths. Ensure @github/copilot is installed, or pass cliPath/cliUrl to CopilotClient.`
-  );
+function getBundledRuntimePath() {
+  return ensureRuntimeBundle(COPILOT_CLI_VERSION);
 }
 class TeardownResilientStreamMessageWriter extends StreamMessageWriter {
   suppressWriteErrors = false;
@@ -264,6 +242,7 @@ class CopilotClient {
   _internalRpc = null;
   processExitPromise = null;
   // Rejects when CLI process exits
+  processTransportError = null;
   negotiatedProtocolVersion = null;
   /** Connection-level session filesystem config, set via constructor option. */
   sessionFsConfig = null;
@@ -430,7 +409,12 @@ class CopilotClient {
     const connEnv = conn.kind === "stdio" || conn.kind === "tcp" ? conn.env : void 0;
     const effectiveEnv = connEnv ?? options.env ?? process.env;
     this.resolvedEnv = effectiveEnv;
-    this.resolvedCliPath = conn.kind === "stdio" || conn.kind === "tcp" ? conn.path ?? effectiveEnv.COPILOT_CLI_PATH ?? getBundledCliPath() : void 0;
+    if (conn.kind === "stdio" || conn.kind === "tcp") {
+      const explicitCliPath = conn.path ?? effectiveEnv.COPILOT_CLI_PATH;
+      if (explicitCliPath) {
+        this.resolvedCliPath = explicitCliPath;
+      }
+    }
     const connArgs = conn.kind === "stdio" || conn.kind === "tcp" ? conn.args ?? [] : [];
     this.connectionExtraArgs = [...connArgs];
     this.options = {
@@ -443,7 +427,8 @@ class CopilotClient {
       baseDirectory: options.baseDirectory,
       sessionIdleTimeoutSeconds: options.sessionIdleTimeoutSeconds ?? 0,
       enableRemoteSessions: options.enableRemoteSessions ?? false,
-      mode: options.mode ?? "copilot-cli"
+      mode: options.mode ?? "copilot-cli",
+      clientInfo: options.clientInfo
     };
     if (this.options.mode === "empty") {
       const hasPersistence = this.options.baseDirectory !== void 0 || this.sessionFsConfig !== null || // External runtimes manage their own persistence layer; the SDK
@@ -459,17 +444,29 @@ class CopilotClient {
   connectionExtraArgs = [];
   /**
    * Parse CLI URL into host and port
-   * Supports formats: "host:port", "http://host:port", "https://host:port", or just "port"
+   * Supports formats: "host:port", "[ipv6]:port", "http://host:port", "https://host:port", or just "port"
    */
   parseCliUrl(url) {
-    let cleanUrl = url.replace(/^https?:\/\//, "");
+    const cleanUrl = url.replace(/^https?:\/\//, "");
     if (/^\d+$/.test(cleanUrl)) {
       return { host: "localhost", port: parseInt(cleanUrl, 10) };
     }
+    const ipv6Match = cleanUrl.match(/^\[([^\]]+)\]:(\d+)$/);
+    if (ipv6Match) {
+      const host2 = ipv6Match[1];
+      if (!isIPv6(host2)) {
+        throw new Error(`Invalid cliUrl format: ${url}`);
+      }
+      const port2 = parseInt(ipv6Match[2], 10);
+      if (isNaN(port2) || port2 <= 0 || port2 > 65535) {
+        throw new Error(`Invalid port in cliUrl: ${url}`);
+      }
+      return { host: host2, port: port2 };
+    }
     const parts = cleanUrl.split(":");
     if (parts.length !== 2) {
       throw new Error(
-        `Invalid cliUrl format: ${url}. Expected "host:port", "http://host:port", or "port"`
+        `Invalid cliUrl format: ${url}. Expected "host:port", "[ipv6]:port", "http://host:port", or "port"`
       );
     }
     const host = parts[0] || "localhost";
@@ -598,6 +595,8 @@ class CopilotClient {
     if (this.state === "connected") {
       return;
     }
+    this.forceStopping = false;
+    this.processTransportError = null;
     this.state = "connecting";
     try {
       if (this.connectionConfig.kind === "inprocess") {
@@ -630,8 +629,10 @@ class CopilotClient {
       }
       this.state = "connected";
     } catch (error) {
+      const startupError = this.processTransportError ?? error;
+      await this.forceStop();
       this.state = "error";
-      throw error;
+      throw startupError;
     }
   }
   /**
@@ -676,7 +677,7 @@ class CopilotClient {
           lastError = error instanceof Error ? error : new Error(String(error));
           if (attempt < 3) {
             const delay = 100 * Math.pow(2, attempt - 1);
-            await new Promise((resolve) => setTimeout(resolve, delay));
+            await new Promise((resolve2) => setTimeout(resolve2, delay));
           }
         }
       }
@@ -743,8 +744,8 @@ class CopilotClient {
       this.socket = null;
       try {
         if (!socket.destroyed) {
-          await new Promise((resolve) => {
-            socket.once("close", () => resolve());
+          await new Promise((resolve2) => {
+            socket.once("close", () => resolve2());
             socket.end();
           });
         }
@@ -1224,6 +1225,7 @@ class CopilotClient {
         gitHubTokenProviderRegistrationId,
         remoteSession: config.remoteSession,
         cloud: config.cloud,
+        featureFlags: config.featureFlags,
         expAssignments: config.expAssignments,
         enableManagedSettings: config.enableManagedSettings,
         managedSettings: config.managedSettings
@@ -1459,6 +1461,7 @@ class CopilotClient {
         gitHubTokenProviderRegistrationId,
         remoteSession: config.remoteSession,
         openCanvases: config.openCanvases,
+        featureFlags: config.featureFlags,
         expAssignments: config.expAssignments,
         enableManagedSettings: config.enableManagedSettings,
         managedSettings: config.managedSettings,
@@ -1550,8 +1553,8 @@ class CopilotClient {
   async listModels() {
     await this.modelsCacheLock;
     let resolveLock;
-    this.modelsCacheLock = new Promise((resolve) => {
-      resolveLock = resolve;
+    this.modelsCacheLock = new Promise((resolve2) => {
+      resolveLock = resolve2;
     });
     try {
       if (this.modelsCache !== null) {
@@ -1607,6 +1610,10 @@ class CopilotClient {
       if (this.onGitHubTelemetry != null) {
         connectParams.enableGitHubTelemetryForwarding = true;
       }
+      const clientInfo = clientInfoToWire(this.options.clientInfo);
+      if (clientInfo != null) {
+        connectParams.clientInfo = clientInfo;
+      }
       const result = await raceAgainstExit(this.internalRpc.connect(connectParams));
       serverVersion = result.protocolVersion;
     } catch (err) {
@@ -1867,7 +1874,8 @@ class CopilotClient {
    * Start the CLI server process
    */
   async startCLIServer() {
-    return new Promise((resolve, reject) => {
+    this.resolvedCliPath ??= await getBundledRuntimePath();
+    return new Promise((resolve2, reject) => {
       this.stderrBuffer = "";
       const args = [...this.connectionExtraArgs, "--headless", "--no-auto-update"];
       if (this.options.logLevel) {
@@ -1904,7 +1912,7 @@ class CopilotClient {
       }
       if (!existsSync(this.resolvedCliPath)) {
         throw new Error(
-          `Copilot CLI not found at ${this.resolvedCliPath}. Ensure @github/copilot is installed.`
+          `Copilot CLI not found at ${this.resolvedCliPath}. Set COPILOT_CLI_PATH to use a custom installation.`
         );
       }
       const stdioConfig = this.connectionConfig.kind === "stdio" ? ["pipe", "pipe", "pipe"] : ["ignore", "pipe", "pipe"];
@@ -1928,7 +1936,7 @@ class CopilotClient {
       let resolved = false;
       if (this.connectionConfig.kind === "stdio") {
         resolved = true;
-        resolve();
+        resolve2();
       } else {
         this.cliProcess.stdout?.on("data", (data) => {
           stdout += data.toString();
@@ -1936,7 +1944,7 @@ class CopilotClient {
           if (match && !resolved) {
             this.runtimePort = parseInt(match[1], 10);
             resolved = true;
-            resolve();
+            resolve2();
           }
         });
       }
@@ -1968,26 +1976,27 @@ stderr: ${stderrOutput}`
       });
       this.processExitPromise = new Promise((_, rejectProcessExit) => {
         this.cliProcess.on("exit", (code) => {
-          setTimeout(() => {
-            const stderrOutput = this.stderrBuffer.trim();
-            if (stderrOutput) {
-              rejectProcessExit(
-                new Error(
-                  `CLI server exited with code ${code}
+          if (this.messageWriter) {
+            this.messageWriter.suppressWriteErrors = true;
+          }
+          const stderrOutput = this.stderrBuffer.trim();
+          if (stderrOutput) {
+            rejectProcessExit(
+              new Error(
+                `CLI server exited with code ${code}
 stderr: ${stderrOutput}`
-                )
-              );
-            } else {
-              rejectProcessExit(
-                new Error(`CLI server exited unexpectedly with code ${code}`)
-              );
-            }
-          }, 50);
+              )
+            );
+          } else {
+            rejectProcessExit(
+              new Error(`CLI server exited unexpectedly with code ${code}`)
+            );
+          }
         });
       });
       this.processExitPromise.catch(() => {
       });
-      this.cliProcess.on("exit", (code) => {
+      this.cliProcess.on("close", (code) => {
         if (!resolved) {
           resolved = true;
           const stderrOutput = this.stderrBuffer.trim();
@@ -2029,7 +2038,20 @@ stderr: ${stderrOutput}`
   }
   /** Starts the in-process FFI runtime with SDK-managed typed options. */
   async startInProcessFfi() {
-    const entrypoint = this.resolveCliPathForFfi();
+    const explicitEntrypoint = this.resolvedEnv.COPILOT_CLI_PATH;
+    let runtimeLibrary;
+    if (explicitEntrypoint) {
+      const entrypointDirectory = dirname(resolve(explicitEntrypoint));
+      const adjacentRuntime = join(entrypointDirectory, "runtime.node");
+      runtimeLibrary = existsSync(adjacentRuntime) ? adjacentRuntime : join(
+        entrypointDirectory,
+        "prebuilds",
+        CopilotClient.getNapiPrebuildsFolder(explicitEntrypoint),
+        "runtime.node"
+      );
+    } else {
+      runtimeLibrary = join(dirname(await getBundledRuntimePath()), "runtime.node");
+    }
     const { FfiRuntimeHost } = await import("./ffiRuntimeHost.js");
     const environment = {};
     if (this.options.gitHubToken) {
@@ -2057,12 +2079,7 @@ stderr: ${stderrOutput}`
     if (this.options.enableRemoteSessions) {
       args.push("--remote");
     }
-    const host = FfiRuntimeHost.create(
-      entrypoint,
-      CopilotClient.getNapiPrebuildsFolder(entrypoint),
-      environment,
-      args
-    );
+    const host = FfiRuntimeHost.create(runtimeLibrary, explicitEntrypoint, environment, args);
     this.ffiHost = host;
     await host.start();
   }
@@ -2082,19 +2099,6 @@ stderr: ${stderrOutput}`
     this.attachConnectionHandlers();
     this.connection.listen();
   }
-  /**
-   * Resolves the CLI entrypoint used for in-process FFI hosting: `COPILOT_CLI_PATH`
-   * when set, otherwise the bundled platform-package entrypoint.
-   */
-  resolveCliPathForFfi() {
-    return this.resolvedEnv.COPILOT_CLI_PATH ?? getBundledCliPath();
-  }
-  /**
-   * Returns the napi prebuilds folder name for the current host — the
-   * `<node-platform>-<arch>` convention (e.g. `win32-x64`, `darwin-arm64`,
-   * `linux-x64`, `linuxmusl-x64`) under which the runtime ships
-   * `prebuilds/<folder>/runtime.node`.
-   */
   static getNapiPrebuildsFolder(entrypoint) {
     const arch = process.arch;
     if (arch !== "x64" && arch !== "arm64") {
@@ -2130,6 +2134,11 @@ stderr: ${stderrOutput}`
       }
       this.state = "error";
       const reason = err instanceof Error ? err.stack ?? err.message : String(err);
+      const stderrOutput = this.stderrBuffer.trim();
+      this.processTransportError = new Error(
+        `CLI server connection failed: ${reason}${stderrOutput ? `
+stderr: ${stderrOutput}` : ""}`
+      );
       this.logDebug(`stdin pipe error: ${reason}`);
       try {
         this.connection?.dispose();
@@ -2166,7 +2175,7 @@ stderr: ${stderrOutput}`
     if (!this.runtimePort) {
       throw new Error("Server port not available");
     }
-    return new Promise((resolve, reject) => {
+    return new Promise((resolve2, reject) => {
       this.socket = new Socket();
       const connectionTimeout = setTimeout(() => {
         this.socket?.destroy();
@@ -2181,7 +2190,7 @@ stderr: ${stderrOutput}`
         );
         this.attachConnectionHandlers();
         this.connection.listen();
-        resolve();
+        resolve2();
       });
       this.socket.on("error", (error) => {
         clearTimeout(connectionTimeout);

package/dist/ffiRuntimeHost.d.ts

@@ -16,16 +16,10 @@ export declare class FfiRuntimeHost {
     readonly sendStream: Writable;
     private constructor();
     /**
-     * Resolves the cdylib next to the given CLI entrypoint and prepares the FFI host.
-     * The cdylib is resolved as `prebuilds/<prebuildsFolder>/runtime.node` relative to
-     * the entrypoint directory (the napi-rs `<node-platform>-<arch>` layout, e.g.
-     * `linux-x64`). Throws if it cannot be found.
-     */
-    static create(cliEntrypoint: string, prebuildsFolder: string, environment: Record<string, string | undefined> | undefined, args: readonly string[]): FfiRuntimeHost;
-    /**
-     * Starts the in-process runtime: spawns the CLI worker via the native host,
-     * waits for readiness, and opens the FFI JSON-RPC connection.
+     * Loads the runtime cdylib at the given path and prepares the FFI host.
      */
+    static create(libraryPath: string, cliEntrypoint: string | undefined, environment: Record<string, string | undefined> | undefined, args: readonly string[]): FfiRuntimeHost;
+    /** Starts the in-process Rust runtime and opens the FFI JSON-RPC connection. */
     start(): Promise<void>;
     private writeFrame;
     /**

package/dist/ffiRuntimeHost.js

@@ -1,6 +1,6 @@
 import { existsSync } from "node:fs";
 import koffi from "koffi";
-import { dirname, join, resolve } from "node:path";
+import { resolve } from "node:path";
 import { PassThrough, Writable } from "node:stream";
 const SYMBOL_PREFIX = "copilot_runtime_";
 const KEEP_ALIVE_INTERVAL_MS = 1 << 30;
@@ -52,7 +52,7 @@ function loadLibrary(libraryPath) {
   return loadedLibrary;
 }
 function buildArgvJson(cliEntrypoint, args) {
-  const argv = cliEntrypoint.toLowerCase().endsWith(".js") ? ["node", cliEntrypoint, "--embedded-host", "--no-auto-update"] : [cliEntrypoint, "--embedded-host", "--no-auto-update"];
+  const argv = cliEntrypoint ? cliEntrypoint.toLowerCase().endsWith(".js") ? ["node", cliEntrypoint, "--embedded-host", "--no-auto-update"] : [cliEntrypoint, "--embedded-host", "--no-auto-update"] : [];
   argv.push(...args);
   return Buffer.from(JSON.stringify(argv), "utf8");
 }
@@ -107,24 +107,21 @@ class FfiRuntimeHost {
   /** The stream JSON-RPC writes client→server frames to. */
   sendStream;
   /**
-   * Resolves the cdylib next to the given CLI entrypoint and prepares the FFI host.
-   * The cdylib is resolved as `prebuilds/<prebuildsFolder>/runtime.node` relative to
-   * the entrypoint directory (the napi-rs `<node-platform>-<arch>` layout, e.g.
-   * `linux-x64`). Throws if it cannot be found.
+   * Loads the runtime cdylib at the given path and prepares the FFI host.
    */
-  static create(cliEntrypoint, prebuildsFolder, environment, args) {
-    const fullEntrypoint = resolve(cliEntrypoint);
-    const distDir = dirname(fullEntrypoint);
-    const libraryPath = join(distDir, "prebuilds", prebuildsFolder, "runtime.node");
-    if (!existsSync(libraryPath)) {
-      throw new Error(`FFI runtime library not found. Looked for '${libraryPath}'.`);
+  static create(libraryPath, cliEntrypoint, environment, args) {
+    const fullLibraryPath = resolve(libraryPath);
+    if (!existsSync(fullLibraryPath)) {
+      throw new Error(`FFI runtime library not found at '${fullLibraryPath}'.`);
     }
-    return new FfiRuntimeHost(libraryPath, fullEntrypoint, environment, args);
+    return new FfiRuntimeHost(
+      fullLibraryPath,
+      cliEntrypoint ? resolve(cliEntrypoint) : void 0,
+      environment,
+      args
+    );
   }
-  /**
-   * Starts the in-process runtime: spawns the CLI worker via the native host,
-   * waits for readiness, and opens the FFI JSON-RPC connection.
-   */
+  /** Starts the in-process Rust runtime and opens the FFI JSON-RPC connection. */
   async start() {
     const argvJson = buildArgvJson(this.cliEntrypoint, this.args);
     const envJson = buildEnvJson(this.environment);
@@ -144,9 +141,7 @@ class FfiRuntimeHost {
       );
     });
     if (!this.serverId) {
-      throw new Error(
-        `copilot_runtime_host_start failed (library '${this.libraryPath}', entrypoint '${this.cliEntrypoint}').`
-      );
+      throw new Error(`copilot_runtime_host_start failed (library '${this.libraryPath}').`);
     }
     this.outboundCallback = koffi.register(
       (_userData, bytesPtr, bytesLen) => this.feedInbound(bytesPtr, bytesLen),