@cloudflare/sandbox 0.0.0-d81d2a5 → 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 (64) hide show
  1. package/CHANGELOG.md +234 -0
  2. package/Dockerfile +172 -84
  3. package/README.md +92 -707
  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 +169 -0
  24. package/src/index.ts +98 -23
  25. package/src/interpreter.ts +62 -44
  26. package/src/request-handler.ts +94 -55
  27. package/src/sandbox.ts +887 -397
  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 -122
  50. package/container_src/handler/exec.ts +0 -340
  51. package/container_src/handler/file.ts +0 -844
  52. package/container_src/handler/git.ts +0 -182
  53. package/container_src/handler/ports.ts +0 -314
  54. package/container_src/handler/process.ts +0 -640
  55. package/container_src/index.ts +0 -531
  56. package/container_src/jupyter-server.ts +0 -336
  57. package/container_src/mime-processor.ts +0 -255
  58. package/container_src/package.json +0 -18
  59. package/container_src/startup.sh +0 -52
  60. package/container_src/types.ts +0 -108
  61. package/src/client.ts +0 -1021
  62. package/src/interpreter-types.ts +0 -383
  63. package/src/jupyter-client.ts +0 -266
  64. package/src/types.ts +0 -401
package/src/sandbox.ts CHANGED
@@ -1,75 +1,135 @@
1
- import { Container, getContainer } from "@cloudflare/containers";
2
- import { CodeInterpreter } from "./interpreter";
1
+ import type { DurableObject } from 'cloudflare:workers';
2
+ import { Container, getContainer, switchPort } from '@cloudflare/containers';
3
3
  import type {
4
4
  CodeContext,
5
5
  CreateContextOptions,
6
- ExecutionResult,
7
- RunCodeOptions,
8
- } from "./interpreter-types";
9
- import { JupyterClient } from "./jupyter-client";
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 {
6
+ ExecEvent,
19
7
  ExecOptions,
20
8
  ExecResult,
9
+ ExecutionResult,
10
+ ExecutionSession,
21
11
  ISandbox,
22
12
  Process,
23
13
  ProcessOptions,
24
14
  ProcessStatus,
25
- StreamOptions,
26
- } from "./types";
27
- import { ProcessNotFoundError, SandboxError } from "./types";
28
-
29
- export function getSandbox(ns: DurableObjectNamespace<Sandbox>, id: string) {
30
- 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;
31
41
 
32
42
  // Store the name on first access
33
43
  stub.setSandboxName?.(id);
34
44
 
35
- 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
+ };
36
75
  }
37
76
 
38
77
  export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
39
78
  defaultPort = 3000; // Default port for the container's Bun server
40
- sleepAfter = "3m"; // Sleep the sandbox if no requests are made in this timeframe
41
- client: JupyterClient;
42
- private sandboxName: string | null = null;
43
- private codeInterpreter: CodeInterpreter;
79
+ sleepAfter: string | number = '10m'; // Sleep the sandbox if no requests are made in this timeframe
44
80
 
45
- constructor(ctx: DurableObjectState, env: Env) {
81
+ client: SandboxClient;
82
+ private codeInterpreter: CodeInterpreter;
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;
90
+
91
+ constructor(ctx: DurableObjectState<{}>, env: Env) {
46
92
  super(ctx, env);
47
- this.client = new JupyterClient({
48
- onCommandComplete: (success, exitCode, _stdout, _stderr, command) => {
49
- console.log(
50
- `[Container] Command completed: ${command}, Success: ${success}, Exit code: ${exitCode}`
51
- );
52
- },
53
- onCommandStart: (command) => {
54
- console.log(`[Container] Command started: ${command}`);
55
- },
56
- onError: (error, _command) => {
57
- console.error(`[Container] Command error: ${error}`);
58
- },
59
- onOutput: (stream, data, _command) => {
60
- console.log(`[Container] [${stream}] ${data}`);
61
- },
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,
62
110
  port: 3000, // Control plane port
63
- stub: this,
111
+ stub: this
64
112
  });
65
113
 
66
- // Initialize code interpreter
114
+ // Initialize code interpreter - pass 'this' after client is ready
115
+ // The CodeInterpreter extracts client.interpreter from the sandbox
67
116
  this.codeInterpreter = new CodeInterpreter(this);
68
117
 
69
- // Load the sandbox name from storage on initialization
118
+ // Load the sandbox name, port tokens, and default session from storage on initialization
70
119
  this.ctx.blockConcurrencyWhile(async () => {
71
120
  this.sandboxName =
72
- (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
+ }
73
133
  });
74
134
  }
75
135
 
@@ -77,56 +137,227 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
77
137
  async setSandboxName(name: string): Promise<void> {
78
138
  if (!this.sandboxName) {
79
139
  this.sandboxName = name;
80
- await this.ctx.storage.put("sandboxName", name);
81
- 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
+ );
82
174
  }
83
175
  }
