@cloudflare/sandbox 0.0.0-444d2da → 0.0.0-46eb4e6

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 (43) hide show
  1. package/CHANGELOG.md +205 -0
  2. package/Dockerfile +97 -10
  3. package/README.md +858 -24
  4. package/container_src/bun.lock +76 -0
  5. package/container_src/circuit-breaker.ts +121 -0
  6. package/container_src/control-process.ts +784 -0
  7. package/container_src/handler/exec.ts +185 -0
  8. package/container_src/handler/file.ts +457 -0
  9. package/container_src/handler/git.ts +130 -0
  10. package/container_src/handler/ports.ts +314 -0
  11. package/container_src/handler/process.ts +568 -0
  12. package/container_src/handler/session.ts +92 -0
  13. package/container_src/index.ts +439 -2739
  14. package/container_src/interpreter-service.ts +276 -0
  15. package/container_src/isolation.ts +1213 -0
  16. package/container_src/mime-processor.ts +255 -0
  17. package/container_src/package.json +9 -0
  18. package/container_src/runtime/executors/javascript/node_executor.ts +123 -0
  19. package/container_src/runtime/executors/python/ipython_executor.py +338 -0
  20. package/container_src/runtime/executors/typescript/ts_executor.ts +138 -0
  21. package/container_src/runtime/process-pool.ts +464 -0
  22. package/container_src/shell-escape.ts +42 -0
  23. package/container_src/startup.sh +11 -0
  24. package/container_src/types.ts +131 -0
  25. package/package.json +6 -8
  26. package/src/client.ts +474 -1355
  27. package/src/errors.ts +219 -0
  28. package/src/file-stream.ts +162 -0
  29. package/src/index.ts +78 -126
  30. package/src/interpreter-client.ts +352 -0
  31. package/src/interpreter-types.ts +390 -0
  32. package/src/interpreter.ts +150 -0
  33. package/src/request-handler.ts +144 -0
  34. package/src/sandbox.ts +756 -0
  35. package/src/security.ts +113 -0
  36. package/src/sse-parser.ts +147 -0
  37. package/src/types.ts +571 -0
  38. package/tsconfig.json +1 -1
  39. package/tests/client.example.ts +0 -308
  40. package/tests/connection-test.ts +0 -81
  41. package/tests/simple-test.ts +0 -81
  42. package/tests/test1.ts +0 -281
  43. package/tests/test2.ts +0 -929
