@cloudflare/sandbox 0.0.0-bb855ca → 0.0.0-c39674b

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 (95) hide show
  1. package/CHANGELOG.md +151 -0
  2. package/Dockerfile +107 -66
  3. package/README.md +88 -710
  4. package/dist/chunk-BFVUNTP4.js +104 -0
  5. package/dist/chunk-BFVUNTP4.js.map +1 -0
  6. package/dist/chunk-EKSWCBCA.js +86 -0
  7. package/dist/chunk-EKSWCBCA.js.map +1 -0
  8. package/dist/chunk-JXZMAU2C.js +559 -0
  9. package/dist/chunk-JXZMAU2C.js.map +1 -0
  10. package/dist/chunk-UZQBJBJF.js +7 -0
  11. package/dist/chunk-UZQBJBJF.js.map +1 -0
  12. package/dist/chunk-YEZBBFK7.js +2420 -0
  13. package/dist/chunk-YEZBBFK7.js.map +1 -0
  14. package/dist/chunk-Z532A7QC.js +78 -0
  15. package/dist/chunk-Z532A7QC.js.map +1 -0
  16. package/dist/file-stream.d.ts +43 -0
  17. package/dist/file-stream.js +9 -0
  18. package/dist/file-stream.js.map +1 -0
  19. package/dist/index.d.ts +9 -0
  20. package/dist/index.js +67 -0
  21. package/dist/index.js.map +1 -0
  22. package/dist/interpreter.d.ts +33 -0
  23. package/dist/interpreter.js +8 -0
  24. package/dist/interpreter.js.map +1 -0
  25. package/dist/request-handler.d.ts +18 -0
  26. package/dist/request-handler.js +13 -0
  27. package/dist/request-handler.js.map +1 -0
  28. package/dist/sandbox-DMlNr93l.d.ts +596 -0
  29. package/dist/sandbox.d.ts +4 -0
  30. package/dist/sandbox.js +13 -0
  31. package/dist/sandbox.js.map +1 -0
  32. package/dist/security.d.ts +31 -0
  33. package/dist/security.js +13 -0
  34. package/dist/security.js.map +1 -0
  35. package/dist/sse-parser.d.ts +28 -0
  36. package/dist/sse-parser.js +11 -0
  37. package/dist/sse-parser.js.map +1 -0
  38. package/dist/version.d.ts +8 -0
  39. package/dist/version.js +7 -0
  40. package/dist/version.js.map +1 -0
  41. package/package.json +13 -5
  42. package/src/clients/base-client.ts +280 -0
  43. package/src/clients/command-client.ts +115 -0
  44. package/src/clients/file-client.ts +269 -0
  45. package/src/clients/git-client.ts +92 -0
  46. package/src/clients/index.ts +64 -0
  47. package/src/clients/interpreter-client.ts +329 -0
  48. package/src/clients/port-client.ts +105 -0
  49. package/src/clients/process-client.ts +177 -0
  50. package/src/clients/sandbox-client.ts +41 -0
  51. package/src/clients/types.ts +84 -0
  52. package/src/clients/utility-client.ts +119 -0
  53. package/src/errors/adapter.ts +180 -0
  54. package/src/errors/classes.ts +469 -0
  55. package/src/errors/index.ts +105 -0
  56. package/src/file-stream.ts +164 -0
  57. package/src/index.ts +85 -21
  58. package/src/interpreter.ts +22 -13
  59. package/src/request-handler.ts +69 -43
  60. package/src/sandbox.ts +663 -444
  61. package/src/security.ts +14 -23
  62. package/src/sse-parser.ts +4 -8
  63. package/src/version.ts +6 -0
  64. package/startup.sh +3 -0
  65. package/tests/base-client.test.ts +328 -0
  66. package/tests/command-client.test.ts +407 -0
  67. package/tests/file-client.test.ts +643 -0
  68. package/tests/file-stream.test.ts +306 -0
  69. package/tests/get-sandbox.test.ts +110 -0
  70. package/tests/git-client.test.ts +328 -0
  71. package/tests/port-client.test.ts +301 -0
  72. package/tests/process-client.test.ts +658 -0
  73. package/tests/sandbox.test.ts +465 -0
  74. package/tests/sse-parser.test.ts +290 -0
  75. package/tests/utility-client.test.ts +332 -0
  76. package/tests/version.test.ts +16 -0
  77. package/tests/wrangler.jsonc +35 -0
  78. package/tsconfig.json +9 -1
  79. package/vitest.config.ts +31 -0
  80. package/container_src/bun.lock +0 -122
  81. package/container_src/handler/exec.ts +0 -340
  82. package/container_src/handler/file.ts +0 -844
  83. package/container_src/handler/git.ts +0 -182
  84. package/container_src/handler/ports.ts +0 -314
  85. package/container_src/handler/process.ts +0 -640
  86. package/container_src/index.ts +0 -531
  87. package/container_src/jupyter-server.ts +0 -336
  88. package/container_src/mime-processor.ts +0 -255
  89. package/container_src/package.json +0 -18
  90. package/container_src/startup.sh +0 -52
  91. package/container_src/types.ts +0 -108
  92. package/src/client.ts +0 -1021
  93. package/src/interpreter-types.ts +0 -383
  94. package/src/jupyter-client.ts +0 -266
  95. package/src/types.ts +0 -401
