@cloudflare/sandbox 0.0.0-6f16c81 → 0.0.0-706e459

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 (56) hide show
  1. package/CHANGELOG.md +284 -0
  2. package/Dockerfile +176 -79
  3. package/README.md +154 -50
  4. package/dist/index.d.ts +1924 -0
  5. package/dist/index.d.ts.map +1 -0
  6. package/dist/index.js +3247 -0
  7. package/dist/index.js.map +1 -0
  8. package/package.json +16 -12
  9. package/src/clients/base-client.ts +295 -0
  10. package/src/clients/command-client.ts +115 -0
  11. package/src/clients/file-client.ts +300 -0
  12. package/src/clients/git-client.ts +98 -0
  13. package/src/clients/index.ts +60 -0
  14. package/src/clients/interpreter-client.ts +333 -0
  15. package/src/clients/port-client.ts +105 -0
  16. package/src/clients/process-client.ts +180 -0
  17. package/src/clients/sandbox-client.ts +39 -0
  18. package/src/clients/types.ts +88 -0
  19. package/src/clients/utility-client.ts +123 -0
  20. package/src/errors/adapter.ts +238 -0
  21. package/src/errors/classes.ts +594 -0
  22. package/src/errors/index.ts +109 -0
  23. package/src/file-stream.ts +169 -0
  24. package/src/index.ts +95 -9
  25. package/src/interpreter.ts +168 -0
  26. package/src/request-handler.ts +119 -31
  27. package/src/sandbox.ts +1117 -134
  28. package/src/security.ts +119 -0
  29. package/src/sse-parser.ts +144 -0
  30. package/src/version.ts +6 -0
  31. package/startup.sh +3 -0
  32. package/tests/base-client.test.ts +364 -0
  33. package/tests/command-client.test.ts +444 -0
  34. package/tests/file-client.test.ts +831 -0
  35. package/tests/file-stream.test.ts +310 -0
  36. package/tests/get-sandbox.test.ts +149 -0
  37. package/tests/git-client.test.ts +487 -0
  38. package/tests/port-client.test.ts +293 -0
  39. package/tests/process-client.test.ts +683 -0
  40. package/tests/request-handler.test.ts +292 -0
  41. package/tests/sandbox.test.ts +706 -0
  42. package/tests/sse-parser.test.ts +291 -0
  43. package/tests/utility-client.test.ts +339 -0
  44. package/tests/version.test.ts +16 -0
  45. package/tests/wrangler.jsonc +35 -0
  46. package/tsconfig.json +9 -1
  47. package/tsdown.config.ts +12 -0
  48. package/vitest.config.ts +31 -0
  49. package/container_src/index.ts +0 -3252
  50. package/container_src/package.json +0 -9
  51. package/src/client.ts +0 -2089
  52. package/tests/client.example.ts +0 -308
  53. package/tests/connection-test.ts +0 -81
  54. package/tests/simple-test.ts +0 -81
  55. package/tests/test1.ts +0 -281
  56. package/tests/test2.ts +0 -929