84
176
 
85
177
  // RPC method to set environment variables
86
178
  async setEnvVars(envVars: Record<string, string>): Promise<void> {
179
+ // Update local state for new sessions
87
180
  this.envVars = { ...this.envVars, ...envVars };
88
- console.log(`[Sandbox] Updated environment variables`);
181
+
182
+ // If default session already exists, update it directly
183
+ if (this.defaultSession) {
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
+ }
200
+ }
201
+ }
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();
89
209
  }
90
210
 
91
211
  override onStart() {
92
- 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
+ });
93
221
  }
94
222
 
95
- override onStop() {
96
- console.log("Sandbox successfully shut down");
97
- if (this.client) {
98
- this.client.clearSession();
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
+ });
99
267
  }
100
268
  }
101
269
 
270
+ override onStop() {
271
+ this.logger.debug('Sandbox stopped');
272
+ }
273
+
102
274
  override onError(error: unknown) {
103
- 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
+ }
104
296
  }
105
297
 
106
298
  // Override fetch to route internal container requests to appropriate ports
107
299
  override async fetch(request: Request): Promise<Response> {
108
- const url = new URL(request.url);
300
+ // Extract or generate trace ID from request
301
+ const traceId =
302
+ TraceContext.fromHeaders(request.headers) || TraceContext.generate();
109
303
 
110
- // Capture and store the sandbox name from the header if present
111
- if (!this.sandboxName && request.headers.has("X-Sandbox-Name")) {
112
- const name = request.headers.get("X-Sandbox-Name")!;
113
- this.sandboxName = name;
114
- await this.ctx.storage.put("sandboxName", name);
115
- console.log(`[Sandbox] Stored sandbox name: ${this.sandboxName}`);
116
- }
304
+ // Create request-specific logger with trace ID
305
+ const requestLogger = this.logger.child({ traceId, operation: 'fetch' });
117
306
 
118
- // Determine which port to route to
119
- const port = this.determinePort(url);
307
+ return await runWithLogger(requestLogger, async () => {
308
+ const url = new URL(request.url);
120
309
 
121
- // Route to the appropriate port
122
- return await this.containerFetch(request, port);
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
+ }
316
+
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');
123
354
  }
124
355
 
125
356
  private determinePort(url: URL): number {
126
357
  // Extract port from proxy requests (e.g., /proxy/8080/*)
127
358
  const proxyMatch = url.pathname.match(/^\/proxy\/(\d+)/);
128
359
  if (proxyMatch) {
129
- return parseInt(proxyMatch[1]);
360
+ return parseInt(proxyMatch[1], 10);
130
361
  }
131
362
 
132
363
  // All other requests go to control plane on port 3000
@@ -134,19 +365,73 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
134
365
  return 3000;
135
366
  }
136
367
 
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> {
377
+ if (!this.defaultSession) {
378
+ const sessionId = `sandbox-${this.sandboxName || 'default'}`;
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
+ }
406
+ }
407
+ return this.defaultSession;
408
+ }
409
+
137
410
  // Enhanced exec method - always returns ExecResult with optional streaming
138
411
  // This replaces the old exec method to match ISandbox interface
