@cloudflare/sandbox 0.0.0-feafd32 → 0.0.0-ff2fa91

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (74) hide show
  1. package/CHANGELOG.md +130 -15
  2. package/Dockerfile +156 -68
  3. package/README.md +92 -769
  4. package/dist/index.d.ts +1889 -0
  5. package/dist/index.d.ts.map +1 -0
  6. package/dist/index.js +3146 -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 +91 -0
  13. package/src/clients/index.ts +60 -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 +123 -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 +88 -63
  25. package/src/interpreter.ts +58 -40
  26. package/src/request-handler.ts +94 -55
  27. package/src/sandbox.ts +978 -490
  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 +415 -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 +706 -0
  42. package/tests/sse-parser.test.ts +291 -0
  43. package/tests/utility-client.test.ts +339 -0
  44. package/tests/version.test.ts +16 -0
  45. package/tests/wrangler.jsonc +35 -0
  46. package/tsconfig.json +9 -1
  47. package/tsdown.config.ts +12 -0
  48. package/vitest.config.ts +31 -0
  49. package/container_src/bun.lock +0 -76
  50. package/container_src/circuit-breaker.ts +0 -121
  51. package/container_src/control-process.ts +0 -784
  52. package/container_src/handler/exec.ts +0 -185
  53. package/container_src/handler/file.ts +0 -406
  54. package/container_src/handler/git.ts +0 -130
  55. package/container_src/handler/ports.ts +0 -314
  56. package/container_src/handler/process.ts +0 -568
  57. package/container_src/handler/session.ts +0 -92
  58. package/container_src/index.ts +0 -592
  59. package/container_src/interpreter-service.ts +0 -276
  60. package/container_src/isolation.ts +0 -1049
  61. package/container_src/mime-processor.ts +0 -255
  62. package/container_src/package.json +0 -18
  63. package/container_src/runtime/executors/javascript/node_executor.ts +0 -123
  64. package/container_src/runtime/executors/python/ipython_executor.py +0 -338
  65. package/container_src/runtime/executors/typescript/ts_executor.ts +0 -138
  66. package/container_src/runtime/process-pool.ts +0 -464
  67. package/container_src/shell-escape.ts +0 -42
  68. package/container_src/startup.sh +0 -11
  69. package/container_src/types.ts +0 -131
  70. package/src/client.ts +0 -1009
  71. package/src/errors.ts +0 -219
  72. package/src/interpreter-client.ts +0 -352
  73. package/src/interpreter-types.ts +0 -390
  74. package/src/types.ts +0 -502
