@cloudflare/sandbox 0.0.0-aa00a75 → 0.0.0-aeba44f

package/tests/file-stream.test.ts

@@ -23,7 +23,7 @@ describe('File Streaming Utilities', () => {
         'data: {"type":"metadata","mimeType":"text/plain","size":11,"isBinary":false,"encoding":"utf-8"}\n\n',
         'data: {"type":"chunk","data":"Hello"}\n\n',
         'data: {"type":"chunk","data":" World"}\n\n',
-        'data: {"type":"complete","bytesRead":11}\n\n',
+        'data: {"type":"complete","bytesRead":11}\n\n'
       ]);
 
       const chunks: string[] = [];
@@ -44,7 +44,7 @@ describe('File Streaming Utilities', () => {
         mimeType: 'text/plain',
         size: 11,
         isBinary: false,
-        encoding: 'utf-8',
+        encoding: 'utf-8'
       });
     });
 
@@ -53,7 +53,7 @@ describe('File Streaming Utilities', () => {
       const stream = createMockSSEStream([
         'data: {"type":"metadata","mimeType":"image/png","size":4,"isBinary":true,"encoding":"base64"}\n\n',
         'data: {"type":"chunk","data":"dGVzdA=="}\n\n',
-        'data: {"type":"complete","bytesRead":4}\n\n',
+        'data: {"type":"complete","bytesRead":4}\n\n'
       ]);
 
       const chunks: (string | Uint8Array)[] = [];
@@ -101,7 +101,7 @@ describe('File Streaming Utilities', () => {
     it('should handle empty files', async () => {
       const stream = createMockSSEStream([
         'data: {"type":"metadata","mimeType":"text/plain","size":0,"isBinary":false,"encoding":"utf-8"}\n\n',
-        'data: {"type":"complete","bytesRead":0}\n\n',
+        'data: {"type":"complete","bytesRead":0}\n\n'
       ]);
 
       const chunks: string[] = [];
@@ -123,7 +123,7 @@ describe('File Streaming Utilities', () => {
       const stream = createMockSSEStream([
         'data: {"type":"metadata","mimeType":"text/plain","size":100,"isBinary":false,"encoding":"utf-8"}\n\n',
         'data: {"type":"chunk","data":"Hello"}\n\n',
-        'data: {"type":"error","error":"Read error: Permission denied"}\n\n',
+        'data: {"type":"error","error":"Read error: Permission denied"}\n\n'
       ]);
 
       const generator = streamFile(stream);
@@ -136,7 +136,9 @@ describe('File Streaming Utilities', () => {
         // Should have thrown
         expect(true).toBe(false);
       } catch (error) {
-        expect((error as Error).message).toContain('Read error: Permission denied');
+        expect((error as Error).message).toContain(
+          'Read error: Permission denied'
+        );
       }
     });
   });
@@ -147,7 +149,7 @@ describe('File Streaming Utilities', () => {
         'data: {"type":"metadata","mimeType":"text/plain","size":11,"isBinary":false,"encoding":"utf-8"}\n\n',
         'data: {"type":"chunk","data":"Hello"}\n\n',
         'data: {"type":"chunk","data":" World"}\n\n',
-        'data: {"type":"complete","bytesRead":11}\n\n',
+        'data: {"type":"complete","bytesRead":11}\n\n'
       ]);
 
       const result = await collectFile(stream);
@@ -157,7 +159,7 @@ describe('File Streaming Utilities', () => {
         mimeType: 'text/plain',
         size: 11,
         isBinary: false,
-        encoding: 'utf-8',
+        encoding: 'utf-8'
       });
     });
 
@@ -166,7 +168,7 @@ describe('File Streaming Utilities', () => {
       const stream = createMockSSEStream([
         'data: {"type":"metadata","mimeType":"image/png","size":4,"isBinary":true,"encoding":"base64"}\n\n',
         'data: {"type":"chunk","data":"dGVzdA=="}\n\n',
-        'data: {"type":"complete","bytesRead":4}\n\n',
+        'data: {"type":"complete","bytesRead":4}\n\n'
       ]);
 
       const result = await collectFile(stream);
@@ -182,7 +184,7 @@ describe('File Streaming Utilities', () => {
     it('should handle empty files', async () => {
       const stream = createMockSSEStream([
         'data: {"type":"metadata","mimeType":"text/plain","size":0,"isBinary":false,"encoding":"utf-8"}\n\n',
-        'data: {"type":"complete","bytesRead":0}\n\n',
+        'data: {"type":"complete","bytesRead":0}\n\n'
       ]);
 
       const result = await collectFile(stream);
@@ -195,7 +197,7 @@ describe('File Streaming Utilities', () => {
       const stream = createMockSSEStream([
         'data: {"type":"metadata","mimeType":"text/plain","size":100,"isBinary":false,"encoding":"utf-8"}\n\n',
         'data: {"type":"chunk","data":"Hello"}\n\n',
-        'data: {"type":"error","error":"File not found"}\n\n',
+        'data: {"type":"error","error":"File not found"}\n\n'
       ]);
 
       await expect(collectFile(stream)).rejects.toThrow('File not found');
@@ -205,7 +207,7 @@ describe('File Streaming Utilities', () => {
       // Create a stream with many chunks
       const chunkCount = 100;
       const events = [
-        'data: {"type":"metadata","mimeType":"text/plain","size":500,"isBinary":false,"encoding":"utf-8"}\n\n',
+        'data: {"type":"metadata","mimeType":"text/plain","size":500,"isBinary":false,"encoding":"utf-8"}\n\n'
       ];
 
       for (let i = 0; i < chunkCount; i++) {
@@ -227,7 +229,7 @@ describe('File Streaming Utilities', () => {
       // Create a stream with many base64 chunks
       const chunkCount = 100;
       const events = [
-        'data: {"type":"metadata","mimeType":"application/octet-stream","size":400,"isBinary":true,"encoding":"base64"}\n\n',
+        'data: {"type":"metadata","mimeType":"application/octet-stream","size":400,"isBinary":true,"encoding":"base64"}\n\n'
       ];
 
       for (let i = 0; i < chunkCount; i++) {
@@ -250,7 +252,7 @@ describe('File Streaming Utilities', () => {
     it('should handle streams with no metadata event', async () => {
       const stream = createMockSSEStream([
         'data: {"type":"chunk","data":"Hello"}\n\n',
-        'data: {"type":"complete","bytesRead":5}\n\n',
+        'data: {"type":"complete","bytesRead":5}\n\n'
       ]);
 
       // Without metadata, we don't know if it's binary or text
@@ -265,7 +267,9 @@ describe('File Streaming Utilities', () => {
         // Should have thrown
         expect(true).toBe(false);
       } catch (error) {
-        expect((error as Error).message).toContain('Received chunk before metadata');
+        expect((error as Error).message).toContain(
+          'Received chunk before metadata'
+        );
       }
     });
 
@@ -273,7 +277,7 @@ describe('File Streaming Utilities', () => {
       const stream = createMockSSEStream([
         'data: {"type":"metadata","mimeType":"text/plain","size":5,"isBinary":false,"encoding":"utf-8"}\n\n',
         'data: {invalid json\n\n',
-        'data: {"type":"complete","bytesRead":5}\n\n',
+        'data: {"type":"complete","bytesRead":5}\n\n'
       ]);
 
       // Malformed JSON is logged but doesn't break the stream
@@ -285,16 +289,16 @@ describe('File Streaming Utilities', () => {
     it('should handle base64 padding correctly', async () => {
       // Test various base64 strings with different padding
       const testCases = [
-        { input: 'YQ==', expected: 'a' },      // 1 byte, 2 padding
-        { input: 'YWI=', expected: 'ab' },    // 2 bytes, 1 padding
-        { input: 'YWJj', expected: 'abc' },   // 3 bytes, no padding
+        { input: 'YQ==', expected: 'a' }, // 1 byte, 2 padding
+        { input: 'YWI=', expected: 'ab' }, // 2 bytes, 1 padding
+        { input: 'YWJj', expected: 'abc' } // 3 bytes, no padding
       ];
 
       for (const testCase of testCases) {
         const stream = createMockSSEStream([
           `data: {"type":"metadata","mimeType":"application/octet-stream","size":${testCase.expected.length},"isBinary":true,"encoding":"base64"}\n\n`,
           `data: {"type":"chunk","data":"${testCase.input}"}\n\n`,
-          `data: {"type":"complete","bytesRead":${testCase.expected.length}}\n\n`,
+          `data: {"type":"complete","bytesRead":${testCase.expected.length}}\n\n`
         ]);
 
         const result = await collectFile(stream);

package/tests/get-sandbox.test.ts

@@ -0,0 +1,149 @@
+import { beforeEach, describe, expect, it, vi } from 'vitest';
+import { getSandbox } from '../src/sandbox';
+
+// Mock the Container module
+vi.mock('@cloudflare/containers', () => ({
+  Container: class Container {
+    ctx: any;
+    env: any;
+    sleepAfter: string | number = '10m';
+    constructor(ctx: any, env: any) {
+      this.ctx = ctx;
+      this.env = env;
+    }
+  },
+  getContainer: vi.fn()
+}));
+
+describe('getSandbox', () => {
+  let mockStub: any;
+  let mockGetContainer: any;
+
+  beforeEach(async () => {
+    vi.clearAllMocks();
+
+    // Create a fresh mock stub for each test
+    mockStub = {
+      sleepAfter: '10m',
+      setSandboxName: vi.fn(),
+      setBaseUrl: vi.fn(),
+      setSleepAfter: vi.fn((value: string | number) => {
+        mockStub.sleepAfter = value;
+      }),
+      setKeepAlive: vi.fn()
+    };
+
+    // Mock getContainer to return our stub
+    const containers = await import('@cloudflare/containers');
+    mockGetContainer = vi.mocked(containers.getContainer);
+    mockGetContainer.mockReturnValue(mockStub);
+  });
+
+  it('should create a sandbox instance with default sleepAfter', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox');
+
+    expect(sandbox).toBeDefined();
+    expect(sandbox.setSandboxName).toHaveBeenCalledWith('test-sandbox');
+  });
+
+  it('should apply sleepAfter option when provided as string', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox', {
+      sleepAfter: '5m'
+    });
+
+    expect(sandbox.sleepAfter).toBe('5m');
+  });
+
+  it('should apply sleepAfter option when provided as number', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox', {
+      sleepAfter: 300 // 5 minutes in seconds
+    });
+
+    expect(sandbox.sleepAfter).toBe(300);
+  });
+
+  it('should apply baseUrl option when provided', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox', {
+      baseUrl: 'https://example.com'
+    });
+
+    expect(sandbox.setBaseUrl).toHaveBeenCalledWith('https://example.com');
+  });
+
+  it('should apply both sleepAfter and baseUrl options together', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox', {
+      sleepAfter: '10m',
+      baseUrl: 'https://example.com'
+    });
+
+    expect(sandbox.sleepAfter).toBe('10m');
+    expect(sandbox.setBaseUrl).toHaveBeenCalledWith('https://example.com');
+  });
+
+  it('should not apply sleepAfter when not provided', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox');
+
+    // Should remain default value from Container
+    expect(sandbox.sleepAfter).toBe('10m');
+  });
+
+  it('should accept various time string formats for sleepAfter', () => {
+    const mockNamespace = {} as any;
+    const testCases = ['30s', '1m', '10m', '1h', '2h'];
+
+    for (const timeString of testCases) {
+      // Reset the mock stub for each iteration
+      mockStub.sleepAfter = '3m';
+
+      const sandbox = getSandbox(mockNamespace, `test-sandbox-${timeString}`, {
+        sleepAfter: timeString
+      });
+
+      expect(sandbox.sleepAfter).toBe(timeString);
+    }
+  });
+
+  it('should apply keepAlive option when provided as true', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox', {
+      keepAlive: true
+    });
+
+    expect(sandbox.setKeepAlive).toHaveBeenCalledWith(true);
+  });
+
+  it('should apply keepAlive option when provided as false', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox', {
+      keepAlive: false
+    });
+
+    expect(sandbox.setKeepAlive).toHaveBeenCalledWith(false);
+  });
+
+  it('should not call setKeepAlive when keepAlive option not provided', () => {
+    const mockNamespace = {} as any;
+    getSandbox(mockNamespace, 'test-sandbox');
+
+    expect(mockStub.setKeepAlive).not.toHaveBeenCalled();
+  });
+
+  it('should apply keepAlive alongside other options', () => {
+    const mockNamespace = {} as any;
+    const sandbox = getSandbox(mockNamespace, 'test-sandbox', {
+      sleepAfter: '5m',
+      baseUrl: 'https://example.com',
+      keepAlive: true
+    });
+
+    expect(sandbox.sleepAfter).toBe('5m');
+    expect(sandbox.setBaseUrl).toHaveBeenCalledWith('https://example.com');
+    expect(sandbox.setKeepAlive).toHaveBeenCalledWith(true);
+  });
+});