@github/copilot-sdk 1.0.0 → 1.0.2-preview.0

package/dist/client.js

@@ -24,9 +24,54 @@ import { getTraceContext } from "./telemetry.js";
 import { ToolSet } from "./toolSet.js";
 import { defaultJoinSessionPermissionHandler } from "./types.js";
 const MIN_PROTOCOL_VERSION = 3;
+const RUNTIME_SHUTDOWN_TIMEOUT_MS = 1e4;
 function isZodSchema(value) {
   return value != null && typeof value === "object" && "toJSONSchema" in value && typeof value.toJSONSchema === "function";
 }
+async function withTimeout(promise, timeoutMs, message) {
+  let timeout;
+  try {
+    return await Promise.race([
+      promise,
+      new Promise((_, reject) => {
+        timeout = setTimeout(() => reject(new Error(message)), timeoutMs);
+      })
+    ]);
+  } finally {
+    if (timeout !== void 0) {
+      clearTimeout(timeout);
+    }
+  }
+}
+async function waitForChildExit(child, timeoutMs) {
+  if (child.exitCode != null || child.signalCode != null) {
+    return true;
+  }
+  return new Promise((resolve) => {
+    let timeout;
+    let settled = false;
+    const onExit = () => {
+      if (settled) {
+        return;
+      }
+      settled = true;
+      clearTimeout(timeout);
+      resolve(true);
+    };
+    timeout = setTimeout(() => {
+      if (settled) {
+        return;
+      }
+      settled = true;
+      child.off("exit", onExit);
+      resolve(false);
+    }, timeoutMs);
+    child.once("exit", onExit);
+    if (child.exitCode != null || child.signalCode != null) {
+      onExit();
+    }
+  });
+}
 function toJsonSchema(parameters) {
   if (!parameters) return void 0;
   if (isZodSchema(parameters)) {
@@ -190,6 +235,13 @@ class CopilotClient {
     }
     return this._internalRpc;
   }
+  logDebugTiming(message, startMs) {
+    const level = this.options.logLevel?.toLowerCase();
+    if (level === "debug" || level === "all") {
+      process.stderr.write(`[copilot-sdk] ${message}. Elapsed=${Date.now() - startMs}ms
+`);
+    }
+  }
   /**
    * Creates a new CopilotClient instance.
    *
@@ -376,8 +428,9 @@ class CopilotClient {
    *
    * This method performs graceful cleanup:
    * 1. Closes all active sessions (releases in-memory resources)
-   * 2. Closes the JSON-RPC connection
-   * 3. Terminates the CLI server process (if spawned by this client)
+   * 2. Requests runtime shutdown for SDK-owned CLI processes
+   * 3. Closes the JSON-RPC connection
+   * 4. Terminates the CLI server process (if spawned by this client)
    *
    * Note: session data on disk is preserved, so sessions can be resumed later.
    * To permanently remove session data before stopping, call
@@ -421,6 +474,34 @@ class CopilotClient {
       }
     }
     this.sessions.clear();
+    let runtimeShutdownCompleted = false;
+    if (this.connection && this.cliProcess && !this.isExternalServer) {
+      const runtimeShutdownStart = Date.now();
+      const shutdownPromise = this.rpc.runtime.shutdown();
+      void shutdownPromise.catch(() => void 0);
+      try {
+        await withTimeout(
+          shutdownPromise,
+          RUNTIME_SHUTDOWN_TIMEOUT_MS,
+          `runtime.shutdown timed out after ${RUNTIME_SHUTDOWN_TIMEOUT_MS}ms`
+        );
+        runtimeShutdownCompleted = true;
+        this.logDebugTiming(
+          "CopilotClient.stop runtime shutdown complete",
+          runtimeShutdownStart
+        );
+      } catch (error) {
+        this.logDebugTiming(
+          "CopilotClient.stop runtime shutdown failed",
+          runtimeShutdownStart
+        );
+        errors.push(
+          new Error(
+            `Failed to gracefully shut down runtime: ${error instanceof Error ? error.message : String(error)}`
+          )
+        );
+      }
+    }
     if (this.connection) {
       try {
         this.connection.dispose();
@@ -433,6 +514,7 @@ class CopilotClient {
       }
       this.connection = null;
       this._rpc = null;
+      this._internalRpc = null;
     }
     this.modelsCache = null;
     if (this.socket) {
@@ -457,12 +539,18 @@ class CopilotClient {
       const child = this.cliProcess;
       this.cliProcess = null;
       try {
-        if (child.exitCode === null && child.signalCode === null) {
-          const exited = new Promise((resolve) => {
-            child.once("exit", () => resolve());
-          });
-          child.kill();
-          await exited;
+        if (child.exitCode == null && child.signalCode == null) {
+          const exitedGracefully = runtimeShutdownCompleted ? await waitForChildExit(child, RUNTIME_SHUTDOWN_TIMEOUT_MS) : false;
+          if (!exitedGracefully) {
+            child.kill();
+            if (!await waitForChildExit(child, RUNTIME_SHUTDOWN_TIMEOUT_MS)) {
+              errors.push(
+                new Error(
+                  `Timed out waiting for CLI process to exit after kill: ${RUNTIME_SHUTDOWN_TIMEOUT_MS}ms`
+                )
+              );
+            }
+          }
         }
       } catch (error) {
         errors.push(
@@ -532,6 +620,7 @@ class CopilotClient {
       }
       this.connection = null;
       this._rpc = null;
+      this._internalRpc = null;
     }
     this.modelsCache = null;
     if (this.socket) {
@@ -624,7 +713,8 @@ class CopilotClient {
         enableFileHooks: false,
         enableHostGitOperations: false,
         enableSessionStore: false,
-        enableSkills: false
+        enableSkills: false,
+        memory: { enabled: false }
       };
     }
     return {};
@@ -774,7 +864,8 @@ class CopilotClient {
           description: tool.description,
           parameters: toJsonSchema(tool.parameters),
           overridesBuiltInTool: tool.overridesBuiltInTool,
-          skipPermission: tool.skipPermission
+          skipPermission: tool.skipPermission,
+          defer: tool.defer
         })),
         canvases: config.canvases?.map((canvas) => canvas.declaration),
         requestCanvasRenderer: config.requestCanvasRenderer,
@@ -824,6 +915,7 @@ class CopilotClient {
         instructionDirectories: config.instructionDirectories,
         disabledSkills: config.disabledSkills,
         infiniteSessions: config.infiniteSessions,
+        memory: config.memory,
         gitHubToken: config.gitHubToken,
         remoteSession: config.remoteSession,
         cloud: config.cloud
@@ -942,7 +1034,8 @@ class CopilotClient {
           description: tool.description,
           parameters: toJsonSchema(tool.parameters),
           overridesBuiltInTool: tool.overridesBuiltInTool,
-          skipPermission: tool.skipPermission
+          skipPermission: tool.skipPermission,
+          defer: tool.defer
         })),
         canvases: config.canvases?.map((canvas) => canvas.declaration),
         requestCanvasRenderer: config.requestCanvasRenderer,
@@ -987,6 +1080,7 @@ class CopilotClient {
         instructionDirectories: config.instructionDirectories,
         disabledSkills: config.disabledSkills,
         infiniteSessions: config.infiniteSessions,
+        memory: config.memory,
         disableResume: config.suppressResumeEvent,
         continuePendingWork: config.continuePendingWork,
         gitHubToken: config.gitHubToken,
@@ -1389,6 +1483,8 @@ class CopilotClient {
         envWithoutNodeDebug.COPILOT_OTEL_ENABLED = "true";
         if (t.otlpEndpoint !== void 0)
           envWithoutNodeDebug.OTEL_EXPORTER_OTLP_ENDPOINT = t.otlpEndpoint;
+        if (t.otlpProtocol !== void 0)
+          envWithoutNodeDebug.OTEL_EXPORTER_OTLP_PROTOCOL = t.otlpProtocol;
         if (t.filePath !== void 0)
           envWithoutNodeDebug.COPILOT_OTEL_FILE_EXPORTER_PATH = t.filePath;
         if (t.exporterType !== void 0)