@@ -1,592 +0,0 @@
1
- import { serve } from "bun";
2
- import {
3
- handleExecuteRequest,
4
- handleStreamingExecuteRequest,
5
- } from "./handler/exec";
6
- import {
7
- handleDeleteFileRequest,
8
- handleListFilesRequest,
9
- handleMkdirRequest,
10
- handleMoveFileRequest,
11
- handleReadFileRequest,
12
- handleRenameFileRequest,
13
- handleWriteFileRequest,
14
- } from "./handler/file";
15
- import { handleGitCheckoutRequest } from "./handler/git";
16
- import {
17
- handleExposePortRequest,
18
- handleGetExposedPortsRequest,
19
- handleProxyRequest,
20
- handleUnexposePortRequest,
21
- } from "./handler/ports";
22
- import {
23
- handleGetProcessLogsRequest,
24
- handleGetProcessRequest,
25
- handleKillAllProcessesRequest,
26
- handleKillProcessRequest,
27
- handleListProcessesRequest,
28
- handleStartProcessRequest,
29
- handleStreamProcessLogsRequest,
30
- } from "./handler/process";
31
- import { handleCreateSession, handleListSessions } from "./handler/session";
32
- import type { CreateContextRequest } from "./interpreter-service";
33
- import {
34
- InterpreterNotReadyError,
35
- InterpreterService,
36
- } from "./interpreter-service";
37
- import { hasNamespaceSupport, SessionManager } from "./isolation";
38
-
39
- // In-memory storage for exposed ports
40
- const exposedPorts = new Map<number, { name?: string; exposedAt: Date }>();
41
-
42
- // Check isolation capabilities on startup
43
- const isolationAvailable = hasNamespaceSupport();
44
- console.log(
45
- `[Container] Process isolation: ${
46
- isolationAvailable
47
- ? "ENABLED (production mode)"
48
- : "DISABLED (development mode)"
49
- }`
50
- );
51
-
52
- // Session manager for secure execution with isolation
53
- const sessionManager = new SessionManager();
54
-
55
- // Graceful shutdown handler
56
- const SHUTDOWN_GRACE_PERIOD_MS = 5000; // Grace period for cleanup (5 seconds for proper async cleanup)
57
-
58
- process.on("SIGTERM", async () => {
59
- console.log("[Container] SIGTERM received, cleaning up sessions...");
60
- await sessionManager.destroyAll();
61
- setTimeout(() => {
62
- process.exit(0);
63
- }, SHUTDOWN_GRACE_PERIOD_MS);
64
- });
65
-
66
- process.on("SIGINT", async () => {
67
- console.log("[Container] SIGINT received, cleaning up sessions...");
68
- await sessionManager.destroyAll();
69
- setTimeout(() => {
70
- process.exit(0);
71
- }, SHUTDOWN_GRACE_PERIOD_MS);
72
- });
73
-
74
- // Cleanup on uncaught exceptions (log but still exit)
75
- process.on("uncaughtException", async (error) => {
76
- console.error("[Container] Uncaught exception:", error);
77
- await sessionManager.destroyAll();
78
- process.exit(1);
79
- });
80
-
81
- // Initialize interpreter service
82
- const interpreterService = new InterpreterService();
83
-
84
- // No initialization needed - service is ready immediately!
85
- console.log("[Container] Interpreter service ready - no cold start!");
86
- console.log("[Container] All API endpoints available immediately");
87
-
88
- const server = serve({
89
- async fetch(req: Request) {
90
- const url = new URL(req.url);
91
- const pathname = url.pathname;
92
-
93
- console.log(`[Container] Incoming ${req.method} request to ${pathname}`);
94
-
95
- // Handle CORS
96
- const corsHeaders = {
97
- "Access-Control-Allow-Headers": "Content-Type, Authorization",
98
- "Access-Control-Allow-Methods": "GET, POST, PUT, DELETE, OPTIONS",
99
- "Access-Control-Allow-Origin": "*",
100
- };
101
-
102
- // Handle preflight requests
103
- if (req.method === "OPTIONS") {
104
- console.log(`[Container] Handling CORS preflight for ${pathname}`);
105
- return new Response(null, { headers: corsHeaders, status: 200 });
106
- }
107
-
108
- try {
109
- // Handle different routes
110
- console.log(`[Container] Processing ${req.method} ${pathname}`);
111
- switch (pathname) {
112
- case "/":
113
- return new Response("Hello from Bun server! 🚀", {
114
- headers: {
115
- "Content-Type": "text/plain; charset=utf-8",
116
- ...corsHeaders,
117
- },
118
- });
119
-
120
- case "/api/session/create":
121
- if (req.method === "POST") {
122
- return handleCreateSession(req, corsHeaders, sessionManager);
123
- }
124
- break;
125
-
126
- case "/api/session/list":
127
- if (req.method === "GET") {
128
- return handleListSessions(corsHeaders, sessionManager);
129
- }
130
- break;
131
-
132
- case "/api/execute":
133
- if (req.method === "POST") {
134
- return handleExecuteRequest(req, corsHeaders, sessionManager);
135
- }
136
- break;
137
-
138
- case "/api/execute/stream":
139
- if (req.method === "POST") {
140
- return handleStreamingExecuteRequest(
141
- req,
142
- sessionManager,
143
- corsHeaders
144
- );
145
- }
146
- break;
147
-
148
- case "/api/ping":
149
- if (req.method === "GET") {
150
- const health = await interpreterService.getHealthStatus();
151
- return new Response(
152
- JSON.stringify({
153
- message: "pong",
154
- timestamp: new Date().toISOString(),
155
- system: "interpreter (70x faster)",
156
- status: health.ready ? "ready" : "initializing",
157
- progress: health.progress,
158
- }),
159
- {
160
- headers: {
161
- "Content-Type": "application/json",
162
- ...corsHeaders,
163
- },
164
- }
165
- );
166
- }
167
- break;
168
-
169
- case "/api/git/checkout":
170
- if (req.method === "POST") {
171
- return handleGitCheckoutRequest(req, corsHeaders, sessionManager);
172
- }
173
- break;
174
-
175
- case "/api/mkdir":
176
- if (req.method === "POST") {
177
- return handleMkdirRequest(req, corsHeaders, sessionManager);
178
- }
179
- break;
180
-
181
- case "/api/write":
182
- if (req.method === "POST") {
183
- return handleWriteFileRequest(req, corsHeaders, sessionManager);
184
- }
185
- break;
186
-
187
- case "/api/read":
188
- if (req.method === "POST") {
189
- return handleReadFileRequest(req, corsHeaders, sessionManager);
190
- }
191
- break;
192
-
193
- case "/api/delete":
194
- if (req.method === "POST") {
195
- return handleDeleteFileRequest(req, corsHeaders, sessionManager);
196
- }
197
- break;
198
-
199
- case "/api/rename":
200
- if (req.method === "POST") {
201
- return handleRenameFileRequest(req, corsHeaders, sessionManager);
202
- }
203
- break;
204
-
205
- case "/api/move":
206
- if (req.method === "POST") {
207
- return handleMoveFileRequest(req, corsHeaders, sessionManager);
208
- }
209
- break;
210
-
211
- case "/api/list-files":
212
- if (req.method === "POST") {
213
- return handleListFilesRequest(req, corsHeaders, sessionManager);
214
- }
215
- break;
216
-
217
- case "/api/expose-port":
218
- if (req.method === "POST") {
219
- return handleExposePortRequest(exposedPorts, req, corsHeaders);
220
- }
221
- break;
222
-
223
- case "/api/unexpose-port":
224
- if (req.method === "DELETE") {
225
- return handleUnexposePortRequest(exposedPorts, req, corsHeaders);
226
- }
227
- break;
228
-
229
- case "/api/exposed-ports":
230
- if (req.method === "GET") {
231
- return handleGetExposedPortsRequest(exposedPorts, req, corsHeaders);
232
- }
233
- break;
234
-
235
- case "/api/process/start":
236
- if (req.method === "POST") {
237
- return handleStartProcessRequest(req, corsHeaders, sessionManager);
238
- }
239
- break;
240
-
241
- case "/api/process/list":
242
- if (req.method === "GET") {
243
- return handleListProcessesRequest(req, corsHeaders, sessionManager);
244
- }
245
- break;
246
-
247
- case "/api/process/kill-all":
248
- if (req.method === "DELETE") {
249
- return handleKillAllProcessesRequest(
250
- req,
251
- corsHeaders,
252
- sessionManager
253
- );
254
- }
255
- break;
256
-
257
- case "/api/contexts":
258
- if (req.method === "POST") {
259
- try {
260
- const body = (await req.json()) as CreateContextRequest;
261
- const context = await interpreterService.createContext(body);
262
- return new Response(
263
- JSON.stringify({
264
- id: context.id,
265
- language: context.language,
266
- cwd: context.cwd,
267
- createdAt: context.createdAt,
268
- lastUsed: context.lastUsed,
269
- }),
270
- {
271
- headers: {
272
- "Content-Type": "application/json",
273
- ...corsHeaders,
274
- },
275
- }
276
- );
277
- } catch (error) {
278
- if (error instanceof InterpreterNotReadyError) {
279
- console.log(
280
- `[Container] Request timed out waiting for interpreter (${error.progress}% complete)`
281
- );
282
- return new Response(
283
- JSON.stringify({
284
- error: error.message,
285
- status: "initializing",
286
- progress: error.progress,
287
- }),
288
- {
289
- status: 503,
290
- headers: {
291
- "Content-Type": "application/json",
292
- "Retry-After": String(error.retryAfter),
293
- ...corsHeaders,
294
- },
295
- }
296
- );
297
- }
298
-
299
- // Check if it's a circuit breaker error
300
- if (
301
- error instanceof Error &&
302
- error.message.includes("Circuit breaker is open")
303
- ) {
304
- console.log(
305
- "[Container] Circuit breaker is open:",
306
- error.message
307
- );
308
- return new Response(
309
- JSON.stringify({
310
- error:
311
- "Service temporarily unavailable due to high error rate. Please try again later.",
312
- status: "circuit_open",
313
- details: error.message,
314
- }),
315
- {
316
- status: 503,
317
- headers: {
318
- "Content-Type": "application/json",
319
- "Retry-After": "60",
320
- ...corsHeaders,
321
- },
322
- }
323
- );
324
- }
325
-
326
- // Only log actual errors with stack traces
327
- console.error("[Container] Error creating context:", error);
328
- return new Response(
329
- JSON.stringify({
330
- error:
331
- error instanceof Error
332
- ? error.message
333
- : "Failed to create context",
334
- }),
335
- {
336
- status: 500,
337
- headers: {
338
- "Content-Type": "application/json",
339
- ...corsHeaders,
340
- },
341
- }
342
- );
343
- }
344
- } else if (req.method === "GET") {
345
- const contexts = await interpreterService.listContexts();
346
- return new Response(JSON.stringify({ contexts }), {
347
- headers: {
348
- "Content-Type": "application/json",
349
- ...corsHeaders,
350
- },
351
- });
352
- }
353
- break;
354
-
355
- case "/api/execute/code":
356
- if (req.method === "POST") {
357
- try {
358
- const body = (await req.json()) as {
359
- context_id: string;
360
- code: string;
361
- language?: string;
362
- };
363
- return await interpreterService.executeCode(
364
- body.context_id,
365
- body.code,
366
- body.language
367
- );
368
- } catch (error) {
369
- // Check if it's a circuit breaker error
370
- if (
371
- error instanceof Error &&
372
- error.message.includes("Circuit breaker is open")
373
- ) {
374
- console.log(
375
- "[Container] Circuit breaker is open for code execution:",
376
- error.message
377
- );
378
- return new Response(
379
- JSON.stringify({
380
- error:
381
- "Service temporarily unavailable due to high error rate. Please try again later.",
382
- status: "circuit_open",
383
- details: error.message,
384
- }),
385
- {
386
- status: 503,
387
- headers: {
388
- "Content-Type": "application/json",
389
- "Retry-After": "30",
390
- ...corsHeaders,
391
- },
392
- }
393
- );
394
- }
395
-
396
- // Don't log stack traces for expected initialization state
397
- if (
398
- error instanceof Error &&
399
- error.message.includes("initializing")
400
- ) {
401
- console.log(
402
- "[Container] Code execution deferred - service still initializing"
403
- );
404
- } else {
405
- console.error("[Container] Error executing code:", error);
406
- }
407
- // Error response is already handled by service.executeCode for not ready state
408
- return new Response(
409
- JSON.stringify({
410
- error:
411
- error instanceof Error
412
- ? error.message
413
- : "Failed to execute code",
414
- }),
415
- {
416
- status: 500,
417
- headers: {
418
- "Content-Type": "application/json",
419
- ...corsHeaders,
420
- },
421
- }
422
- );
423
- }
424
- }
425
- break;
426
-
427
- default:
428
- // Handle dynamic routes for contexts
429
- if (
430
- pathname.startsWith("/api/contexts/") &&
431
- pathname.split("/").length === 4
432
- ) {
433
- const contextId = pathname.split("/")[3];
434
- if (req.method === "DELETE") {
435
- try {
436
- await interpreterService.deleteContext(contextId);
437
- return new Response(JSON.stringify({ success: true }), {
438
- headers: {
439
- "Content-Type": "application/json",
440
- ...corsHeaders,
441
- },
442
- });
443
- } catch (error) {
444
- if (error instanceof InterpreterNotReadyError) {
445
- console.log(
446
- `[Container] Request timed out waiting for interpreter (${error.progress}% complete)`
447
- );
448
- return new Response(
449
- JSON.stringify({
450
- error: error.message,
451
- status: "initializing",
452
- progress: error.progress,
453
- }),
454
- {
455
- status: 503,
456
- headers: {
457
- "Content-Type": "application/json",
458
- "Retry-After": "5",
459
- ...corsHeaders,
460
- },
461
- }
462
- );
463
- }
464
- return new Response(
465
- JSON.stringify({
466
- error:
467
- error instanceof Error
468
- ? error.message
469
- : "Failed to delete context",
470
- }),
471
- {
472
- status:
473
- error instanceof Error &&
474
- error.message.includes("not found")
475
- ? 404
476
- : 500,
477
- headers: {
478
- "Content-Type": "application/json",
479
- ...corsHeaders,
480
- },
481
- }
482
- );
483
- }
484
- }
485
- }
486
-
487
- // Handle dynamic routes for individual processes
488
- if (pathname.startsWith("/api/process/")) {
489
- const segments = pathname.split("/");
490
- if (segments.length >= 4) {
491
- const processId = segments[3];
492
- const action = segments[4]; // Optional: logs, stream, etc.
493
-
494
- if (!action && req.method === "GET") {
495
- return handleGetProcessRequest(
496
- req,
497
- corsHeaders,
498
- processId,
499
- sessionManager
500
- );
501
- } else if (!action && req.method === "DELETE") {
502
- return handleKillProcessRequest(
503
- req,
504
- corsHeaders,
505
- processId,
506
- sessionManager
507
- );
508
- } else if (action === "logs" && req.method === "GET") {
509
- return handleGetProcessLogsRequest(
510
- req,
511
- corsHeaders,
512
- processId,
513
- sessionManager
514
- );
515
- } else if (action === "stream" && req.method === "GET") {
516
- return handleStreamProcessLogsRequest(
517
- req,
518
- corsHeaders,
519
- processId,
520
- sessionManager
521
- );
522
- }
523
- }
524
- }
525
- // Check if this is a proxy request for an exposed port
526
- if (pathname.startsWith("/proxy/")) {
527
- return handleProxyRequest(exposedPorts, req, corsHeaders);
528
- }
529
-
530
- console.log(`[Container] Route not found: ${pathname}`);
531
- return new Response("Not Found", {
532
- headers: corsHeaders,
533
- status: 404,
534
- });
535
- }
536
- } catch (error) {
537
- console.error(
538
- `[Container] Error handling ${req.method} ${pathname}:`,
539
- error
540
- );
541
- return new Response(
542
- JSON.stringify({
543
- error: "Internal server error",
544
- message: error instanceof Error ? error.message : "Unknown error",
545
- }),
546
- {
547
- headers: {
548
- "Content-Type": "application/json",
549
- ...corsHeaders,
550
- },
551
- status: 500,
552
- }
553
- );
554
- }
555
- },
556
- hostname: "0.0.0.0",
557
- port: 3000,
558
- // We don't need this, but typescript complains
559
- websocket: { async message() {} },
560
- });
561
-
562
- console.log(`🚀 Bun server running on http://0.0.0.0:${server.port}`);
563
- console.log(`📡 HTTP API endpoints available:`);
564
- console.log(` POST /api/session/create - Create a new session`);
565
- console.log(` GET /api/session/list - List all sessions`);
566
- console.log(` POST /api/execute - Execute a command (non-streaming)`);
567
- console.log(` POST /api/execute/stream - Execute a command (streaming)`);
568
- console.log(` POST /api/git/checkout - Checkout a git repository`);
569
- console.log(` POST /api/mkdir - Create a directory`);
570
- console.log(` POST /api/write - Write a file`);
571
- console.log(` POST /api/read - Read a file`);
572
- console.log(` POST /api/delete - Delete a file`);
573
- console.log(` POST /api/rename - Rename a file`);
574
- console.log(` POST /api/move - Move a file`);
575
- console.log(` POST /api/expose-port - Expose a port for external access`);
576
- console.log(` DELETE /api/unexpose-port - Unexpose a port`);
577
- console.log(` GET /api/exposed-ports - List exposed ports`);
578
- console.log(` POST /api/process/start - Start a background process`);
579
- console.log(` GET /api/process/list - List all processes`);
580
- console.log(` GET /api/process/{id} - Get process status`);
581
- console.log(` DELETE /api/process/{id} - Kill a process`);
582
- console.log(` GET /api/process/{id}/logs - Get process logs`);
583
- console.log(` GET /api/process/{id}/stream - Stream process logs (SSE)`);
584
- console.log(` DELETE /api/process/kill-all - Kill all processes`);
585
- console.log(` GET /proxy/{port}/* - Proxy requests to exposed ports`);
586
- console.log(` POST /api/contexts - Create a code execution context`);
587
- console.log(` GET /api/contexts - List all contexts`);
588
- console.log(` DELETE /api/contexts/{id} - Delete a context`);
589
- console.log(
590
- ` POST /api/execute/code - Execute code in a context (streaming)`
591
- );
592
- console.log(` GET /api/ping - Health check`);