@cloudflare/sandbox 0.0.0-0b4cc05 → 0.0.0-102fc4f

package/src/clients/base-client.ts

@@ -1,17 +1,14 @@
-import type { Logger } from "@repo/shared";
-import { createNoOpLogger } from "@repo/shared";
+import type { Logger } from '@repo/shared';
+import { createNoOpLogger } from '@repo/shared';
 import { getHttpStatus } from '@repo/shared/errors';
 import type { ErrorResponse as NewErrorResponse } from '../errors';
 import { createErrorFromResponse, ErrorCode } from '../errors';
 import type { SandboxError } from '../errors/classes';
-import type {
-  HttpClientOptions,
-  ResponseHandler
-} from './types';
+import type { HttpClientOptions, ResponseHandler } from './types';
 
 // Container provisioning retry configuration
-const TIMEOUT_MS = 60_000;  // 60 seconds total timeout budget
-const MIN_TIME_FOR_RETRY_MS = 10_000;  // Need at least 10s remaining to retry (8s Container + 2s delay)
+const TIMEOUT_MS = 60_000; // 60 seconds total timeout budget
+const MIN_TIME_FOR_RETRY_MS = 10_000; // Need at least 10s remaining to retry (8s Container + 2s delay)
 
 /**
  * Abstract base class providing common HTTP functionality for all domain clients
@@ -42,7 +39,8 @@ export abstract class BaseHttpClient {
 
       // Only retry container provisioning 503s, not user app 503s
       if (response.status === 503) {
-        const isContainerProvisioning = await this.isContainerProvisioningError(response);
+        const isContainerProvisioning =
+          await this.isContainerProvisioningError(response);
 
         if (isContainerProvisioning) {
           const elapsed = Date.now() - startTime;
@@ -60,13 +58,16 @@ export abstract class BaseHttpClient {
               remainingSec: Math.floor(remaining / 1000)
             });
 
-            await new Promise(resolve => setTimeout(resolve, delay));
+            await new Promise((resolve) => setTimeout(resolve, delay));
             attempt++;
             continue;
           } else {
             // Exhausted retries - log error and return response
             // Let existing error handling convert to proper error
-            this.logger.error('Container failed to provision after multiple attempts', new Error(`Failed after ${attempt + 1} attempts over 60s`));
+            this.logger.error(
+              'Container failed to provision after multiple attempts',
+              new Error(`Failed after ${attempt + 1} attempts over 60s`)
+            );
             return response;
           }
         }
@@ -87,9 +88,9 @@ export abstract class BaseHttpClient {
     const response = await this.doFetch(endpoint, {
       method: 'POST',
       headers: {
-        'Content-Type': 'application/json',
+        'Content-Type': 'application/json'
       },
-      body: JSON.stringify(data),
+      body: JSON.stringify(data)
     });
 
     return this.handleResponse(response, responseHandler);
@@ -103,7 +104,7 @@ export abstract class BaseHttpClient {
     responseHandler?: ResponseHandler<T>
   ): Promise<T> {
     const response = await this.doFetch(endpoint, {
-      method: 'GET',
+      method: 'GET'
     });
 
     return this.handleResponse(response, responseHandler);
@@ -117,13 +118,12 @@ export abstract class BaseHttpClient {
     responseHandler?: ResponseHandler<T>
   ): Promise<T> {
     const response = await this.doFetch(endpoint, {
-      method: 'DELETE',
+      method: 'DELETE'
     });
 
     return this.handleResponse(response, responseHandler);
   }
 
-
   /**
    * Handle HTTP response with error checking and parsing
    */