139
412
  async exec(command: string, options?: ExecOptions): Promise<ExecResult> {
413
+ const session = await this.ensureDefaultSession();
414
+ return this.execWithSession(command, session, options);
415
+ }
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> {
140
426
  const startTime = Date.now();
141
427
  const timestamp = new Date().toISOString();
142
428
 
143
- // Handle timeout
144
429
  let timeoutId: NodeJS.Timeout | undefined;
145
430
 
146
431
  try {
147
432
  // Handle cancellation
148
433
  if (options?.signal?.aborted) {
149
- throw new Error("Operation was aborted");
434
+ throw new Error('Operation was aborted');
150
435
  }
151
436
 
152
437
  let result: ExecResult;
@@ -155,23 +440,20 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
155
440
  // Streaming with callbacks - we need to collect the final result
156
441
  result = await this.executeWithStreaming(
157
442
  command,
443
+ sessionId,
158
444
  options,
159
445
  startTime,
160
446
  timestamp
161
447
  );
162
448
  } else {
163
- // Regular execution
164
- const response = await this.client.execute(command, {
165
- sessionId: options?.sessionId,
166
- cwd: options?.cwd,
167
- env: options?.env,
168
- });
449
+ // Regular execution with session
450
+ const response = await this.client.commands.execute(command, sessionId);
169
451
 
170
452
  const duration = Date.now() - startTime;
171
453
  result = this.mapExecuteResponseToExecResult(
172
454
  response,
173
455
  duration,
174
- options?.sessionId
456
+ sessionId
175
457
  );
176
458
  }
177
459
 
@@ -195,34 +477,33 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
195
477
 
196
478
  private async executeWithStreaming(
197
479
  command: string,
480
+ sessionId: string,
198
481
  options: ExecOptions,
199
482
  startTime: number,
200
483
  timestamp: string
201
484
  ): Promise<ExecResult> {
202
- let stdout = "";
203
- let stderr = "";
485
+ let stdout = '';
486
+ let stderr = '';
204
487
 
205
488
  try {
206
- const stream = await this.client.executeCommandStream(
489
+ const stream = await this.client.commands.executeStream(
207
490
  command,
208
- options.sessionId
491
+ sessionId
209
492
  );
210
493
 
211
- for await (const event of parseSSEStream<import("./types").ExecEvent>(
212
- stream
213
- )) {
494
+ for await (const event of parseSSEStream<ExecEvent>(stream)) {
214
495
  // Check for cancellation
215
496
  if (options.signal?.aborted) {
216
- throw new Error("Operation was aborted");
497
+ throw new Error('Operation was aborted');
217
498
  }
218
499
 
219
500
  switch (event.type) {
220
- case "stdout":
221
- case "stderr":
501
+ case 'stdout':
502
+ case 'stderr':
222
503
  if (event.data) {
223
504
  // Update accumulated output
224
- if (event.type === "stdout") stdout += event.data;
225
- if (event.type === "stderr") stderr += event.data;
505
+ if (event.type === 'stdout') stdout += event.data;
506
+ if (event.type === 'stderr') stderr += event.data;
226
507
 
227
508
  // Call user's callback
228
509
  if (options.onOutput) {
@@ -231,40 +512,38 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
231
512
  }
232
513
  break;
233
514
 
234
- case "complete": {
515
+ case 'complete': {
235
516
  // Use result from complete event if available
236
517
  const duration = Date.now() - startTime;
237
- return (
238
- event.result || {
239
- success: event.exitCode === 0,
240
- exitCode: event.exitCode || 0,
241
- stdout,
242
- stderr,
243
- command,
244
- duration,
245
- timestamp,
246
- sessionId: options.sessionId,
247
- }
248
- );
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
+ };
249
528
  }
250
529
 
251
- case "error":
252
- throw new Error(event.error || "Command execution failed");
530
+ case 'error':
531
+ throw new Error(event.data || 'Command execution failed');
253
532
  }
254
533
  }
255
534
 
256
535
  // If we get here without a complete event, something went wrong
257
- throw new Error("Stream ended without completion event");
536
+ throw new Error('Stream ended without completion event');
258
537
  } catch (error) {
259
538
  if (options.signal?.aborted) {
260
- throw new Error("Operation was aborted");
539
+ throw new Error('Operation was aborted');
261
540
  }
262
541
  throw error;
263
542
  }
264
543
  }
265
544
 
266
545
  private mapExecuteResponseToExecResult(
267
- response: import("./client").ExecuteResponse,
546
+ response: ExecuteResponse,
268
547
  duration: number,
269
548
  sessionId?: string
270
549
  ): ExecResult {
@@ -276,63 +555,89 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
276
555
  command: response.command,
277
556
  duration,
278
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,
279
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
+ }
280
609
  };
281
610
  }
282
611
 
283
612
  // Background process management
284
613
  async startProcess(
285
614
  command: string,
286
- options?: ProcessOptions
615
+ options?: ProcessOptions,
616
+ sessionId?: string
287
617
  ): Promise<Process> {
288
618
  // Use the new HttpClient method to start the process
289
619
  try {
290
- const response = await this.client.startProcess(command, {
291
- processId: options?.processId,
292
- sessionId: options?.sessionId,
293
- timeout: options?.timeout,
294
- env: options?.env,
295
- cwd: options?.cwd,
296
- encoding: options?.encoding,
297
- autoCleanup: options?.autoCleanup,
298
- });
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
+ );
299
628
 
300
- const process = response.process;
301
- const processObj: Process = {
302
- id: process.id,
303
- pid: process.pid,
304
- command: process.command,
305
- status: process.status as ProcessStatus,
306
- startTime: new Date(process.startTime),
307
- endTime: undefined,
308
- exitCode: undefined,
309
- sessionId: process.sessionId,
310
-
311
- async kill(): Promise<void> {
312
- throw new Error("Method will be replaced");
313
- },
314
- async getStatus(): Promise<ProcessStatus> {
315
- throw new Error("Method will be replaced");
316
- },
317
- async getLogs(): Promise<{ stdout: string; stderr: string }> {
318
- throw new Error("Method will be replaced");
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
319
638
  },
320
- };
321
-
322
- // Bind context properly
323
- processObj.kill = async (signal?: string) => {
324
- await this.killProcess(process.id, signal);
325
- };
326
-
327
- processObj.getStatus = async () => {
328
- const current = await this.getProcess(process.id);
329
- return current?.status || "error";
330
- };
331
-
332
- processObj.getLogs = async () => {
333
- const logs = await this.getProcessLogs(process.id);
334
- return { stdout: logs.stdout, stderr: logs.stderr };
335
- };
639
+ session
640
+ );
336
641
 
337
642
  // Call onStart callback if provided
338
643
  if (options?.onStart) {
@@ -349,94 +654,64 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
349
654
  }
350
655
  }
351
656
 
352
- async listProcesses(): Promise<Process[]> {
353
- const response = await this.client.listProcesses();
354
-
355
- return response.processes.map((processData) => ({
356
- id: processData.id,
357
- pid: processData.pid,
358
- command: processData.command,
359
- status: processData.status,
360
- startTime: new Date(processData.startTime),
361
- endTime: processData.endTime ? new Date(processData.endTime) : undefined,
362
- exitCode: processData.exitCode,
363
- sessionId: processData.sessionId,
364
-
365
- kill: async (signal?: string) => {
366
- await this.killProcess(processData.id, signal);
367
- },
368
-
369
- getStatus: async () => {
370
- const current = await this.getProcess(processData.id);
371
- return current?.status || "error";
372
- },
657
+ async listProcesses(sessionId?: string): Promise<Process[]> {
658
+ const session = sessionId ?? (await this.ensureDefaultSession());
659
+ const response = await this.client.processes.listProcesses();
373
660
 
374
- getLogs: async () => {
375
- const logs = await this.getProcessLogs(processData.id);
376
- return { stdout: logs.stdout, stderr: logs.stderr };
377
- },
378
- }));
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
+ );
379
675
  }
380
676
 
381
- async getProcess(id: string): Promise<Process | null> {
382
- const response = await this.client.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);
383
680
  if (!response.process) {
384
681
  return null;
385
682
  }
386
683
 
387
684
  const processData = response.process;
388
- return {
389
- id: processData.id,
390
- pid: processData.pid,
391
- command: processData.command,
392
- status: processData.status,
393
- startTime: new Date(processData.startTime),
394
- endTime: processData.endTime ? new Date(processData.endTime) : undefined,
395
- exitCode: processData.exitCode,
396
- sessionId: processData.sessionId,
397
-
398
- kill: async (signal?: string) => {
399
- await this.killProcess(processData.id, signal);
400
- },
401
-
402
- getStatus: async () => {
403
- const current = await this.getProcess(processData.id);
404
- return current?.status || "error";
405
- },
406
-
407
- getLogs: async () => {
408
- const logs = await this.getProcessLogs(processData.id);
409
- return { stdout: logs.stdout, stderr: logs.stderr };
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
410
694
  },
411
- };
695
+ session
696
+ );
412
697
  }
