Add detach everywhere

thomasjpfan · thomasjpfan · commit f9c6f6c94b04 · 2026-01-28T18:45:31.000Z
diff --git a/modal-go/examples/image-building/main.go b/modal-go/examples/image-building/main.go
@@ -44,6 +44,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	fmt.Println("Created Sandbox with ID:", sb.SandboxID)
diff --git a/modal-go/examples/sandbox-agent/main.go b/modal-go/examples/sandbox-agent/main.go
@@ -36,6 +36,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	repoURL := "https://github.com/modal-labs/libmodal"
diff --git a/modal-go/examples/sandbox-cloud-bucket/main.go b/modal-go/examples/sandbox-cloud-bucket/main.go
@@ -51,6 +51,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	fmt.Printf("S3 Sandbox: %s\n", sb.SandboxID)
diff --git a/modal-go/examples/sandbox-connect-token/main.go b/modal-go/examples/sandbox-connect-token/main.go
@@ -36,6 +36,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	creds, err := sb.CreateConnectToken(ctx, &modal.SandboxCreateConnectTokenParams{UserMetadata: "abc"})
diff --git a/modal-go/examples/sandbox-exec/main.go b/modal-go/examples/sandbox-exec/main.go
@@ -32,6 +32,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	p, err := sb.Exec(ctx,
diff --git a/modal-go/examples/sandbox-filesystem-snapshot/main.go b/modal-go/examples/sandbox-filesystem-snapshot/main.go
@@ -33,6 +33,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	_, err = sb.Exec(ctx, []string{"mkdir", "-p", "/app/data"}, nil)
@@ -57,6 +60,9 @@ func main() {
 		log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 	}
 	fmt.Println("Terminated first Sandbox")
+	if err := sb.Detach(); err != nil {
+		log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+	}
 
 	// Create new Sandbox from snapshot Image
 	sb2, err := mc.Sandboxes.Create(ctx, app, snapshotImage, nil)
@@ -69,6 +75,9 @@ func main() {
 		if err := sb2.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb2.SandboxID, err)
 		}
+		if err := sb2.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	proc, err := sb2.Exec(ctx, []string{"cat", "/app/data/info.txt"}, nil)
diff --git a/modal-go/examples/sandbox-filesystem/main.go b/modal-go/examples/sandbox-filesystem/main.go
@@ -33,6 +33,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	// Write a file
diff --git a/modal-go/examples/sandbox-gpu/main.go b/modal-go/examples/sandbox-gpu/main.go
@@ -34,6 +34,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	fmt.Println("Running `nvidia-smi` in Sandbox:")
diff --git a/modal-go/examples/sandbox-image-mount/main.go b/modal-go/examples/sandbox-image-mount/main.go
@@ -52,6 +52,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 	fmt.Printf("Started first Sandbox: %s\n", sb.SandboxID)
 
@@ -93,6 +96,9 @@ func main() {
 	if err := sb.Terminate(ctx); err != nil {
 		log.Fatalf("Failed to terminate Sandbox: %v", err)
 	}
+	if err := sb.Detach(); err != nil {
+		log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+	}
 
 	// Start a new Sandbox, and mount the repo directory:
 	sb2, err := mc.Sandboxes.Create(ctx, app, baseImage, nil)
diff --git a/modal-go/examples/sandbox-named/main.go b/modal-go/examples/sandbox-named/main.go
@@ -36,6 +36,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	fmt.Printf("Created Sandbox with name: %s\n", sandboxName)
diff --git a/modal-go/examples/sandbox-poll/main.go b/modal-go/examples/sandbox-poll/main.go
@@ -34,6 +34,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	initialPoll, err := sb.Poll(ctx)
diff --git a/modal-go/examples/sandbox-prewarm/main.go b/modal-go/examples/sandbox-prewarm/main.go
@@ -48,6 +48,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 	fmt.Printf("Sandbox: %s\n", sb.SandboxID)
 }
diff --git a/modal-go/examples/sandbox-private-image/main.go b/modal-go/examples/sandbox-private-image/main.go
@@ -41,6 +41,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	_, err = sb.Stdin.Write([]byte("this is input that should be mirrored by the Python one-liner"))
diff --git a/modal-go/examples/sandbox-proxy/main.go b/modal-go/examples/sandbox-proxy/main.go
@@ -40,6 +40,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	p, err := sb.Exec(ctx, []string{"curl", "-s", "ifconfig.me"}, nil)
diff --git a/modal-go/examples/sandbox-secrets/main.go b/modal-go/examples/sandbox-secrets/main.go
@@ -45,6 +45,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	output, err := io.ReadAll(sb.Stdout)
diff --git a/modal-go/examples/sandbox-tunnels/main.go b/modal-go/examples/sandbox-tunnels/main.go
@@ -39,6 +39,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	fmt.Printf("Sandbox created: %s\n", sb.SandboxID)
diff --git a/modal-go/examples/sandbox/main.go b/modal-go/examples/sandbox/main.go
@@ -34,6 +34,9 @@ func main() {
 		if err := sb.Terminate(context.Background()); err != nil {
 			log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)
 		}
+		if err := sb.Detach(); err != nil {
+			log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)
+		}
 	}()
 
 	sbFromID, err := mc.Sandboxes.FromID(ctx, sb.SandboxID)
diff --git a/modal-go/sandbox.go b/modal-go/sandbox.go
@@ -360,10 +360,8 @@ func (t *Tunnel) TCPSocket() (string, int, error) {
 }
 
 // Sandbox represents a Modal Sandbox, which can run commands and manage
