@github/copilot-sdk 1.0.13-preview.4 → 1.0.13

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 { isIPv6, Socket } from "node:net";
 import { dirname, isAbsolute, join, resolve } from "node:path";
-import { fileURLToPath } from "node:url";
 import {
   createMessageConnection,
   ErrorCodes,
@@ -20,7 +18,8 @@ import {
 } from "./generated/rpc.js";
 import { getSdkProtocolVersion } from "./sdkProtocolVersion.js";
 import { CopilotSession } from "./session.js";
-import { materializeRuntimeBundle } from "./runtimeArtifacts.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";
@@ -128,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;
@@ -185,53 +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 getBundledCliPackage() {
-  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 {
-          root: dirname(packageEntryPath),
-          platform: packageName.slice("@github/copilot-".length)
-        };
-      } 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 root = join(base, ...packageName.split("/"));
-      const candidate = join(root, "index.js");
-      if (existsSync(candidate)) {
-        return {
-          root,
-          platform: packageName.slice("@github/copilot-".length)
-        };
-      }
-    }
-  }
-  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() {
-  const bundled = getBundledCliPackage();
-  return materializeRuntimeBundle({
-    packageRoot: bundled.root,
-    platform: bundled.platform
-  });
+  return ensureRuntimeBundle(COPILOT_CLI_VERSION);
 }
 class TeardownResilientStreamMessageWriter extends StreamMessageWriter {
   suppressWriteErrors = false;
@@ -251,6 +214,7 @@ class CopilotClient {
   ffiHost = null;
   connection = null;
   messageWriter = null;
+  connectionClosed = false;
   socket = null;
   runtimePort = null;
   actualHost = "localhost";
@@ -450,8 +414,6 @@ class CopilotClient {
       const explicitCliPath = conn.path ?? effectiveEnv.COPILOT_CLI_PATH;
       if (explicitCliPath) {
         this.resolvedCliPath = explicitCliPath;
-      } else {
-        this.resolvedCliPath = getBundledRuntimePath();
       }
     }
     const connArgs = conn.kind === "stdio" || conn.kind === "tcp" ? conn.args ?? [] : [];
@@ -466,7 +428,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
@@ -482,17 +445,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";
@@ -622,6 +597,7 @@ class CopilotClient {
       return;
     }
     this.forceStopping = false;
+    this.connectionClosed = false;
     this.processTransportError = null;
     this.state = "connecting";
     try {
@@ -720,7 +696,7 @@ class CopilotClient {
     }
     this.sessions.clear();
     this.githubTokenProviders.clear();
-    if (this.connection && (this.cliProcess || this.ffiHost) && !this.isExternalServer) {
+    if (this.connection && !this.connectionClosed && (this.cliProcess || this.ffiHost) && !this.isExternalServer) {
       const runtimeShutdownStart = Date.now();
       const shutdownPromise = this.rpc.runtime.shutdown();
       void shutdownPromise.catch(() => void 0);
@@ -1251,6 +1227,7 @@ class CopilotClient {
         gitHubTokenProviderRegistrationId,
         remoteSession: config.remoteSession,
         cloud: config.cloud,
+        featureFlags: config.featureFlags,
         expAssignments: config.expAssignments,
         enableManagedSettings: config.enableManagedSettings,
         managedSettings: config.managedSettings
@@ -1284,6 +1261,7 @@ class CopilotClient {
       await this.updateSessionOptionsForMode(session, config);
       this.commitGitHubTokenProvider(returnedSessionId, gitHubTokenProviderRegistrationId);
     } catch (e) {
+      session?._markDisconnected();
       if (registeredId !== void 0) {
         this.sessions.delete(registeredId);
       }
@@ -1486,6 +1464,7 @@ class CopilotClient {
         gitHubTokenProviderRegistrationId,
         remoteSession: config.remoteSession,
         openCanvases: config.openCanvases,
+        featureFlags: config.featureFlags,
         expAssignments: config.expAssignments,
         enableManagedSettings: config.enableManagedSettings,
         managedSettings: config.managedSettings,
@@ -1515,6 +1494,7 @@ class CopilotClient {
       await this.updateSessionOptionsForMode(session, config);
       this.commitGitHubTokenProvider(sessionId, gitHubTokenProviderRegistrationId);
     } catch (e) {
+      session._markDisconnected();
       this.sessions.delete(sessionId);
       if (gitHubTokenProviderRegistrationId !== void 0) {
         this.githubTokenProviders.delete(gitHubTokenProviderRegistrationId);
@@ -1630,10 +1610,17 @@ class CopilotClient {
     const raceAgainstExit = (p) => this.processExitPromise ? Promise.race([p, this.processExitPromise]) : p;
     let serverVersion;
     try {
-      const connectParams = { token: this.effectiveConnectionToken };
+      const connectParams = {
+        token: this.effectiveConnectionToken,
+        supportedTaskKinds: ["agent", "client", "shell"]
+      };
       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) {
@@ -1894,6 +1881,7 @@ class CopilotClient {
    * Start the CLI server process
    */
   async startCLIServer() {
+    this.resolvedCliPath ??= await getBundledRuntimePath();
     return new Promise((resolve2, reject) => {
       this.stderrBuffer = "";
       const args = [...this.connectionExtraArgs, "--headless", "--no-auto-update"];
@@ -1931,7 +1919,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"];
@@ -2058,12 +2046,19 @@ stderr: ${stderrOutput}`
   /** Starts the in-process FFI runtime with SDK-managed typed options. */
   async startInProcessFfi() {
     const explicitEntrypoint = this.resolvedEnv.COPILOT_CLI_PATH;
-    const runtimeLibrary = explicitEntrypoint ? join(
-      dirname(resolve(explicitEntrypoint)),
-      "prebuilds",
-      CopilotClient.getNapiPrebuildsFolder(explicitEntrypoint),
-      "runtime.node"
-    ) : join(dirname(getBundledRuntimePath()), "runtime.node");
+    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) {
@@ -2249,12 +2244,24 @@ stderr: ${stderrOutput}` : ""}`
         return await this.handleHooksInvoke(params);
       }
     );
-    this.connection.onClose(() => {
+    const connection = this.connection;
+    const markDisconnected = () => {
+      if (this.connection !== connection) {
+        return;
+      }
+      this.connectionClosed = true;
       this.state = "disconnected";
+      for (const session of this.sessions.values()) {
+        session._markDisconnected();
+      }
+      this.sessions.clear();
       this.githubTokenProviders.clear();
-    });
-    this.connection.onError((_error) => {
-      this.state = "disconnected";
+    };
+    this.connection.onClose(markDisconnected);
+    this.connection.onError(() => {
+      if (this.connection === connection) {
+        this.state = "disconnected";
+      }
     });
   }
   handleSessionEventNotification(notification) {