413
698
 
414
- async killProcess(id: string, _signal?: string): Promise<void> {
415
- try {
416
- // Note: signal parameter is not currently supported by the HttpClient implementation
417
- await this.client.killProcess(id);
418
- } catch (error) {
419
- if (
420
- error instanceof Error &&
421
- error.message.includes("Process not found")
422
- ) {
423
- throw new ProcessNotFoundError(id);
424
- }
425
- throw new SandboxError(
426
- `Failed to kill process ${id}: ${
427
- error instanceof Error ? error.message : "Unknown error"
428
- }`,
429
- "KILL_PROCESS_FAILED"
430
- );
431
- }
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);
432
707
  }
433
708
 
434
- async killAllProcesses(): Promise<number> {
435
- const response = await this.client.killAllProcesses();
436
- return response.killedCount;
709
+ async killAllProcesses(sessionId?: string): Promise<number> {
710
+ const response = await this.client.processes.killAllProcesses();
711
+ return response.cleanedCount;
437
712
  }
438
713
 
439
- async cleanupCompletedProcesses(): Promise<number> {
714
+ async cleanupCompletedProcesses(sessionId?: string): Promise<number> {
440
715
  // For now, this would need to be implemented as a container endpoint
441
716
  // as we no longer maintain local process storage
442
717
  // We'll return 0 as a placeholder until the container endpoint is added
@@ -444,23 +719,16 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
444
719
  }
445
720
 
446
721
  async getProcessLogs(
447
- id: string
448
- ): Promise<{ stdout: string; stderr: string }> {
449
- try {
450
- const response = await this.client.getProcessLogs(id);
451
- return {
452
- stdout: response.stdout,
453
- stderr: response.stderr,
454
- };
455
- } catch (error) {
456
- if (
457
- error instanceof Error &&
458
- error.message.includes("Process not found")
459
- ) {
460
- throw new ProcessNotFoundError(id);
461
- }
462
- throw error;
463
- }
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
+ };
464
732
  }
465
733
 
466
734
  // Streaming methods - return ReadableStream for RPC compatibility
@@ -470,216 +738,321 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
470
738
  ): Promise<ReadableStream<Uint8Array>> {
471
739
  // Check for cancellation
472
740
  if (options?.signal?.aborted) {
473
- throw new Error("Operation was aborted");
741
+ throw new Error('Operation was aborted');
474
742
  }
475
743
 
476
- // Get the stream from HttpClient (need to add this method)
477
- const stream = await this.client.executeCommandStream(
478
- command,
479
- options?.sessionId
480
- );
744
+ const session = await this.ensureDefaultSession();
745
+ // Get the stream from CommandClient
746
+ return this.client.commands.executeStream(command, session);
747
+ }
481
748
 
