@vercel/sandbox 0.0.13 → 0.0.15

package/.turbo/turbo-build.log

@@ -1,4 +1,4 @@
 
-> @vercel/sandbox@0.0.13 build /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
+> @vercel/sandbox@0.0.15 build /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
 > tsc
 

package/.turbo/turbo-typecheck.log

@@ -1,4 +1,4 @@
 
-> @vercel/sandbox@0.0.13 typecheck /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
+> @vercel/sandbox@0.0.15 typecheck /home/runner/work/sandbox-sdk/sandbox-sdk/packages/sandbox
 > tsc --noEmit
 

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @vercel/sandbox
 
+## 0.0.15
+
+### Patch Changes
+
+- Remove warning when consuming logs more than once ([#91](https://github.com/vercel/sandbox-sdk/pull/91))
+
+- Improve future compatibility of runtime parameter ([#88](https://github.com/vercel/sandbox-sdk/pull/88))
+
+## 0.0.14
+
+### Patch Changes
+
+- Use `@vercel/oidc` for authentication ([#87](https://github.com/vercel/sandbox-sdk/pull/87))
+
+- Expose more data in `Command` ([#85](https://github.com/vercel/sandbox-sdk/pull/85))
+
 ## 0.0.13
 
 ### Patch Changes

package/README.md

@@ -35,7 +35,52 @@ vercel env pull
 
 Now create `next-dev.ts`:
 
-{@includeCode ../cli/src/example-next.ts}
+```ts
+import ms from "ms";
+import { Sandbox } from "@vercel/sandbox";
+import { setTimeout } from "timers/promises";
+import { spawn } from "child_process";
+
+async function main() {
+  const sandbox = await Sandbox.create({
+    source: {
+      url: "https://github.com/vercel/sandbox-example-next.git",
+      type: "git",
+    },
+    resources: { vcpus: 4 },
+    timeout: ms("5m"),
+    ports: [3000],
+    runtime: "node22",
+  });
+
+  console.log(`Installing dependencies...`);
+  const install = await sandbox.runCommand({
+    cmd: "npm",
+    args: ["install", "--loglevel", "info"],
+    stderr: process.stderr,
+    stdout: process.stdout,
+  });
+
+  if (install.exitCode != 0) {
+    console.log("installing packages failed");
+    process.exit(1);
+  }
+
+  console.log(`Starting the development server...`);
+  await sandbox.runCommand({
+    cmd: "npm",
+    args: ["run", "dev"],
+    stderr: process.stderr,
+    stdout: process.stdout,
+    detached: true,
+  });
+
+  await setTimeout(500);
+  spawn("open", [sandbox.domain(3000)]);
+}
+
+main().catch(console.error);
+```
 
 Run it like this:
 

package/dist/api-client/api-client.d.ts

@@ -53,7 +53,7 @@ export declare class APIClient extends BaseClient {
         resources?: {
             vcpus: number;
         };
-        runtime?: "node22" | "python3.13";
+        runtime?: "node22" | "python3.13" | (string & {});
     }): Promise<Parsed<{
         sandbox: {
             region: string;

package/dist/api-client/api-client.js

@@ -8,20 +8,10 @@ const base_client_1 = require("./base-client");
 const validators_1 = require("./validators");
 const api_error_1 = require("./api-error");
 const file_writer_1 = require("./file-writer");
-const lru_cache_1 = require("lru-cache");
 const version_1 = require("../version");
 const consume_readable_1 = require("../utils/consume-readable");
 const jsonlines_1 = __importDefault(require("jsonlines"));
 const os_1 = __importDefault(require("os"));
-const ms_1 = __importDefault(require("ms"));
-/**
- * Allows to track the logs hits for a command un a to maximum of items and
- * TTL so that we don't incur in memory leaks in a log running process.
- */
-const logHits = new lru_cache_1.LRUCache({
-    ttl: (0, ms_1.default)("45m"),
-    max: 1000,
-});
 class APIClient extends base_client_1.BaseClient {
     constructor(params) {
         super({
@@ -128,18 +118,6 @@ class APIClient extends base_client_1.BaseClient {
                 message: "Expected a stream of logs",
             });
         }
-        /**
-         * Currently, once we consume logs in the backend we cannot read them
-         * again. This logic writes a warning when the endpoint for a command
-         * logs is consumed more than once to alert the user about this.
-         *
-         * This is a temporary solution, we should be able to handle this in
-         * the backend in the future.
-         */
-        if (logHits.get(url)) {
-            console.warn(`Multiple consumers for logs of command \`${params.cmdId}\`. This may lead to unexpected behavior.`);
-        }
-        logHits.set(url, true);
         for await (const chunk of response.body.pipe(jsonlines_1.default.parse())) {
             yield validators_1.LogLine.parse(chunk);
         }

package/dist/command.d.ts

@@ -24,10 +24,13 @@ export declare class Command {
      * Data for the command execution.
      */
     private cmd;
+    exitCode: number | null;
     /**
      * ID of the command execution.
      */
     get cmdId(): string;
+    get cwd(): string;
+    get startedAt(): number;
     /**
      * @param params - Object containing the client, sandbox ID, and command ID.
      * @param params.client - API client used to interact with the backend.

package/dist/command.js

@@ -19,6 +19,12 @@ class Command {
     get cmdId() {
         return this.cmd.id;
     }
+    get cwd() {
+        return this.cmd.cwd;
+    }
+    get startedAt() {
+        return this.cmd.startedAt;
+    }
     /**
      * @param params - Object containing the client, sandbox ID, and command ID.
      * @param params.client - API client used to interact with the backend.
@@ -29,6 +35,7 @@ class Command {
         this.client = client;
         this.sandboxId = sandboxId;
         this.cmd = cmd;
+        this.exitCode = cmd.exitCode ?? null;
     }
     /**
      * Iterate over the output of this command.

package/dist/sandbox.d.ts

@@ -51,7 +51,7 @@ export interface CreateSandboxParams {
      * The runtime of the sandbox, currently only `node22` and `python3.13` are supported.
      * If not specified, the default runtime `node22` will be used.
      */
-    runtime?: "node22" | "python3.13";
+    runtime?: "node22" | "python3.13" | (string & {});
 }
 /** @inline */
 interface GetSandboxParams {

package/dist/utils/get-credentials.js

@@ -1,7 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.getCredentials = getCredentials;
-const get_vercel_oidc_token_1 = require("./get-vercel-oidc-token");
+const oidc_1 = require("@vercel/oidc");
 const decode_base64_url_1 = require("./decode-base64-url");
 const zod_1 = require("zod");
 /**
@@ -19,7 +19,7 @@ function getCredentials(params) {
     if (credentials) {
         return credentials;
     }
-    const oidcToken = (0, get_vercel_oidc_token_1.getVercelOidcToken)();
+    const oidcToken = (0, oidc_1.getVercelOidcTokenSync)();
     if (oidcToken) {
         return getCredentialsFromOIDCToken(oidcToken);
     }

package/dist/version.d.ts

@@ -1 +1 @@
-export declare const VERSION = "0.0.13";
+export declare const VERSION = "0.0.15";

package/dist/version.js

@@ -2,4 +2,4 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.VERSION = void 0;
 // Autogenerated by inject-version.ts
-exports.VERSION = "0.0.13";
+exports.VERSION = "0.0.15";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vercel/sandbox",
-  "version": "0.0.13",
+  "version": "0.0.15",
   "description": "",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",
@@ -9,10 +9,10 @@
   "author": "",
   "license": "ISC",
   "dependencies": {
+    "@vercel/oidc": "^2.0.0",
     "async-retry": "1.3.3",
     "form-data": "3.0.0",
     "jsonlines": "0.1.1",
-    "lru-cache": "11.1.0",
     "ms": "2.1.3",
     "node-fetch": "2.6.11",
     "tar-stream": "3.1.7",

package/src/api-client/api-client.ts

@@ -14,22 +14,11 @@ import {
 } from "./validators";
 import { APIError } from "./api-error";
 import { FileWriter } from "./file-writer";
-import { LRUCache } from "lru-cache";
 import { VERSION } from "../version";
 import { consumeReadable } from "../utils/consume-readable";
 import { z } from "zod";
 import jsonlines from "jsonlines";
 import os from "os";
-import ms from "ms";
-
-/**
- * Allows to track the logs hits for a command un a to maximum of items and
- * TTL so that we don't incur in memory leaks in a log running process.
- */
-const logHits = new LRUCache<string, boolean>({
-  ttl: ms("45m"),
-  max: 1000,
-});
 
 export class APIClient extends BaseClient {
   private teamId: string;
@@ -78,7 +67,7 @@ export class APIClient extends BaseClient {
       | { type: "tarball"; url: string };
     timeout?: number;
     resources?: { vcpus: number };
-    runtime?: "node22" | "python3.13";
+    runtime?: "node22" | "python3.13" | (string & {});
   }) {
     return parseOrThrow(
       SandboxAndRoutesResponse,
@@ -239,21 +228,6 @@ export class APIClient extends BaseClient {
       });
     }
 
-    /**
-     * Currently, once we consume logs in the backend we cannot read them
-     * again. This logic writes a warning when the endpoint for a command
-     * logs is consumed more than once to alert the user about this.
-     *
-     * This is a temporary solution, we should be able to handle this in
-     * the backend in the future.
-     */
-    if (logHits.get(url)) {
-      console.warn(
-        `Multiple consumers for logs of command \`${params.cmdId}\`. This may lead to unexpected behavior.`,
-      );
-    }
-
-    logHits.set(url, true);
     for await (const chunk of response.body.pipe(jsonlines.parse())) {
       yield LogLine.parse(chunk);
     }

package/src/command.test.ts

@@ -4,19 +4,14 @@ import { Sandbox } from "./sandbox";
 let sandbox: Sandbox;
 
 beforeEach(async () => {
-  sandbox = await Sandbox.create({
-    projectId: process.env.VERCEL_PROJECT_ID!,
-    teamId: process.env.VERCEL_TEAM_ID!,
-    token: process.env.VERCEL_TOKEN!,
-  });
+  sandbox = await Sandbox.create();
 });
 
 afterEach(async () => {
   await sandbox.stop();
 });
 
-it("warns when there is more than one logs consumer", async () => {
-  const warnSpy = vi.spyOn(console, "warn").mockImplementation(() => {});
+it("supports more than one logs consumer", async () => {
   const stdoutSpy = vi
     .spyOn(process.stdout, "write")
     .mockImplementation(() => true);
@@ -27,13 +22,8 @@ it("warns when there is more than one logs consumer", async () => {
     stdout: process.stdout,
   });
 
-  expect(await cmd.stdout()).toEqual("");
+  expect(await cmd.stdout()).toEqual("Hello World!\n");
   expect(stdoutSpy).toHaveBeenCalledWith("Hello World!\n");
-  expect(warnSpy).toHaveBeenCalledWith(
-    expect.stringMatching(
-      /Multiple consumers for logs of command `[^`]+`\.\sThis may lead to unexpected behavior\./,
-    ),
-  );
 });
 
 it("does not warn when there is only one logs consumer", async () => {
@@ -89,9 +79,12 @@ it("can execute commands with sudo", async () => {
   expect(output).toContain("USER=root\n");
   expect(output).toContain("SUDO_USER=vercel-sandbox\n");
 
-  // The actual path contains more, but this is enough
-  // to verify that we do not reset it to a default path.
-  expect(output).toContain("PATH=/vercel/bin");
+  const pathLine = output.split("\n").find((line) => line.startsWith("PATH="));
+  expect(pathLine).toBeDefined();
+
+  const pathSegments = pathLine!.slice(5).split(":");
+  expect(pathSegments).toContain("/vercel/bin");
+  expect(pathSegments).toContain("/vercel/runtimes/node22/bin");
 
   const dnf = await sandbox.runCommand({
     cmd: "dnf",
@@ -102,5 +95,5 @@ it("can execute commands with sudo", async () => {
   expect(dnf.exitCode).toBe(0);
 
   const which = await sandbox.runCommand("which", ["go"]);
-  expect(which.output()).resolves.toContain("/usr/bin/go");
+  expect(await which.output()).toContain("/usr/bin/go");
 });

package/src/command.ts

@@ -28,6 +28,8 @@ export class Command {
    */
   private cmd: CommandData;
 
+  public exitCode: number | null;
+
   /**
    * ID of the command execution.
    */
@@ -35,6 +37,14 @@ export class Command {
     return this.cmd.id;
   }
 
+  get cwd() {
+    return this.cmd.cwd;
+  }
+
+  get startedAt() {
+    return this.cmd.startedAt;
+  }
+
   /**
    * @param params - Object containing the client, sandbox ID, and command ID.
    * @param params.client - API client used to interact with the backend.
@@ -53,6 +63,7 @@ export class Command {
     this.client = client;
     this.sandboxId = sandboxId;
     this.cmd = cmd;
+    this.exitCode = cmd.exitCode ?? null;
   }
 
   /**

package/src/sandbox.test.ts

@@ -5,11 +5,7 @@ import { Sandbox } from "./sandbox";
 let sandbox: Sandbox;
 
 beforeEach(async () => {
-  sandbox = await Sandbox.create({
-    projectId: process.env.VERCEL_PROJECT_ID!,
-    teamId: process.env.VERCEL_TEAM_ID!,
-    token: process.env.VERCEL_TOKEN!,
-  });
+  sandbox = await Sandbox.create();
 });
 
 afterEach(async () => {
@@ -18,8 +14,8 @@ afterEach(async () => {
 
 it("allows to write files and then read them", async () => {
   await sandbox.writeFiles([
-    { path: "hello1.txt", stream: Buffer.from("Hello 1") },
-    { path: "hello2.txt", stream: Buffer.from("Hello 2") },
+    { path: "hello1.txt", content: Buffer.from("Hello 1") },
+    { path: "hello2.txt", content: Buffer.from("Hello 2") },
   ]);
 
   const content1 = await sandbox.readFile({ path: "hello1.txt" });

package/src/sandbox.ts

@@ -51,7 +51,7 @@ export interface CreateSandboxParams {
    * The runtime of the sandbox, currently only `node22` and `python3.13` are supported.
    * If not specified, the default runtime `node22` will be used.
    */
-  runtime?: "node22" | "python3.13";
+  runtime?: "node22" | "python3.13" | (string & {});
 }
 
 /** @inline */

package/src/utils/get-credentials.ts

@@ -1,4 +1,4 @@
-import { getVercelOidcToken } from "./get-vercel-oidc-token";
+import { getVercelOidcTokenSync } from "@vercel/oidc";
 import { decodeBase64Url } from "./decode-base64-url";
 import { z } from "zod";
 
@@ -34,7 +34,7 @@ export function getCredentials<T>(params?: T | Credentials): Credentials {
     return credentials;
   }
 
-  const oidcToken = getVercelOidcToken();
+  const oidcToken = getVercelOidcTokenSync();
   if (oidcToken) {
     return getCredentialsFromOIDCToken(oidcToken);
   }

package/src/version.ts

@@ -1,2 +1,2 @@
 // Autogenerated by inject-version.ts
-export const VERSION = "0.0.13";
+export const VERSION = "0.0.15";

package/vercel.json

@@ -0,0 +1,9 @@
+{
+  "redirects": [
+    {
+      "source": "/(.*)",
+      "destination": "https://vercel.com/docs/vercel-sandbox",
+      "permanent": true
+    }
+  ]
+}

package/dist/utils/get-vercel-oidc-token.d.ts

@@ -1,6 +0,0 @@
-/**
- * This function is implemented in @vercel/functions but it is asynchronous.
- * In order to keep it synchronous, we are implementing it here as well.
- * Ideally we should remove this and use the one from @vercel/functions.
- */
-export declare function getVercelOidcToken(): string | undefined;

package/dist/utils/get-vercel-oidc-token.js

@@ -1,21 +0,0 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.getVercelOidcToken = getVercelOidcToken;
-/**
- * This function is implemented in @vercel/functions but it is asynchronous.
- * In order to keep it synchronous, we are implementing it here as well.
- * Ideally we should remove this and use the one from @vercel/functions.
- */
-function getVercelOidcToken() {
-    const token = getContext().headers?.["x-vercel-oidc-token"] ??
-        process.env.VERCEL_OIDC_TOKEN;
-    if (!token && process.env.NODE_ENV === "production") {
-        throw new Error(`The 'x-vercel-oidc-token' header is missing from the request. Do you have the OIDC option enabled in the Vercel project settings?`);
-    }
-    return token;
-}
-const SYMBOL_FOR_REQ_CONTEXT = Symbol.for("@vercel/request-context");
-function getContext() {
-    const fromSymbol = globalThis;
-    return fromSymbol[SYMBOL_FOR_REQ_CONTEXT]?.get?.() ?? {};
-}

package/src/utils/get-vercel-oidc-token.ts

@@ -1,31 +0,0 @@
-/**
- * This function is implemented in @vercel/functions but it is asynchronous.
- * In order to keep it synchronous, we are implementing it here as well.
- * Ideally we should remove this and use the one from @vercel/functions.
- */
-export function getVercelOidcToken(): string | undefined {
-  const token =
-    getContext().headers?.["x-vercel-oidc-token"] ??
-    process.env.VERCEL_OIDC_TOKEN;
-
-  if (!token && process.env.NODE_ENV === "production") {
-    throw new Error(
-      `The 'x-vercel-oidc-token' header is missing from the request. Do you have the OIDC option enabled in the Vercel project settings?`,
-    );
-  }
-
-  return token;
-}
-
-const SYMBOL_FOR_REQ_CONTEXT = Symbol.for("@vercel/request-context");
-
-interface Context {
-  headers?: Record<string, string>;
-}
-
-function getContext(): Context {
-  const fromSymbol: typeof globalThis & {
-    [SYMBOL_FOR_REQ_CONTEXT]?: { get?: () => Context };
-  } = globalThis;
-  return fromSymbol[SYMBOL_FOR_REQ_CONTEXT]?.get?.() ?? {};
-}