@cloudflare/sandbox 0.0.0-af082ab → 0.0.0-b61841c

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