482
- // Return the ReadableStream directly - can be converted to AsyncIterable by consumers
483
- return stream;
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);
484
763
  }
485
764
 
765
+ /**
766
+ * Stream logs from a background process as a ReadableStream.
767
+ */
486
768
  async streamProcessLogs(
487
769
  processId: string,
488
770
  options?: { signal?: AbortSignal }
489
771
  ): Promise<ReadableStream<Uint8Array>> {
490
772
  // Check for cancellation
491
773
  if (options?.signal?.aborted) {
492
- throw new Error("Operation was aborted");
774
+ throw new Error('Operation was aborted');
493
775
  }
494
776
 
495
- // Get the stream from HttpClient
496
- const stream = await this.client.streamProcessLogs(processId);
497
-
498
- // Return the ReadableStream directly - can be converted to AsyncIterable by consumers
499
- return stream;
777
+ return this.client.processes.streamProcessLogs(processId);
500
778
  }
501
779
 
502
780
  async gitCheckout(
503
781
  repoUrl: string,
504
- options: { branch?: string; targetDir?: string }
782
+ options: { branch?: string; targetDir?: string; sessionId?: string }
505
783
  ) {
506
- return this.client.gitCheckout(repoUrl, options.branch, options.targetDir);
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
+ });
507
789
  }
