@cloudflare/sandbox 0.0.0-f5fcd52 → 0.0.0-f9dc800

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 +173 -0
  2. package/Dockerfile +48 -38
  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 +408 -3004
  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 +5 -9
  26. package/src/client.ts +359 -1400
  27. package/src/errors.ts +219 -0
  28. package/src/file-stream.ts +162 -0
  29. package/src/index.ts +77 -10
  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 +69 -20
  34. package/src/sandbox.ts +604 -106
  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,178 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.3.5
4
+
5
+ ### Patch Changes
6
+
7
+ - [#88](https://github.com/cloudflare/sandbox-sdk/pull/88) [`46eb4e6`](https://github.com/cloudflare/sandbox-sdk/commit/46eb4e6b6c671b682fc74f83563ccf5f316011cb) Thanks [@ghostwriternr](https://github.com/ghostwriternr)! - Add binary file support with automatic MIME detection and streaming
8
+
9
+ ## 0.3.4
10
+
11
+ ### Patch Changes
12
+
13
+ - [#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
14
+
15
+ ## 0.3.3
16
+
17
+ ### Patch Changes
18
+
19
+ - [#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
20
+
21
+ ## 0.3.2
22
+
23
+ ### Patch Changes
24
+
25
+ - [#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.
26
+
27
+ ## 0.3.1
28
+
29
+ ### Patch Changes
30
+
31
+ - [#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
32
+
33
+ - [#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
34
+
35
+ - [#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
36
+
37
+ - [#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.
38
+
39
+ ## 0.3.0
40
+
41
+ ### Minor Changes
42
+
43
+ - [#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
44
+
45
+ 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.
46
+
47
+ **Key security improvements:**
48
+
49
+ - Control plane processes are hidden from sandboxed commands
50
+ - Platform secrets in `/proc/1/environ` are inaccessible
51
+ - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
52
+
53
+ **Breaking changes:**
54
+
55
+ 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.
56
+
57
+ ```javascript
58
+ // Before: manual session management
59
+ await sandbox.exec("cd /app", { sessionId: "my-session" });
60
+
61
+ // After: automatic session per sandbox
62
+ await sandbox.exec("cd /app");
63
+ ```
64
+
65
+ 2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
66
+
67
+ ```javascript
68
+ // Before: each exec was independent
69
+ await sandbox.exec("cd /app");
70
+ await sandbox.exec("pwd"); // Output: /workspace
71
+
72
+ // After: state persists in session
73
+ await sandbox.exec("cd /app");
74
+ await sandbox.exec("pwd"); // Output: /app
75
+ ```
76
+
77
+ **Migration guide:**
78
+
79
+ - Remove `sessionId` from all method calls - each sandbox maintains its own session
80
+ - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
81
+ ```javascript
82
+ // Create independent sessions with different environments
83
+ const buildSession = await sandbox.createSession({
84
+ name: "build",
85
+ env: { NODE_ENV: "production" },
86
+ cwd: "/build",
87
+ });
88
+ const testSession = await sandbox.createSession({
89
+ name: "test",
90
+ env: { NODE_ENV: "test" },
91
+ cwd: "/test",
92
+ });
93
+ ```
94
+ - Environment variables set in one command persist to the next
95
+ - Background processes remain active until explicitly killed
96
+ - Requires CAP_SYS_ADMIN (available in production, falls back gracefully in dev)
97
+
98
+ ### Patch Changes
99
+
100
+ - [#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
101
+
102
+ ## 0.2.4
103
+
104
+ ### Patch Changes
105
+
106
+ - [#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
107
+
108
+ ## 0.2.3
109
+
110
+ ### Patch Changes
111
+
112
+ - [#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
113
+
114
+ ## 0.2.2
115
+
116
+ ### Patch Changes
117
+
118
+ - [#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
119
+
120
+ ## 0.2.1
121
+
122
+ ### Patch Changes
123
+
124
+ - [#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
125
+
126
+ ## 0.2.0
127
+
128
+ ### Minor Changes
129
+
130
+ - [#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
131
+
132
+ ## 0.1.4
133
+
134
+ ### Patch Changes
135
+
136
+ - [#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
137
+
138
+ - [#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
139
+
140
+ - [#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`
141
+
142
+ - [#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
143
+
144
+ ## 0.1.3
145
+
146
+ ### Patch Changes
147
+
148
+ - [#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
149
+
150
+ ## 0.1.2
151
+
152
+ ### Patch Changes
153
+
154
+ - [#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
155
+
156
+ - [#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
157
+
158
+ ## 0.1.1
159
+
160
+ ### Patch Changes
161
+
162
+ - [`157dde9`](https://github.com/cloudflare/sandbox-sdk/commit/157dde9b1f23e9bb6f3e9c3f0514b639a8813897) Thanks [@threepointone](https://github.com/threepointone)! - update deps
163
+
164
+ - [`a04f6b6`](https://github.com/cloudflare/sandbox-sdk/commit/a04f6b6c0b2ef9e3ce0851b53769f1c10d8c6de6) Thanks [@threepointone](https://github.com/threepointone)! - trigger a build with updated deps
165
+
166
+ ## 0.1.0
167
+
168
+ ### Minor Changes
169
+
170
+ - [#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
171
+
172
+ ### Patch Changes
173
+
174
+ - [#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
175
+
3
176
  ## 0.0.9
4
177
 
5
178
  ### Patch Changes
package/Dockerfile CHANGED
@@ -1,4 +1,5 @@
1
1
  # Sandbox base image with development tools, Python, Node.js, and Bun
2
+ FROM oven/bun:latest AS bun-source
2
3
  FROM ubuntu:22.04
3
4
 
4
5
  # Prevent interactive prompts during package installation
@@ -12,6 +13,7 @@ RUN apt-get update && apt-get install -y \
12
13
  git \
13
14
  unzip \
14
15
  zip \
16
+ file \
15
17
  # Process management
16
18
  procps \
17
19
  htop \
@@ -30,64 +32,72 @@ RUN apt-get update && apt-get install -y \
30
32
  python3.11 \
31
33
  python3.11-dev \
32
34
  python3-pip \
35
+ python3.11-venv \
33
36
  # Other useful tools
34
- sudo \
35
37
  ca-certificates \
36
38
  gnupg \
37
39
  lsb-release \
40
+ strace \
38
41
  && rm -rf /var/lib/apt/lists/*
39
42
 
40
43
  # Set Python 3.11 as default python3
41
44
  RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
42
45
 
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 \
46
+ # Install Node.js 20 LTS using official NodeSource setup script
47
+ RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
50
48
  && apt-get install -y nodejs \
51
49
  && rm -rf /var/lib/apt/lists/*
52
50
 
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
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
58
54
 
59
- # Install global npm packages as root
60
- RUN npm install -g yarn pnpm
55
+ # Install essential Python packages for code execution
56
+ RUN pip3 install --no-cache-dir \
57
+ matplotlib \
58
+ numpy \
59
+ pandas \
60
+ ipython
61
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
68
-
69
- # Set ownership of the app directory to sandbox user
70
- RUN chown -R sandbox:sandbox /app
71
-
72
- # Set environment variables
73
- ENV PATH="/home/sandbox/.local/bin:${PATH}"
74
-
75
- # Switch to non-root user
76
- USER sandbox
62
+ # Set up container server directory
63
+ WORKDIR /container-server
77
64
 
78
65
  # Verify installations
79
66
  RUN python3 --version && \
80
67
  node --version && \
81
68
  npm --version && \
82
- bun --version && \
83
- yarn --version && \
84
- pnpm --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
85
74
 
86
- # Copy container source files
87
- COPY --chown=sandbox:sandbox container_src/* ./
75
+ COPY container_src/ ./
88
76
 
89
- # Expose the application port
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)
90
97
  EXPOSE 3000
91
98
 
92
- # Run the application
93
- CMD ["bun", "index.ts"]
99
+ # Make startup script executable
100
+ RUN chmod +x startup.sh
101
+
102
+ # Use startup script
103
+ CMD ["./startup.sh"]