@cloudflare/sandbox 0.0.0-c0d9d33 → 0.0.0-c77ae8b

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