508
790
 
509
- async mkdir(path: string, options: { recursive?: boolean } = {}) {
510
- return this.client.mkdir(path, options.recursive);
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
+ });
511
799
  }
512
800
 
513
801
  async writeFile(
514
802
  path: string,
515
803
  content: string,
516
- options: { encoding?: string } = {}
804
+ options: { encoding?: string; sessionId?: string } = {}
517
805
  ) {
518
- return this.client.writeFile(path, content, options.encoding);
806
+ const session = options.sessionId ?? (await this.ensureDefaultSession());
807
+ return this.client.files.writeFile(path, content, session, {
808
+ encoding: options.encoding
809
+ });
519
810
  }
520
811
 
521
- async deleteFile(path: string) {
522
- return this.client.deleteFile(path);
812
+ async deleteFile(path: string, sessionId?: string) {
813
+ const session = sessionId ?? (await this.ensureDefaultSession());
814
+ return this.client.files.deleteFile(path, session);
523
815
  }
524
816
 
525
- async renameFile(oldPath: string, newPath: string) {
526
- return this.client.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);
527
820
  }
528
821
 
529
- async moveFile(sourcePath: string, destinationPath: string) {
530
- return this.client.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);
829
+ }
830
+
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
+ });
839
+ }
840
+
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);
853
+ }
854
+
855
+ async listFiles(
856
+ path: string,
857
+ options?: { recursive?: boolean; includeHidden?: boolean }
858
+ ) {
859
+ const session = await this.ensureDefaultSession();
860
+ return this.client.files.listFiles(path, session, options);
531
861
  }
532
862
 
533
- async readFile(path: string, options: { encoding?: string } = {}) {
534
- return this.client.readFile(path, options.encoding);
863
+ async exists(path: string, sessionId?: string) {
864
+ const session = sessionId ?? (await this.ensureDefaultSession());
865
+ return this.client.files.exists(path, session);
535
866
  }
536
867
 
537
868
  async exposePort(port: number, options: { name?: string; hostname: string }) {
538
- 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);
539
883
 
540
884
  // We need the sandbox name to construct preview URLs
541
885
  if (!this.sandboxName) {
542
886
  throw new Error(
543
- "Sandbox name not available. Ensure sandbox is accessed through getSandbox()"
887
+ 'Sandbox name not available. Ensure sandbox is accessed through getSandbox()'
544
888
  );
545
889
  }
546
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
+
547
896
  const url = this.constructPreviewUrl(
548
897
  port,
549
898
  this.sandboxName,
550
- options.hostname
899
+ options.hostname,
900
+ token
551
901
  );
552
902
 
553
903
  return {
554
904
  url,
555
905
  port,
556
- name: options?.name,
906
+ name: options?.name
557
907
  };
558
908
  }
559
909
 
560
910
  async unexposePort(port: number) {
561
911
  if (!validatePort(port)) {
562
- logSecurityEvent(
563
- "INVALID_PORT_UNEXPOSE",
564
- {
565
- port,
566
- },
567
- "high"
568
- );
569
912
  throw new SecurityError(
570
913
  `Invalid port number: ${port}. Must be between 1024-65535 and not reserved.`
571
914
  );
572
915
  }
573
916
 
574
- await this.client.unexposePort(port);
917
+ const sessionId = await this.ensureDefaultSession();
918
+ await this.client.ports.unexposePort(port, sessionId);
575
919
 
576
- logSecurityEvent(
577
- "PORT_UNEXPOSED",
578
- {
579
- port,
580
- },
581
- "low"
582
- );
920
+ // Clean up token for this port
921
+ if (this.portTokens.has(port)) {
922
+ this.portTokens.delete(port);
923
+ await this.persistPortTokens();
924
+ }
583
925
  }
