@cloudflare/sandbox 0.0.0-cecde0a → 0.0.0-d55b0f4

package/CHANGELOG.md

@@ -1,5 +1,31 @@
 # @cloudflare/sandbox
 
+## 0.1.2
+
+### Patch Changes
+
+- [#30](https://github.com/cloudflare/sandbox-sdk/pull/30) [`30e5c25`](https://github.com/cloudflare/sandbox-sdk/commit/30e5c25cf7d4b07f9049724206c531e2d5d29d5c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Remove actions timeout
+
+- [#29](https://github.com/cloudflare/sandbox-sdk/pull/29) [`d78508f`](https://github.com/cloudflare/sandbox-sdk/commit/d78508f7287a59e0423edd2999c2c83e9e34ccfd) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Create multi-platform Docker image and switch to Cloudflare official repo
+
+## 0.1.1
+
+### Patch Changes
+
+- [`157dde9`](https://github.com/cloudflare/sandbox-sdk/commit/157dde9b1f23e9bb6f3e9c3f0514b639a8813897) Thanks [@threepointone](https://github.com/threepointone)! - update deps
+
+- [`a04f6b6`](https://github.com/cloudflare/sandbox-sdk/commit/a04f6b6c0b2ef9e3ce0851b53769f1c10d8c6de6) Thanks [@threepointone](https://github.com/threepointone)! - trigger a build with updated deps
+
+## 0.1.0
+
+### Minor Changes
+
+- [#24](https://github.com/cloudflare/sandbox-sdk/pull/24) [`cecde0a`](https://github.com/cloudflare/sandbox-sdk/commit/cecde0a7530a87deffd8562fb8b01d66ee80ee19) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Redesign command execution API
+
+### Patch Changes
+
+- [#22](https://github.com/cloudflare/sandbox-sdk/pull/22) [`f5fcd52`](https://github.com/cloudflare/sandbox-sdk/commit/f5fcd52025d1f7958a374e69d75e3fc590275f3f) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Allow setting env variables dynamically and remove command restrictions
+
 ## 0.0.9
 
 ### Patch Changes

package/Dockerfile

@@ -1,4 +1,5 @@
 # Sandbox base image with development tools, Python, Node.js, and Bun
+FROM oven/bun:latest AS bun-source
 FROM ubuntu:22.04
 
 # Prevent interactive prompts during package installation
@@ -50,11 +51,9 @@ RUN apt-get update && apt-get install -y ca-certificates curl gnupg \
     && apt-get install -y nodejs \
     && rm -rf /var/lib/apt/lists/*
 
-# Install Bun using the official installation script
-RUN curl -fsSL https://bun.sh/install | bash \
-    && mv /root/.bun/bin/bun /usr/local/bin/bun \
-    && mv /root/.bun/bin/bunx /usr/local/bin/bunx \
-    && rm -rf /root/.bun
+# Install Bun from official image (avoids architecture compatibility issues)
+COPY --from=bun-source /usr/local/bin/bun /usr/local/bin/bun
+COPY --from=bun-source /usr/local/bin/bunx /usr/local/bin/bunx
 
 # Install global npm packages as root
 RUN npm install -g yarn pnpm

package/package.json

@@ -1,13 +1,13 @@
 {
   "name": "@cloudflare/sandbox",
-  "version": "0.0.0-cecde0a",
+  "version": "0.0.0-d55b0f4",
   "repository": {
     "type": "git",
     "url": "https://github.com/cloudflare/sandbox-sdk"
   },
   "description": "A sandboxed environment for running commands",
   "dependencies": {
-    "@cloudflare/containers": "^0.0.24"
+    "@cloudflare/containers": "^0.0.25"
   },
   "tags": [
     "sandbox",
@@ -18,8 +18,9 @@
   ],
   "scripts": {
     "build": "rm -rf dist && tsup src/*.ts --outDir dist --dts --sourcemap --format esm",
-    "docker:build": "docker build -t ghostwriternr/cloudflare-sandbox:$npm_package_version .",
-    "docker:publish": "docker push docker.io/ghostwriternr/cloudflare-sandbox:$npm_package_version"
+    "docker:local": "docker build . -t cloudflare/sandbox-test:$npm_package_version",
+    "docker:publish": "docker buildx build --platform linux/amd64,linux/arm64 -t cloudflare/sandbox:$npm_package_version --push .",
+    "docker:publish:beta": "docker buildx build --platform linux/amd64,linux/arm64 -t cloudflare/sandbox:$npm_package_version-beta --push ."
   },
   "exports": {
     ".": {

package/src/sandbox.ts

@@ -31,6 +31,7 @@ export function getSandbox(ns: DurableObjectNamespace<Sandbox>, id: string) {
 }
 
 export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
+  defaultPort = 3000; // Default port for the container's Bun server
   sleepAfter = "3m"; // Sleep the sandbox if no requests are made in this timeframe
   client: HttpClient;
   private sandboxName: string | null = null;

package/tsconfig.json

@@ -1,3 +1,3 @@
 {
-  "extends": "../../tsconfig.json"
+  "extends": "../../tsconfig.base.json"
 }

package/README.md

@@ -1,365 +0,0 @@
-## @cloudflare/sandbox
-
-> **⚠️ Experimental** - This library is currently experimental and we're actively seeking feedback. Please try it out and let us know what you think!
-
-A library to spin up a sandboxed environment.
-
-First, setup your wrangler.json to use the sandbox:
-
-```jsonc
-{
-  // ...
-  "containers": [
-    {
-      "class_name": "Sandbox",
-      "image": "./node_modules/@cloudflare/sandbox/Dockerfile",
-      "name": "sandbox"
-    }
-  ],
-  "durable_objects": {
-    "bindings": [
-      {
-        "class_name": "Sandbox",
-        "name": "Sandbox"
-      }
-    ]
-  },
-  "migrations": [
-    {
-      "new_sqlite_classes": ["Sandbox"],
-      "tag": "v1"
-    }
-  ]
-}
-```
-
-Then, export the Sandbox class in your worker:
-
-```ts
-export { Sandbox } from "@cloudflare/sandbox";
-```
-
-You can then use the Sandbox class in your worker:
-
-```ts
-import { getSandbox } from "@cloudflare/sandbox";
-
-export default {
-  async fetch(request: Request, env: Env) {
-    const sandbox = getSandbox(env.Sandbox, "my-sandbox");
-    const result = await sandbox.exec("ls -la");
-    return Response.json(result);
-  },
-};
-```
-
-### Core Methods
-
-#### Command Execution
-- `exec(command: string, options?: ExecOptions)`: Execute a command and return the complete result.
-- `execStream(command: string, options?: StreamOptions)`: Execute a command with real-time streaming (returns ReadableStream).
-
-#### Process Management
-- `startProcess(command: string, options?: ProcessOptions)`: Start a background process.
-- `listProcesses()`: List all running processes.
-- `getProcess(id: string)`: Get details of a specific process.
-- `killProcess(id: string, signal?: string)`: Kill a specific process.
-- `killAllProcesses()`: Kill all running processes.
-- `streamProcessLogs(processId: string, options?: { signal?: AbortSignal })`: Stream logs from a running process (returns ReadableStream).
-
-#### File Operations
-- `gitCheckout(repoUrl: string, options: { branch?: string; targetDir?: string })`: Checkout a git repository.
-- `mkdir(path: string, options?: { recursive?: boolean })`: Create a directory.
-- `writeFile(path: string, content: string, options?: { encoding?: string })`: Write content to a file.
-- `readFile(path: string, options?: { encoding?: string })`: Read content from a file.
-- `deleteFile(path: string)`: Delete a file.
-- `renameFile(oldPath: string, newPath: string)`: Rename a file.
-- `moveFile(sourcePath: string, destinationPath: string)`: Move a file.
-
-#### Port Management
-- `exposePort(port: number, options: { name?: string; hostname: string })`: Expose a port for external access.
-- `unexposePort(port: number)`: Unexpose a previously exposed port.
-- `getExposedPorts(hostname: string)`: List all exposed ports with their preview URLs.
-
-### Beautiful AsyncIterable Streaming APIs ✨
-
-The SDK provides streaming methods that return `ReadableStream` for RPC compatibility, along with a `parseSSEStream` utility to convert them to typed AsyncIterables:
-
-#### Stream Command Output
-```typescript
-import { parseSSEStream, type ExecEvent } from '@cloudflare/sandbox';
-
-// Get the stream and convert to AsyncIterable
-const stream = await sandbox.execStream('npm run build');
-for await (const event of parseSSEStream<ExecEvent>(stream)) {
-  switch (event.type) {
-    case 'start':
-      console.log(`Build started: ${event.command}`);
-      break;
-    case 'stdout':
-      console.log(`[OUT] ${event.data}`);
-      break;
-    case 'stderr':
-      console.error(`[ERR] ${event.data}`);
-      break;
-    case 'complete':
-      console.log(`Build finished with exit code: ${event.exitCode}`);
-      break;
-    case 'error':
-      console.error(`Build error: ${event.error}`);
-      break;
-  }
-}
-```
-
-#### Stream Process Logs
-```typescript
-import { parseSSEStream, type LogEvent } from '@cloudflare/sandbox';
-
-// Monitor background process logs
-const webServer = await sandbox.startProcess('node server.js');
-
-const logStream = await sandbox.streamProcessLogs(webServer.id);
-for await (const log of parseSSEStream<LogEvent>(logStream)) {
-  if (log.type === 'stdout') {
-    console.log(`Server: ${log.data}`);
-  } else if (log.type === 'stderr' && log.data.includes('ERROR')) {
-    // React to errors
-    await handleError(log);
-  } else if (log.type === 'exit') {
-    console.log(`Server exited with code: ${log.exitCode}`);
-    break;
-  }
-}
-```
-
-#### Why parseSSEStream?
-
-The streaming methods return `ReadableStream<Uint8Array>` to ensure compatibility across Durable Object RPC boundaries. The `parseSSEStream` utility converts these streams into typed AsyncIterables, giving you the best of both worlds:
-
-- **RPC Compatibility**: ReadableStream can be serialized across process boundaries
-- **Beautiful APIs**: AsyncIterable provides clean `for await` syntax with typed events
-- **Type Safety**: Full TypeScript support with `ExecEvent` and `LogEvent` types
-
-#### Advanced Examples
-
-##### CI/CD Build System
-```typescript
-import { parseSSEStream, type ExecEvent } from '@cloudflare/sandbox';
-
-export async function runBuild(env: Env, buildId: string) {
-  const sandbox = getSandbox(env.Sandbox, buildId);
-  const buildLog: string[] = [];
-
-  try {
-    const stream = await sandbox.execStream('npm run build');
-    for await (const event of parseSSEStream<ExecEvent>(stream)) {
-      buildLog.push(`[${event.type}] ${event.data || ''}`);
-
-      if (event.type === 'complete') {
-        await env.BUILDS.put(buildId, {
-          status: event.exitCode === 0 ? 'success' : 'failed',
-          exitCode: event.exitCode,
-          logs: buildLog.join('\n'),
-          duration: Date.now() - new Date(event.timestamp).getTime()
-        });
-      }
-    }
-  } catch (error) {
-    await env.BUILDS.put(buildId, {
-      status: 'error',
-      error: error.message,
-      logs: buildLog.join('\n')
-    });
-  }
-}
-```
-
-##### System Monitoring
-```typescript
-import { parseSSEStream, type LogEvent } from '@cloudflare/sandbox';
-
-export default {
-  async scheduled(controller: ScheduledController, env: Env) {
-    const sandbox = getSandbox(env.Sandbox, 'monitor');
-
-    // Monitor system logs
-    const monitor = await sandbox.startProcess('journalctl -f');
-
-    const logStream = await sandbox.streamProcessLogs(monitor.id);
-    for await (const log of parseSSEStream<LogEvent>(logStream)) {
-      if (log.type === 'stdout') {
-        // Check for critical errors
-        if (log.data.includes('CRITICAL')) {
-          await env.ALERTS.send({
-            severity: 'critical',
-            message: log.data,
-            timestamp: log.timestamp
-          });
-        }
-
-        // Store logs
-        await env.LOGS.put(`${log.timestamp}-${monitor.id}`, log.data);
-      }
-    }
-  }
-}
-```
-
-##### Streaming to Frontend via SSE
-```typescript
-// Worker endpoint that streams to frontend
-app.get('/api/build/:id/stream', async (req, env) => {
-  const sandbox = getSandbox(env.Sandbox, req.params.id);
-  const encoder = new TextEncoder();
-
-  return new Response(
-    new ReadableStream({
-      async start(controller) {
-        try {
-          for await (const event of sandbox.execStream('npm run build')) {
-            // Forward events to frontend as SSE
-            const sseEvent = `data: ${JSON.stringify(event)}\n\n`;
-            controller.enqueue(encoder.encode(sseEvent));
-          }
-        } catch (error) {
-          const errorEvent = `data: ${JSON.stringify({
-            type: 'error',
-            error: error.message
-          })}\n\n`;
-          controller.enqueue(encoder.encode(errorEvent));
-        } finally {
-          controller.close();
-        }
-      }
-    }),
-    {
-      headers: {
-        'Content-Type': 'text/event-stream',
-        'Cache-Control': 'no-cache'
-      }
-    }
-  );
-});
-```
-
-### Streaming Utilities
-
-The SDK exports additional utilities for working with SSE streams:
-
-#### `parseSSEStream`
-Converts a `ReadableStream<Uint8Array>` (from SSE endpoints) into a typed `AsyncIterable<T>`. This is the primary utility for consuming streams from the SDK.
-
-```typescript
-import { parseSSEStream, type ExecEvent } from '@cloudflare/sandbox';
-
-const stream = await sandbox.execStream('npm build');
-for await (const event of parseSSEStream<ExecEvent>(stream)) {
-  console.log(event);
-}
-```
-
-#### `responseToAsyncIterable`
-Converts a `Response` object with SSE content directly to `AsyncIterable<T>`. Useful when fetching from external SSE endpoints.
-
-```typescript
-import { responseToAsyncIterable, type LogEvent } from '@cloudflare/sandbox';
-
-// Fetch from an external SSE endpoint
-const response = await fetch('https://api.example.com/logs/stream', {
-  headers: { 'Accept': 'text/event-stream' }
-});
-
-// Convert Response to typed AsyncIterable
-for await (const event of responseToAsyncIterable<LogEvent>(response)) {
-  console.log(`[${event.type}] ${event.data}`);
-}
-```
-
-#### `asyncIterableToSSEStream`
-Converts an `AsyncIterable<T>` into an SSE-formatted `ReadableStream<Uint8Array>`. Perfect for Worker endpoints that need to transform or filter events before sending to clients.
-
-```typescript
-import { getSandbox, parseSSEStream, asyncIterableToSSEStream, type LogEvent } from '@cloudflare/sandbox';
-
-export async function handleFilteredLogs(request: Request, env: Env) {
-  const sandbox = getSandbox(env.SANDBOX);
-  
-  // Custom async generator that filters logs
-  async function* filterLogs() {
-    const stream = await sandbox.streamProcessLogs('web-server');
-    
-    for await (const log of parseSSEStream<LogEvent>(stream)) {
-      // Only forward error logs to the client
-      if (log.type === 'stderr' || log.data.includes('ERROR')) {
-        yield log;
-      }
-    }
-  }
-
-  // Convert filtered AsyncIterable back to SSE stream for the response
-  const sseStream = asyncIterableToSSEStream(filterLogs());
-  
-  return new Response(sseStream, {
-    headers: {
-      'Content-Type': 'text/event-stream',
-      'Cache-Control': 'no-cache',
-    }
-  });
-}
-```
-
-**Advanced Example - Merging Multiple Streams:**
-```typescript
-async function* mergeBuilds(env: Env) {
-  const sandbox1 = getSandbox(env.SANDBOX1);
-  const sandbox2 = getSandbox(env.SANDBOX2);
-  
-  // Start builds in parallel
-  const [stream1, stream2] = await Promise.all([
-    sandbox1.execStream('npm run build:frontend'),
-    sandbox2.execStream('npm run build:backend')
-  ]);
-  
-  // Parse and merge events
-  const frontend = parseSSEStream<ExecEvent>(stream1);
-  const backend = parseSSEStream<ExecEvent>(stream2);
-  
-  // Merge with source identification
-  for await (const event of frontend) {
-    yield { ...event, source: 'frontend' };
-  }
-  for await (const event of backend) {
-    yield { ...event, source: 'backend' };
-  }
-}
-
-// Convert merged stream to SSE for client
-const mergedSSE = asyncIterableToSSEStream(mergeBuilds(env));
-```
-
-### Cancellation Support
-
-Both streaming methods support cancellation via AbortSignal:
-
-```typescript
-const controller = new AbortController();
-
-// Cancel after 30 seconds
-setTimeout(() => controller.abort(), 30000);
-
-try {
-  for await (const event of sandbox.execStream('long-running-task', {
-    signal: controller.signal
-  })) {
-    // Process events
-    if (shouldCancel(event)) {
-      controller.abort();
-    }
-  }
-} catch (error) {
-  if (error.message.includes('aborted')) {
-    console.log('Operation cancelled');
-  }
-}
-```