@cloudflare/sandbox 0.0.0-aa00a75 → 0.0.0-aeba44f
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.
- package/CHANGELOG.md +158 -15
- package/Dockerfile +88 -71
- package/LICENSE +176 -0
- package/README.md +10 -5
- package/dist/index.d.ts +1953 -9
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +3278 -53
- package/dist/index.js.map +1 -1
- package/package.json +11 -9
- package/src/clients/base-client.ts +39 -24
- package/src/clients/command-client.ts +8 -8
- package/src/clients/file-client.ts +51 -20
- package/src/clients/git-client.ts +9 -3
- package/src/clients/index.ts +16 -15
- package/src/clients/interpreter-client.ts +51 -47
- package/src/clients/port-client.ts +10 -10
- package/src/clients/process-client.ts +11 -8
- package/src/clients/sandbox-client.ts +2 -4
- package/src/clients/types.ts +6 -2
- package/src/clients/utility-client.ts +67 -5
- package/src/errors/adapter.ts +90 -32
- package/src/errors/classes.ts +189 -64
- package/src/errors/index.ts +9 -5
- package/src/file-stream.ts +11 -6
- package/src/index.ts +28 -17
- package/src/interpreter.ts +50 -41
- package/src/request-handler.ts +34 -21
- package/src/sandbox.ts +502 -151
- package/src/security.ts +21 -6
- package/src/sse-parser.ts +4 -3
- package/src/version.ts +6 -0
- package/startup.sh +1 -1
- package/tests/base-client.test.ts +116 -80
- package/tests/command-client.test.ts +149 -112
- package/tests/file-client.test.ts +373 -185
- package/tests/file-stream.test.ts +24 -20
- package/tests/get-sandbox.test.ts +149 -0
- package/tests/git-client.test.ts +260 -101
- package/tests/port-client.test.ts +100 -108
- package/tests/process-client.test.ts +204 -179
- package/tests/request-handler.test.ts +292 -0
- package/tests/sandbox.test.ts +336 -62
- package/tests/sse-parser.test.ts +17 -16
- package/tests/utility-client.test.ts +129 -56
- package/tests/version.test.ts +16 -0
- package/tsdown.config.ts +12 -0
- package/vitest.config.ts +6 -6
- package/dist/chunk-BCJ7SF3Q.js +0 -117
- package/dist/chunk-BCJ7SF3Q.js.map +0 -1
- package/dist/chunk-BFVUNTP4.js +0 -104
- package/dist/chunk-BFVUNTP4.js.map +0 -1
- package/dist/chunk-EKSWCBCA.js +0 -86
- package/dist/chunk-EKSWCBCA.js.map +0 -1
- package/dist/chunk-HGF554LH.js +0 -2236
- package/dist/chunk-HGF554LH.js.map +0 -1
- package/dist/chunk-Z532A7QC.js +0 -78
- package/dist/chunk-Z532A7QC.js.map +0 -1
- package/dist/file-stream.d.ts +0 -43
- package/dist/file-stream.js +0 -9
- package/dist/file-stream.js.map +0 -1
- package/dist/interpreter.d.ts +0 -33
- package/dist/interpreter.js +0 -8
- package/dist/interpreter.js.map +0 -1
- package/dist/request-handler.d.ts +0 -18
- package/dist/request-handler.js +0 -12
- package/dist/request-handler.js.map +0 -1
- package/dist/sandbox-D9K2ypln.d.ts +0 -583
- package/dist/sandbox.d.ts +0 -4
- package/dist/sandbox.js +0 -12
- package/dist/sandbox.js.map +0 -1
- package/dist/security.d.ts +0 -31
- package/dist/security.js +0 -13
- package/dist/security.js.map +0 -1
- package/dist/sse-parser.d.ts +0 -28
- package/dist/sse-parser.js +0 -11
- package/dist/sse-parser.js.map +0 -1
package/CHANGELOG.md
CHANGED
|
@@ -1,5 +1,151 @@
|
|
|
1
1
|
# @cloudflare/sandbox
|
|
2
2
|
|
|
3
|
+
## 0.4.19
|
|
4
|
+
|
|
5
|
+
### Patch Changes
|
|
6
|
+
|
|
7
|
+
- [#203](https://github.com/cloudflare/sandbox-sdk/pull/203) [`63b07c0`](https://github.com/cloudflare/sandbox-sdk/commit/63b07c0895f3cb9bf44fc84df1b5671b27391152) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - Fix listFiles to work in hidden directories without includeHidden flag
|
|
8
|
+
|
|
9
|
+
## 0.4.18
|
|
10
|
+
|
|
11
|
+
### Patch Changes
|
|
12
|
+
|
|
13
|
+
- [`228ef5b`](https://github.com/cloudflare/sandbox-sdk/commit/228ef5b6e57fa3c38dc8d90e006ae58d0815aaec) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix encoding parameter handling in file operations to enable MIME auto-detection. Previously, SDK and container handlers added default 'utf8' encoding, preventing MIME-based detection of binary files. Now encoding parameter is passed through as-is, allowing automatic detection when not explicitly specified.
|
|
14
|
+
|
|
15
|
+
## 0.4.17
|
|
16
|
+
|
|
17
|
+
### Patch Changes
|
|
18
|
+
|
|
19
|
+
- [#198](https://github.com/cloudflare/sandbox-sdk/pull/198) [`93c6cc7`](https://github.com/cloudflare/sandbox-sdk/commit/93c6cc7c6b8df9e0a733fa852faf5d2f1c5758da) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix container startup failures when WORKDIR is changed in derived Dockerfiles
|
|
20
|
+
|
|
21
|
+
## 0.4.16
|
|
22
|
+
|
|
23
|
+
### Patch Changes
|
|
24
|
+
|
|
25
|
+
- [#184](https://github.com/cloudflare/sandbox-sdk/pull/184) [`7989b61`](https://github.com/cloudflare/sandbox-sdk/commit/7989b6105cea8c381dd162be0bcb29db3e214fde) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Redact credentials from Git URLs in logs
|
|
26
|
+
|
|
27
|
+
- [#186](https://github.com/cloudflare/sandbox-sdk/pull/186) [`c2e3384`](https://github.com/cloudflare/sandbox-sdk/commit/c2e3384b151ae3f430c2edc8c492921d0b6b8b1c) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - Expose deleteSession API with proper safeguards
|
|
28
|
+
- Add `deleteSession(sessionId)` method to public SDK API
|
|
29
|
+
- Prevent deletion of default session (throws error with guidance to use `sandbox.destroy()`)
|
|
30
|
+
- Session cleanup kills all running commands in parallel before destroying shell
|
|
31
|
+
- Return structured `SessionDeleteResult` with success status, sessionId, and timestamp
|
|
32
|
+
|
|
33
|
+
## 0.4.15
|
|
34
|
+
|
|
35
|
+
### Patch Changes
|
|
36
|
+
|
|
37
|
+
- [#185](https://github.com/cloudflare/sandbox-sdk/pull/185) [`7897cdd`](https://github.com/cloudflare/sandbox-sdk/commit/7897cddefc366bbd640ea138b34a520a0b2ddf8c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix foreground commands blocking on background processes
|
|
38
|
+
|
|
39
|
+
- [#183](https://github.com/cloudflare/sandbox-sdk/pull/183) [`ff2fa91`](https://github.com/cloudflare/sandbox-sdk/commit/ff2fa91479357ef88cfb22418f88acb257462faa) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - update python to 3.11.14
|
|
40
|
+
|
|
41
|
+
## 0.4.14
|
|
42
|
+
|
|
43
|
+
### Patch Changes
|
|
44
|
+
|
|
45
|
+
- [#172](https://github.com/cloudflare/sandbox-sdk/pull/172) [`1bf3576`](https://github.com/cloudflare/sandbox-sdk/commit/1bf35768b02532c77df6f30a2f2eb08cb2b12115) Thanks [@threepointone](https://github.com/threepointone)! - Update dependencies
|
|
46
|
+
|
|
47
|
+
- [#176](https://github.com/cloudflare/sandbox-sdk/pull/176) [`7edbfa9`](https://github.com/cloudflare/sandbox-sdk/commit/7edbfa906668d75f540527f50b52483dc787192c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add cache mounts to Dockerfile for faster builds
|
|
48
|
+
|
|
49
|
+
Adds cache mounts for npm, apt, and pip package managers in the Dockerfile. This speeds up Docker image builds when dependencies change, particularly beneficial for users building from source.
|
|
50
|
+
|
|
51
|
+
- [#172](https://github.com/cloudflare/sandbox-sdk/pull/172) [`1bf3576`](https://github.com/cloudflare/sandbox-sdk/commit/1bf35768b02532c77df6f30a2f2eb08cb2b12115) Thanks [@threepointone](https://github.com/threepointone)! - Fix type generation
|
|
52
|
+
|
|
53
|
+
We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
|
|
54
|
+
|
|
55
|
+
- [#175](https://github.com/cloudflare/sandbox-sdk/pull/175) [`77cb937`](https://github.com/cloudflare/sandbox-sdk/commit/77cb93762a619523758f769a10509e665ca819fe) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Move .connect to .wsConnect within DO stub
|
|
56
|
+
|
|
57
|
+
## 0.4.13
|
|
58
|
+
|
|
59
|
+
### Patch Changes
|
|
60
|
+
|
|
61
|
+
- [#168](https://github.com/cloudflare/sandbox-sdk/pull/168) [`6b08f02`](https://github.com/cloudflare/sandbox-sdk/commit/6b08f02c061aef07cc98188abef2973ac92365f8) Thanks [@threepointone](https://github.com/threepointone)! - Fix type generation
|
|
62
|
+
|
|
63
|
+
We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
|
|
64
|
+
|
|
65
|
+
- [#162](https://github.com/cloudflare/sandbox-sdk/pull/162) [`c4db459`](https://github.com/cloudflare/sandbox-sdk/commit/c4db459389a7b86048a03410d67d4dd7bf4a6085) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - Add WebSocket support via connect() method for routing client WebSocket connections directly to container services
|
|
66
|
+
|
|
67
|
+
## 0.4.12
|
|
68
|
+
|
|
69
|
+
### Patch Changes
|
|
70
|
+
|
|
71
|
+
- [#137](https://github.com/cloudflare/sandbox-sdk/pull/137) [`7f4442b`](https://github.com/cloudflare/sandbox-sdk/commit/7f4442b7a097587d8f8e8f9ff2f887df6943a3db) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - add keepAlive flag to prevent containers from shutting down
|
|
72
|
+
|
|
73
|
+
## 0.4.11
|
|
74
|
+
|
|
75
|
+
### Patch Changes
|
|
76
|
+
|
|
77
|
+
- [#159](https://github.com/cloudflare/sandbox-sdk/pull/159) [`e16659a`](https://github.com/cloudflare/sandbox-sdk/commit/e16659a1815923f1cd1176f51a052725d820ee16) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Use latest containers package version
|
|
78
|
+
|
|
79
|
+
## 0.4.10
|
|
80
|
+
|
|
81
|
+
### Patch Changes
|
|
82
|
+
|
|
83
|
+
- [#156](https://github.com/cloudflare/sandbox-sdk/pull/156) [`b61841c`](https://github.com/cloudflare/sandbox-sdk/commit/b61841cfb3248022ee8136311e54955ed9faa1ee) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix WebSocket upgrade requests through exposed ports
|
|
84
|
+
|
|
85
|
+
## 0.4.9
|
|
86
|
+
|
|
87
|
+
### Patch Changes
|
|
88
|
+
|
|
89
|
+
- [#152](https://github.com/cloudflare/sandbox-sdk/pull/152) [`8e7773e`](https://github.com/cloudflare/sandbox-sdk/commit/8e7773ec9571a5f968cbbc5f48e38e01d7d13b77) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add exists() method to check if a file or directory exists
|
|
90
|
+
|
|
91
|
+
This adds a new `exists()` method to the SDK that checks whether a file or directory exists at a given path. The method returns a boolean indicating existence, similar to Python's `os.path.exists()` and JavaScript's `fs.existsSync()`.
|
|
92
|
+
|
|
93
|
+
The implementation is end-to-end:
|
|
94
|
+
- New `FileExistsResult` and `FileExistsRequest` types in shared package
|
|
95
|
+
- Handler endpoint at `/api/exists` in container layer
|
|
96
|
+
- Client method in `FileClient` and `Sandbox` classes
|
|
97
|
+
- Full test coverage (unit tests and E2E tests)
|
|
98
|
+
|
|
99
|
+
## 0.4.8
|
|
100
|
+
|
|
101
|
+
### Patch Changes
|
|
102
|
+
|
|
103
|
+
- [#153](https://github.com/cloudflare/sandbox-sdk/pull/153) [`f6a5c3e`](https://github.com/cloudflare/sandbox-sdk/commit/f6a5c3e1607fce5fc26f816e9206ae437898d5af) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix token extraction regex causing Invalid token errors
|
|
104
|
+
|
|
105
|
+
## 0.4.7
|
|
106
|
+
|
|
107
|
+
### Patch Changes
|
|
108
|
+
|
|
109
|
+
- [#141](https://github.com/cloudflare/sandbox-sdk/pull/141) [`c39674b`](https://github.com/cloudflare/sandbox-sdk/commit/c39674b8fe2e986e59a794b6bb3a5f51a87bae89) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix commands hanging when reading stdin by redirecting stdin to /dev/null
|
|
110
|
+
|
|
111
|
+
- [#143](https://github.com/cloudflare/sandbox-sdk/pull/143) [`276efc0`](https://github.com/cloudflare/sandbox-sdk/commit/276efc0ca8776bcc8de79e7e58dd24d9f418cc5c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Remove unnecessary existing session check
|
|
112
|
+
|
|
113
|
+
## 0.4.6
|
|
114
|
+
|
|
115
|
+
### Patch Changes
|
|
116
|
+
|
|
117
|
+
- [#133](https://github.com/cloudflare/sandbox-sdk/pull/133) [`da2cfb8`](https://github.com/cloudflare/sandbox-sdk/commit/da2cfb876675eb3445970c90b4d70d00288a7c74) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - feat: Add version sync detection between npm package and Docker image
|
|
118
|
+
|
|
119
|
+
## 0.4.5
|
|
120
|
+
|
|
121
|
+
### Patch Changes
|
|
122
|
+
|
|
123
|
+
- [#127](https://github.com/cloudflare/sandbox-sdk/pull/127) [`e79ac80`](https://github.com/cloudflare/sandbox-sdk/commit/e79ac80bc855a3ec527d44cc14585794b23cb129) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - configurable sleepAfter
|
|
124
|
+
|
|
125
|
+
## 0.4.4
|
|
126
|
+
|
|
127
|
+
### Patch Changes
|
|
128
|
+
|
|
129
|
+
- [#125](https://github.com/cloudflare/sandbox-sdk/pull/125) [`fddccfd`](https://github.com/cloudflare/sandbox-sdk/commit/fddccfdce8204ce2aa7dadc0ad9fb2acbdeaec51) Thanks [@whoiskatrin](https://github.com/whoiskatrin)! - add docker image to pkg workflow
|
|
130
|
+
|
|
131
|
+
## 0.4.3
|
|
132
|
+
|
|
133
|
+
### Patch Changes
|
|
134
|
+
|
|
135
|
+
- [#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)
|
|
136
|
+
|
|
137
|
+
## 0.4.2
|
|
138
|
+
|
|
139
|
+
### Patch Changes
|
|
140
|
+
|
|
141
|
+
- [`e53d7e7`](https://github.com/cloudflare/sandbox-sdk/commit/e53d7e7ce185f79bdd899029bb532e9651ae7ba5) Thanks [@threepointone](https://github.com/threepointone)! - fix build by inlining repo/shared
|
|
142
|
+
|
|
143
|
+
## 0.4.1
|
|
144
|
+
|
|
145
|
+
### Patch Changes
|
|
146
|
+
|
|
147
|
+
- [#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
|
|
148
|
+
|
|
3
149
|
## 0.4.0
|
|
4
150
|
|
|
5
151
|
### Minor Changes
|
|
@@ -43,50 +189,47 @@
|
|
|
43
189
|
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.
|
|
44
190
|
|
|
45
191
|
**Key security improvements:**
|
|
46
|
-
|
|
47
192
|
- Control plane processes are hidden from sandboxed commands
|
|
48
193
|
- Platform secrets in `/proc/1/environ` are inaccessible
|
|
49
194
|
- Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
|
|
50
195
|
|
|
51
196
|
**Breaking changes:**
|
|
52
|
-
|
|
53
197
|
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.
|
|
54
198
|
|
|
55
199
|
```javascript
|
|
56
200
|
// Before: manual session management
|
|
57
|
-
await sandbox.exec(
|
|
201
|
+
await sandbox.exec('cd /app', { sessionId: 'my-session' });
|
|
58
202
|
|
|
59
203
|
// After: automatic session per sandbox
|
|
60
|
-
await sandbox.exec(
|
|
204
|
+
await sandbox.exec('cd /app');
|
|
61
205
|
```
|
|
62
206
|
|
|
63
207
|
2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
|
|
64
208
|
|
|
65
209
|
```javascript
|
|
66
210
|
// Before: each exec was independent
|
|
67
|
-
await sandbox.exec(
|
|
68
|
-
await sandbox.exec(
|
|
211
|
+
await sandbox.exec('cd /app');
|
|
212
|
+
await sandbox.exec('pwd'); // Output: /workspace
|
|
69
213
|
|
|
70
214
|
// After: state persists in session
|
|
71
|
-
await sandbox.exec(
|
|
72
|
-
await sandbox.exec(
|
|
215
|
+
await sandbox.exec('cd /app');
|
|
216
|
+
await sandbox.exec('pwd'); // Output: /app
|
|
73
217
|
```
|
|
74
218
|
|
|
75
219
|
**Migration guide:**
|
|
76
|
-
|
|
77
220
|
- Remove `sessionId` from all method calls - each sandbox maintains its own session
|
|
78
221
|
- If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
|
|
79
222
|
```javascript
|
|
80
223
|
// Create independent sessions with different environments
|
|
81
224
|
const buildSession = await sandbox.createSession({
|
|
82
|
-
name:
|
|
83
|
-
env: { NODE_ENV:
|
|
84
|
-
cwd:
|
|
225
|
+
name: 'build',
|
|
226
|
+
env: { NODE_ENV: 'production' },
|
|
227
|
+
cwd: '/build'
|
|
85
228
|
});
|
|
86
229
|
const testSession = await sandbox.createSession({
|
|
87
|
-
name:
|
|
88
|
-
env: { NODE_ENV:
|
|
89
|
-
cwd:
|
|
230
|
+
name: 'test',
|
|
231
|
+
env: { NODE_ENV: 'test' },
|
|
232
|
+
cwd: '/test'
|
|
90
233
|
});
|
|
91
234
|
```
|
|
92
235
|
- Environment variables set in one command persist to the next
|
package/Dockerfile
CHANGED
|
@@ -29,8 +29,9 @@ WORKDIR /app
|
|
|
29
29
|
COPY --from=pruner /app/out/json/ .
|
|
30
30
|
COPY --from=pruner /app/out/package-lock.json ./package-lock.json
|
|
31
31
|
|
|
32
|
-
# Install ALL dependencies
|
|
33
|
-
RUN npm
|
|
32
|
+
# Install ALL dependencies with cache mount for npm packages
|
|
33
|
+
RUN --mount=type=cache,target=/root/.npm \
|
|
34
|
+
CI=true npm ci
|
|
34
35
|
|
|
35
36
|
# Copy pruned source code
|
|
36
37
|
COPY --from=pruner /app/out/full/ .
|
|
@@ -53,81 +54,101 @@ COPY --from=builder /app/packages ./packages
|
|
|
53
54
|
COPY --from=builder /app/tooling ./tooling
|
|
54
55
|
|
|
55
56
|
# Install ONLY production dependencies (excludes typescript, @types/*, etc.)
|
|
56
|
-
RUN npm
|
|
57
|
+
RUN --mount=type=cache,target=/root/.npm \
|
|
58
|
+
CI=true npm ci --production
|
|
57
59
|
|
|
58
60
|
# ============================================================================
|
|
59
|
-
# Stage 4:
|
|
61
|
+
# Stage 4: Download pre-built Python 3.11.14
|
|
62
|
+
# ============================================================================
|
|
63
|
+
FROM ubuntu:22.04 AS python-builder
|
|
64
|
+
|
|
65
|
+
# Prevent interactive prompts during package installation
|
|
66
|
+
ENV DEBIAN_FRONTEND=noninteractive
|
|
67
|
+
|
|
68
|
+
# Accept architecture from Docker BuildKit (for multi-arch builds)
|
|
69
|
+
ARG TARGETARCH
|
|
70
|
+
|
|
71
|
+
# Install minimal dependencies for downloading
|
|
72
|
+
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
73
|
+
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
74
|
+
rm -f /etc/apt/apt.conf.d/docker-clean && \
|
|
75
|
+
echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' >/etc/apt/apt.conf.d/keep-cache && \
|
|
76
|
+
apt-get update && apt-get install -y --no-install-recommends \
|
|
77
|
+
wget ca-certificates
|
|
78
|
+
|
|
79
|
+
# Download and extract pre-built Python 3.11.14 from python-build-standalone
|
|
80
|
+
# Using PGO+LTO optimized builds for better performance
|
|
81
|
+
# Supports multi-arch: amd64 (x86_64) and arm64 (aarch64)
|
|
82
|
+
RUN --mount=type=cache,target=/tmp/python-cache \
|
|
83
|
+
# Map Docker TARGETARCH to python-build-standalone arch naming
|
|
84
|
+
if [ "$TARGETARCH" = "amd64" ]; then \
|
|
85
|
+
PYTHON_ARCH="x86_64-unknown-linux-gnu"; \
|
|
86
|
+
EXPECTED_SHA256="edd8d11aa538953d12822fab418359a692fd1ee4ca2675579fbf0fa31e3688f1"; \
|
|
87
|
+
elif [ "$TARGETARCH" = "arm64" ]; then \
|
|
88
|
+
PYTHON_ARCH="aarch64-unknown-linux-gnu"; \
|
|
89
|
+
EXPECTED_SHA256="08141d31f95d86a23f23e4c741b726de0055f12f83200d1d4867b4e8e6e967c5"; \
|
|
90
|
+
else \
|
|
91
|
+
echo "Unsupported architecture: $TARGETARCH" && exit 1; \
|
|
92
|
+
fi && \
|
|
93
|
+
cd /tmp/python-cache && \
|
|
94
|
+
wget -nc https://github.com/indygreg/python-build-standalone/releases/download/20251028/cpython-3.11.14+20251028-${PYTHON_ARCH}-install_only.tar.gz && \
|
|
95
|
+
# Verify SHA256 checksum for security
|
|
96
|
+
echo "${EXPECTED_SHA256} cpython-3.11.14+20251028-${PYTHON_ARCH}-install_only.tar.gz" | sha256sum -c - && \
|
|
97
|
+
cd /tmp && \
|
|
98
|
+
tar -xzf /tmp/python-cache/cpython-3.11.14+20251028-${PYTHON_ARCH}-install_only.tar.gz && \
|
|
99
|
+
mv python /usr/local/ && \
|
|
100
|
+
rm -rf /tmp/cpython-*
|
|
101
|
+
|
|
102
|
+
# ============================================================================
|
|
103
|
+
# Stage 5: Runtime - Ubuntu 22.04 with only runtime dependencies
|
|
60
104
|
# ============================================================================
|
|
61
105
|
FROM ubuntu:22.04 AS runtime
|
|
62
106
|
|
|
107
|
+
# Accept version as build argument (passed from npm_package_version)
|
|
108
|
+
ARG SANDBOX_VERSION=unknown
|
|
109
|
+
|
|
63
110
|
# Prevent interactive prompts during package installation
|
|
64
111
|
ENV DEBIAN_FRONTEND=noninteractive
|
|
65
112
|
|
|
66
|
-
#
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
71
|
-
|
|
72
|
-
|
|
73
|
-
|
|
74
|
-
|
|
75
|
-
|
|
76
|
-
|
|
77
|
-
|
|
78
|
-
|
|
79
|
-
|
|
80
|
-
|
|
81
|
-
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
87
|
-
|
|
88
|
-
|
|
89
|
-
# Python dependencies
|
|
90
|
-
python3.11 \
|
|
91
|
-
python3.11-dev \
|
|
92
|
-
python3-pip \
|
|
93
|
-
python3.11-venv \
|
|
94
|
-
# Other useful tools
|
|
95
|
-
ca-certificates \
|
|
96
|
-
gnupg \
|
|
97
|
-
lsb-release \
|
|
98
|
-
strace \
|
|
99
|
-
&& rm -rf /var/lib/apt/lists/*
|
|
113
|
+
# Set the sandbox version as an environment variable for version checking
|
|
114
|
+
ENV SANDBOX_VERSION=${SANDBOX_VERSION}
|
|
115
|
+
|
|
116
|
+
# Install runtime packages and Python runtime libraries
|
|
117
|
+
RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
|
|
118
|
+
--mount=type=cache,target=/var/lib/apt,sharing=locked \
|
|
119
|
+
rm -f /etc/apt/apt.conf.d/docker-clean && \
|
|
120
|
+
echo 'Binary::apt::APT::Keep-Downloaded-Packages "true";' >/etc/apt/apt.conf.d/keep-cache && \
|
|
121
|
+
apt-get update && apt-get install -y --no-install-recommends \
|
|
122
|
+
ca-certificates curl wget procps git unzip zip jq file \
|
|
123
|
+
libssl3 zlib1g libbz2-1.0 libreadline8 libsqlite3-0 \
|
|
124
|
+
libncursesw6 libtinfo6 libxml2 libxmlsec1 libffi8 liblzma5 libtk8.6 && \
|
|
125
|
+
update-ca-certificates
|
|
126
|
+
|
|
127
|
+
# Copy pre-built Python from python-builder stage
|
|
128
|
+
COPY --from=python-builder /usr/local/python /usr/local/python
|
|
129
|
+
|
|
130
|
+
# Create symlinks and update shared library cache
|
|
131
|
+
RUN ln -s /usr/local/python/bin/python3.11 /usr/local/bin/python3.11 && \
|
|
132
|
+
ln -s /usr/local/python/bin/python3 /usr/local/bin/python3 && \
|
|
133
|
+
ln -s /usr/local/python/bin/pip3 /usr/local/bin/pip3 && \
|
|
134
|
+
echo "/usr/local/python/lib" > /etc/ld.so.conf.d/python.conf && \
|
|
135
|
+
ldconfig
|
|
100
136
|
|
|
101
137
|
# Set Python 3.11 as default python3
|
|
102
|
-
RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
|
|
138
|
+
RUN update-alternatives --install /usr/bin/python3 python3 /usr/local/bin/python3.11 1
|
|
139
|
+
|
|
140
|
+
# Install Python packages
|
|
141
|
+
RUN --mount=type=cache,target=/root/.cache/pip \
|
|
142
|
+
pip3 install --no-cache-dir matplotlib numpy pandas ipython
|
|
103
143
|
|
|
104
|
-
# Install Node.js 20 LTS
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
144
|
+
# Install Node.js 20 LTS from official Node image
|
|
145
|
+
COPY --from=node:20-slim /usr/local/bin/node /usr/local/bin/node
|
|
146
|
+
COPY --from=node:20-slim /usr/local/lib/node_modules /usr/local/lib/node_modules
|
|
147
|
+
RUN ln -s /usr/local/lib/node_modules/npm/bin/npm-cli.js /usr/local/bin/npm && \
|
|
148
|
+
ln -s /usr/local/lib/node_modules/npm/bin/npx-cli.js /usr/local/bin/npx
|
|
108
149
|
|
|
109
150
|
# Install Bun runtime from official image
|
|
110
151
|
COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
|
|
111
|
-
COPY --from=oven/bun:1 /usr/local/bin/bunx /usr/local/bin/bunx
|
|
112
|
-
|
|
113
|
-
# Install development tools globally
|
|
114
|
-
RUN npm install -g \
|
|
115
|
-
wrangler \
|
|
116
|
-
vite \
|
|
117
|
-
opencode-ai
|
|
118
|
-
|
|
119
|
-
# Install essential Python packages for code execution
|
|
120
|
-
RUN pip3 install --no-cache-dir \
|
|
121
|
-
matplotlib \
|
|
122
|
-
numpy \
|
|
123
|
-
pandas \
|
|
124
|
-
ipython
|
|
125
|
-
|
|
126
|
-
# Verify installations
|
|
127
|
-
RUN python3 --version && \
|
|
128
|
-
node --version && \
|
|
129
|
-
npm --version && \
|
|
130
|
-
bun --version
|
|
131
152
|
|
|
132
153
|
# Set up runtime container server directory
|
|
133
154
|
WORKDIR /container-server
|
|
@@ -143,10 +164,9 @@ COPY --from=builder /app/packages/sandbox-container/src/runtime/executors/python
|
|
|
143
164
|
# Includes: @repo/shared, zod, esbuild (runtime dependencies)
|
|
144
165
|
COPY --from=prod-deps /app/node_modules ./node_modules
|
|
145
166
|
|
|
146
|
-
# Copy workspace packages
|
|
147
|
-
|
|
148
|
-
COPY --from=prod-deps /app/packages/shared ./packages/shared
|
|
149
|
-
COPY --from=prod-deps /app/tooling/typescript-config ./tooling/typescript-config
|
|
167
|
+
# Copy workspace packages
|
|
168
|
+
COPY --from=prod-deps /app/packages/shared/dist ./packages/shared/dist
|
|
169
|
+
COPY --from=prod-deps /app/packages/shared/package.json ./packages/shared/package.json
|
|
150
170
|
|
|
151
171
|
# Configure process pool sizes (can be overridden at runtime)
|
|
152
172
|
ENV PYTHON_POOL_MIN_SIZE=3
|
|
@@ -157,9 +177,6 @@ ENV TYPESCRIPT_POOL_MIN_SIZE=3
|
|
|
157
177
|
ENV TYPESCRIPT_POOL_MAX_SIZE=10
|
|
158
178
|
|
|
159
179
|
# Create clean workspace directory for user code
|
|
160
|
-
# Architecture:
|
|
161
|
-
# /container-server/ - SDK infrastructure (server, executors, dependencies)
|
|
162
|
-
# /workspace/ - User's clean workspace for their code
|
|
163
180
|
RUN mkdir -p /workspace
|
|
164
181
|
|
|
165
182
|
# Expose the application port (3000 for control)
|
|
@@ -170,4 +187,4 @@ COPY packages/sandbox/startup.sh ./
|
|
|
170
187
|
RUN chmod +x startup.sh
|
|
171
188
|
|
|
172
189
|
# Use startup script
|
|
173
|
-
CMD ["
|
|
190
|
+
CMD ["/container-server/startup.sh"]
|
package/LICENSE
ADDED
|
@@ -0,0 +1,176 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
package/README.md
CHANGED
|
@@ -10,8 +10,6 @@ The Sandbox SDK lets you run untrusted code safely in isolated containers. Execu
|
|
|
10
10
|
|
|
11
11
|
Perfect for AI code execution, interactive development environments, data analysis platforms, CI/CD systems, and any application that needs secure code execution at the edge.
|
|
12
12
|
|
|
13
|
-
> **Note:** The latest published version of the SDK is on the [v03 branch](https://github.com/cloudflare/sandbox-sdk/tree/v03). This main branch is currently the development version and is not yet published.
|
|
14
|
-
|
|
15
13
|
## Getting Started
|
|
16
14
|
|
|
17
15
|
### Prerequisites
|
|
@@ -118,9 +116,17 @@ export default {
|
|
|
118
116
|
- **Preview URLs** - Expose services with public URLs
|
|
119
117
|
- **Git Integration** - Clone repositories directly
|
|
120
118
|
|
|
119
|
+
## Contributing
|
|
120
|
+
|
|
121
|
+
We welcome contributions from the community! See [CONTRIBUTING.md](./CONTRIBUTING.md) for guidelines on:
|
|
122
|
+
|
|
123
|
+
- Setting up your development environment
|
|
124
|
+
- Creating pull requests
|
|
125
|
+
- Code style and testing requirements
|
|
126
|
+
|
|
121
127
|
## Development
|
|
122
128
|
|
|
123
|
-
This repository contains the SDK source code.
|
|
129
|
+
This repository contains the SDK source code. Quick start:
|
|
124
130
|
|
|
125
131
|
```bash
|
|
126
132
|
# Clone the repo
|
|
@@ -146,7 +152,6 @@ See the [examples directory](./examples) for complete working examples:
|
|
|
146
152
|
|
|
147
153
|
- [Minimal](./examples/minimal) - Basic sandbox setup
|
|
148
154
|
- [Code Interpreter](./examples/code-interpreter) - Use sandbox as an interpreter tool with gpt-oss
|
|
149
|
-
- [Complete](./examples/basic) - Huge example integrated with every sandbox feature
|
|
150
155
|
|
|
151
156
|
## Status
|
|
152
157
|
|
|
@@ -154,7 +159,7 @@ See the [examples directory](./examples) for complete working examples:
|
|
|
154
159
|
|
|
155
160
|
## License
|
|
156
161
|
|
|
157
|
-
[
|
|
162
|
+
[Apache License 2.0](LICENSE)
|
|
158
163
|
|
|
159
164
|
## Links
|
|
160
165
|
|