feat(sdk,cli): allow mounting drive from snapshot

Author: QuiiBz

.changeset/ten-states-watch.md

@@ -0,0 +1,15 @@
+---
+"@vercel/sandbox": minor
+"@vercel/sandbox-mock": minor
+"sandbox": minor
+---
+
+`read-only` mounts have been replaced by snapshots: you can now mount the same drive on many sandboxes at once, using read-only snapshots:
+
+```ts
+await Sandbox.create({
+  mounts: {
+    '/data': drive.snapshot()
+  }
+})
+```

packages/sandbox/docs/index.md

@@ -92,7 +92,7 @@ Options:
     --snapshot, -s <snapshot_id>               Start the sandbox from a snapshot ID [optional]
     --env <key=value>, -e=<key=value>          Environment variables to set for the command
     --tag <key=value>, -t=<key=value>          Key-value tags to associate with the sandbox (e.g. --tag env=staging)
-    --mount <drive:path[:mode]>                Attach a drive to the sandbox. Format: "drive:/path[:read-only|read-write]".
+    --mount <drive:path[:mode]>                Attach a drive to the sandbox. Format: "drive:/path[:snapshot|read-write]".
     --region <REGION>                          Region to create the sandbox in (defaults to iad1; any Vercel region is supported, e.g. sfo1, fra1, hnd1, syd1) [optional]
     --failover-regions <REGION,...|none>       Comma-separated regions the sandbox can fail over to (e.g. --failover-regions sfo1,fra1). Must not include the sandbox region. Pass "none" for no failover regions, overriding the project default. [optional]
     --snapshot-expiration <DURATION|none>      Default snapshot expiration. Use "none" or 0 for no expiration. Example: 7d, 30d [optional]
@@ -153,7 +153,7 @@ Options:
     --snapshot, -s <snapshot_id>               Start the sandbox from a snapshot ID [optional]
     --env <key=value>, -e=<key=value>          Default environment variables for sandbox commands
     --tag <key=value>, -t=<key=value>          Key-value tags to associate with the sandbox (e.g. --tag env=staging)
-    --mount <drive:path[:mode]>                Attach a drive to the sandbox. Format: "drive:/path[:read-only|read-write]".
+    --mount <drive:path[:mode]>                Attach a drive to the sandbox. Format: "drive:/path[:snapshot|read-write]".
     --region <REGION>                          Region to create the sandbox in (defaults to iad1; any Vercel region is supported, e.g. sfo1, fra1, hnd1, syd1) [optional]
     --failover-regions <REGION,...|none>       Comma-separated regions the sandbox can fail over to (e.g. --failover-regions sfo1,fra1). Must not include the sandbox region. Pass "none" for no failover regions, overriding the project default. [optional]
     --snapshot-expiration <DURATION|none>      Default snapshot expiration. Use "none" or 0 for no expiration. Example: 7d, 30d [optional]
@@ -208,7 +208,7 @@ Options:
     --snapshot, -s <snapshot_id>               Start the sandbox from a snapshot ID [optional]
     --env <key=value>, -e=<key=value>          Default environment variables for sandbox commands
     --tag <key=value>, -t=<key=value>          Key-value tags to associate with the sandbox (e.g. --tag env=staging)
-    --mount <drive:path[:mode]>                Attach a drive to the sandbox. Format: "drive:/path[:read-only|read-write]".
+    --mount <drive:path[:mode]>                Attach a drive to the sandbox. Format: "drive:/path[:snapshot|read-write]".
     --region <REGION>                          Region to create the sandbox in (defaults to iad1; any Vercel region is supported, e.g. sfo1, fra1, hnd1, syd1) [optional]
     --failover-regions <REGION,...|none>       Comma-separated regions the sandbox can fail over to (e.g. --failover-regions sfo1,fra1). Must not include the sandbox region. Pass "none" for no failover regions, overriding the project default. [optional]
     --snapshot-expiration <DURATION|none>      Default snapshot expiration. Use "none" or 0 for no expiration. Example: 7d, 30d [optional]

packages/sandbox/src/args/drive.ts

@@ -1,14 +1,14 @@
 import * as cmd from "cmd-ts";
 import chalk from "chalk";
-import type { SandboxMountMode, SandboxMounts } from "@vercel/sandbox";
+import type { SandboxMountMode, Sandbox } from "@vercel/sandbox";
 
 export interface DriveMount {
   drive: string;
   path: string;
   mode?: SandboxMountMode;
 }
 