package/CHANGELOG.md CHANGED
@@ -1,5 +1,210 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.3.4
4
+
5
+ ### Patch Changes
6
+
7
+ - [#86](https://github.com/cloudflare/sandbox-sdk/pull/86) [`feafd32`](https://github.com/cloudflare/sandbox-sdk/commit/feafd32a51f50dfaf4994bddcbfb56d46cada622) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Fix session reuse to reuse existing healthy session
8
+
9
+ ## 0.3.3
10
+
11
+ ### Patch Changes
12
+
13
+ - [#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
14
+
15
+ ## 0.3.2
16
+
17
+ ### Patch Changes
18
+
19
+ - [#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.
20
+
21
+ ## 0.3.1
22
+
23
+ ### Patch Changes
24
+
25
+ - [#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
26
+
27
+ - [#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
28
+
29
+ - [#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
30
+
31
+ - [#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.
32
+
33
+ ## 0.3.0
34
+
35
+ ### Minor Changes
36
+
37
+ - [#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
38
+
39
+ 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.
40
+
41
+ **Key security improvements:**
42
+
43
+ - Control plane processes are hidden from sandboxed commands
44
+ - Platform secrets in `/proc/1/environ` are inaccessible
45
+ - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
46
+
47
+ **Breaking changes:**
48
+
49
+ 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.
50
+
51
+ ```javascript
52
+ // Before: manual session management
53
+ await sandbox.exec("cd /app", { sessionId: "my-session" });
54
+
55
+ // After: automatic session per sandbox
56
+ await sandbox.exec("cd /app");
57
+ ```
58
+
59
+ 2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
60
+
61
+ ```javascript
62
+ // Before: each exec was independent
63
+ await sandbox.exec("cd /app");
64
+ await sandbox.exec("pwd"); // Output: /workspace
65
+
66
+ // After: state persists in session
67
+ await sandbox.exec("cd /app");
68
+ await sandbox.exec("pwd"); // Output: /app
69
+ ```
70
+
71
+ **Migration guide:**
72
+
73
+ - Remove `sessionId` from all method calls - each sandbox maintains its own session
74
+ - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
75
+ ```javascript
76
+ // Create independent sessions with different environments
77
+ const buildSession = await sandbox.createSession({
78
+ name: "build",
79
+ env: { NODE_ENV: "production" },
80
+ cwd: "/build",
81
+ });
82
+ const testSession = await sandbox.createSession({
83
+ name: "test",
84
+ env: { NODE_ENV: "test" },
85
+ cwd: "/test",
86
+ });
87
+ ```
88
+ - Environment variables set in one command persist to the next
89
+ - Background processes remain active until explicitly killed
90
+ - Requires CAP_SYS_ADMIN (available in production, falls back gracefully in dev)
91
+
92
+ ### Patch Changes
93
+
94
+ - [#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
95
+
96
+ ## 0.2.4
97
+
98
+ ### Patch Changes
99
+
100
+ - [#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
101
+
102
+ ## 0.2.3
103
+
104
+ ### Patch Changes
105
+
106
+ - [#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
107
+
108
+ ## 0.2.2
109
+
110
+ ### Patch Changes
111
+
112
+ - [#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
113
+
114
+ ## 0.2.1
115
+
116
+ ### Patch Changes
117
+
118
+ - [#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
119
+
120
+ ## 0.2.0
121
+
122
+ ### Minor Changes
123
+
124
+ - [#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
125
+
126
+ ## 0.1.4
127
+
128
+ ### Patch Changes
129
+
130
+ - [#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
131
+
132
+ - [#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
133
+
134
+ - [#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`
135
+
136
+ - [#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
137
+
138
+ ## 0.1.3
139
+
140
+ ### Patch Changes
141
+
142
+ - [#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
143
+
144
+ ## 0.1.2
145
+
146
+ ### Patch Changes
147
+
148
+ - [#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
149
+
150
+ - [#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
151
+
152
+ ## 0.1.1
153
+
154
+ ### Patch Changes
155
+
156
+ - [`157dde9`](https://github.com/cloudflare/sandbox-sdk/commit/157dde9b1f23e9bb6f3e9c3f0514b639a8813897) Thanks [@threepointone](https://github.com/threepointone)! - update deps
157
+
158
+ - [`a04f6b6`](https://github.com/cloudflare/sandbox-sdk/commit/a04f6b6c0b2ef9e3ce0851b53769f1c10d8c6de6) Thanks [@threepointone](https://github.com/threepointone)! - trigger a build with updated deps
159
+
160
+ ## 0.1.0
161
+
162
+ ### Minor Changes
163
+
164
+ - [#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
165
+
166
+ ### Patch Changes
167
+
168
+ - [#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
169
+
170
+ ## 0.0.9
171
+
172
+ ### Patch Changes
173
+
174
+ - [#20](https://github.com/cloudflare/sandbox-sdk/pull/20) [`f106fda`](https://github.com/cloudflare/sandbox-sdk/commit/f106fdac98e7ef35677326290d45cbf3af88982c) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - add preview URLs and dynamic port forwarding
175
+
176
+ ## 0.0.8
177
+
178
+ ### Patch Changes
179
+
180
+ - [`60af265`](https://github.com/cloudflare/sandbox-sdk/commit/60af265d834e83fd30a921a3e1be232f13fe24da) Thanks [@threepointone](https://github.com/threepointone)! - update dependencies
181
+
182
+ ## 0.0.7
183
+
184
+ ### Patch Changes
185
+
186
+ - [`d1c7c99`](https://github.com/cloudflare/sandbox-sdk/commit/d1c7c99df6555eff71bcd59852e4b8eed2ad8cb6) Thanks [@threepointone](https://github.com/threepointone)! - fix file operations
187
+
188
+ ## 0.0.6
189
+
190
+ ### Patch Changes
191
+
192
+ - [#9](https://github.com/cloudflare/sandbox-sdk/pull/9) [`24f5470`](https://github.com/cloudflare/sandbox-sdk/commit/24f547048d5a26137de4656cea13d83ad2cc0b43) Thanks [@ItsWendell](https://github.com/ItsWendell)! - fix baseUrl for stub and stub forwarding
193
+
194
+ ## 0.0.5
195
+
196
+ ### Patch Changes
197
+
198
+ - [#5](https://github.com/cloudflare/sandbox-sdk/pull/5) [`7c15b81`](https://github.com/cloudflare/sandbox-sdk/commit/7c15b817899e4d9e1f25747aaf439e5e9e880d15) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Make package ready for deployment
199
+
200
+ ## 0.0.4
201
+
202
+ ### Patch Changes
203
+
204
+ - [`c0d9d33`](https://github.com/cloudflare/sandbox-sdk/commit/c0d9d3396badee1eab45e6b4a73d48957f31409b) Thanks [@threepointone](https://github.com/threepointone)! - actually work
205
+
206
+ - [`444d2da`](https://github.com/cloudflare/sandbox-sdk/commit/444d2dafde9a0f190e50c879b0e768da1b289b51) Thanks [@threepointone](https://github.com/threepointone)! - add experimental label
207
+
3
208
  ## 0.0.3
4
209
 
5
210
  ### Patch Changes
package/Dockerfile CHANGED
@@ -1,16 +1,103 @@
1
- # syntax=docker/dockerfile:1
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
2
4
 
3
- FROM oven/bun:latest
4
- # Set destination for COPY
5
- WORKDIR /app
5
+ # Prevent interactive prompts during package installation
6
+ ENV DEBIAN_FRONTEND=noninteractive
6
7
 
7
- # Install git
8
- RUN apt-get update && apt-get install -y git
8
+ # Install essential system packages and development tools
9
+ RUN apt-get update && apt-get install -y \
10
+ # Basic utilities
11
+ curl \
12
+ wget \
13
+ git \
14
+ unzip \
15
+ zip \
16
+ file \
17
+ # Process management
18
+ procps \
19
+ htop \
20
+ # Build tools
21
+ build-essential \
22
+ pkg-config \
23
+ # Network tools
24
+ net-tools \
25
+ iputils-ping \
26
+ dnsutils \
27
+ # Text processing
28
+ jq \
29
+ vim \
30
+ nano \
31
+ # Python dependencies
32
+ python3.11 \
33
+ python3.11-dev \
34
+ python3-pip \
35
+ python3.11-venv \
36
+ # Other useful tools
37
+ ca-certificates \
38
+ gnupg \
39
+ lsb-release \
40
+ strace \
41
+ && rm -rf /var/lib/apt/lists/*
9
42
 
10
- COPY container_src/* ./
11
- # RUN bun install
43
+ # Set Python 3.11 as default python3
44
+ RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
12
45
 
46
+ # Install Node.js 20 LTS using official NodeSource setup script
47
+ RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
48
+ && apt-get install -y nodejs \
49
+ && rm -rf /var/lib/apt/lists/*
50
+
51
+ # Install Bun from official image (avoids architecture compatibility issues)
52
+ COPY --from=bun-source /usr/local/bin/bun /usr/local/bin/bun
53
+ COPY --from=bun-source /usr/local/bin/bunx /usr/local/bin/bunx
54
+
55
+ # Install essential Python packages for code execution
56
+ RUN pip3 install --no-cache-dir \
57
+ matplotlib \
58
+ numpy \
59
+ pandas \
60
+ ipython
61
+
62
+ # Set up container server directory
63
+ WORKDIR /container-server
64
+
65
+ # Verify installations
66
+ RUN python3 --version && \
67
+ node --version && \
68
+ npm --version && \
69
+ bun --version
70
+
71
+ # Copy container source files to server directory
72
+ COPY container_src/package.json container_src/bun.lock ./
73
+ RUN bun install --frozen-lockfile
74
+
75
+ COPY container_src/ ./
76
+
77
+ # Compile TypeScript files using the locally installed TypeScript
78
+ RUN npx tsc control-process.ts --outDir . --module commonjs --target es2020 --esModuleInterop --skipLibCheck
79
+ RUN cd runtime/executors/javascript && npx tsc node_executor.ts --module commonjs --target es2020 --esModuleInterop --skipLibCheck
80
+ RUN cd runtime/executors/typescript && npx tsc ts_executor.ts --module commonjs --target es2020 --esModuleInterop --skipLibCheck
81
+
82
+ # Configure process pool sizes (can be overridden at runtime)
83
+ ENV PYTHON_POOL_MIN_SIZE=3
84
+ ENV PYTHON_POOL_MAX_SIZE=15
85
+ ENV JAVASCRIPT_POOL_MIN_SIZE=3
86
+ ENV JAVASCRIPT_POOL_MAX_SIZE=10
87
+ ENV TYPESCRIPT_POOL_MIN_SIZE=3
88
+ ENV TYPESCRIPT_POOL_MAX_SIZE=10
89
+
90
+ # Create clean workspace directory for user code
91
+ # Architecture:
92
+ # /container-server/ - SDK infrastructure (server, executors, dependencies)
93
+ # /workspace/ - User's clean workspace for their code
94
+ RUN mkdir -p /workspace
95
+
96
+ # Expose the application port (3000 for control)
13
97
  EXPOSE 3000
14
- # Run
15
- CMD ["bun", "index.ts"]
16
98
 
99
+ # Make startup script executable
100
+ RUN chmod +x startup.sh
101
+
102
+ # Use startup script
103
+ CMD ["./startup.sh"]