@@ -145,7 +145,9 @@ export abstract class BaseHttpClient {
       // Handle malformed JSON responses gracefully
       const errorResponse: NewErrorResponse = {
         code: ErrorCode.INVALID_JSON_RESPONSE,
-        message: `Invalid JSON response: ${error instanceof Error ? error.message : 'Unknown parsing error'}`,
+        message: `Invalid JSON response: ${
+          error instanceof Error ? error.message : 'Unknown parsing error'
+        }`,
         context: {},
         httpStatus: response.status,
         timestamp: new Date().toISOString()
@@ -182,8 +184,6 @@ export abstract class BaseHttpClient {
     throw error;
   }
 
-
-
   /**
    * Create a streaming response handler for Server-Sent Events
    */
@@ -205,7 +205,10 @@ export abstract class BaseHttpClient {
    * Utility method to log successful operations
    */
   protected logSuccess(operation: string, details?: string): void {
-    this.logger.info(`${operation} completed successfully`, details ? { details } : undefined);
+    this.logger.info(
+      `${operation} completed successfully`,
+      details ? { details } : undefined
+    );
   }
 
   /**
@@ -242,7 +245,9 @@ export abstract class BaseHttpClient {
    * Check if 503 response is from container provisioning (retryable)
    * vs user application (not retryable)
    */
-  private async isContainerProvisioningError(response: Response): Promise<boolean> {
+  private async isContainerProvisioningError(
+    response: Response
+  ): Promise<boolean> {
     try {
       // Clone response so we don't consume the original body
       const cloned = response.clone();
@@ -251,13 +256,19 @@ export abstract class BaseHttpClient {
       // Container package returns specific message for provisioning errors
       return text.includes('There is no Container instance available');
     } catch (error) {
-      this.logger.error('Error checking response body', error instanceof Error ? error : new Error(String(error)));
+      this.logger.error(
+        'Error checking response body',
+        error instanceof Error ? error : new Error(String(error))
+      );
       // If we can't read the body, don't retry to be safe
       return false;
     }
   }
 
-  private async executeFetch(path: string, options?: RequestInit): Promise<Response> {
+  private async executeFetch(
+    path: string,
+    options?: RequestInit
+  ): Promise<Response> {
     const url = this.options.stub
       ? `http://localhost:${this.options.port}${path}`
       : `${this.baseUrl}${path}`;
@@ -273,7 +284,11 @@ export abstract class BaseHttpClient {
         return await fetch(url, options);
       }
     } catch (error) {
-      this.logger.error('HTTP request error', error instanceof Error ? error : new Error(String(error)), { method: options?.method || 'GET', url });
+      this.logger.error(
+        'HTTP request error',
+        error instanceof Error ? error : new Error(String(error)),
+        { method: options?.method || 'GET', url }
+      );
       throw error;
     }
   }

package/src/clients/command-client.ts

@@ -1,5 +1,9 @@
 import { BaseHttpClient } from './base-client';
-import type { BaseApiResponse, HttpClientOptions, SessionRequest } from './types';
+import type {
+  BaseApiResponse,
+  HttpClientOptions,
+  SessionRequest
+} from './types';
 
 /**
  * Request interface for command execution
@@ -23,7 +27,6 @@ export interface ExecuteResponse extends BaseApiResponse {
  * Client for command execution operations
  */
 export class CommandClient extends BaseHttpClient {
-
   /**
    * Execute a command and return the complete result
    * @param command - The command to execute
@@ -42,10 +45,7 @@ export class CommandClient extends BaseHttpClient {
         ...(timeoutMs !== undefined && { timeoutMs })
       };
 
-      const response = await this.post<ExecuteResponse>(
-        '/api/execute',
-        data
-      );
+      const response = await this.post<ExecuteResponse>('/api/execute', data);
 
       this.logSuccess(
         'Command executed',
@@ -90,9 +90,9 @@ export class CommandClient extends BaseHttpClient {
       const response = await this.doFetch('/api/execute/stream', {
         method: 'POST',
         headers: {
-          'Content-Type': 'application/json',
+          'Content-Type': 'application/json'
         },
-        body: JSON.stringify(data),
+        body: JSON.stringify(data)
       });
 
       const stream = await this.handleStreamResponse(response);

package/src/clients/file-client.ts

@@ -1,5 +1,6 @@
 import type {
   DeleteFileResult,
+  FileExistsResult,
   ListFilesOptions,
   ListFilesResult,
   MkdirResult,
@@ -48,7 +49,6 @@ export interface FileOperationRequest extends SessionRequest {
  * Client for file system operations
  */
 export class FileClient extends BaseHttpClient {
-
   /**
    * Create a directory
    * @param path - Directory path to create
@@ -64,12 +64,15 @@ export class FileClient extends BaseHttpClient {
       const data = {
         path,
         sessionId,
-        recursive: options?.recursive ?? false,
+        recursive: options?.recursive ?? false
       };
 
       const response = await this.post<MkdirResult>('/api/mkdir', data);
-      
-      this.logSuccess('Directory created', `${path} (recursive: ${data.recursive})`);
+
+      this.logSuccess(
+        'Directory created',
+        `${path} (recursive: ${data.recursive})`
+      );
       return response;
     } catch (error) {
       this.logError('mkdir', error);
@@ -95,11 +98,11 @@ export class FileClient extends BaseHttpClient {
         path,
         content,
         sessionId,
-        encoding: options?.encoding ?? 'utf8',
+        encoding: options?.encoding
       };
 
       const response = await this.post<WriteFileResult>('/api/write', data);
-      
+
       this.logSuccess('File written', `${path} (${content.length} chars)`);
       return response;
     } catch (error) {
@@ -123,12 +126,15 @@ export class FileClient extends BaseHttpClient {
       const data = {
         path,
         sessionId,
-        encoding: options?.encoding ?? 'utf8',
+        encoding: options?.encoding
       };
 
       const response = await this.post<ReadFileResult>('/api/read', data);
 
-      this.logSuccess('File read', `${path} (${response.content.length} chars)`);
+      this.logSuccess(
+        'File read',
+        `${path} (${response.content.length} chars)`
+      );
       return response;
     } catch (error) {
       this.logError('readFile', error);
@@ -149,15 +155,15 @@ export class FileClient extends BaseHttpClient {
     try {
       const data = {
         path,
-        sessionId,
+        sessionId
       };
 
       const response = await this.doFetch('/api/read/stream', {
         method: 'POST',
         headers: {
-          'Content-Type': 'application/json',
+          'Content-Type': 'application/json'
         },
-        body: JSON.stringify(data),
+        body: JSON.stringify(data)
       });
 
       const stream = await this.handleStreamResponse(response);
@@ -174,15 +180,12 @@ export class FileClient extends BaseHttpClient {
    * @param path - File path to delete
    * @param sessionId - The session ID for this operation
    */
-  async deleteFile(
-    path: string,
-    sessionId: string
-  ): Promise<DeleteFileResult> {
+  async deleteFile(path: string, sessionId: string): Promise<DeleteFileResult> {
     try {
       const data = { path, sessionId };
 
       const response = await this.post<DeleteFileResult>('/api/delete', data);
-      
+
       this.logSuccess('File deleted', path);
       return response;
     } catch (error) {
@@ -206,7 +209,7 @@ export class FileClient extends BaseHttpClient {
       const data = { oldPath: path, newPath, sessionId };
 
       const response = await this.post<RenameFileResult>('/api/rename', data);
-      
+
       this.logSuccess('File renamed', `${path} -> ${newPath}`);
       return response;
     } catch (error) {
@@ -254,10 +257,13 @@ export class FileClient extends BaseHttpClient {
       const data = {
         path,
         sessionId,
-        options: options || {},
+        options: options || {}
       };
 
-      const response = await this.post<ListFilesResult>('/api/list-files', data);
+      const response = await this.post<ListFilesResult>(
+        '/api/list-files',
+        data
+      );
 
       this.logSuccess('Files listed', `${path} (${response.count} files)`);
       return response;
@@ -266,4 +272,29 @@ export class FileClient extends BaseHttpClient {
       throw error;
     }
   }
-}
+
+  /**
+   * Check if a file or directory exists
+   * @param path - Path to check
+   * @param sessionId - The session ID for this operation
+   */
+  async exists(path: string, sessionId: string): Promise<FileExistsResult> {
+    try {
+      const data = {
+        path,
+        sessionId
+      };
+
+      const response = await this.post<FileExistsResult>('/api/exists', data);
+
+      this.logSuccess(
+        'Path existence checked',
+        `${path} (exists: ${response.exists})`
+      );
+      return response;
+    } catch (error) {
+      this.logError('exists', error);
+      throw error;
+    }
+  }
+}

package/src/clients/git-client.ts

@@ -1,4 +1,5 @@
 import type { GitCheckoutResult } from '@repo/shared';
+import { GitLogger } from '@repo/shared';
 import { BaseHttpClient } from './base-client';
 import type { HttpClientOptions, SessionRequest } from './types';
 
@@ -18,6 +19,11 @@ export interface GitCheckoutRequest extends SessionRequest {
  * Client for Git repository operations
  */
 export class GitClient extends BaseHttpClient {
+  constructor(options: HttpClientOptions = {}) {
+    super(options);
+    // Wrap logger with GitLogger to auto-redact credentials
+    this.logger = new GitLogger(this.logger);
+  }
 
   /**
    * Clone a Git repository
@@ -45,7 +51,7 @@ export class GitClient extends BaseHttpClient {
       const data: GitCheckoutRequest = {
         repoUrl,
         sessionId,
-        targetDir,
+        targetDir
       };
 
       // Only include branch if explicitly specified
@@ -79,7 +85,7 @@ export class GitClient extends BaseHttpClient {
       const url = new URL(repoUrl);
       const pathParts = url.pathname.split('/');
       const repoName = pathParts[pathParts.length - 1];
-      
+
       // Remove .git extension if present
       return repoName.replace(/\.git$/, '');
     } catch {
@@ -89,4 +95,4 @@ export class GitClient extends BaseHttpClient {
       return repoName.replace(/\.git$/, '') || 'repo';
     }
   }
-}
+}

package/src/clients/index.ts

@@ -1,11 +1,7 @@
 // Main client exports
 
-
 // Command client types
-export type {
-  ExecuteRequest,
-  ExecuteResponse,
-} from './command-client';
+export type { ExecuteRequest, ExecuteResponse } from './command-client';
 
 // Domain-specific clients
 export { CommandClient } from './command-client';
@@ -14,23 +10,23 @@ export type {
   FileOperationRequest,
   MkdirRequest,
   ReadFileRequest,
-  WriteFileRequest,
+  WriteFileRequest
 } from './file-client';
 export { FileClient } from './file-client';
 // Git client types
-export type {
-  GitCheckoutRequest,
-  GitCheckoutResult,
-} from './git-client';
+export type { GitCheckoutRequest, GitCheckoutResult } from './git-client';
 export { GitClient } from './git-client';
-export { type ExecutionCallbacks, InterpreterClient } from './interpreter-client';
+export {
+  type ExecutionCallbacks,
+  InterpreterClient
+} from './interpreter-client';
 // Port client types
 export type {
   ExposePortRequest,
   PortCloseResult,
   PortExposeResult,
   PortListResult,
-  UnexposePortRequest,
+  UnexposePortRequest
 } from './port-client';
 export { PortClient } from './port-client';
 // Process client types
@@ -41,7 +37,7 @@ export type {
   ProcessListResult,
   ProcessLogsResult,
   ProcessStartResult,
-  StartProcessRequest,
+  StartProcessRequest
 } from './process-client';
 export { ProcessClient } from './process-client';
 export { SandboxClient } from './sandbox-client';
@@ -53,11 +49,16 @@ export type {
   HttpClientOptions,
   RequestConfig,
   ResponseHandler,
-  SessionRequest,
+  SessionRequest
 } from './types';
 // Utility client types
 export type {
   CommandsResponse,
+  CreateSessionRequest,
+  CreateSessionResponse,
+  DeleteSessionRequest,
+  DeleteSessionResponse,
   PingResponse,
+  VersionResponse
 } from './utility-client';
-export { UtilityClient } from './utility-client';
+export { UtilityClient } from './utility-client';