@cloudflare/sandbox 0.0.0-fd5ec7f → 0.0.0-fddccfd

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (81) hide show
  1. package/CHANGELOG.md +157 -0
  2. package/Dockerfile +112 -51
  3. package/README.md +90 -488
  4. package/dist/chunk-2P3MDMNJ.js +2367 -0
  5. package/dist/chunk-2P3MDMNJ.js.map +1 -0
  6. package/dist/chunk-BFVUNTP4.js +104 -0
  7. package/dist/chunk-BFVUNTP4.js.map +1 -0
  8. package/dist/chunk-EKSWCBCA.js +86 -0
  9. package/dist/chunk-EKSWCBCA.js.map +1 -0
  10. package/dist/chunk-JXZMAU2C.js +559 -0
  11. package/dist/chunk-JXZMAU2C.js.map +1 -0
  12. package/dist/chunk-Z532A7QC.js +78 -0
  13. package/dist/chunk-Z532A7QC.js.map +1 -0
  14. package/dist/file-stream.d.ts +43 -0
  15. package/dist/file-stream.js +9 -0
  16. package/dist/file-stream.js.map +1 -0
  17. package/dist/index.d.ts +9 -0
  18. package/dist/index.js +66 -0
  19. package/dist/index.js.map +1 -0
  20. package/dist/interpreter.d.ts +33 -0
  21. package/dist/interpreter.js +8 -0
  22. package/dist/interpreter.js.map +1 -0
  23. package/dist/request-handler.d.ts +18 -0
  24. package/dist/request-handler.js +12 -0
  25. package/dist/request-handler.js.map +1 -0
  26. package/dist/sandbox-CZTMzV2R.d.ts +587 -0
  27. package/dist/sandbox.d.ts +4 -0
  28. package/dist/sandbox.js +12 -0
  29. package/dist/sandbox.js.map +1 -0
  30. package/dist/security.d.ts +31 -0
  31. package/dist/security.js +13 -0
  32. package/dist/security.js.map +1 -0
  33. package/dist/sse-parser.d.ts +28 -0
  34. package/dist/sse-parser.js +11 -0
  35. package/dist/sse-parser.js.map +1 -0
  36. package/package.json +13 -5
  37. package/src/clients/base-client.ts +280 -0
  38. package/src/clients/command-client.ts +115 -0
  39. package/src/clients/file-client.ts +269 -0
  40. package/src/clients/git-client.ts +92 -0
  41. package/src/clients/index.ts +63 -0
  42. package/src/clients/interpreter-client.ts +329 -0
  43. package/src/clients/port-client.ts +105 -0
  44. package/src/clients/process-client.ts +177 -0
  45. package/src/clients/sandbox-client.ts +41 -0
  46. package/src/clients/types.ts +84 -0
  47. package/src/clients/utility-client.ts +94 -0
  48. package/src/errors/adapter.ts +180 -0
  49. package/src/errors/classes.ts +469 -0
  50. package/src/errors/index.ts +105 -0
  51. package/src/file-stream.ts +164 -0
  52. package/src/index.ts +85 -12
  53. package/src/interpreter.ts +159 -0
  54. package/src/request-handler.ts +69 -43
  55. package/src/sandbox.ts +578 -292
  56. package/src/security.ts +14 -23
  57. package/src/sse-parser.ts +4 -8
  58. package/startup.sh +3 -0
  59. package/tests/base-client.test.ts +328 -0
  60. package/tests/command-client.test.ts +407 -0
  61. package/tests/file-client.test.ts +643 -0
  62. package/tests/file-stream.test.ts +306 -0
  63. package/tests/git-client.test.ts +328 -0
  64. package/tests/port-client.test.ts +301 -0
  65. package/tests/process-client.test.ts +658 -0
  66. package/tests/sandbox.test.ts +465 -0
  67. package/tests/sse-parser.test.ts +290 -0
  68. package/tests/utility-client.test.ts +266 -0
  69. package/tests/wrangler.jsonc +35 -0
  70. package/tsconfig.json +9 -1
  71. package/vitest.config.ts +31 -0
  72. package/container_src/handler/exec.ts +0 -338
  73. package/container_src/handler/file.ts +0 -844
  74. package/container_src/handler/git.ts +0 -182
  75. package/container_src/handler/ports.ts +0 -314
  76. package/container_src/handler/process.ts +0 -640
  77. package/container_src/index.ts +0 -361
  78. package/container_src/package.json +0 -9
  79. package/container_src/types.ts +0 -108
  80. package/src/client.ts +0 -1038
  81. package/src/types.ts +0 -386