-export type DriveMounts = SandboxMounts;
+export type DriveMounts = NonNullable<Sandbox["mounts"]>;
 
 export const driveName = cmd.extendType(cmd.string, {
   displayName: "name",
@@ -25,7 +25,7 @@ export const driveName = cmd.extendType(cmd.string, {
 export const driveMount = cmd.extendType(cmd.string, {
   displayName: "drive:path[:mode]",
   description:
-    'Drive mount in the format "drive:/path[:read-only|read-write]".',
+    'Drive mount in the format "drive:/path[:snapshot|read-write]".',
   async from(input) {
     return parseDriveMount(input);
   },
@@ -36,7 +36,13 @@ export const driveMounts = cmd.extendType(cmd.array(driveMount), {
     const mounts: DriveMounts = Object.create(null);
 
     for (const mount of input) {
-      mounts[mount.path] = { drive: mount.drive, mode: mount.mode };
+      mounts[mount.path] = {
+        name: mount.drive,
+        mode:
+          mount.mode === "read-only"
+            ? "snapshot"
+            : (mount.mode ?? "read-write"),
+      };
     }
 
     return mounts;
@@ -47,7 +53,7 @@ export const mounts = cmd.multioption({
   long: "mount",
   type: driveMounts,
   description:
-    'Attach a drive to the sandbox. Format: "drive:/path[:read-only|read-write]".',
+    'Attach a drive to the sandbox. Format: "drive:/path[:snapshot|read-write]".',
 });
 
 export const driveMaxSize = cmd.extendType(cmd.number, {
@@ -75,18 +81,22 @@ export const driveRegion = cmd.extendType(cmd.string, {
 
 export function parseDriveMount(input: string): DriveMount {
   const [drive, path, mode, ...rest] = input.split(":");
-  const validModes: SandboxMountMode[] = ["read-only", "read-write"];
+  const validModes: SandboxMountMode[] = ["snapshot", "read-write"];
 
   if (rest.length > 0 || !drive || path === undefined) {
     throw new Error(
       [
         `Invalid drive mount: ${input}.`,
-        `${chalk.bold("hint:")} Use "drive:/path" or "drive:/path:read-only".`,
+        `${chalk.bold("hint:")} Use "drive:/path" or "drive:/path:snapshot".`,
       ].join("\n"),
     );
   }
 
-  if (mode !== undefined && !validModes.includes(mode as SandboxMountMode)) {
+  if (
+    mode !== undefined &&
+    mode !== "read-only" &&
+    !validModes.includes(mode as SandboxMountMode)
+  ) {
     throw new Error(
       [
         `Invalid drive mount mode: ${mode}.`,

packages/sandbox/src/commands/config.ts

@@ -841,7 +841,7 @@ function formatMounts(mounts: Sandbox["mounts"]): string {
     return "-";
   }
   return entries
-    .map(([path, { drive, mode }]) => `${drive}:${path}:${mode ?? "read-write"}`)
+    .map(([path, { name, mode }]) => `${name}:${path}:${mode ?? "read-write"}`)
     .join(", ");
 }
 

packages/sandbox/src/commands/list.ts

@@ -196,14 +196,14 @@ const SandboxStatusColor: Record<Sandbox["status"], ChalkInstance> = {
   aborted: chalk.gray.dim,
 };
 
-function formatMounts(
-  mounts: Record<string, { drive: string; mode?: "read-only" | "read-write" }> | undefined,
-): string {
+function formatMounts(mounts: Sandbox["mounts"]): string {
   if (!mounts || Object.keys(mounts).length === 0) {
     return "-";
   }
 
   return Object.entries(mounts)
-    .map(([path, mount]) => `${mount.drive}:${path}:${mount.mode ?? "read-write"}`)
+    .map(
+      ([path, mount]) => `${mount.name}:${path}:${mount.mode ?? "read-write"}`,
+    )
     .join(", ");
 }

packages/sandbox/test/args/drive.test.ts

@@ -6,6 +6,17 @@ import {
 } from "../../src/args/drive";
 
 describe("drive arguments", () => {
+  test("accepts read-only as a snapshot alias", async () => {
+    expect(parseDriveMount("cache:/data:read-only")).toEqual({
+      drive: "cache",
+      path: "/data",
+      mode: "read-only",
+    });
+    await expect(driveMounts.from(["cache:/data:read-only"])).resolves.toEqual({
+      "/data": { name: "cache", mode: "snapshot" },
+    });
+  });
+
   test("parses and trims a drive region", async () => {
     await expect(driveRegion.from(" sfo1 ")).resolves.toBe("sfo1");
   });
@@ -24,11 +35,11 @@ describe("drive arguments", () => {
     });
   });
 
-  test("parses read-only drive mounts", () => {
-    expect(parseDriveMount("cache:/data:read-only")).toEqual({
+  test("parses snapshot drive mounts", () => {
+    expect(parseDriveMount("cache:/data:snapshot")).toEqual({
       drive: "cache",
       path: "/data",
-      mode: "read-only",
+      mode: "snapshot",
     });
   });
 
@@ -44,8 +55,8 @@ describe("drive arguments", () => {
     await expect(
       driveMounts.from(["cache:/data", "nested-cache:/data/cache"]),
     ).resolves.toEqual({
-      "/data": { drive: "cache", mode: undefined },
-      "/data/cache": { drive: "nested-cache", mode: undefined },
+      "/data": { name: "cache", mode: "read-write" },
+      "/data/cache": { name: "nested-cache", mode: "read-write" },
     });
   });
 });

packages/sandbox/test/commands/config.test.ts

@@ -80,16 +80,16 @@ describe("config command", () => {
     await cmd.run(config, [
       "mounts",
       "my-sandbox",
-      "--mount=data:/mnt/data:read-only",
+      "--mount=data:/mnt/data:snapshot",
       "--mount=cache:/mnt/cache",
       "--scope=team",
       "--project=proj",
     ]);
 
     expect(mockUpdate).toHaveBeenCalledWith({
       mounts: {
-        "/mnt/data": { drive: "data", mode: "read-only" },
-        "/mnt/cache": { drive: "cache", mode: undefined },
+        "/mnt/data": { name: "data", mode: "snapshot" },
+        "/mnt/cache": { name: "cache", mode: "read-write" },
       },
     });
   });

packages/vercel-sandbox-mock/src/sandbox.test.ts

@@ -1,6 +1,7 @@
 import { randomUUID } from "node:crypto";
 import { describe, expect, test } from "vitest";
 import { Sandbox } from "./sandbox";
+import { Drive } from "./drive";
 
 const uniq = () => `sb-${randomUUID().slice(0, 8)}`;
 
@@ -28,22 +29,25 @@ describe("Sandbox (real SDK over mock fetch)", () => {
   });
 
   test("update replaces and clears mounts", async () => {
+    const drive = await Drive.getOrCreate({ name: uniq() });
     const sandbox = await Sandbox.create({
       name: uniq(),
-      mounts: { "/mnt/data": { drive: "data" } },
+      mounts: { "/mnt/data": drive },
+    });
+    expect(sandbox.mounts).toEqual({
+      "/mnt/data": { name: drive.name, mode: "read-write" },
     });
-    expect(sandbox.mounts).toEqual({ "/mnt/data": { drive: "data" } });
 
     await sandbox.update({
-      mounts: { "/mnt/cache": { drive: "cache", mode: "read-only" } },
+      mounts: { "/mnt/cache": drive.snapshot() },
     });
     expect(sandbox.mounts).toEqual({
-      "/mnt/cache": { drive: "cache", mode: "read-only" },
+      "/mnt/cache": { name: drive.name, mode: "snapshot" },
     });
 
     const reread = await Sandbox.get({ name: sandbox.name, resume: false });
     expect(reread.mounts).toEqual({
-      "/mnt/cache": { drive: "cache", mode: "read-only" },
+      "/mnt/cache": { name: drive.name, mode: "snapshot" },
     });
 
     await sandbox.update({ mounts: {} });

packages/vercel-sandbox-mock/src/server/registry.ts

@@ -71,7 +71,7 @@ export interface SandboxRecord {
   runtime?: string;
   timeout: number;
   tags?: Record<string, string>;
-  mounts?: Record<string, { drive: string; mode?: "read-only" | "read-write" }>;
+  mounts?: Record<string, { name: string; mode: "snapshot" | "read-write" }>;
   networkPolicy?: unknown;
   cwd: string;
   env?: Record<string, string>;

packages/vercel-sandbox/src/api-client/api-client.ts

@@ -41,7 +41,7 @@ import { NetworkPolicy } from "../network-policy.js";
 import { toAPINetworkPolicy } from "../utils/network-policy.js";
 import { getPrivateParams, WithPrivate } from "../utils/types.js";
 import type { RUNTIMES, SandboxRegion } from "../constants.js";
-import type { BaseCreateSandboxParams } from "../sandbox.js";
+import type { SandboxMetaData } from "./validators.js";
 
 interface Claims {
   owner_id: string;
@@ -186,7 +186,7 @@ export class APIClient extends BaseClient {
         expiration?: number;
         deleteEvicted?: boolean;
       };
-      mounts?: BaseCreateSandboxParams["mounts"];
+      mounts?: SandboxMetaData["mounts"];
       region?: SandboxRegion;
       failoverRegions?: SandboxRegion[];
       signal?: AbortSignal;
@@ -1035,7 +1035,7 @@ export class APIClient extends BaseClient {
     currentSnapshotId?: string;
     region?: SandboxRegion;
     failoverRegions?: SandboxRegion[];
-    mounts?: BaseCreateSandboxParams["mounts"];
+    mounts?: SandboxMetaData["mounts"];
     signal?: AbortSignal;
   }) {
     return parseOrThrow(