package/CHANGELOG.md CHANGED
@@ -1,5 +1,289 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.4.15
4
+
5
+ ### Patch Changes
6
+
7
+ - [#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
8
+
9
+ - [#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
10
+
11
+ ## 0.4.14
12
+
13
+ ### Patch Changes
14
+
15
+ - [#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
16
+
17
+ - [#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
18
+
19
+ 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.
20
+
21
+ - [#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
22
+
23
+ We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
24
+
25
+ - [#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
26
+
27
+ ## 0.4.13
28
+
29
+ ### Patch Changes
30
+
31
+ - [#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
32
+
33
+ We inline types from `@repo/shared` so that it includes the types we reexport. Fixes #165
34
+
35
+ - [#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
36
+
37
+ ## 0.4.12
38
+
39
+ ### Patch Changes
40
+
41
+ - [#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
42
+
43
+ ## 0.4.11
44
+
45
+ ### Patch Changes
46
+
47
+ - [#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
48
+
49
+ ## 0.4.10
50
+
51
+ ### Patch Changes
52
+
53
+ - [#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
54
+
55
+ ## 0.4.9
56
+
57
+ ### Patch Changes
58
+
59
+ - [#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
60
+
61
+ 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()`.
62
+
63
+ The implementation is end-to-end:
64
+ - New `FileExistsResult` and `FileExistsRequest` types in shared package
65
+ - Handler endpoint at `/api/exists` in container layer
66
+ - Client method in `FileClient` and `Sandbox` classes
67
+ - Full test coverage (unit tests and E2E tests)
68
+
69
+ ## 0.4.8
70
+
71
+ ### Patch Changes
72
+
73
+ - [#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
74
+
75
+ ## 0.4.7
76
+
77
+ ### Patch Changes
78
+
79
+ - [#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
80
+
81
+ - [#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
82
+
83
+ ## 0.4.6
84
+
85
+ ### Patch Changes
86
+
87
+ - [#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
88
+
89
+ ## 0.4.5
90
+
91
+ ### Patch Changes
92
+
93
+ - [#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
94
+
95
+ ## 0.4.4
96
+
97
+ ### Patch Changes
98
+
99
+ - [#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
100
+
101
+ ## 0.4.3
102
+
103
+ ### Patch Changes
104
+
105
+ - [#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)
106
+
107
+ ## 0.4.2
108
+
109
+ ### Patch Changes
110
+
111
+ - [`e53d7e7`](https://github.com/cloudflare/sandbox-sdk/commit/e53d7e7ce185f79bdd899029bb532e9651ae7ba5) Thanks [@threepointone](https://github.com/threepointone)! - fix build by inlining repo/shared
112
+
113
+ ## 0.4.1
114
+
115
+ ### Patch Changes
116
+
117
+ - [#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
118
+
119
+ ## 0.4.0
120
+
121
+ ### Minor Changes
122
+
123
+ - [#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.
124
+
125
+ ### Patch Changes
126
+
127
+ - [#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
128
+
129
+ ## 0.3.3
130
+
131
+ ### Patch Changes
132
+
133
+ - [#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
134
+
135
+ ## 0.3.2
136
+
137
+ ### Patch Changes
138
+
139
+ - [#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.
140
+
141
+ ## 0.3.1
142
+
143
+ ### Patch Changes
144
+
145
+ - [#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
146
+
147
+ - [#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
148
+
149
+ - [#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
150
+
151
+ - [#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.
152
+
153
+ ## 0.3.0
154
+
155
+ ### Minor Changes
156
+
157
+ - [#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
158
+
159
+ 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.
160
+
161
+ **Key security improvements:**
162
+ - Control plane processes are hidden from sandboxed commands
163
+ - Platform secrets in `/proc/1/environ` are inaccessible
164
+ - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
165
+
166
+ **Breaking changes:**
167
+ 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.
168
+
169
+ ```javascript
170
+ // Before: manual session management
171
+ await sandbox.exec('cd /app', { sessionId: 'my-session' });
172
+
173
+ // After: automatic session per sandbox
174
+ await sandbox.exec('cd /app');
175
+ ```
176
+
177
+ 2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
178
+
179
+ ```javascript
180
+ // Before: each exec was independent
181
+ await sandbox.exec('cd /app');
182
+ await sandbox.exec('pwd'); // Output: /workspace
183
+
184
+ // After: state persists in session
185
+ await sandbox.exec('cd /app');
186
+ await sandbox.exec('pwd'); // Output: /app
187
+ ```
188
+
189
+ **Migration guide:**
190
+ - Remove `sessionId` from all method calls - each sandbox maintains its own session
191
+ - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
192
+ ```javascript
193
+ // Create independent sessions with different environments
194
+ const buildSession = await sandbox.createSession({
195
+ name: 'build',
196
+ env: { NODE_ENV: 'production' },
197
+ cwd: '/build'
198
+ });
199
+ const testSession = await sandbox.createSession({
200
+ name: 'test',
201
+ env: { NODE_ENV: 'test' },
202
+ cwd: '/test'
203
+ });
204
+ ```
205
+ - Environment variables set in one command persist to the next
206
+ - Background processes remain active until explicitly killed
207
+ - Requires CAP_SYS_ADMIN (available in production, falls back gracefully in dev)
208
+
209
+ ### Patch Changes
210
+
211
+ - [#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
212
+
213
+ ## 0.2.4
214
+
215
+ ### Patch Changes
216
+
217
+ - [#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
218
+
219
+ ## 0.2.3
220
+
221
+ ### Patch Changes
222
+
223
+ - [#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
224
+
225
+ ## 0.2.2
226
+
227
+ ### Patch Changes
228
+
229
+ - [#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
230
+
231
+ ## 0.2.1
232
+
233
+ ### Patch Changes
234
+
235
+ - [#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
236
+
237
+ ## 0.2.0
238
+
239
+ ### Minor Changes
240
+
241
+ - [#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
242
+
243
+ ## 0.1.4
244
+
245
+ ### Patch Changes
246
+
247
+ - [#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
248
+
249
+ - [#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
250
+
251
+ - [#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`
252
+
253
+ - [#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
254
+
255
+ ## 0.1.3
256
+
257
+ ### Patch Changes
258
+
259
+ - [#32](https://github.com/cloudflare/sandbox-sdk/pull/32) [`1a42464`](https://github.com/cloudflare/sandbox-sdk/commit/1a4246479369c5d0160705caf192aa1816540d52) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Bring back package README
260
+
261
+ ## 0.1.2
262
+
263
+ ### Patch Changes
264
+
265
+ - [#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
266
+
267
+ - [#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
268
+
269
+ ## 0.1.1
270
+
271
+ ### Patch Changes
272
+
273
+ - [`157dde9`](https://github.com/cloudflare/sandbox-sdk/commit/157dde9b1f23e9bb6f3e9c3f0514b639a8813897) Thanks [@threepointone](https://github.com/threepointone)! - update deps
274
+
275
+ - [`a04f6b6`](https://github.com/cloudflare/sandbox-sdk/commit/a04f6b6c0b2ef9e3ce0851b53769f1c10d8c6de6) Thanks [@threepointone](https://github.com/threepointone)! - trigger a build with updated deps
276
+
277
+ ## 0.1.0
278
+
279
+ ### Minor Changes
280
+
281
+ - [#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
282
+
283
+ ### Patch Changes
284
+
285
+ - [#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
286
+
3
287
  ## 0.0.9
4
288
 
5
289
  ### Patch Changes
package/Dockerfile CHANGED
@@ -1,93 +1,190 @@
1
- # Sandbox base image with development tools, Python, Node.js, and Bun
2
- 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 with cache mount for npm packages
33
+ RUN --mount=type=cache,target=/root/.npm \
34
+ npm ci
35
+
36
+ # Copy pruned source code
37
+ COPY --from=pruner /app/out/full/ .
38
+
39
+ # Build all packages (Turborepo handles dependency order automatically)
40
+ # This builds @repo/shared first, then @repo/sandbox-container
41
+ RUN npx turbo run build
42
+
43
+ # ============================================================================
44
+ # Stage 3: Install production-only dependencies
45
+ # ============================================================================
46
+ FROM node:20-alpine AS prod-deps
47
+
48
+ WORKDIR /app
49
+
50
+ # Copy package files from builder
51
+ COPY --from=builder /app/package.json ./package.json
52
+ COPY --from=builder /app/package-lock.json ./package-lock.json
53
+ COPY --from=builder /app/packages ./packages
54
+ COPY --from=builder /app/tooling ./tooling
55
+
56
+ # Install ONLY production dependencies (excludes typescript, @types/*, etc.)
57
+ RUN --mount=type=cache,target=/root/.npm \
58
+ npm ci --production
59
+
60
+ # ============================================================================
61
+ # Stage 4: Download pre-built Python 3.11.14
62
+ # ============================================================================
63
+ FROM ubuntu:22.04 AS python-builder
3
64
 
4
65
  # Prevent interactive prompts during package installation
5
66
  ENV DEBIAN_FRONTEND=noninteractive
6
67
 
7
- # Install essential system packages and development tools
8
- RUN apt-get update && apt-get install -y \
9
- # Basic utilities
10
- curl \
11
- wget \
12
- git \
13
- unzip \
14
- zip \
15
- # Process management
16
- procps \
17
- htop \
18
- # Build tools
19
- build-essential \
20
- pkg-config \
21
- # Network tools
22
- net-tools \
23
- iputils-ping \
24
- dnsutils \
25
- # Text processing
26
- jq \
27
- vim \
28
- nano \
29
- # Python dependencies
30
- python3.11 \
31
- python3.11-dev \
32
- python3-pip \
33
- # Other useful tools
34
- sudo \
35
- ca-certificates \
36
- gnupg \
37
- lsb-release \
38
- && rm -rf /var/lib/apt/lists/*
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
104
+ # ============================================================================
105
+ FROM ubuntu:22.04 AS runtime
106
+
107
+ # Accept version as build argument (passed from npm_package_version)
108
+ ARG SANDBOX_VERSION=unknown
109
+
110
+ # Prevent interactive prompts during package installation
111
+ ENV DEBIAN_FRONTEND=noninteractive
112
+
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
39
136
 
40
137
  # Set Python 3.11 as default python3
41
- RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
42
-
43
- # Install Node.js 22 LTS
44
- # Using the official NodeSource repository setup script
45
- RUN apt-get update && apt-get install -y ca-certificates curl gnupg \
46
- && mkdir -p /etc/apt/keyrings \
47
- && curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \
48
- && 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 \
49
- && apt-get update \
50
- && apt-get install -y nodejs \
51
- && rm -rf /var/lib/apt/lists/*
52
-
53
- # Install Bun using the official installation script
54
- RUN curl -fsSL https://bun.sh/install | bash \
55
- && mv /root/.bun/bin/bun /usr/local/bin/bun \
56
- && mv /root/.bun/bin/bunx /usr/local/bin/bunx \
57
- && rm -rf /root/.bun
58
-
59
- # Install global npm packages as root
60
- RUN npm install -g yarn pnpm
61
-
62
- # Create a non-root user for running applications
63
- RUN useradd -m -s /bin/bash sandbox \
64
- && echo "sandbox ALL=(ALL) NOPASSWD:ALL" >> /etc/sudoers
65
-
66
- # Set up working directory
67
- WORKDIR /app
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
143
+
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
68
149
 
69
- # Set ownership of the app directory to sandbox user
70
- RUN chown -R sandbox:sandbox /app
150
+ # Install Bun runtime from official image
151
+ COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
71
152
 
72
- # Set environment variables
73
- ENV PATH="/home/sandbox/.local/bin:${PATH}"
153
+ # Set up runtime container server directory
154
+ WORKDIR /container-server
74
155
 
75
- # Switch to non-root user
76
- USER sandbox
156
+ # Copy built sandbox-container package
157
+ COPY --from=builder /app/packages/sandbox-container/dist ./dist
158
+ COPY --from=builder /app/packages/sandbox-container/package.json ./package.json
77
159
 
78
- # Verify installations
79
- RUN python3 --version && \
80
- node --version && \
81
- npm --version && \
82
- bun --version && \
83
- yarn --version && \
84
- pnpm --version
160
+ # Copy Python executor to runtime location
161
+ COPY --from=builder /app/packages/sandbox-container/src/runtime/executors/python/ipython_executor.py ./dist/runtime/executors/python/
85
162
 
86
- # Copy container source files
87
- COPY --chown=sandbox:sandbox container_src/* ./
163
+ # Copy production-only node_modules (excludes typescript, @types/*, etc.)
164
+ # Includes: @repo/shared, zod, esbuild (runtime dependencies)
165
+ COPY --from=prod-deps /app/node_modules ./node_modules
88
166
 
89
- # Expose the application port
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
170
+
171
+ # Configure process pool sizes (can be overridden at runtime)
172
+ ENV PYTHON_POOL_MIN_SIZE=3
173
+ ENV PYTHON_POOL_MAX_SIZE=15
174
+ ENV JAVASCRIPT_POOL_MIN_SIZE=3
175
+ ENV JAVASCRIPT_POOL_MAX_SIZE=10
176
+ ENV TYPESCRIPT_POOL_MIN_SIZE=3
177
+ ENV TYPESCRIPT_POOL_MAX_SIZE=10
178
+
179
+ # Create clean workspace directory for user code
180
+ RUN mkdir -p /workspace
181
+
182
+ # Expose the application port (3000 for control)
90
183
  EXPOSE 3000
91
184
 
92
- # Run the application
93
- CMD ["bun", "index.ts"]
185
+ # Copy and make startup script executable
186
+ COPY packages/sandbox/startup.sh ./
187
+ RUN chmod +x startup.sh
188
+
189
+ # Use startup script
190
+ CMD ["./startup.sh"]