584
926
 
585
927
  async getExposedPorts(hostname: string) {
586
- const response = await this.client.getExposedPorts();
928
+ const sessionId = await this.ensureDefaultSession();
929
+ const response = await this.client.ports.getExposedPorts(sessionId);
587
930
 
588
931
  // We need the sandbox name to construct preview URLs
589
932
  if (!this.sandboxName) {
590
933
  throw new Error(
591
- "Sandbox name not available. Ensure sandbox is accessed through getSandbox()"
934
+ 'Sandbox name not available. Ensure sandbox is accessed through getSandbox()'
592
935
  );
593
936
  }
594
937
 
595
- return response.ports.map((port) => ({
596
- url: this.constructPreviewUrl(port.port, this.sandboxName!, hostname),
597
- port: port.port,
598
- name: port.name,
599
- exposedAt: port.exposedAt,
600
- }));
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);
601
1020
  }
602
1021
 
603
1022
  private constructPreviewUrl(
604
1023
  port: number,
605
1024
  sandboxId: string,
606
- hostname: string
1025
+ hostname: string,
1026
+ token: string
607
1027
  ): string {
608
1028
  if (!validatePort(port)) {
609
- logSecurityEvent(
610
- "INVALID_PORT_REJECTED",
611
- {
612
- port,
613
- sandboxId,
614
- hostname,
615
- },
616
- "high"
617
- );
618
1029
  throw new SecurityError(
619
1030
  `Invalid port number: ${port}. Must be between 1024-65535 and not reserved.`
620
1031
  );
621
1032
  }
622
1033
 
623
- let sanitizedSandboxId: string;
624
- try {
625
- sanitizedSandboxId = sanitizeSandboxId(sandboxId);
626
- } catch (error) {
627
- logSecurityEvent(
628
- "INVALID_SANDBOX_ID_REJECTED",
629
- {
630
- sandboxId,
631
- port,
632
- hostname,
633
- error: error instanceof Error ? error.message : "Unknown error",
634
- },
635
- "high"
636
- );
637
- throw error;
638
- }
1034
+ // Validate sandbox ID (will throw SecurityError if invalid)
1035
+ const sanitizedSandboxId = sanitizeSandboxId(sandboxId);
639
1036
 
640
1037
  const isLocalhost = isLocalhostPattern(hostname);
641
1038
 
642
1039
  if (isLocalhost) {
643
1040
  // Unified subdomain approach for localhost (RFC 6761)
644
- const [host, portStr] = hostname.split(":");
645
- const mainPort = portStr || "80";
1041
+ const [host, portStr] = hostname.split(':');
1042
+ const mainPort = portStr || '80';
646
1043
 
647
1044
  // Use URL constructor for safe URL building
648
1045
  try {
649
1046
  const baseUrl = new URL(`http://${host}:${mainPort}`);
650
- // Construct subdomain safely
651
- const subdomainHost = `${port}-${sanitizedSandboxId}.${host}`;
1047
+ // Construct subdomain safely with mandatory token
1048
+ const subdomainHost = `${port}-${sanitizedSandboxId}-${token}.${host}`;
652
1049
  baseUrl.hostname = subdomainHost;
653
1050
 
654
- const finalUrl = baseUrl.toString();
655
-
656
- logSecurityEvent(
657
- "PREVIEW_URL_CONSTRUCTED",
658
- {
659
- port,
660
- sandboxId: sanitizedSandboxId,
661
- hostname,
662
- resultUrl: finalUrl,
663
- environment: "localhost",
664
- },
665
- "low"
666
- );
667
-
668
- return finalUrl;
1051
+ return baseUrl.toString();
669
1052
  } catch (error) {
670
- logSecurityEvent(
671
- "URL_CONSTRUCTION_FAILED",
672
- {
673
- port,
674
- sandboxId: sanitizedSandboxId,
675
- hostname,
676
- error: error instanceof Error ? error.message : "Unknown error",
677
- },
678
- "high"
679
- );
680
1053
  throw new SecurityError(
681
1054
  `Failed to construct preview URL: ${
682
- error instanceof Error ? error.message : "Unknown error"
1055
+ error instanceof Error ? error.message : 'Unknown error'
683
1056
  }`
684
1057
  );
685
1058
  }
@@ -688,73 +1061,196 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
688
1061
  // Production subdomain logic - enforce HTTPS
689
1062
  try {
690
1063
  // Always use HTTPS for production (non-localhost)
691
- const protocol = "https";
1064
+ const protocol = 'https';
692
1065
  const baseUrl = new URL(`${protocol}://${hostname}`);
693
1066
 
694
- // Construct subdomain safely
695
- const subdomainHost = `${port}-${sanitizedSandboxId}.${hostname}`;
1067
+ // Construct subdomain safely with mandatory token
1068
+ const subdomainHost = `${port}-${sanitizedSandboxId}-${token}.${hostname}`;
696
1069
  baseUrl.hostname = subdomainHost;
697
1070
 
698
- const finalUrl = baseUrl.toString();
699
-
700
- logSecurityEvent(
701
- "PREVIEW_URL_CONSTRUCTED",
702
- {
703
- port,
704
- sandboxId: sanitizedSandboxId,
705
- hostname,
706
- resultUrl: finalUrl,
707
- environment: "production",
708
- },
709
- "low"
710
- );
711
-
712
- return finalUrl;
1071
+ return baseUrl.toString();
713
1072
  } catch (error) {
714
- logSecurityEvent(
715
- "URL_CONSTRUCTION_FAILED",
716
- {
717
- port,
718
- sandboxId: sanitizedSandboxId,
719
- hostname,
720
- error: error instanceof Error ? error.message : "Unknown error",
721
- },
722
- "high"
723
- );
724
1073
  throw new SecurityError(
725
1074
  `Failed to construct preview URL: ${
726
- error instanceof Error ? error.message : "Unknown error"
1075
+ error instanceof Error ? error.message : 'Unknown error'
727
1076
  }`
728
1077
  );
729
1078
  }
730
1079
  }
731
1080
 
732
- // Code Interpreter Methods
1081
+ // ============================================================================
1082
+ // Session Management - Advanced Use Cases
1083
+ // ============================================================================
733
1084
 
734
1085
  /**
735
- * Create a new code execution context
1086
+ * Create isolated execution session for advanced use cases
1087
+ * Returns ExecutionSession with full sandbox API bound to specific session
736
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
+ }
1117
+
1118
+ /**
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
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
+
737
1240
  async createCodeContext(
738
1241
  options?: CreateContextOptions
739
1242
  ): Promise<CodeContext> {
740
1243
  return this.codeInterpreter.createCodeContext(options);
741
1244
  }
742
1245
 
743
- /**
744
- * Run code with streaming callbacks
745
- */
746
1246
  async runCode(
747
1247
  code: string,
748
1248
  options?: RunCodeOptions
749
1249
  ): Promise<ExecutionResult> {
750
1250
  const execution = await this.codeInterpreter.runCode(code, options);
751
- // Convert to plain object for RPC serialization
752
1251
  return execution.toJSON();
753
1252
  }
754
1253
 
755
- /**
756
- * Run code and return a streaming response
757
- */
758
1254
  async runCodeStream(
759
1255
  code: string,
760
1256
  options?: RunCodeOptions
@@ -762,16 +1258,10 @@ export class Sandbox<Env = unknown> extends Container<Env> implements ISandbox {
762
1258
  return this.codeInterpreter.runCodeStream(code, options);
763
1259
  }
764
1260
 
765
- /**
766
- * List all code contexts
767
- */
768
1261
  async listCodeContexts(): Promise<CodeContext[]> {
769
1262
  return this.codeInterpreter.listCodeContexts();
770
1263
  }
771
1264
 
772
- /**
773
- * Delete a code context
774
- */
775
1265
  async deleteCodeContext(contextId: string): Promise<void> {
776
1266
  return this.codeInterpreter.deleteCodeContext(contextId);
777
1267
  }