@cloudflare/sandbox 0.0.0-a04f6b6 → 0.0.0-aa00a75
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.
- package/CHANGELOG.md +161 -0
- package/Dockerfile +120 -27
- package/README.md +164 -0
- package/dist/chunk-BCJ7SF3Q.js +117 -0
- package/dist/chunk-BCJ7SF3Q.js.map +1 -0
- package/dist/chunk-BFVUNTP4.js +104 -0
- package/dist/chunk-BFVUNTP4.js.map +1 -0
- package/dist/chunk-EKSWCBCA.js +86 -0
- package/dist/chunk-EKSWCBCA.js.map +1 -0
- package/dist/chunk-HGF554LH.js +2236 -0
- package/dist/chunk-HGF554LH.js.map +1 -0
- package/dist/chunk-Z532A7QC.js +78 -0
- package/dist/chunk-Z532A7QC.js.map +1 -0
- package/dist/file-stream.d.ts +43 -0
- package/dist/file-stream.js +9 -0
- package/dist/file-stream.js.map +1 -0
- package/dist/index.d.ts +9 -0
- package/dist/index.js +55 -0
- package/dist/index.js.map +1 -0
- package/dist/interpreter.d.ts +33 -0
- package/dist/interpreter.js +8 -0
- package/dist/interpreter.js.map +1 -0
- package/dist/request-handler.d.ts +18 -0
- package/dist/request-handler.js +12 -0
- package/dist/request-handler.js.map +1 -0
- package/dist/sandbox-D9K2ypln.d.ts +583 -0
- package/dist/sandbox.d.ts +4 -0
- package/dist/sandbox.js +12 -0
- package/dist/sandbox.js.map +1 -0
- package/dist/security.d.ts +31 -0
- package/dist/security.js +13 -0
- package/dist/security.js.map +1 -0
- package/dist/sse-parser.d.ts +28 -0
- package/dist/sse-parser.js +11 -0
- package/dist/sse-parser.js.map +1 -0
- package/package.json +11 -4
- package/src/clients/base-client.ts +280 -0
- package/src/clients/command-client.ts +115 -0
- package/src/clients/file-client.ts +269 -0
- package/src/clients/git-client.ts +92 -0
- package/src/clients/index.ts +63 -0
- package/src/clients/interpreter-client.ts +329 -0
- package/src/clients/port-client.ts +105 -0
- package/src/clients/process-client.ts +177 -0
- package/src/clients/sandbox-client.ts +41 -0
- package/src/clients/types.ts +84 -0
- package/src/clients/utility-client.ts +94 -0
- package/src/errors/adapter.ts +180 -0
- package/src/errors/classes.ts +469 -0
- package/src/errors/index.ts +105 -0
- package/src/file-stream.ts +164 -0
- package/src/index.ts +85 -12
- package/src/interpreter.ts +159 -0
- package/src/request-handler.ts +69 -43
- package/src/sandbox.ts +560 -288
- package/src/security.ts +14 -23
- package/src/sse-parser.ts +4 -8
- package/startup.sh +3 -0
- package/tests/base-client.test.ts +328 -0
- package/tests/command-client.test.ts +407 -0
- package/tests/file-client.test.ts +643 -0
- package/tests/file-stream.test.ts +306 -0
- package/tests/git-client.test.ts +328 -0
- package/tests/port-client.test.ts +301 -0
- package/tests/process-client.test.ts +658 -0
- package/tests/sandbox.test.ts +465 -0
- package/tests/sse-parser.test.ts +290 -0
- package/tests/utility-client.test.ts +266 -0
- package/tests/wrangler.jsonc +35 -0
- package/tsconfig.json +9 -1
- package/vitest.config.ts +31 -0
- package/container_src/handler/exec.ts +0 -337
- package/container_src/handler/file.ts +0 -844
- package/container_src/handler/git.ts +0 -182
- package/container_src/handler/ports.ts +0 -314
- package/container_src/handler/process.ts +0 -640
- package/container_src/index.ts +0 -361
- package/container_src/package.json +0 -9
- package/container_src/types.ts +0 -103
- package/src/client.ts +0 -1038
- package/src/types.ts +0 -386
package/src/sandbox.ts
CHANGED
|
@@ -1,66 +1,99 @@
|
|
|
1
|
+
import type { DurableObject } from 'cloudflare:workers';
|
|
1
2
|
import { Container, getContainer } from "@cloudflare/containers";
|
|
2
|
-
import { HttpClient } from "./client";
|
|
3
|
-
import { isLocalhostPattern } from "./request-handler";
|
|
4
|
-
import {
|
|
5
|
-
logSecurityEvent,
|
|
6
|
-
SecurityError,
|
|
7
|
-
sanitizeSandboxId,
|
|
8
|
-
validatePort
|
|
9
|
-
} from "./security";
|
|
10
3
|
import type {
|
|
4
|
+
CodeContext,
|
|
5
|
+
CreateContextOptions,
|
|
6
|
+
ExecEvent,
|
|
11
7
|
ExecOptions,
|
|
12
8
|
ExecResult,
|
|
9
|
+
ExecutionResult,
|
|
10
|
+
ExecutionSession,
|
|
13
11
|
ISandbox,
|
|
14
12
|
Process,
|
|
15
13
|
ProcessOptions,
|
|
16
14
|
ProcessStatus,
|
|
15
|
+
RunCodeOptions,
|
|
16
|
+
SessionOptions,
|
|
17
17
|
StreamOptions
|
|
18
|
-
} from "
|
|
18
|
+
} from "@repo/shared";
|
|
19
|
+
import { createLogger, runWithLogger, TraceContext } from "@repo/shared";
|
|
20
|
+
import { type ExecuteResponse, SandboxClient } from "./clients";
|
|
21
|
+
import type { ErrorResponse } from './errors';
|
|
22
|
+
import { CustomDomainRequiredError, ErrorCode } from './errors';
|
|
23
|
+
import { CodeInterpreter } from "./interpreter";
|
|
24
|
+
import { isLocalhostPattern } from "./request-handler";
|
|
19
25
|
import {
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
26
|
+
SecurityError,
|
|
27
|
+
sanitizeSandboxId,
|
|
28
|
+
validatePort
|
|
29
|
+
} from "./security";
|
|
30
|
+
import { parseSSEStream } from "./sse-parser";
|
|
23
31
|
|
|
24
|
-
export function getSandbox(ns: DurableObjectNamespace<Sandbox>, id: string
|
|
32
|
+
export function getSandbox(ns: DurableObjectNamespace<Sandbox>, id: string, options?: {
|
|
33
|
+
baseUrl: string
|
|
34
|
+
}) {
|
|
25
35
|
const stub = getContainer(ns, id);
|
|
26
36
|
|
|
27
37
|
// Store the name on first access
|
|
28
38
|
stub.setSandboxName?.(id);
|
|
29
39
|
|
|
40
|
+
if(options?.baseUrl) {
|
|
41
|
+
stub.setBaseUrl(options.baseUrl);
|
|
42
|
+
}
|
|
43
|
+
|
|
30
44
|
return stub;
|
|
31
45
|
}
|
|
32
46
|
|
|
33
47
|
export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
48
|
+
defaultPort = 3000; // Default port for the container's Bun server
|
|
34
49
|
sleepAfter = "3m"; // Sleep the sandbox if no requests are made in this timeframe
|
|
35
|
-
|
|
50
|
+
|
|
51
|
+
client: SandboxClient;
|
|
52
|
+
private codeInterpreter: CodeInterpreter;
|
|
36
53
|
private sandboxName: string | null = null;
|
|
54
|
+
private baseUrl: string | null = null;
|
|
55
|
+
private portTokens: Map<number, string> = new Map();
|
|
56
|
+
private defaultSession: string | null = null;
|
|
57
|
+
envVars: Record<string, string> = {};
|
|
58
|
+
private logger: ReturnType<typeof createLogger>;
|
|
37
59
|
|
|
38
|
-
constructor(ctx:
|
|
60
|
+
constructor(ctx: DurableObject['ctx'], env: Env) {
|
|
39
61
|
super(ctx, env);
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
62
|
+
|
|
63
|
+
const envObj = env as any;
|
|
64
|
+
// Set sandbox environment variables from env object
|
|
65
|
+
const sandboxEnvKeys = ['SANDBOX_LOG_LEVEL', 'SANDBOX_LOG_FORMAT'] as const;
|
|
66
|
+
sandboxEnvKeys.forEach(key => {
|
|
67
|
+
if (envObj?.[key]) {
|
|
68
|
+
this.envVars[key] = envObj[key];
|
|
69
|
+
}
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
this.logger = createLogger({
|
|
73
|
+
component: 'sandbox-do',
|
|
74
|
+
sandboxId: this.ctx.id.toString()
|
|
75
|
+
});
|
|
76
|
+
|
|
77
|
+
this.client = new SandboxClient({
|
|
78
|
+
logger: this.logger,
|
|
57
79
|
port: 3000, // Control plane port
|
|
58
80
|
stub: this,
|
|
59
81
|
});
|
|
60
82
|
|
|
61
|
-
//
|
|
83
|
+
// Initialize code interpreter - pass 'this' after client is ready
|
|
84
|
+
// The CodeInterpreter extracts client.interpreter from the sandbox
|
|
85
|
+
this.codeInterpreter = new CodeInterpreter(this);
|
|
86
|
+
|
|
87
|
+
// Load the sandbox name and port tokens from storage on initialization
|
|
62
88
|
this.ctx.blockConcurrencyWhile(async () => {
|
|
63
89
|
this.sandboxName = await this.ctx.storage.get<string>('sandboxName') || null;
|
|
90
|
+
const storedTokens = await this.ctx.storage.get<Record<string, string>>('portTokens') || {};
|
|
91
|
+
|
|
92
|
+
// Convert stored tokens back to Map
|
|
93
|
+
this.portTokens = new Map();
|
|
94
|
+
for (const [portStr, token] of Object.entries(storedTokens)) {
|
|
95
|
+
this.portTokens.set(parseInt(portStr, 10), token);
|
|
96
|
+
}
|
|
64
97
|
});
|
|
65
98
|
}
|
|
66
99
|
|
|
@@ -69,55 +102,94 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
69
102
|
if (!this.sandboxName) {
|
|
70
103
|
this.sandboxName = name;
|
|
71
104
|
await this.ctx.storage.put('sandboxName', name);
|
|
72
|
-
|
|
105
|
+
}
|
|
106
|
+
}
|
|
107
|
+
|
|
108
|
+
// RPC method to set the base URL
|
|
109
|
+
async setBaseUrl(baseUrl: string): Promise<void> {
|
|
110
|
+
if (!this.baseUrl) {
|
|
111
|
+
this.baseUrl = baseUrl;
|
|
112
|
+
await this.ctx.storage.put('baseUrl', baseUrl);
|
|
113
|
+
console.log(`[Sandbox] Stored base URL: ${baseUrl}`);
|
|
114
|
+
} else {
|
|
115
|
+
if(this.baseUrl !== baseUrl) {
|
|
116
|
+
throw new Error('Base URL already set and different from one previously provided');
|
|
117
|
+
}
|
|
73
118
|
}
|
|
74
119
|
}
|
|
75
120
|
|
|
76
121
|
// RPC method to set environment variables
|
|
77
122
|
async setEnvVars(envVars: Record<string, string>): Promise<void> {
|
|
123
|
+
// Update local state for new sessions
|
|
78
124
|
this.envVars = { ...this.envVars, ...envVars };
|
|
79
|
-
|
|
125
|
+
|
|
126
|
+
// If default session already exists, update it directly
|
|
127
|
+
if (this.defaultSession) {
|
|
128
|
+
// Set environment variables by executing export commands in the existing session
|
|
129
|
+
for (const [key, value] of Object.entries(envVars)) {
|
|
130
|
+
const escapedValue = value.replace(/'/g, "'\\''");
|
|
131
|
+
const exportCommand = `export ${key}='${escapedValue}'`;
|
|
132
|
+
|
|
133
|
+
const result = await this.client.commands.execute(exportCommand, this.defaultSession);
|
|
134
|
+
|
|
135
|
+
if (result.exitCode !== 0) {
|
|
136
|
+
throw new Error(`Failed to set ${key}: ${result.stderr || 'Unknown error'}`);
|
|
137
|
+
}
|
|
138
|
+
}
|
|
139
|
+
}
|
|
140
|
+
}
|
|
141
|
+
|
|
142
|
+
/**
|
|
143
|
+
* Cleanup and destroy the sandbox container
|
|
144
|
+
*/
|
|
145
|
+
override async destroy(): Promise<void> {
|
|
146
|
+
this.logger.info('Destroying sandbox container');
|
|
147
|
+
await super.destroy();
|
|
80
148
|
}
|
|
81
149
|
|
|
82
150
|
override onStart() {
|
|
83
|
-
|
|
151
|
+
this.logger.debug('Sandbox started');
|
|
84
152
|
}
|
|
85
153
|
|
|
86
154
|
override onStop() {
|
|
87
|
-
|
|
88
|
-
if (this.client) {
|
|
89
|
-
this.client.clearSession();
|
|
90
|
-
}
|
|
155
|
+
this.logger.debug('Sandbox stopped');
|
|
91
156
|
}
|
|
92
157
|
|
|
93
158
|
override onError(error: unknown) {
|
|
94
|
-
|
|
159
|
+
this.logger.error('Sandbox error', error instanceof Error ? error : new Error(String(error)));
|
|
95
160
|
}
|
|
96
161
|
|
|
97
162
|
// Override fetch to route internal container requests to appropriate ports
|
|
98
163
|
override async fetch(request: Request): Promise<Response> {
|
|
99
|
-
|
|
164
|
+
// Extract or generate trace ID from request
|
|
165
|
+
const traceId = TraceContext.fromHeaders(request.headers) || TraceContext.generate();
|
|
100
166
|
|
|
101
|
-
//
|
|
102
|
-
|
|
103
|
-
|
|
104
|
-
|
|
105
|
-
|
|
106
|
-
|
|
107
|
-
|
|
167
|
+
// Create request-specific logger with trace ID
|
|
168
|
+
const requestLogger = this.logger.child({ traceId, operation: 'fetch' });
|
|
169
|
+
|
|
170
|
+
return await runWithLogger(requestLogger, async () => {
|
|
171
|
+
const url = new URL(request.url);
|
|
172
|
+
|
|
173
|
+
// Capture and store the sandbox name from the header if present
|
|
174
|
+
if (!this.sandboxName && request.headers.has('X-Sandbox-Name')) {
|
|
175
|
+
const name = request.headers.get('X-Sandbox-Name')!;
|
|
176
|
+
this.sandboxName = name;
|
|
177
|
+
await this.ctx.storage.put('sandboxName', name);
|
|
178
|
+
}
|
|
108
179
|
|
|
109
|
-
|
|
110
|
-
|
|
180
|
+
// Determine which port to route to
|
|
181
|
+
const port = this.determinePort(url);
|
|
111
182
|
|
|
112
|
-
|
|
113
|
-
|
|
183
|
+
// Route to the appropriate port
|
|
184
|
+
return await this.containerFetch(request, port);
|
|
185
|
+
});
|
|
114
186
|
}
|
|
115
187
|
|
|
116
188
|
private determinePort(url: URL): number {
|
|
117
189
|
// Extract port from proxy requests (e.g., /proxy/8080/*)
|
|
118
190
|
const proxyMatch = url.pathname.match(/^\/proxy\/(\d+)/);
|
|
119
191
|
if (proxyMatch) {
|
|
120
|
-
return parseInt(proxyMatch[1]);
|
|
192
|
+
return parseInt(proxyMatch[1], 10);
|
|
121
193
|
}
|
|
122
194
|
|
|
123
195
|
// All other requests go to control plane on port 3000
|
|
@@ -125,9 +197,43 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
125
197
|
return 3000;
|
|
126
198
|
}
|
|
127
199
|
|
|
200
|
+
/**
|
|
201
|
+
* Ensure default session exists - lazy initialization
|
|
202
|
+
* This is called automatically by all public methods that need a session
|
|
203
|
+
*/
|
|
204
|
+
private async ensureDefaultSession(): Promise<string> {
|
|
205
|
+
if (!this.defaultSession) {
|
|
206
|
+
const sessionId = `sandbox-${this.sandboxName || 'default'}`;
|
|
207
|
+
|
|
208
|
+
// Create session in container
|
|
209
|
+
await this.client.utils.createSession({
|
|
210
|
+
id: sessionId,
|
|
211
|
+
env: this.envVars || {},
|
|
212
|
+
cwd: '/workspace',
|
|
213
|
+
});
|
|
214
|
+
|
|
215
|
+
this.defaultSession = sessionId;
|
|
216
|
+
this.logger.debug('Default session initialized', { sessionId });
|
|
217
|
+
}
|
|
218
|
+
return this.defaultSession;
|
|
219
|
+
}
|
|
220
|
+
|
|
128
221
|
// Enhanced exec method - always returns ExecResult with optional streaming
|
|
129
222
|
// This replaces the old exec method to match ISandbox interface
|
|
130
223
|
async exec(command: string, options?: ExecOptions): Promise<ExecResult> {
|
|
224
|
+
const session = await this.ensureDefaultSession();
|
|
225
|
+
return this.execWithSession(command, session, options);
|
|
226
|
+
}
|
|
227
|
+
|
|
228
|
+
/**
|
|
229
|
+
* Internal session-aware exec implementation
|
|
230
|
+
* Used by both public exec() and session wrappers
|
|
231
|
+
*/
|
|
232
|
+
private async execWithSession(
|
|
233
|
+
command: string,
|
|
234
|
+
sessionId: string,
|
|
235
|
+
options?: ExecOptions
|
|
236
|
+
): Promise<ExecResult> {
|
|
131
237
|
const startTime = Date.now();
|
|
132
238
|
const timestamp = new Date().toISOString();
|
|
133
239
|
|
|
@@ -144,16 +250,13 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
144
250
|
|
|
145
251
|
if (options?.stream && options?.onOutput) {
|
|
146
252
|
// Streaming with callbacks - we need to collect the final result
|
|
147
|
-
result = await this.executeWithStreaming(command, options, startTime, timestamp);
|
|
253
|
+
result = await this.executeWithStreaming(command, sessionId, options, startTime, timestamp);
|
|
148
254
|
} else {
|
|
149
|
-
// Regular execution
|
|
150
|
-
const response = await this.client.execute(
|
|
151
|
-
command,
|
|
152
|
-
options?.sessionId
|
|
153
|
-
);
|
|
255
|
+
// Regular execution with session
|
|
256
|
+
const response = await this.client.commands.execute(command, sessionId);
|
|
154
257
|
|
|
155
258
|
const duration = Date.now() - startTime;
|
|
156
|
-
result = this.mapExecuteResponseToExecResult(response, duration,
|
|
259
|
+
result = this.mapExecuteResponseToExecResult(response, duration, sessionId);
|
|
157
260
|
}
|
|
158
261
|
|
|
159
262
|
// Call completion callback if provided
|
|
@@ -176,6 +279,7 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
176
279
|
|
|
177
280
|
private async executeWithStreaming(
|
|
178
281
|
command: string,
|
|
282
|
+
sessionId: string,
|
|
179
283
|
options: ExecOptions,
|
|
180
284
|
startTime: number,
|
|
181
285
|
timestamp: string
|
|
@@ -184,10 +288,9 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
184
288
|
let stderr = '';
|
|
185
289
|
|
|
186
290
|
try {
|
|
187
|
-
const stream = await this.client.
|
|
188
|
-
const { parseSSEStream } = await import('./sse-parser');
|
|
291
|
+
const stream = await this.client.commands.executeStream(command, sessionId);
|
|
189
292
|
|
|
190
|
-
for await (const event of parseSSEStream<
|
|
293
|
+
for await (const event of parseSSEStream<ExecEvent>(stream)) {
|
|
191
294
|
// Check for cancellation
|
|
192
295
|
if (options.signal?.aborted) {
|
|
193
296
|
throw new Error('Operation was aborted');
|
|
@@ -211,20 +314,20 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
211
314
|
case 'complete': {
|
|
212
315
|
// Use result from complete event if available
|
|
213
316
|
const duration = Date.now() - startTime;
|
|
214
|
-
return
|
|
215
|
-
success: event.exitCode === 0,
|
|
216
|
-
exitCode: event.exitCode
|
|
317
|
+
return {
|
|
318
|
+
success: (event.exitCode ?? 0) === 0,
|
|
319
|
+
exitCode: event.exitCode ?? 0,
|
|
217
320
|
stdout,
|
|
218
321
|
stderr,
|
|
219
322
|
command,
|
|
220
323
|
duration,
|
|
221
324
|
timestamp,
|
|
222
|
-
sessionId
|
|
325
|
+
sessionId
|
|
223
326
|
};
|
|
224
327
|
}
|
|
225
328
|
|
|
226
329
|
case 'error':
|
|
227
|
-
throw new Error(event.
|
|
330
|
+
throw new Error(event.data || 'Command execution failed');
|
|
228
331
|
}
|
|
229
332
|
}
|
|
230
333
|
|
|
@@ -240,7 +343,7 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
240
343
|
}
|
|
241
344
|
|
|
242
345
|
private mapExecuteResponseToExecResult(
|
|
243
|
-
response:
|
|
346
|
+
response: ExecuteResponse,
|
|
244
347
|
duration: number,
|
|
245
348
|
sessionId?: string
|
|
246
349
|
): ExecResult {
|
|
@@ -256,57 +359,68 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
256
359
|
};
|
|
257
360
|
}
|
|
258
361
|
|
|
362
|
+
/**
|
|
363
|
+
* Create a Process domain object from HTTP client DTO
|
|
364
|
+
* Centralizes process object creation with bound methods
|
|
365
|
+
* This eliminates duplication across startProcess, listProcesses, getProcess, and session wrappers
|
|
366
|
+
*/
|
|
367
|
+
private createProcessFromDTO(
|
|
368
|
+
data: {
|
|
369
|
+
id: string;
|
|
370
|
+
pid?: number;
|
|
371
|
+
command: string;
|
|
372
|
+
status: ProcessStatus;
|
|
373
|
+
startTime: string | Date;
|
|
374
|
+
endTime?: string | Date;
|
|
375
|
+
exitCode?: number;
|
|
376
|
+
},
|
|
377
|
+
sessionId: string
|
|
378
|
+
): Process {
|
|
379
|
+
return {
|
|
380
|
+
id: data.id,
|
|
381
|
+
pid: data.pid,
|
|
382
|
+
command: data.command,
|
|
383
|
+
status: data.status,
|
|
384
|
+
startTime: typeof data.startTime === 'string' ? new Date(data.startTime) : data.startTime,
|
|
385
|
+
endTime: data.endTime ? (typeof data.endTime === 'string' ? new Date(data.endTime) : data.endTime) : undefined,
|
|
386
|
+
exitCode: data.exitCode,
|
|
387
|
+
sessionId,
|
|
388
|
+
|
|
389
|
+
kill: async (signal?: string) => {
|
|
390
|
+
await this.killProcess(data.id, signal);
|
|
391
|
+
},
|
|
392
|
+
|
|
393
|
+
getStatus: async () => {
|
|
394
|
+
const current = await this.getProcess(data.id);
|
|
395
|
+
return current?.status || 'error';
|
|
396
|
+
},
|
|
397
|
+
|
|
398
|
+
getLogs: async () => {
|
|
399
|
+
const logs = await this.getProcessLogs(data.id);
|
|
400
|
+
return { stdout: logs.stdout, stderr: logs.stderr };
|
|
401
|
+
}
|
|
402
|
+
};
|
|
403
|
+
}
|
|
404
|
+
|
|
259
405
|
|
|
260
406
|
// Background process management
|
|
261
|
-
async startProcess(command: string, options?: ProcessOptions): Promise<Process> {
|
|
407
|
+
async startProcess(command: string, options?: ProcessOptions, sessionId?: string): Promise<Process> {
|
|
262
408
|
// Use the new HttpClient method to start the process
|
|
263
409
|
try {
|
|
264
|
-
const
|
|
265
|
-
|
|
266
|
-
|
|
267
|
-
timeout: options?.timeout,
|
|
268
|
-
env: options?.env,
|
|
269
|
-
cwd: options?.cwd,
|
|
270
|
-
encoding: options?.encoding,
|
|
271
|
-
autoCleanup: options?.autoCleanup
|
|
410
|
+
const session = sessionId ?? await this.ensureDefaultSession();
|
|
411
|
+
const response = await this.client.processes.startProcess(command, session, {
|
|
412
|
+
processId: options?.processId
|
|
272
413
|
});
|
|
273
414
|
|
|
274
|
-
const
|
|
275
|
-
|
|
276
|
-
|
|
277
|
-
|
|
278
|
-
|
|
279
|
-
|
|
280
|
-
startTime: new Date(process.startTime),
|
|
415
|
+
const processObj = this.createProcessFromDTO({
|
|
416
|
+
id: response.processId,
|
|
417
|
+
pid: response.pid,
|
|
418
|
+
command: response.command,
|
|
419
|
+
status: 'running' as ProcessStatus,
|
|
420
|
+
startTime: new Date(),
|
|
281
421
|
endTime: undefined,
|
|
282
|
-
exitCode: undefined
|
|
283
|
-
|
|
284
|
-
|
|
285
|
-
async kill(): Promise<void> {
|
|
286
|
-
throw new Error('Method will be replaced');
|
|
287
|
-
},
|
|
288
|
-
async getStatus(): Promise<ProcessStatus> {
|
|
289
|
-
throw new Error('Method will be replaced');
|
|
290
|
-
},
|
|
291
|
-
async getLogs(): Promise<{ stdout: string; stderr: string }> {
|
|
292
|
-
throw new Error('Method will be replaced');
|
|
293
|
-
}
|
|
294
|
-
};
|
|
295
|
-
|
|
296
|
-
// Bind context properly
|
|
297
|
-
processObj.kill = async (signal?: string) => {
|
|
298
|
-
await this.killProcess(process.id, signal);
|
|
299
|
-
};
|
|
300
|
-
|
|
301
|
-
processObj.getStatus = async () => {
|
|
302
|
-
const current = await this.getProcess(process.id);
|
|
303
|
-
return current?.status || 'error';
|
|
304
|
-
};
|
|
305
|
-
|
|
306
|
-
processObj.getLogs = async () => {
|
|
307
|
-
const logs = await this.getProcessLogs(process.id);
|
|
308
|
-
return { stdout: logs.stdout, stderr: logs.stderr };
|
|
309
|
-
};
|
|
422
|
+
exitCode: undefined
|
|
423
|
+
}, session);
|
|
310
424
|
|
|
311
425
|
// Call onStart callback if provided
|
|
312
426
|
if (options?.onStart) {
|
|
@@ -324,108 +438,68 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
324
438
|
}
|
|
325
439
|
}
|
|
326
440
|
|
|
327
|
-
async listProcesses(): Promise<Process[]> {
|
|
328
|
-
const
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
},
|
|
343
|
-
|
|
344
|
-
getStatus: async () => {
|
|
345
|
-
const current = await this.getProcess(processData.id);
|
|
346
|
-
return current?.status || 'error';
|
|
347
|
-
},
|
|
348
|
-
|
|
349
|
-
getLogs: async () => {
|
|
350
|
-
const logs = await this.getProcessLogs(processData.id);
|
|
351
|
-
return { stdout: logs.stdout, stderr: logs.stderr };
|
|
352
|
-
}
|
|
353
|
-
}));
|
|
441
|
+
async listProcesses(sessionId?: string): Promise<Process[]> {
|
|
442
|
+
const session = sessionId ?? await this.ensureDefaultSession();
|
|
443
|
+
const response = await this.client.processes.listProcesses();
|
|
444
|
+
|
|
445
|
+
return response.processes.map(processData =>
|
|
446
|
+
this.createProcessFromDTO({
|
|
447
|
+
id: processData.id,
|
|
448
|
+
pid: processData.pid,
|
|
449
|
+
command: processData.command,
|
|
450
|
+
status: processData.status,
|
|
451
|
+
startTime: processData.startTime,
|
|
452
|
+
endTime: processData.endTime,
|
|
453
|
+
exitCode: processData.exitCode
|
|
454
|
+
}, session)
|
|
455
|
+
);
|
|
354
456
|
}
|
|
355
457
|
|
|
356
|
-
async getProcess(id: string): Promise<Process | null> {
|
|
357
|
-
const
|
|
458
|
+
async getProcess(id: string, sessionId?: string): Promise<Process | null> {
|
|
459
|
+
const session = sessionId ?? await this.ensureDefaultSession();
|
|
460
|
+
const response = await this.client.processes.getProcess(id);
|
|
358
461
|
if (!response.process) {
|
|
359
462
|
return null;
|
|
360
463
|
}
|
|
361
464
|
|
|
362
465
|
const processData = response.process;
|
|
363
|
-
return {
|
|
466
|
+
return this.createProcessFromDTO({
|
|
364
467
|
id: processData.id,
|
|
365
468
|
pid: processData.pid,
|
|
366
469
|
command: processData.command,
|
|
367
470
|
status: processData.status,
|
|
368
|
-
startTime:
|
|
369
|
-
endTime: processData.endTime
|
|
370
|
-
exitCode: processData.exitCode
|
|
371
|
-
|
|
372
|
-
|
|
373
|
-
kill: async (signal?: string) => {
|
|
374
|
-
await this.killProcess(processData.id, signal);
|
|
375
|
-
},
|
|
376
|
-
|
|
377
|
-
getStatus: async () => {
|
|
378
|
-
const current = await this.getProcess(processData.id);
|
|
379
|
-
return current?.status || 'error';
|
|
380
|
-
},
|
|
381
|
-
|
|
382
|
-
getLogs: async () => {
|
|
383
|
-
const logs = await this.getProcessLogs(processData.id);
|
|
384
|
-
return { stdout: logs.stdout, stderr: logs.stderr };
|
|
385
|
-
}
|
|
386
|
-
};
|
|
471
|
+
startTime: processData.startTime,
|
|
472
|
+
endTime: processData.endTime,
|
|
473
|
+
exitCode: processData.exitCode
|
|
474
|
+
}, session);
|
|
387
475
|
}
|
|
388
476
|
|
|
389
|
-
async killProcess(id: string,
|
|
390
|
-
|
|
391
|
-
|
|
392
|
-
|
|
393
|
-
} catch (error) {
|
|
394
|
-
if (error instanceof Error && error.message.includes('Process not found')) {
|
|
395
|
-
throw new ProcessNotFoundError(id);
|
|
396
|
-
}
|
|
397
|
-
throw new SandboxError(
|
|
398
|
-
`Failed to kill process ${id}: ${error instanceof Error ? error.message : 'Unknown error'}`,
|
|
399
|
-
'KILL_PROCESS_FAILED'
|
|
400
|
-
);
|
|
401
|
-
}
|
|
477
|
+
async killProcess(id: string, signal?: string, sessionId?: string): Promise<void> {
|
|
478
|
+
// Note: signal parameter is not currently supported by the HttpClient implementation
|
|
479
|
+
// The HTTP client already throws properly typed errors, so we just let them propagate
|
|
480
|
+
await this.client.processes.killProcess(id);
|
|
402
481
|
}
|
|
403
482
|
|
|
404
|
-
async killAllProcesses(): Promise<number> {
|
|
405
|
-
const response = await this.client.killAllProcesses();
|
|
406
|
-
return response.
|
|
483
|
+
async killAllProcesses(sessionId?: string): Promise<number> {
|
|
484
|
+
const response = await this.client.processes.killAllProcesses();
|
|
485
|
+
return response.cleanedCount;
|
|
407
486
|
}
|
|
408
487
|
|
|
409
|
-
async cleanupCompletedProcesses(): Promise<number> {
|
|
488
|
+
async cleanupCompletedProcesses(sessionId?: string): Promise<number> {
|
|
410
489
|
// For now, this would need to be implemented as a container endpoint
|
|
411
490
|
// as we no longer maintain local process storage
|
|
412
491
|
// We'll return 0 as a placeholder until the container endpoint is added
|
|
413
492
|
return 0;
|
|
414
493
|
}
|
|
415
494
|
|
|
416
|
-
async getProcessLogs(id: string): Promise<{ stdout: string; stderr: string }> {
|
|
417
|
-
|
|
418
|
-
|
|
419
|
-
|
|
420
|
-
|
|
421
|
-
|
|
422
|
-
|
|
423
|
-
}
|
|
424
|
-
if (error instanceof Error && error.message.includes('Process not found')) {
|
|
425
|
-
throw new ProcessNotFoundError(id);
|
|
426
|
-
}
|
|
427
|
-
throw error;
|
|
428
|
-
}
|
|
495
|
+
async getProcessLogs(id: string, sessionId?: string): Promise<{ stdout: string; stderr: string; processId: string }> {
|
|
496
|
+
// The HTTP client already throws properly typed errors, so we just let them propagate
|
|
497
|
+
const response = await this.client.processes.getProcessLogs(id);
|
|
498
|
+
return {
|
|
499
|
+
stdout: response.stdout,
|
|
500
|
+
stderr: response.stderr,
|
|
501
|
+
processId: response.processId
|
|
502
|
+
};
|
|
429
503
|
}
|
|
430
504
|
|
|
431
505
|
|
|
@@ -436,11 +510,21 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
436
510
|
throw new Error('Operation was aborted');
|
|
437
511
|
}
|
|
438
512
|
|
|
439
|
-
|
|
440
|
-
|
|
513
|
+
const session = await this.ensureDefaultSession();
|
|
514
|
+
// Get the stream from CommandClient
|
|
515
|
+
return this.client.commands.executeStream(command, session);
|
|
516
|
+
}
|
|
441
517
|
|
|
442
|
-
|
|
443
|
-
|
|
518
|
+
/**
|
|
519
|
+
* Internal session-aware execStream implementation
|
|
520
|
+
*/
|
|
521
|
+
private async execStreamWithSession(command: string, sessionId: string, options?: StreamOptions): Promise<ReadableStream<Uint8Array>> {
|
|
522
|
+
// Check for cancellation
|
|
523
|
+
if (options?.signal?.aborted) {
|
|
524
|
+
throw new Error('Operation was aborted');
|
|
525
|
+
}
|
|
526
|
+
|
|
527
|
+
return this.client.commands.executeStream(command, sessionId);
|
|
444
528
|
}
|
|
445
529
|
|
|
446
530
|
async streamProcessLogs(processId: string, options?: { signal?: AbortSignal }): Promise<ReadableStream<Uint8Array>> {
|
|
@@ -449,69 +533,117 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
449
533
|
throw new Error('Operation was aborted');
|
|
450
534
|
}
|
|
451
535
|
|
|
452
|
-
|
|
453
|
-
const stream = await this.client.streamProcessLogs(processId);
|
|
454
|
-
|
|
455
|
-
// Return the ReadableStream directly - can be converted to AsyncIterable by consumers
|
|
456
|
-
return stream;
|
|
536
|
+
return this.client.processes.streamProcessLogs(processId);
|
|
457
537
|
}
|
|
458
538
|
|
|
459
539
|
async gitCheckout(
|
|
460
540
|
repoUrl: string,
|
|
461
|
-
options: { branch?: string; targetDir?: string }
|
|
541
|
+
options: { branch?: string; targetDir?: string; sessionId?: string }
|
|
462
542
|
) {
|
|
463
|
-
|
|
543
|
+
const session = options.sessionId ?? await this.ensureDefaultSession();
|
|
544
|
+
return this.client.git.checkout(repoUrl, session, {
|
|
545
|
+
branch: options.branch,
|
|
546
|
+
targetDir: options.targetDir
|
|
547
|
+
});
|
|
464
548
|
}
|
|
465
549
|
|
|
466
550
|
async mkdir(
|
|
467
551
|
path: string,
|
|
468
|
-
options: { recursive?: boolean } = {}
|
|
552
|
+
options: { recursive?: boolean; sessionId?: string } = {}
|
|
469
553
|
) {
|
|
470
|
-
|
|
554
|
+
const session = options.sessionId ?? await this.ensureDefaultSession();
|
|
555
|
+
return this.client.files.mkdir(path, session, { recursive: options.recursive });
|
|
471
556
|
}
|
|
472
557
|
|
|
473
558
|
async writeFile(
|
|
474
559
|
path: string,
|
|
475
560
|
content: string,
|
|
476
|
-
options: { encoding?: string } = {}
|
|
561
|
+
options: { encoding?: string; sessionId?: string } = {}
|
|
477
562
|
) {
|
|
478
|
-
|
|
563
|
+
const session = options.sessionId ?? await this.ensureDefaultSession();
|
|
564
|
+
return this.client.files.writeFile(path, content, session, { encoding: options.encoding });
|
|
479
565
|
}
|
|
480
566
|
|
|
481
|
-
async deleteFile(path: string) {
|
|
482
|
-
|
|
567
|
+
async deleteFile(path: string, sessionId?: string) {
|
|
568
|
+
const session = sessionId ?? await this.ensureDefaultSession();
|
|
569
|
+
return this.client.files.deleteFile(path, session);
|
|
483
570
|
}
|
|
484
571
|
|
|
485
572
|
async renameFile(
|
|
486
573
|
oldPath: string,
|
|
487
|
-
newPath: string
|
|
574
|
+
newPath: string,
|
|
575
|
+
sessionId?: string
|
|
488
576
|
) {
|
|
489
|
-
|
|
577
|
+
const session = sessionId ?? await this.ensureDefaultSession();
|
|
578
|
+
return this.client.files.renameFile(oldPath, newPath, session);
|
|
490
579
|
}
|
|
491
580
|
|
|
492
581
|
async moveFile(
|
|
493
582
|
sourcePath: string,
|
|
494
|
-
destinationPath: string
|
|
583
|
+
destinationPath: string,
|
|
584
|
+
sessionId?: string
|
|
495
585
|
) {
|
|
496
|
-
|
|
586
|
+
const session = sessionId ?? await this.ensureDefaultSession();
|
|
587
|
+
return this.client.files.moveFile(sourcePath, destinationPath, session);
|
|
497
588
|
}
|
|
498
589
|
|
|
499
590
|
async readFile(
|
|
500
591
|
path: string,
|
|
501
|
-
options: { encoding?: string } = {}
|
|
592
|
+
options: { encoding?: string; sessionId?: string } = {}
|
|
502
593
|
) {
|
|
503
|
-
|
|
594
|
+
const session = options.sessionId ?? await this.ensureDefaultSession();
|
|
595
|
+
return this.client.files.readFile(path, session, { encoding: options.encoding });
|
|
596
|
+
}
|
|
597
|
+
|
|
598
|
+
/**
|
|
599
|
+
* Stream a file from the sandbox using Server-Sent Events
|
|
600
|
+
* Returns a ReadableStream that can be consumed with streamFile() or collectFile() utilities
|
|
601
|
+
* @param path - Path to the file to stream
|
|
602
|
+
* @param options - Optional session ID
|
|
603
|
+
*/
|
|
604
|
+
async readFileStream(
|
|
605
|
+
path: string,
|
|
606
|
+
options: { sessionId?: string } = {}
|
|
607
|
+
): Promise<ReadableStream<Uint8Array>> {
|
|
608
|
+
const session = options.sessionId ?? await this.ensureDefaultSession();
|
|
609
|
+
return this.client.files.readFileStream(path, session);
|
|
610
|
+
}
|
|
611
|
+
|
|
612
|
+
async listFiles(
|
|
613
|
+
path: string,
|
|
614
|
+
options?: { recursive?: boolean; includeHidden?: boolean }
|
|
615
|
+
) {
|
|
616
|
+
const session = await this.ensureDefaultSession();
|
|
617
|
+
return this.client.files.listFiles(path, session, options);
|
|
504
618
|
}
|
|
505
619
|
|
|
506
620
|
async exposePort(port: number, options: { name?: string; hostname: string }) {
|
|
507
|
-
|
|
621
|
+
// Check if hostname is workers.dev domain (doesn't support wildcard subdomains)
|
|
622
|
+
if (options.hostname.endsWith('.workers.dev')) {
|
|
623
|
+
const errorResponse: ErrorResponse = {
|
|
624
|
+
code: ErrorCode.CUSTOM_DOMAIN_REQUIRED,
|
|
625
|
+
message: `Port exposure requires a custom domain. .workers.dev domains do not support wildcard subdomains required for port proxying.`,
|
|
626
|
+
context: { originalError: options.hostname },
|
|
627
|
+
httpStatus: 400,
|
|
628
|
+
timestamp: new Date().toISOString()
|
|
629
|
+
};
|
|
630
|
+
throw new CustomDomainRequiredError(errorResponse);
|
|
631
|
+
}
|
|
632
|
+
|
|
633
|
+
const sessionId = await this.ensureDefaultSession();
|
|
634
|
+
await this.client.ports.exposePort(port, sessionId, options?.name);
|
|
508
635
|
|
|
509
636
|
// We need the sandbox name to construct preview URLs
|
|
510
637
|
if (!this.sandboxName) {
|
|
511
638
|
throw new Error('Sandbox name not available. Ensure sandbox is accessed through getSandbox()');
|
|
512
639
|
}
|
|
513
640
|
|
|
514
|
-
|
|
641
|
+
// Generate and store token for this port
|
|
642
|
+
const token = this.generatePortToken();
|
|
643
|
+
this.portTokens.set(port, token);
|
|
644
|
+
await this.persistPortTokens();
|
|
645
|
+
|
|
646
|
+
const url = this.constructPreviewUrl(port, this.sandboxName, options.hostname, token);
|
|
515
647
|
|
|
516
648
|
return {
|
|
517
649
|
url,
|
|
@@ -522,58 +654,101 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
522
654
|
|
|
523
655
|
async unexposePort(port: number) {
|
|
524
656
|
if (!validatePort(port)) {
|
|
525
|
-
logSecurityEvent('INVALID_PORT_UNEXPOSE', {
|
|
526
|
-
port
|
|
527
|
-
}, 'high');
|
|
528
657
|
throw new SecurityError(`Invalid port number: ${port}. Must be between 1024-65535 and not reserved.`);
|
|
529
658
|
}
|
|
530
659
|
|
|
531
|
-
await this.
|
|
660
|
+
const sessionId = await this.ensureDefaultSession();
|
|
661
|
+
await this.client.ports.unexposePort(port, sessionId);
|
|
532
662
|
|
|
533
|
-
|
|
534
|
-
|
|
535
|
-
|
|
663
|
+
// Clean up token for this port
|
|
664
|
+
if (this.portTokens.has(port)) {
|
|
665
|
+
this.portTokens.delete(port);
|
|
666
|
+
await this.persistPortTokens();
|
|
667
|
+
}
|
|
536
668
|
}
|
|
537
669
|
|
|
538
670
|
async getExposedPorts(hostname: string) {
|
|
539
|
-
const
|
|
671
|
+
const sessionId = await this.ensureDefaultSession();
|
|
672
|
+
const response = await this.client.ports.getExposedPorts(sessionId);
|
|
540
673
|
|
|
541
674
|
// We need the sandbox name to construct preview URLs
|
|
542
675
|
if (!this.sandboxName) {
|
|
543
676
|
throw new Error('Sandbox name not available. Ensure sandbox is accessed through getSandbox()');
|
|
544
677
|
}
|
|
545
678
|
|
|
546
|
-
return response.ports.map(port =>
|
|
547
|
-
|
|
548
|
-
|
|
549
|
-
|
|
550
|
-
|
|
551
|
-
|
|
679
|
+
return response.ports.map(port => {
|
|
680
|
+
// Get token for this port - must exist for all exposed ports
|
|
681
|
+
const token = this.portTokens.get(port.port);
|
|
682
|
+
if (!token) {
|
|
683
|
+
throw new Error(`Port ${port.port} is exposed but has no token. This should not happen.`);
|
|
684
|
+
}
|
|
685
|
+
|
|
686
|
+
return {
|
|
687
|
+
url: this.constructPreviewUrl(port.port, this.sandboxName!, hostname, token),
|
|
688
|
+
port: port.port,
|
|
689
|
+
status: port.status,
|
|
690
|
+
};
|
|
691
|
+
});
|
|
692
|
+
}
|
|
693
|
+
|
|
694
|
+
|
|
695
|
+
async isPortExposed(port: number): Promise<boolean> {
|
|
696
|
+
try {
|
|
697
|
+
const sessionId = await this.ensureDefaultSession();
|
|
698
|
+
const response = await this.client.ports.getExposedPorts(sessionId);
|
|
699
|
+
return response.ports.some(exposedPort => exposedPort.port === port);
|
|
700
|
+
} catch (error) {
|
|
701
|
+
this.logger.error('Error checking if port is exposed', error instanceof Error ? error : new Error(String(error)), { port });
|
|
702
|
+
return false;
|
|
703
|
+
}
|
|
704
|
+
}
|
|
705
|
+
|
|
706
|
+
async validatePortToken(port: number, token: string): Promise<boolean> {
|
|
707
|
+
// First check if port is exposed
|
|
708
|
+
const isExposed = await this.isPortExposed(port);
|
|
709
|
+
if (!isExposed) {
|
|
710
|
+
return false;
|
|
711
|
+
}
|
|
712
|
+
|
|
713
|
+
// Get stored token for this port - must exist for all exposed ports
|
|
714
|
+
const storedToken = this.portTokens.get(port);
|
|
715
|
+
if (!storedToken) {
|
|
716
|
+
// This should not happen - all exposed ports must have tokens
|
|
717
|
+
this.logger.error('Port is exposed but has no token - bug detected', undefined, { port });
|
|
718
|
+
return false;
|
|
719
|
+
}
|
|
720
|
+
|
|
721
|
+
// Constant-time comparison to prevent timing attacks
|
|
722
|
+
return storedToken === token;
|
|
723
|
+
}
|
|
724
|
+
|
|
725
|
+
private generatePortToken(): string {
|
|
726
|
+
// Generate cryptographically secure 16-character token using Web Crypto API
|
|
727
|
+
// Available in Cloudflare Workers runtime
|
|
728
|
+
const array = new Uint8Array(12); // 12 bytes = 16 base64url chars (after padding removal)
|
|
729
|
+
crypto.getRandomValues(array);
|
|
730
|
+
|
|
731
|
+
// Convert to base64url format (URL-safe, no padding, lowercase)
|
|
732
|
+
const base64 = btoa(String.fromCharCode(...array));
|
|
733
|
+
return base64.replace(/\+/g, '-').replace(/\//g, '_').replace(/=/g, '').toLowerCase();
|
|
552
734
|
}
|
|
553
735
|
|
|
736
|
+
private async persistPortTokens(): Promise<void> {
|
|
737
|
+
// Convert Map to plain object for storage
|
|
738
|
+
const tokensObj: Record<string, string> = {};
|
|
739
|
+
for (const [port, token] of this.portTokens.entries()) {
|
|
740
|
+
tokensObj[port.toString()] = token;
|
|
741
|
+
}
|
|
742
|
+
await this.ctx.storage.put('portTokens', tokensObj);
|
|
743
|
+
}
|
|
554
744
|
|
|
555
|
-
private constructPreviewUrl(port: number, sandboxId: string, hostname: string): string {
|
|
745
|
+
private constructPreviewUrl(port: number, sandboxId: string, hostname: string, token: string): string {
|
|
556
746
|
if (!validatePort(port)) {
|
|
557
|
-
logSecurityEvent('INVALID_PORT_REJECTED', {
|
|
558
|
-
port,
|
|
559
|
-
sandboxId,
|
|
560
|
-
hostname
|
|
561
|
-
}, 'high');
|
|
562
747
|
throw new SecurityError(`Invalid port number: ${port}. Must be between 1024-65535 and not reserved.`);
|
|
563
748
|
}
|
|
564
749
|
|
|
565
|
-
|
|
566
|
-
|
|
567
|
-
sanitizedSandboxId = sanitizeSandboxId(sandboxId);
|
|
568
|
-
} catch (error) {
|
|
569
|
-
logSecurityEvent('INVALID_SANDBOX_ID_REJECTED', {
|
|
570
|
-
sandboxId,
|
|
571
|
-
port,
|
|
572
|
-
hostname,
|
|
573
|
-
error: error instanceof Error ? error.message : 'Unknown error'
|
|
574
|
-
}, 'high');
|
|
575
|
-
throw error;
|
|
576
|
-
}
|
|
750
|
+
// Validate sandbox ID (will throw SecurityError if invalid)
|
|
751
|
+
const sanitizedSandboxId = sanitizeSandboxId(sandboxId);
|
|
577
752
|
|
|
578
753
|
const isLocalhost = isLocalhostPattern(hostname);
|
|
579
754
|
|
|
@@ -585,28 +760,12 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
585
760
|
// Use URL constructor for safe URL building
|
|
586
761
|
try {
|
|
587
762
|
const baseUrl = new URL(`http://${host}:${mainPort}`);
|
|
588
|
-
// Construct subdomain safely
|
|
589
|
-
const subdomainHost = `${port}-${sanitizedSandboxId}.${host}`;
|
|
763
|
+
// Construct subdomain safely with mandatory token
|
|
764
|
+
const subdomainHost = `${port}-${sanitizedSandboxId}-${token}.${host}`;
|
|
590
765
|
baseUrl.hostname = subdomainHost;
|
|
591
766
|
|
|
592
|
-
|
|
593
|
-
|
|
594
|
-
logSecurityEvent('PREVIEW_URL_CONSTRUCTED', {
|
|
595
|
-
port,
|
|
596
|
-
sandboxId: sanitizedSandboxId,
|
|
597
|
-
hostname,
|
|
598
|
-
resultUrl: finalUrl,
|
|
599
|
-
environment: 'localhost'
|
|
600
|
-
}, 'low');
|
|
601
|
-
|
|
602
|
-
return finalUrl;
|
|
767
|
+
return baseUrl.toString();
|
|
603
768
|
} catch (error) {
|
|
604
|
-
logSecurityEvent('URL_CONSTRUCTION_FAILED', {
|
|
605
|
-
port,
|
|
606
|
-
sandboxId: sanitizedSandboxId,
|
|
607
|
-
hostname,
|
|
608
|
-
error: error instanceof Error ? error.message : 'Unknown error'
|
|
609
|
-
}, 'high');
|
|
610
769
|
throw new SecurityError(`Failed to construct preview URL: ${error instanceof Error ? error.message : 'Unknown error'}`);
|
|
611
770
|
}
|
|
612
771
|
}
|
|
@@ -617,29 +776,142 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
|
|
|
617
776
|
const protocol = "https";
|
|
618
777
|
const baseUrl = new URL(`${protocol}://${hostname}`);
|
|
619
778
|
|
|
620
|
-
// Construct subdomain safely
|
|
621
|
-
const subdomainHost = `${port}-${sanitizedSandboxId}.${hostname}`;
|
|
779
|
+
// Construct subdomain safely with mandatory token
|
|
780
|
+
const subdomainHost = `${port}-${sanitizedSandboxId}-${token}.${hostname}`;
|
|
622
781
|
baseUrl.hostname = subdomainHost;
|
|
623
782
|
|
|
624
|
-
|
|
625
|
-
|
|
626
|
-
logSecurityEvent('PREVIEW_URL_CONSTRUCTED', {
|
|
627
|
-
port,
|
|
628
|
-
sandboxId: sanitizedSandboxId,
|
|
629
|
-
hostname,
|
|
630
|
-
resultUrl: finalUrl,
|
|
631
|
-
environment: 'production'
|
|
632
|
-
}, 'low');
|
|
633
|
-
|
|
634
|
-
return finalUrl;
|
|
783
|
+
return baseUrl.toString();
|
|
635
784
|
} catch (error) {
|
|
636
|
-
logSecurityEvent('URL_CONSTRUCTION_FAILED', {
|
|
637
|
-
port,
|
|
638
|
-
sandboxId: sanitizedSandboxId,
|
|
639
|
-
hostname,
|
|
640
|
-
error: error instanceof Error ? error.message : 'Unknown error'
|
|
641
|
-
}, 'high');
|
|
642
785
|
throw new SecurityError(`Failed to construct preview URL: ${error instanceof Error ? error.message : 'Unknown error'}`);
|
|
643
786
|
}
|
|
644
787
|
}
|
|
788
|
+
|
|
789
|
+
// ============================================================================
|
|
790
|
+
// Session Management - Advanced Use Cases
|
|
791
|
+
// ============================================================================
|
|
792
|
+
|
|
793
|
+
/**
|
|
794
|
+
* Create isolated execution session for advanced use cases
|
|
795
|
+
* Returns ExecutionSession with full sandbox API bound to specific session
|
|
796
|
+
*/
|
|
797
|
+
async createSession(options?: SessionOptions): Promise<ExecutionSession> {
|
|
798
|
+
const sessionId = options?.id || `session-${Date.now()}`;
|
|
799
|
+
|
|
800
|
+
// Create session in container
|
|
801
|
+
await this.client.utils.createSession({
|
|
802
|
+
id: sessionId,
|
|
803
|
+
env: options?.env,
|
|
804
|
+
cwd: options?.cwd,
|
|
805
|
+
});
|
|
806
|
+
|
|
807
|
+
// Return wrapper that binds sessionId to all operations
|
|
808
|
+
return this.getSessionWrapper(sessionId);
|
|
809
|
+
}
|
|
810
|
+
|
|
811
|
+
/**
|
|
812
|
+
* Get an existing session by ID
|
|
813
|
+
* Returns ExecutionSession wrapper bound to the specified session
|
|
814
|
+
*
|
|
815
|
+
* This is useful for retrieving sessions across different requests/contexts
|
|
816
|
+
* without storing the ExecutionSession object (which has RPC lifecycle limitations)
|
|
817
|
+
*
|
|
818
|
+
* @param sessionId - The ID of an existing session
|
|
819
|
+
* @returns ExecutionSession wrapper bound to the session
|
|
820
|
+
*/
|
|
821
|
+
async getSession(sessionId: string): Promise<ExecutionSession> {
|
|
822
|
+
// No need to verify session exists in container - operations will fail naturally if it doesn't
|
|
823
|
+
return this.getSessionWrapper(sessionId);
|
|
824
|
+
}
|
|
825
|
+
|
|
826
|
+
/**
|
|
827
|
+
* Internal helper to create ExecutionSession wrapper for a given sessionId
|
|
828
|
+
* Used by both createSession and getSession
|
|
829
|
+
*/
|
|
830
|
+
private getSessionWrapper(sessionId: string): ExecutionSession {
|
|
831
|
+
return {
|
|
832
|
+
id: sessionId,
|
|
833
|
+
|
|
834
|
+
// Command execution - delegate to internal session-aware methods
|
|
835
|
+
exec: (command, options) => this.execWithSession(command, sessionId, options),
|
|
836
|
+
execStream: (command, options) => this.execStreamWithSession(command, sessionId, options),
|
|
837
|
+
|
|
838
|
+
// Process management
|
|
839
|
+
startProcess: (command, options) => this.startProcess(command, options, sessionId),
|
|
840
|
+
listProcesses: () => this.listProcesses(sessionId),
|
|
841
|
+
getProcess: (id) => this.getProcess(id, sessionId),
|
|
842
|
+
killProcess: (id, signal) => this.killProcess(id, signal),
|
|
843
|
+
killAllProcesses: () => this.killAllProcesses(),
|
|
844
|
+
cleanupCompletedProcesses: () => this.cleanupCompletedProcesses(),
|
|
845
|
+
getProcessLogs: (id) => this.getProcessLogs(id),
|
|
846
|
+
streamProcessLogs: (processId, options) => this.streamProcessLogs(processId, options),
|
|
847
|
+
|
|
848
|
+
// File operations - pass sessionId via options or parameter
|
|
849
|
+
writeFile: (path, content, options) => this.writeFile(path, content, { ...options, sessionId }),
|
|
850
|
+
readFile: (path, options) => this.readFile(path, { ...options, sessionId }),
|
|
851
|
+
readFileStream: (path) => this.readFileStream(path, { sessionId }),
|
|
852
|
+
mkdir: (path, options) => this.mkdir(path, { ...options, sessionId }),
|
|
853
|
+
deleteFile: (path) => this.deleteFile(path, sessionId),
|
|
854
|
+
renameFile: (oldPath, newPath) => this.renameFile(oldPath, newPath, sessionId),
|
|
855
|
+
moveFile: (sourcePath, destPath) => this.moveFile(sourcePath, destPath, sessionId),
|
|
856
|
+
listFiles: (path, options) => this.client.files.listFiles(path, sessionId, options),
|
|
857
|
+
|
|
858
|
+
// Git operations
|
|
859
|
+
gitCheckout: (repoUrl, options) => this.gitCheckout(repoUrl, { ...options, sessionId }),
|
|
860
|
+
|
|
861
|
+
// Environment management - needs special handling
|
|
862
|
+
setEnvVars: async (envVars: Record<string, string>) => {
|
|
863
|
+
try {
|
|
864
|
+
// Set environment variables by executing export commands
|
|
865
|
+
for (const [key, value] of Object.entries(envVars)) {
|
|
866
|
+
const escapedValue = value.replace(/'/g, "'\\''");
|
|
867
|
+
const exportCommand = `export ${key}='${escapedValue}'`;
|
|
868
|
+
|
|
869
|
+
const result = await this.client.commands.execute(exportCommand, sessionId);
|
|
870
|
+
|
|
871
|
+
if (result.exitCode !== 0) {
|
|
872
|
+
throw new Error(`Failed to set ${key}: ${result.stderr || 'Unknown error'}`);
|
|
873
|
+
}
|
|
874
|
+
}
|
|
875
|
+
} catch (error) {
|
|
876
|
+
this.logger.error('Failed to set environment variables', error instanceof Error ? error : new Error(String(error)), { sessionId });
|
|
877
|
+
throw error;
|
|
878
|
+
}
|
|
879
|
+
},
|
|
880
|
+
|
|
881
|
+
// Code interpreter methods - delegate to sandbox's code interpreter
|
|
882
|
+
createCodeContext: (options) => this.codeInterpreter.createCodeContext(options),
|
|
883
|
+
runCode: async (code, options) => {
|
|
884
|
+
const execution = await this.codeInterpreter.runCode(code, options);
|
|
885
|
+
return execution.toJSON();
|
|
886
|
+
},
|
|
887
|
+
runCodeStream: (code, options) => this.codeInterpreter.runCodeStream(code, options),
|
|
888
|
+
listCodeContexts: () => this.codeInterpreter.listCodeContexts(),
|
|
889
|
+
deleteCodeContext: (contextId) => this.codeInterpreter.deleteCodeContext(contextId),
|
|
890
|
+
};
|
|
891
|
+
}
|
|
892
|
+
|
|
893
|
+
// ============================================================================
|
|
894
|
+
// Code interpreter methods - delegate to CodeInterpreter wrapper
|
|
895
|
+
// ============================================================================
|
|
896
|
+
|
|
897
|
+
async createCodeContext(options?: CreateContextOptions): Promise<CodeContext> {
|
|
898
|
+
return this.codeInterpreter.createCodeContext(options);
|
|
899
|
+
}
|
|
900
|
+
|
|
901
|
+
async runCode(code: string, options?: RunCodeOptions): Promise<ExecutionResult> {
|
|
902
|
+
const execution = await this.codeInterpreter.runCode(code, options);
|
|
903
|
+
return execution.toJSON();
|
|
904
|
+
}
|
|
905
|
+
|
|
906
|
+
async runCodeStream(code: string, options?: RunCodeOptions): Promise<ReadableStream> {
|
|
907
|
+
return this.codeInterpreter.runCodeStream(code, options);
|
|
908
|
+
}
|
|
909
|
+
|
|
910
|
+
async listCodeContexts(): Promise<CodeContext[]> {
|
|
911
|
+
return this.codeInterpreter.listCodeContexts();
|
|
912
|
+
}
|
|
913
|
+
|
|
914
|
+
async deleteCodeContext(contextId: string): Promise<void> {
|
|
915
|
+
return this.codeInterpreter.deleteCodeContext(contextId);
|
|
916
|
+
}
|
|
645
917
|
}
|