@cloudflare/sandbox 0.0.0-ee8c772 → 0.0.0-eec5bb6

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