@github/copilot-sdk 1.0.29-preview.1 → 1.0.29-preview.10

package/dist/client.js

@@ -1,8 +1,8 @@
 import { spawn } from "node:child_process";
 import { randomUUID } from "node:crypto";
-import { existsSync } from "node:fs";
+import { accessSync, constants, existsSync, statSync } from "node:fs";
 import { isIPv6, Socket } from "node:net";
-import { dirname, isAbsolute, join, resolve } from "node:path";
+import { dirname, isAbsolute, join, resolve, win32 } from "node:path";
 import {
   createMessageConnection as createRpcMessageConnection,
   ErrorCodes,
@@ -36,6 +36,19 @@ import { defaultJoinSessionPermissionHandler } from "./types.js";
 const MIN_PROTOCOL_VERSION = 3;
 const RUNTIME_SHUTDOWN_TIMEOUT_MS = 1e4;
 const CLOUD_SESSION_CLEANUP_TIMEOUT_MS = 1e4;
+const messageEncodeErrors = /* @__PURE__ */ new WeakSet();
+const jsonMessageEncoder = {
+  name: "application/json",
+  encode: (msg, options) => {
+    try {
+      return Promise.resolve(Buffer.from(JSON.stringify(msg), options.charset));
+    } catch (thrown) {
+      const error = thrown instanceof Error ? thrown : new Error(String(thrown));
+      messageEncodeErrors.add(error);
+      return Promise.reject(error);
+    }
+  }
+};
 function createMessageConnection(reader, writer) {
   let dispatch;
   let finishDrain;
@@ -270,8 +283,15 @@ function getNodeExecPath() {
 function getBundledRuntimePath() {
   return ensureRuntimeBundle(COPILOT_CLI_VERSION);
 }
+async function getSpawnableBundledRuntimePath() {
+  const runtimePath = await getBundledRuntimePath();
+  return process.platform === "win32" ? win32.toNamespacedPath(runtimePath) : runtimePath;
+}
 class TeardownResilientStreamMessageWriter extends StreamMessageWriter {
   suppressWriteErrors = false;
+  constructor(writable) {
+    super(writable, { contentTypeEncoder: jsonMessageEncoder });
+  }
   async write(msg) {
     try {
       await super.write(msg);
@@ -318,8 +338,10 @@ class CopilotClient {
   effectiveConnectionToken;
   onListModels;
   onGetTraceContext;
-  modelsCache = null;
-  modelsCacheLock = Promise.resolve();
+  modelsCache = {
+    models: null,
+    lock: Promise.resolve()
+  };
   sessionLifecycleHandlers = /* @__PURE__ */ new Set();
   typedLifecycleHandlers = /* @__PURE__ */ new Map();
   _rpc = null;
@@ -430,19 +452,22 @@ class CopilotClient {
    */
   constructor(options = {}) {
     const conn = options._internalConnection ?? options.connection ?? CopilotClient.resolveDefaultConnection();
+    if ((conn.kind === "uri" || conn.kind === "parent-process") && options.internalTestOptions !== void 0) {
+      throw new Error("internalTestOptions requires a runtime owned by this client");
+    }
     if (conn.kind === "uri" && (options.gitHubToken !== void 0 || options.useLoggedInUser !== void 0)) {
       throw new Error(
         "gitHubToken and useLoggedInUser cannot be used with RuntimeConnection.forUri (external server manages its own auth)"
       );
     }
-    if (conn.kind === "inprocess" && options.workingDirectory !== void 0) {
+    if (conn.kind === "inprocess" && options.env !== void 0) {
       throw new Error(
-        "workingDirectory is not supported with RuntimeConnection.forInProcess(): the in-process transport hosts the runtime in this process, so honoring it would require mutating the shared process-global cwd. Change the host process's working directory before constructing the client instead."
+        "env is not supported with RuntimeConnection.forInProcess(): environment variables belong to the shared host process. Use typed client/session options or a child-process transport."
       );
     }
-    if (conn.kind === "inprocess" && options.env !== void 0) {
+    if (conn.kind === "inprocess" && options.workingDirectory !== void 0) {
       throw new Error(
-        "env is not supported with RuntimeConnection.forInProcess(): the in-process transport loads the native runtime into the shared host process, whose single environment block cannot carry per-client values. Set the variables on the host process environment instead."
+        "workingDirectory is not supported with RuntimeConnection.forInProcess(): the in-process transport hosts the runtime in this process, so honoring it would require mutating the shared process-global cwd. Set SessionConfig.workingDirectory instead."
       );
     }
     if (conn.kind === "inprocess" && options.telemetry !== void 0) {
@@ -508,6 +533,7 @@ class CopilotClient {
     const connArgs = conn.kind === "stdio" || conn.kind === "tcp" ? conn.args ?? [] : [];
     this.connectionExtraArgs = [...connArgs];
     this.options = {
+      internalTestOptions: options.internalTestOptions,
       entra: options.entra ? { ...options.entra, tokenProvider: options.entra.tokenProvider } : void 0,
       workingDirectory: options.workingDirectory ?? process.cwd(),
       logLevel: options.logLevel,
@@ -779,12 +805,17 @@ class CopilotClient {
    * Stops the CLI server and closes all active sessions.
    *
    * This method performs graceful cleanup:
-   * 1. Closes all active sessions (releases in-memory resources)
+   * 1. Closes all active sessions (releases in-memory resources); detach
+   *    requests share one shutdown timeout
    * 2. Requests runtime shutdown for SDK-owned CLI processes
    * 3. Closes the JSON-RPC connection
    * 4. Signals EOF to an owned stdio process and waits for host cleanup, then
    *    terminates the process if it does not exit within the shutdown timeout
    *
+   * In-process connections first abort active turns without a timeout. That
+   * step is outside the detach deadline, so in-process stop() can still wait
+   * indefinitely if the runtime stops answering abort requests.
+   *
    * Note: session data on disk is preserved, so sessions can be resumed later.
    * To permanently remove session data before stopping, call
    * {@link deleteSession} for each session first.
@@ -806,16 +837,31 @@ class CopilotClient {
     if (this.connectionConfig.kind === "inprocess") {
       await Promise.allSettled(activeSessions.map((session) => session.abort()));
     }
+    let detachDeadlineTimer;
+    const detachDeadline = new Promise((resolve2) => {
+      detachDeadlineTimer = setTimeout(() => resolve2("timeout"), RUNTIME_SHUTDOWN_TIMEOUT_MS);
+    });
     for (const session of activeSessions) {
       const sessionId = session.sessionId;
       let lastError = null;
+      let attempts = 0;
       for (let attempt = 1; attempt <= 3; attempt++) {
         if (this.connectionClosed) {
           lastError = null;
           break;
         }
+        attempts = attempt;
         try {
-          await session.disconnect();
+          const outcome = await Promise.race([
+            session.disconnect().then(() => "disconnected"),
+            detachDeadline
+          ]);
+          if (outcome === "timeout") {
+            lastError = new Error(
+              `session.detach did not complete within the ${RUNTIME_SHUTDOWN_TIMEOUT_MS}ms shutdown timeout`
+            );
+            break;
+          }
           lastError = null;
           break;
         } catch (error) {
@@ -833,11 +879,12 @@ class CopilotClient {
       if (lastError) {
         errors.push(
           new Error(
-            `Failed to disconnect session ${sessionId} after 3 attempts: ${lastError.message}`
+            `Failed to disconnect session ${sessionId} after ${attempts} ${attempts === 1 ? "attempt" : "attempts"}: ${lastError.message}`
           )
         );
       }
     }
+    clearTimeout(detachDeadlineTimer);
     for (const session of activeSessions) {
       session._markDisconnected();
     }
@@ -888,7 +935,7 @@ class CopilotClient {
       this._rpc = null;
       this._internalRpc = null;
     }
-    this.modelsCache = null;
+    this.modelsCache = { models: null, lock: Promise.resolve() };
     if (this.socket) {
       const socket = this.socket;
       this.socket = null;
@@ -1050,7 +1097,7 @@ class CopilotClient {
       this._rpc = null;
       this._internalRpc = null;
     }
-    this.modelsCache = null;
+    this.modelsCache = { models: null, lock: Promise.resolve() };
     if (this.socket) {
       try {
         this.socket.destroy();
@@ -1107,7 +1154,7 @@ class CopilotClient {
    * // Session with model and tools
    * const session = await client.createSession({
    *   onPermissionRequest: approveAll,
-   *   model: "gpt-4",
+   *   model: "gpt-5.4",
    *   tools: [{
    *     name: "get_weather",
    *     description: "Get weather for a location",
@@ -2069,14 +2116,16 @@ class CopilotClient {
    * @throws Error if not connected (when no custom handler is set)
    */
   async listModels() {
-    await this.modelsCacheLock;
+    const cache = this.modelsCache;
+    const previousLock = cache.lock;
     let resolveLock;
-    this.modelsCacheLock = new Promise((resolve2) => {
+    cache.lock = new Promise((resolve2) => {
       resolveLock = resolve2;
     });
+    await previousLock;
     try {
-      if (this.modelsCache !== null) {
-        return [...this.modelsCache];
+      if (cache.models !== null) {
+        return [...cache.models];
       }
       let models;
       if (this.onListModels) {
@@ -2105,7 +2154,7 @@ class CopilotClient {
           }
         }
       }
-      this.modelsCache = [...models];
+      cache.models = [...models];
       return [...models];
     } finally {
       resolveLock();
@@ -2293,7 +2342,9 @@ class CopilotClient {
         gitRoot: context.gitRoot,
         repository: context.repository,
         branch: context.branch
-      } : void 0
+      } : void 0,
+      clientName: raw.clientName,
+      lastClientName: raw.lastClientName
     };
   }
   /**
@@ -2368,15 +2419,40 @@ class CopilotClient {
     };
   }
   /**
-   * Builds the environment for the spawned runtime child process (stdio/TCP): applies
-   * the auth token, connection token, `COPILOT_HOME`, keychain setting, and telemetry
-   * variables on top of the effective env. Not used by the in-process (FFI) transport,
-   * whose worker inherits the host process's ambient environment
-   * (see {@link CopilotClient.startInProcessFfi}).
+   * Builds runtime configuration for child processes and the per-host FFI snapshot.
+   * Typed auth, home, keychain, and telemetry options override the effective env.
    */
   buildRuntimeEnv() {
-    const env = { ...this.resolvedEnv };
+    const env = process.platform === "win32" ? Object.fromEntries(
+      Object.entries(this.resolvedEnv).map(([key, value]) => [
+        key.toUpperCase(),
+        value
+      ])
+    ) : { ...this.resolvedEnv };
     delete env.NODE_DEBUG;
+    const test = this.options.internalTestOptions;
+    if (test) {
+      const overrides = {
+        COPILOT_API_URL: test.copilotApiUrl,
+        COPILOT_DEBUG_GITHUB_API_URL: test.githubApiUrl,
+        HTTP_PROXY: test.proxyUrl,
+        HTTPS_PROXY: test.proxyUrl,
+        http_proxy: test.proxyUrl,
+        https_proxy: test.proxyUrl,
+        NO_PROXY: test.noProxy,
+        no_proxy: test.noProxy,
+        NODE_EXTRA_CA_CERTS: test.caCertificatePath,
+        SSL_CERT_FILE: test.caCertificatePath,
+        REQUESTS_CA_BUNDLE: test.caCertificatePath,
+        CURL_CA_BUNDLE: test.caCertificatePath,
+        GIT_SSL_CAINFO: test.caCertificatePath
+      };
+      for (const [key, value] of Object.entries(overrides)) {
+        if (value !== void 0) {
+          env[process.platform === "win32" ? key.toUpperCase() : key] = value;
+        }
+      }
+    }
     if (this.options.gitHubToken) {
       env.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken;
     }
@@ -2385,6 +2461,9 @@ class CopilotClient {
     }
     if (this.options.baseDirectory) {
       env.COPILOT_HOME = this.options.baseDirectory;
+      if (this.connectionConfig.kind === "inprocess") {
+        env.COPILOT_CACHE_HOME = join(this.options.baseDirectory, "cache");
+      }
     }
     if (this.options.mode === "empty") {
       env.COPILOT_DISABLE_KEYTAR = "1";
@@ -2411,7 +2490,7 @@ class CopilotClient {
    * Start the CLI server process
    */
   async startCLIServer() {
-    this.resolvedCliPath ??= await getBundledRuntimePath();
+    this.resolvedCliPath ??= await getSpawnableBundledRuntimePath();
     return new Promise((resolve2, reject) => {
       this.stderrBuffer = "";
       const args = [...this.connectionExtraArgs, "--headless", "--no-auto-update"];
@@ -2449,6 +2528,22 @@ class CopilotClient {
           `Copilot CLI not found at ${this.resolvedCliPath}. Set COPILOT_CLI_PATH to use a custom installation.`
         );
       }
+      const workingDirectory = this.options.workingDirectory;
+      let workingDirectoryProblem;
+      try {
+        workingDirectoryProblem = statSync(workingDirectory).isDirectory() ? void 0 : "does not exist or is not a directory";
+        if (!workingDirectoryProblem) {
+          accessSync(workingDirectory, constants.X_OK);
+        }
+      } catch (error) {
+        const code = error.code;
+        workingDirectoryProblem = code === "ENOENT" || code === "ENOTDIR" ? "does not exist or is not a directory" : `cannot be entered: ${error instanceof Error ? error.message : String(error)}`;
+      }
+      if (workingDirectoryProblem) {
+        throw new Error(
+          `Working directory ${workingDirectory} ${workingDirectoryProblem}.`
+        );
+      }
       const stdioConfig = this.connectionConfig.kind === "stdio" ? ["pipe", "pipe", "pipe"] : ["ignore", "pipe", "pipe"];
       const isJsFile = this.resolvedCliPath.endsWith(".js");
       if (isJsFile) {
@@ -2600,16 +2695,7 @@ stderr: ${this.stderrBuffer.trim().slice(-8192) || "(empty)"}`
       runtimeLibrary = join(dirname(bundledRuntimePath), "runtime.node");
     }
     const { FfiRuntimeHost } = await import("./ffiRuntimeHost.js");
-    const environment = {};
-    if (this.options.gitHubToken) {
-      environment.COPILOT_SDK_AUTH_TOKEN = this.options.gitHubToken;
-    }
-    if (this.options.baseDirectory) {
-      environment.COPILOT_HOME = this.options.baseDirectory;
-    }
-    if (this.options.mode === "empty") {
-      environment.COPILOT_DISABLE_KEYTAR = "1";
-    }
+    const environment = this.buildRuntimeEnv();
     const args = [];
     if (this.options.logLevel) {
       args.push("--log-level", this.options.logLevel);
@@ -2870,6 +2956,14 @@ stderr: ${stderrOutput}` : ""}`
       "skillProvider.list",
       async (params, token) => await this.resolveSkillProviderSession(params)._handleSkillProviderList(token)
     );
+    this.connection.onRequest(
+      "sessionManagement.create",
+      async (params, token) => {
+        const session = this.sessions.get(params.sessionId);
+        if (!session) throw new Error("Session creation owner is unavailable");
+        return await session._handleSessionManagementCreate(params, token);
+      }
+    );
     this.connection.onRequest(
       "skillProvider.read",
       async (params, token) => {
@@ -2907,7 +3001,7 @@ stderr: ${stderrOutput}` : ""}`
       this.messageWriter = null;
       this._rpc = null;
       this._internalRpc = null;
-      this.modelsCache = null;
+      this.modelsCache = { models: null, lock: Promise.resolve() };
     };
     const disconnectAfterDrain = () => {
       if (exitFallback !== void 0) {
@@ -2942,7 +3036,10 @@ stderr: ${stderrOutput}` : ""}`
         exitFallback.unref?.();
       });
     }
-    this.connection.onError(() => {
+    this.connection.onError(([error]) => {
+      if (messageEncodeErrors.has(error)) {
+        return;
+      }
       if (connectionEpoch === this.connectionEpoch && this.connection === connection) {
         this.state = "disconnected";
       }
@@ -3003,7 +3100,8 @@ stderr: ${stderrOutput}` : ""}`
     const result = await session._handleUserInputRequest({
       question: params.question,
       choices: params.choices,
-      allowFreeform: params.allowFreeform
+      allowFreeform: params.allowFreeform,
+      requestId: params.requestId
     });
     return result;
   }
@@ -3019,7 +3117,8 @@ stderr: ${stderrOutput}` : ""}`
       summary: params.summary,
       planContent: params.planContent,
       actions: params.actions,
-      recommendedAction: params.recommendedAction
+      recommendedAction: params.recommendedAction,
+      requestId: params.requestId
     });
   }
   async handleAutoModeSwitchRequest(params) {

package/dist/copilotRequestHandler.js

@@ -82,7 +82,9 @@ class CopilotWebSocketForwarder extends CopilotWebSocketHandler {
     if (this.#upstream) {
       return;
     }
-    const upstream = new WebSocket(this.context.url);
+    const upstream = new WebSocket(this.context.url, {
+      headers: forwardedRequestHeaders(this.context.headers)
+    });
     upstream.binaryType = "arraybuffer";
     this.#upstream = upstream;
     upstream.addEventListener("message", (event) => {
@@ -122,13 +124,16 @@ class CopilotWebSocketForwarder extends CopilotWebSocketHandler {
     });
   }
   async close(status = CopilotWebSocketCloseStatus.normalClosure) {
+    const upstream = this.#upstream;
+    this.#upstream = null;
+    const completion = super.close(status);
     try {
-      if (this.#upstream?.readyState === WebSocket.OPEN || this.#upstream?.readyState === WebSocket.CONNECTING) {
-        this.#upstream?.close();
+      if (upstream?.readyState === WebSocket.OPEN || upstream?.readyState === WebSocket.CONNECTING) {
+        upstream.close();
       }
     } catch {
     }
-    await super.close(status);
+    await completion;
   }
   async [Symbol.asyncDispose]() {
     try {
@@ -467,19 +472,24 @@ const FORBIDDEN_REQUEST_HEADERS = /* @__PURE__ */ new Set([
   "te",
   "trailer"
 ]);
-async function buildFetchRequest(exchange) {
+function forwardedRequestHeaders(source) {
   const headers = new Headers();
-  for (const [name, values] of Object.entries(exchange.headers)) {
+  for (const [name, values] of Object.entries(source)) {
     if (!values) {
       continue;
     }
-    if (FORBIDDEN_REQUEST_HEADERS.has(name.toLowerCase())) {
+    const lower = name.toLowerCase();
+    if (FORBIDDEN_REQUEST_HEADERS.has(lower) || lower.startsWith("sec-websocket-")) {
       continue;
     }
     for (const value of values) {
       headers.append(name, value);
     }
   }
+  return headers;
+}
+async function buildFetchRequest(exchange) {
+  const headers = forwardedRequestHeaders(exchange.headers);
   const method = exchange.method.toUpperCase();
   const hasBody = method !== "GET" && method !== "HEAD";
   let body;

package/dist/generated/lifecycle-diagnostics.d.ts

@@ -116,6 +116,10 @@ export interface RuntimeLifecycleProgressStateDiagnosticEvent {
  * Experimental, observational-only state of runtime progress and the lifecycle operations that block it. Observation and delivery never control runtime or model behavior. Process death, diagnostic projection loss, transport loss, or serialization failure can prevent external delivery.
  */
 export interface RuntimeLifecycleProgressStateData {
+    /**
+     * Agent that owns this progress. Absent for the primary agent and progress without an agent owner.
+     */
+    agentId?: string;
     /**
      * Complete dependency blocker set after this progress change.
      */