@cloudflare/sandbox 0.0.0-d670ba2 → 0.0.0-d8514d1

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