package/CHANGELOG.md CHANGED
@@ -1,5 +1,162 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.4.3
4
+
5
+ ### Patch Changes
6
+
7
+ - [#114](https://github.com/cloudflare/sandbox-sdk/pull/114) [`8c1f440`](https://github.com/cloudflare/sandbox-sdk/commit/8c1f440ad6fd89a5c69f9ca9d055ad9b183dd1c3) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Debloat base docker image (2.63GB → 1.03GB)
8
+
9
+ ## 0.4.2
10
+
11
+ ### Patch Changes
12
+
13
+ - [`e53d7e7`](https://github.com/cloudflare/sandbox-sdk/commit/e53d7e7ce185f79bdd899029bb532e9651ae7ba5) Thanks [@threepointone](https://github.com/threepointone)! - fix build by inlining repo/shared
14
+
15
+ ## 0.4.1
16
+
17
+ ### Patch Changes
18
+
19
+ - [#111](https://github.com/cloudflare/sandbox-sdk/pull/111) [`1b5496b`](https://github.com/cloudflare/sandbox-sdk/commit/1b5496bfceaee53c31911b409476ea87bebffe4c) Thanks [@threepointone](https://github.com/threepointone)! - trigger a release
20
+
21
+ ## 0.4.0
22
+
23
+ ### Minor Changes
24
+
25
+ - [#95](https://github.com/cloudflare/sandbox-sdk/pull/95) [`7aee736`](https://github.com/cloudflare/sandbox-sdk/commit/7aee736bf07a4bf9020e2109bdaaa70214d52a01) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Rewrite SDK with cleaner design patterns and tests. Remove the unnecessary isolation cruft and fix foundational issues with streaming, sessions, validations and error handling. Cover the SDK with unit & e2e tests.
26
+
27
+ ### Patch Changes
28
+
29
+ - [#106](https://github.com/cloudflare/sandbox-sdk/pull/106) [`da947cd`](https://github.com/cloudflare/sandbox-sdk/commit/da947cd9543fc99831eefb1e8741fc905cb8fa42) Thanks [@jahands](https://github.com/jahands)! - fix examples failing to deploy and prevent committing node_modules
30
+
31
+ ## 0.3.3
32
+
33
+ ### Patch Changes
34
+
35
+ - [#83](https://github.com/cloudflare/sandbox-sdk/pull/83) [`eec5bb6`](https://github.com/cloudflare/sandbox-sdk/commit/eec5bb6203dd5d775b4b54e91c26de25eeb767ce) Thanks [@mikenomitch](https://github.com/mikenomitch)! - Bump containers package version
36
+
37
+ ## 0.3.2
38
+
39
+ ### Patch Changes
40
+
41
+ - [#76](https://github.com/cloudflare/sandbox-sdk/pull/76) [`ef9e320`](https://github.com/cloudflare/sandbox-sdk/commit/ef9e320dcef30e57797fef6ebd9a9383fa9720d9) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Replace Jupyter with lightweight interpreters for >90% faster cold starts for `.runCode` calls, while maintaining full code execution capabilities and rich output support.
42
+
43
+ ## 0.3.1
44
+
45
+ ### Patch Changes
46
+
47
+ - [#71](https://github.com/cloudflare/sandbox-sdk/pull/71) [`fb3c9c2`](https://github.com/cloudflare/sandbox-sdk/commit/fb3c9c22242d9d4f157c26f547f1e697ef7875f9) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Bump containers package version
48
+
49
+ - [#70](https://github.com/cloudflare/sandbox-sdk/pull/70) [`e1fa354`](https://github.com/cloudflare/sandbox-sdk/commit/e1fa354ab1bc7b0e89db4901b67028ebf1a93d0a) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix escaped quotes in file write operations
50
+
51
+ - [#68](https://github.com/cloudflare/sandbox-sdk/pull/68) [`69b91d1`](https://github.com/cloudflare/sandbox-sdk/commit/69b91d1a8f6afb63262cc381ea93e94a033ed5e8) Thanks [@CyrusNuevoDia](https://github.com/CyrusNuevoDia)! - Configurable timeouts via environment variables in isolation.ts
52
+
53
+ - [#66](https://github.com/cloudflare/sandbox-sdk/pull/66) [`eca93b9`](https://github.com/cloudflare/sandbox-sdk/commit/eca93b97e40fa0d3bd9dc27af2cc214ec355b696) Thanks [@peterp](https://github.com/peterp)! - Determine if the port is specified in the URL.
54
+
55
+ ## 0.3.0
56
+
57
+ ### Minor Changes
58
+
59
+ - [#59](https://github.com/cloudflare/sandbox-sdk/pull/59) [`b6757f7`](https://github.com/cloudflare/sandbox-sdk/commit/b6757f730c34381d5a70d513944bbf9840f598ab) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add process isolation for sandbox commands
60
+
61
+ Implements PID namespace isolation to protect control plane processes (Jupyter, Bun) from sandboxed code. Commands executed via `exec()` now run in isolated namespaces that cannot see or interact with system processes.
62
+
63
+ **Key security improvements:**
64
+
65
+ - Control plane processes are hidden from sandboxed commands
66
+ - Platform secrets in `/proc/1/environ` are inaccessible
67
+ - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
68
+
69
+ **Breaking changes:**
70
+
71
+ 1. **Removed `sessionId` parameter**: The `sessionId` parameter has been removed from all methods (`exec()`, `execStream()`, `startProcess()`, etc.). Each sandbox now maintains its own persistent session automatically.
72
+
73
+ ```javascript
74
+ // Before: manual session management
75
+ await sandbox.exec("cd /app", { sessionId: "my-session" });
76
+
77
+ // After: automatic session per sandbox
78
+ await sandbox.exec("cd /app");
79
+ ```
80
+
81
+ 2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
82
+
83
+ ```javascript
84
+ // Before: each exec was independent
85
+ await sandbox.exec("cd /app");
86
+ await sandbox.exec("pwd"); // Output: /workspace
87
+
88
+ // After: state persists in session
89
+ await sandbox.exec("cd /app");
90
+ await sandbox.exec("pwd"); // Output: /app
91
+ ```
92
+
93
+ **Migration guide:**
94
+
95
+ - Remove `sessionId` from all method calls - each sandbox maintains its own session
96
+ - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
97
+ ```javascript
98
+ // Create independent sessions with different environments
99
+ const buildSession = await sandbox.createSession({
100
+ name: "build",
101
+ env: { NODE_ENV: "production" },
102
+ cwd: "/build",
103
+ });
104
+ const testSession = await sandbox.createSession({
105
+ name: "test",
106
+ env: { NODE_ENV: "test" },
107
+ cwd: "/test",
108
+ });
109
+ ```
110
+ - Environment variables set in one command persist to the next
111
+ - Background processes remain active until explicitly killed
112
+ - Requires CAP_SYS_ADMIN (available in production, falls back gracefully in dev)
113
+
114
+ ### Patch Changes
115
+
116
+ - [#62](https://github.com/cloudflare/sandbox-sdk/pull/62) [`4bedc3a`](https://github.com/cloudflare/sandbox-sdk/commit/4bedc3aba347f3d4090a6efe2c9778bac00ce74a) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix broken build due to bun lockfile not being used
117
+
118
+ ## 0.2.4
119
+
120
+ ### Patch Changes
121
+
122
+ - [#57](https://github.com/cloudflare/sandbox-sdk/pull/57) [`12bbd12`](https://github.com/cloudflare/sandbox-sdk/commit/12bbd1229c07ef8c1c0bf58a4235a27938155b08) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add listFiles method
123
+
124
+ ## 0.2.3
125
+
126
+ ### Patch Changes
127
+
128
+ - [#53](https://github.com/cloudflare/sandbox-sdk/pull/53) [`c87db11`](https://github.com/cloudflare/sandbox-sdk/commit/c87db117693a86cfb667bf09fb7720d6a6e0524d) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Improve jupyterlab config to speed up startup
129
+
130
+ ## 0.2.2
131
+
132
+ ### Patch Changes
133
+
134
+ - [#51](https://github.com/cloudflare/sandbox-sdk/pull/51) [`4aceb32`](https://github.com/cloudflare/sandbox-sdk/commit/4aceb3215c836f59afcb88b2b325016b3f623f46) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Handle intermittent interpreter failures and decouple jupyter startup
135
+
136
+ ## 0.2.1
137
+
138
+ ### Patch Changes
139
+
140
+ - [#49](https://github.com/cloudflare/sandbox-sdk/pull/49) [`d81d2a5`](https://github.com/cloudflare/sandbox-sdk/commit/d81d2a563c9af8947d5444019ed4d6156db563e3) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Implement code interpreter API
141
+
142
+ ## 0.2.0
143
+
144
+ ### Minor Changes
145
+
146
+ - [#47](https://github.com/cloudflare/sandbox-sdk/pull/47) [`8a93d0c`](https://github.com/cloudflare/sandbox-sdk/commit/8a93d0cae18a25bda6506b8b0a08d9e9eb3bb290) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Change default directory to a clean /workspace
147
+
148
+ ## 0.1.4
149
+
150
+ ### Patch Changes
151
+
152
+ - [#46](https://github.com/cloudflare/sandbox-sdk/pull/46) [`7de28be`](https://github.com/cloudflare/sandbox-sdk/commit/7de28be482d9634551572d548c7c4b5842df812d) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Update README
153
+
154
+ - [#44](https://github.com/cloudflare/sandbox-sdk/pull/44) [`215ab49`](https://github.com/cloudflare/sandbox-sdk/commit/215ab494427d7e2a92bb9a25384cb493a221c200) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Update example to use env & cwd
155
+
156
+ - [#42](https://github.com/cloudflare/sandbox-sdk/pull/42) [`bb72193`](https://github.com/cloudflare/sandbox-sdk/commit/bb72193ad75695979bd1132206f481e91fe37325) Thanks [@jonasnobile](https://github.com/jonasnobile)! - Propagate `cwd` and `env` options in `executeCommand`
157
+
158
+ - [#27](https://github.com/cloudflare/sandbox-sdk/pull/27) [`fd5ec7f`](https://github.com/cloudflare/sandbox-sdk/commit/fd5ec7f34bc12b06320a89356c4af07801f52d64) Thanks [@threepointone](https://github.com/threepointone)! - remove yarn and pnpm from the image
159
+
3
160
  ## 0.1.3
4
161
 
5
162
  ### Patch Changes
package/Dockerfile CHANGED
@@ -1,76 +1,137 @@
1
- # Sandbox base image with development tools, Python, Node.js, and Bun
2
- FROM oven/bun:latest AS bun-source
3
- FROM ubuntu:22.04
1
+ # Sandbox container image with full development environment
2
+ # Multi-stage build optimized for Turborepo monorepo
3
+
4
+ # ============================================================================
5
+ # Stage 1: Prune monorepo to only include necessary packages
6
+ # ============================================================================
7
+ FROM node:20-alpine AS pruner
8
+
9
+ WORKDIR /app
10
+
11
+ # Install Turborepo globally
12
+ RUN npm install -g turbo
13
+
14
+ # Copy entire monorepo
15
+ COPY . .
16
+
17
+ # Prune to only @repo/sandbox-container and its dependencies (@repo/shared)
18
+ # The --docker flag generates out/json and out/full directories
19
+ RUN turbo prune @repo/sandbox-container --docker
20
+
21
+ # ============================================================================
22
+ # Stage 2: Install dependencies and build packages
23
+ # ============================================================================
24
+ FROM node:20-alpine AS builder
25
+
26
+ WORKDIR /app
27
+
28
+ # Copy pruned lockfile and package.json files (for Docker layer caching)
29
+ COPY --from=pruner /app/out/json/ .
30
+ COPY --from=pruner /app/out/package-lock.json ./package-lock.json
31
+
32
+ # Install ALL dependencies (including devDependencies for build)
33
+ RUN npm ci
34
+
35
+ # Copy pruned source code
36
+ COPY --from=pruner /app/out/full/ .
37
+
38
+ # Build all packages (Turborepo handles dependency order automatically)
39
+ # This builds @repo/shared first, then @repo/sandbox-container
40
+ RUN npx turbo run build
41
+
42
+ # ============================================================================
43
+ # Stage 3: Install production-only dependencies
44
+ # ============================================================================
45
+ FROM node:20-alpine AS prod-deps
46
+
47
+ WORKDIR /app
48
+
49
+ # Copy package files from builder
50
+ COPY --from=builder /app/package.json ./package.json
51
+ COPY --from=builder /app/package-lock.json ./package-lock.json
52
+ COPY --from=builder /app/packages ./packages
53
+ COPY --from=builder /app/tooling ./tooling
54
+
55
+ # Install ONLY production dependencies (excludes typescript, @types/*, etc.)
56
+ RUN npm ci --production
57
+
58
+ # ============================================================================
59
+ # Stage 4: Runtime - Ubuntu 22.04 with only runtime dependencies
60
+ # ============================================================================
61
+ FROM ubuntu:22.04 AS runtime
4
62
 
5
63
  # Prevent interactive prompts during package installation
6
64
  ENV DEBIAN_FRONTEND=noninteractive
7
65
 
8
- # Install essential system packages and development tools
9
- RUN apt-get update && apt-get install -y \
10
- # Basic utilities
66
+ # Install essential runtime packages
67
+ RUN apt-get update && apt-get install -y --no-install-recommends \
11
68
  curl \
12
69
  wget \
70
+ ca-certificates \
71
+ python3.11 \
72
+ python3-pip \
73
+ python3.11-venv \
74
+ procps \
13
75
  git \
14
76
  unzip \
15
77
  zip \
16
- # Process management
17
- procps \
18
- htop \
19
- # Build tools
20
- build-essential \
21
- pkg-config \
22
- # Network tools
23
- net-tools \
24
- iputils-ping \
25
- dnsutils \
26
- # Text processing
27
78
  jq \
28
- vim \
29
- nano \
30
- # Python dependencies
31
- python3.11 \
32
- python3.11-dev \
33
- python3-pip \
34
- # Other useful tools
35
- sudo \
36
- ca-certificates \
37
- gnupg \
38
- lsb-release \
79
+ file \
39
80
  && rm -rf /var/lib/apt/lists/*
40
81
 
41
82
  # Set Python 3.11 as default python3
42
83
  RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
43
84
 
44
- # Install Node.js 22 LTS
45
- # Using the official NodeSource repository setup script
46
- RUN apt-get update && apt-get install -y ca-certificates curl gnupg \
47
- && mkdir -p /etc/apt/keyrings \
48
- && curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \
49
- && echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_22.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list \
50
- && apt-get update \
85
+ # Install Node.js 20 LTS using official NodeSource setup script
86
+ RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
51
87
  && apt-get install -y nodejs \
52
88
  && rm -rf /var/lib/apt/lists/*
53
89
 
54
- # Install Bun from official image (avoids architecture compatibility issues)
55
- COPY --from=bun-source /usr/local/bin/bun /usr/local/bin/bun
56
- COPY --from=bun-source /usr/local/bin/bunx /usr/local/bin/bunx
90
+ # Install Bun runtime from official image
91
+ COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
57
92
 
93
+ # Install essential Python packages for code execution
94
+ RUN pip3 install --no-cache-dir \
95
+ matplotlib \
96
+ numpy \
97
+ pandas \
98
+ ipython
58
99
 
59
- # Set up working directory
60
- WORKDIR /app
100
+ # Set up runtime container server directory
101
+ WORKDIR /container-server
102
+
103
+ # Copy built sandbox-container package
104
+ COPY --from=builder /app/packages/sandbox-container/dist ./dist
105
+ COPY --from=builder /app/packages/sandbox-container/package.json ./package.json
61
106
 
62
- # Verify installations
63
- RUN python3 --version && \
64
- node --version && \
65
- npm --version && \
66
- bun --version
67
-
107
+ # Copy Python executor to runtime location
108
+ COPY --from=builder /app/packages/sandbox-container/src/runtime/executors/python/ipython_executor.py ./dist/runtime/executors/python/
68
109
 
69
- # Copy container source files
70
- COPY container_src/ ./
110
+ # Copy production-only node_modules (excludes typescript, @types/*, etc.)
111
+ # Includes: @repo/shared, zod, esbuild (runtime dependencies)
112
+ COPY --from=prod-deps /app/node_modules ./node_modules
71
113
 
72
- # Expose the application port
114
+ # Copy workspace packages
115
+ COPY --from=prod-deps /app/packages/shared/dist ./packages/shared/dist
116
+ COPY --from=prod-deps /app/packages/shared/package.json ./packages/shared/package.json
117
+
118
+ # Configure process pool sizes (can be overridden at runtime)
119
+ ENV PYTHON_POOL_MIN_SIZE=3
120
+ ENV PYTHON_POOL_MAX_SIZE=15
121
+ ENV JAVASCRIPT_POOL_MIN_SIZE=3
122
+ ENV JAVASCRIPT_POOL_MAX_SIZE=10
123
+ ENV TYPESCRIPT_POOL_MIN_SIZE=3
124
+ ENV TYPESCRIPT_POOL_MAX_SIZE=10
125
+
126
+ # Create clean workspace directory for user code
127
+ RUN mkdir -p /workspace
128
+
129
+ # Expose the application port (3000 for control)
73
130
  EXPOSE 3000
74
131
 
75
- # Run the application
76
- CMD ["bun", "index.ts"]
132
+ # Copy and make startup script executable
133
+ COPY packages/sandbox/startup.sh ./
134
+ RUN chmod +x startup.sh
135
+
136
+ # Use startup script
137
+ CMD ["./startup.sh"]