Add sb.terminate({ wait: true }) parameter to JS (#277)

Author: ehdr

modal-js/src/index.ts

@@ -63,6 +63,7 @@ export { Retries } from "./retries";
 export type {
   SandboxExecParams,
   SandboxFromNameParams,
+  SandboxTerminateParams,
   SandboxCreateConnectCredentials,
   SandboxCreateConnectTokenParams,
   StdioBehavior,

modal-js/src/sandbox.ts

@@ -579,6 +579,11 @@ export type SandboxExecParams = {
 };
 
 /** Optional parameters for {@link Sandbox#createConnectToken Sandbox.createConnectToken()}. */
+export type SandboxTerminateParams = {
+  /** If true, wait for the Sandbox to finish and return the exit code. */
+  wait?: boolean;
+};
+
 export type SandboxCreateConnectTokenParams = {
   /** Optional user-provided metadata string that will be added to the headers by the proxy when forwarding requests to the Sandbox. */
   userMetadata?: string;
@@ -1018,11 +1023,20 @@ export class Sandbox {
     return { url: resp.url, token: resp.token };
   }
 
-  async terminate(): Promise<void> {
+  async terminate(): Promise<void>;
+  async terminate(params: { wait: true }): Promise<number>;
+  async terminate(params?: SandboxTerminateParams): Promise<number | void> {
     this.#ensureAttached();
     await this.#client.cpClient.sandboxTerminate({ sandboxId: this.sandboxId });
-    this.#taskId = undefined; // Reset task ID after termination
+
+    let exitCode: number | undefined;
+    if (params?.wait) {
+      exitCode = await this.wait();
+    }
+
+    this.#taskId = undefined;
     this.detach();
+    return exitCode;
   }
 
   /**

modal-js/test/legacy/proxy.test.ts

@@ -1,4 +1,4 @@
-import { App, Proxy, Sandbox } from "modal";
+import { App, Proxy } from "modal";
 import { expect, test } from "vitest";
 
 test("CreateSandboxWithProxy", async () => {
@@ -17,10 +17,7 @@ test("CreateSandboxWithProxy", async () => {
   });
   expect(sb.sandboxId).toBeTruthy();
 
-  await sb.terminate();
-
-  const sbFromId = await Sandbox.fromId(sb.sandboxId);
-  expect(await sbFromId.wait()).toBe(137);
+  expect(await sb.terminate({ wait: true })).toBe(137);
 });
 
 test("ProxyNotFound", async () => {

modal-js/test/legacy/sandbox.test.ts

@@ -14,10 +14,7 @@ test("CreateOneSandbox", async () => {
 
   const sb = await app.createSandbox(image);
   expect(sb.sandboxId).toBeTruthy();
-  await sb.terminate();
-
-  const sbFromId = await Sandbox.fromId(sb.sandboxId);
-  expect(await sbFromId.wait()).toBe(137);
+  expect(await sb.terminate({ wait: true })).toBe(137);
 });
 
 test("PassCatToStdin", async () => {

modal-js/test/sandbox.test.ts

@@ -25,10 +25,7 @@ test("CreateOneSandbox", async () => {
 
   const sb = await tc.sandboxes.create(app, image);
   expect(sb.sandboxId).toBeTruthy();
-  await sb.terminate();
-
-  const sbFromId = await tc.sandboxes.fromId(sb.sandboxId);
-  expect(await sbFromId.wait()).toBe(137);
+  expect(await sb.terminate({ wait: true })).toBe(137);
 });
 
 test("PassCatToStdin", async () => {