-// input/output streams for a remote process. After creating a sandbox, make sure
-// to either call [Sandbox.Detach] or [Sandbox.Terminate]:
-//   - [Sandbox.Detach] keeps the sandbox running and disconnects your client from communicating with the sandbox.
-//   - [Sandbox.Terminate] stops the sandbox from running and disconnects your client from communicating with the sandbox.
+// input/output streams for a remote process. After you are done interacting with the sandbox,
+// we recommend calling [Sandbox.Detach] which disconnects your client from the sandbox.
 type Sandbox struct {
 	SandboxID string
 	Stdin     io.WriteCloser
diff --git a/modal-go/test/sandbox_test.go b/modal-go/test/sandbox_test.go
@@ -880,7 +880,12 @@ func TestSandboxDetachIsIdempotent(t *testing.T) {
 
 	sb, err := tc.Sandboxes.Create(ctx, app, image, nil)
 	g.Expect(err).ToNot(gomega.HaveOccurred())
-	defer terminateSandbox(g, sb)
+	sbFromID, err := tc.Sandboxes.FromID(ctx, sb.SandboxID)
+	g.Expect(err).ToNot(gomega.HaveOccurred())
+	defer func() {
+		terminateSandbox(g, sbFromID)
+		_ = sbFromID.Detach()
+	}()
 
 	err = sb.Detach()
 	g.Expect(err).ToNot(gomega.HaveOccurred())
@@ -924,7 +929,12 @@ func TestSandboxDetachForbidsAllOperations(t *testing.T) {
 
 	sb, err := tc.Sandboxes.Create(ctx, app, image, nil)
 	g.Expect(err).ToNot(gomega.HaveOccurred())
-	defer terminateSandbox(g, sb)
+	sbFromID, err := tc.Sandboxes.FromID(ctx, sb.SandboxID)
+	g.Expect(err).ToNot(gomega.HaveOccurred())
+	defer func() {
+		terminateSandbox(g, sbFromID)
+		_ = sbFromID.Detach()
+	}()
 
 	err = sb.Detach()
 	g.Expect(err).ToNot(gomega.HaveOccurred())
diff --git a/modal-go/test/testutils_test.go b/modal-go/test/testutils_test.go
@@ -43,4 +43,6 @@ func newGRPCMockClient(t *testing.T) *grpcmock.MockClient {
 func terminateSandbox(g *gomega.WithT, sb *modal.Sandbox) {
 	err := sb.Terminate(context.Background())
 	g.Expect(err).ShouldNot(gomega.HaveOccurred())
+	err = sb.Detach()
+	g.Expect(err).ShouldNot(gomega.HaveOccurred())
 }

Original file line number	Diff line number	Diff line change
`@@ -44,6 +44,9 @@ func main() {`
`44`	`44`	`if err := sb.Terminate(context.Background()); err != nil {`
`45`	`45`	`log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)`
`46`	`46`	`}`
	`47`	`+ if err := sb.Detach(); err != nil {`
	`48`	`+ log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)`
	`49`	`+ }`
`47`	`50`	`}()`
`48`	`51`
`49`	`52`	`fmt.Println("Created Sandbox with ID:", sb.SandboxID)`
Original file line number	Diff line number	Diff line change
`@@ -36,6 +36,9 @@ func main() {`
`36`	`36`	`if err := sb.Terminate(context.Background()); err != nil {`
`37`	`37`	`log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)`
`38`	`38`	`}`
	`39`	`+ if err := sb.Detach(); err != nil {`
	`40`	`+ log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)`
	`41`	`+ }`
`39`	`42`	`}()`
`40`	`43`
`41`	`44`	`repoURL := "https://github.com/modal-labs/libmodal"`
Original file line number	Diff line number	Diff line change
`@@ -51,6 +51,9 @@ func main() {`
`51`	`51`	`if err := sb.Terminate(context.Background()); err != nil {`
`52`	`52`	`log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)`
`53`	`53`	`}`
	`54`	`+ if err := sb.Detach(); err != nil {`
	`55`	`+ log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)`
	`56`	`+ }`
`54`	`57`	`}()`
`55`	`58`
`56`	`59`	`fmt.Printf("S3 Sandbox: %s\n", sb.SandboxID)`
Original file line number	Diff line number	Diff line change
`@@ -32,6 +32,9 @@ func main() {`
`32`	`32`	`if err := sb.Terminate(context.Background()); err != nil {`
`33`	`33`	`log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)`
`34`	`34`	`}`
	`35`	`+ if err := sb.Detach(); err != nil {`
	`36`	`+ log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)`
	`37`	`+ }`
`35`	`38`	`}()`
`36`	`39`
`37`	`40`	`p, err := sb.Exec(ctx,`
Original file line number	Diff line number	Diff line change
`@@ -33,6 +33,9 @@ func main() {`
`33`	`33`	`if err := sb.Terminate(context.Background()); err != nil {`
`34`	`34`	`log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)`
`35`	`35`	`}`
	`36`	`+ if err := sb.Detach(); err != nil {`
	`37`	`+ log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)`
	`38`	`+ }`
`36`	`39`	`}()`
`37`	`40`
`38`	`41`	`// Write a file`
Original file line number	Diff line number	Diff line change
`@@ -34,6 +34,9 @@ func main() {`
`34`	`34`	`if err := sb.Terminate(context.Background()); err != nil {`
`35`	`35`	`log.Fatalf("Failed to terminate Sandbox %s: %v", sb.SandboxID, err)`
`36`	`36`	`}`
	`37`	`+ if err := sb.Detach(); err != nil {`
	`38`	`+ log.Fatalf("Failed to detach Sandbox %s: %v", sb.SandboxID, err)`
	`39`	`+ }`
`37`	`40`	`}()`
`38`	`41`
`39`	`42`	fmt.Println("Running `nvidia-smi` in Sandbox:")