package/CHANGELOG.md CHANGED
@@ -1,5 +1,156 @@
1
1
  # @cloudflare/sandbox
2
2
 
3
+ ## 0.4.6
4
+
5
+ ### Patch Changes
6
+
7
+ - [#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
8
+
9
+ ## 0.4.5
10
+
11
+ ### Patch Changes
12
+
13
+ - [#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
14
+
15
+ ## 0.4.4
16
+
17
+ ### Patch Changes
18
+
19
+ - [#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
20
+
21
+ ## 0.4.3
22
+
23
+ ### Patch Changes
24
+
25
+ - [#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)
26
+
27
+ ## 0.4.2
28
+
29
+ ### Patch Changes
30
+
31
+ - [`e53d7e7`](https://github.com/cloudflare/sandbox-sdk/commit/e53d7e7ce185f79bdd899029bb532e9651ae7ba5) Thanks [@threepointone](https://github.com/threepointone)! - fix build by inlining repo/shared
32
+
33
+ ## 0.4.1
34
+
35
+ ### Patch Changes
36
+
37
+ - [#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
38
+
39
+ ## 0.4.0
40
+
41
+ ### Minor Changes
42
+
43
+ - [#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.
44
+
45
+ ### Patch Changes
46
+
47
+ - [#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
48
+
49
+ ## 0.3.3
50
+
51
+ ### Patch Changes
52
+
53
+ - [#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
54
+
55
+ ## 0.3.2
56
+
57
+ ### Patch Changes
58
+
59
+ - [#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.
60
+
61
+ ## 0.3.1
62
+
63
+ ### Patch Changes
64
+
65
+ - [#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
66
+
67
+ - [#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
68
+
69
+ - [#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
70
+
71
+ - [#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.
72
+
73
+ ## 0.3.0
74
+
75
+ ### Minor Changes
76
+
77
+ - [#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
78
+
79
+ 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.
80
+
81
+ **Key security improvements:**
82
+
83
+ - Control plane processes are hidden from sandboxed commands
84
+ - Platform secrets in `/proc/1/environ` are inaccessible
85
+ - Ports 8888 (Jupyter) and 3000 (Bun) are protected from hijacking
86
+
87
+ **Breaking changes:**
88
+
89
+ 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.
90
+
91
+ ```javascript
92
+ // Before: manual session management
93
+ await sandbox.exec("cd /app", { sessionId: "my-session" });
94
+
95
+ // After: automatic session per sandbox
96
+ await sandbox.exec("cd /app");
97
+ ```
98
+
99
+ 2. **Commands now maintain state**: Commands within the same sandbox now share state (working directory, environment variables, background processes). Previously each command was stateless.
100
+
101
+ ```javascript
102
+ // Before: each exec was independent
103
+ await sandbox.exec("cd /app");
104
+ await sandbox.exec("pwd"); // Output: /workspace
105
+
106
+ // After: state persists in session
107
+ await sandbox.exec("cd /app");
108
+ await sandbox.exec("pwd"); // Output: /app
109
+ ```
110
+
111
+ **Migration guide:**
112
+
113
+ - Remove `sessionId` from all method calls - each sandbox maintains its own session
114
+ - If you need isolated execution contexts within the same sandbox, use `sandbox.createSession()`:
115
+ ```javascript
116
+ // Create independent sessions with different environments
117
+ const buildSession = await sandbox.createSession({
118
+ name: "build",
119
+ env: { NODE_ENV: "production" },
120
+ cwd: "/build",
121
+ });
122
+ const testSession = await sandbox.createSession({
123
+ name: "test",
124
+ env: { NODE_ENV: "test" },
125
+ cwd: "/test",
126
+ });
127
+ ```
128
+ - Environment variables set in one command persist to the next
129
+ - Background processes remain active until explicitly killed
130
+ - Requires CAP_SYS_ADMIN (available in production, falls back gracefully in dev)
131
+
132
+ ### Patch Changes
133
+
134
+ - [#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
135
+
136
+ ## 0.2.4
137
+
138
+ ### Patch Changes
139
+
140
+ - [#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
141
+
142
+ ## 0.2.3
143
+
144
+ ### Patch Changes
145
+
146
+ - [#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
147
+
148
+ ## 0.2.2
149
+
150
+ ### Patch Changes
151
+
152
+ - [#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
153
+
3
154
  ## 0.2.1
4
155
 
5
156
  ### Patch Changes
package/Dockerfile CHANGED
@@ -1,101 +1,142 @@
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
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 (including devDependencies for build)
33
+ RUN npm ci
34
+
35
+ # Copy pruned source code
36
+ COPY --from=pruner /app/out/full/ .
37
+
38
+ # Build all packages (Turborepo handles dependency order automatically)
39
+ # This builds @repo/shared first, then @repo/sandbox-container
40
+ RUN npx turbo run build
41
+
42
+ # ============================================================================
43
+ # Stage 3: Install production-only dependencies
44
+ # ============================================================================
45
+ FROM node:20-alpine AS prod-deps
46
+
47
+ WORKDIR /app
48
+
49
+ # Copy package files from builder
50
+ COPY --from=builder /app/package.json ./package.json
51
+ COPY --from=builder /app/package-lock.json ./package-lock.json
52
+ COPY --from=builder /app/packages ./packages
53
+ COPY --from=builder /app/tooling ./tooling
54
+
55
+ # Install ONLY production dependencies (excludes typescript, @types/*, etc.)
56
+ RUN npm ci --production
57
+
58
+ # ============================================================================
59
+ # Stage 4: Runtime - Ubuntu 22.04 with only runtime dependencies
60
+ # ============================================================================
61
+ FROM ubuntu:22.04 AS runtime
62
+
63
+ # Accept version as build argument (passed from npm_package_version)
64
+ ARG SANDBOX_VERSION=unknown
4
65
 
5
66
  # Prevent interactive prompts during package installation
6
67
  ENV DEBIAN_FRONTEND=noninteractive
7
68
 
8
- # Install essential system packages and development tools
9
- RUN apt-get update && apt-get install -y \
10
- # Basic utilities
69
+ # Set the sandbox version as an environment variable for version checking
70
+ ENV SANDBOX_VERSION=${SANDBOX_VERSION}
71
+
72
+ # Install essential runtime packages
73
+ RUN apt-get update && apt-get install -y --no-install-recommends \
11
74
  curl \
12
75
  wget \
76
+ ca-certificates \
77
+ python3.11 \
78
+ python3-pip \
79
+ python3.11-venv \
80
+ procps \
13
81
  git \
14
82
  unzip \
15
83
  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
84
  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
- sudo \
37
- ca-certificates \
38
- gnupg \
39
- lsb-release \
85
+ file \
40
86
  && rm -rf /var/lib/apt/lists/*
41
87
 
42
88
  # Set Python 3.11 as default python3
43
89
  RUN update-alternatives --install /usr/bin/python3 python3 /usr/bin/python3.11 1
44
90
 
45
- # Install Node.js 20 LTS
46
- # Using the official NodeSource repository setup script
47
- RUN apt-get update && apt-get install -y ca-certificates curl gnupg \
48
- && mkdir -p /etc/apt/keyrings \
49
- && curl -fsSL https://deb.nodesource.com/gpgkey/nodesource-repo.gpg.key | gpg --dearmor -o /etc/apt/keyrings/nodesource.gpg \
50
- && echo "deb [signed-by=/etc/apt/keyrings/nodesource.gpg] https://deb.nodesource.com/node_20.x nodistro main" | tee /etc/apt/sources.list.d/nodesource.list \
51
- && apt-get update \
91
+ # Install Node.js 20 LTS using official NodeSource setup script
92
+ RUN curl -fsSL https://deb.nodesource.com/setup_20.x | bash - \
52
93
  && apt-get install -y nodejs \
53
94
  && rm -rf /var/lib/apt/lists/*
54
95
 
55
- # Install Bun from official image (avoids architecture compatibility issues)
56
- COPY --from=bun-source /usr/local/bin/bun /usr/local/bin/bun
57
- COPY --from=bun-source /usr/local/bin/bunx /usr/local/bin/bunx
96
+ # Install Bun runtime from official image
97
+ COPY --from=oven/bun:1 /usr/local/bin/bun /usr/local/bin/bun
58
98
 
59
- # Install Jupyter and kernels
99
+ # Install essential Python packages for code execution
60
100
  RUN pip3 install --no-cache-dir \
61
- jupyter \
62
- jupyterlab \
63
- ipykernel \
64
- notebook \
65
101
  matplotlib \
66
102
  numpy \
67
103
  pandas \
68
- seaborn \
69
- && python3 -m ipykernel install --user --name python3
104
+ ipython
70
105
 
71
- # Install JavaScript kernel (ijavascript) - using E2B's fork
72
- RUN npm install -g --unsafe-perm git+https://github.com/e2b-dev/ijavascript.git \
73
- && ijsinstall --install=global
74
-
75
- # Set up container server directory
106
+ # Set up runtime container server directory
76
107
  WORKDIR /container-server
77
108
 
78
- # Verify installations
79
- RUN python3 --version && \
80
- node --version && \
81
- npm --version && \
82
- bun --version && \
83
- jupyter --version && \
84
- jupyter kernelspec list
109
+ # Copy built sandbox-container package
110
+ COPY --from=builder /app/packages/sandbox-container/dist ./dist
111
+ COPY --from=builder /app/packages/sandbox-container/package.json ./package.json
112
+
113
+ # Copy Python executor to runtime location
114
+ COPY --from=builder /app/packages/sandbox-container/src/runtime/executors/python/ipython_executor.py ./dist/runtime/executors/python/
115
+
116
+ # Copy production-only node_modules (excludes typescript, @types/*, etc.)
117
+ # Includes: @repo/shared, zod, esbuild (runtime dependencies)
118
+ COPY --from=prod-deps /app/node_modules ./node_modules
85
119
 
86
- # Copy container source files to server directory
87
- COPY container_src/package.json ./
88
- RUN bun install
120
+ # Copy workspace packages
121
+ COPY --from=prod-deps /app/packages/shared/dist ./packages/shared/dist
122
+ COPY --from=prod-deps /app/packages/shared/package.json ./packages/shared/package.json
89
123
 
90
- COPY container_src/ ./
124
+ # Configure process pool sizes (can be overridden at runtime)
125
+ ENV PYTHON_POOL_MIN_SIZE=3
126
+ ENV PYTHON_POOL_MAX_SIZE=15
127
+ ENV JAVASCRIPT_POOL_MIN_SIZE=3
128
+ ENV JAVASCRIPT_POOL_MAX_SIZE=10
129
+ ENV TYPESCRIPT_POOL_MIN_SIZE=3
130
+ ENV TYPESCRIPT_POOL_MAX_SIZE=10
91
131
 
92
- # Create clean workspace directory for users
132
+ # Create clean workspace directory for user code
93
133
  RUN mkdir -p /workspace
94
134
 
95
- # Expose the application port (3000 for control, 8888 for Jupyter)
96
- EXPOSE 3000 8888
135
+ # Expose the application port (3000 for control)
136
+ EXPOSE 3000
97
137
 
98
- # Make startup script executable
138
+ # Copy and make startup script executable
139
+ COPY packages/sandbox/startup.sh ./
99
140
  RUN chmod +x startup.sh
100
141
 
101
142
  # Use startup script