things

Author: christianalfoni

openapi.json

@@ -1061,6 +1061,14 @@
             "description": "GitHub token for the session",
             "type": "string"
           },
+          "git_user_email": {
+            "description": "Git user email to configure for this session",
+            "type": "string"
+          },
+          "git_user_name": {
+            "description": "Git user name to configure for this session",
+            "type": "string"
+          },
           "permission": {
             "description": "Permission level for the session",
             "enum": ["read", "write"],
@@ -1962,7 +1970,7 @@
     "/vm/{id}/sessions": {
       "post": {
         "callbacks": {},
-        "description": "Creates a new session on a running VM. A session represents an isolated Linux user, with their own container.\nA session has a single use token that the user can use to connect to the VM. This token has specific permissions (currently, read or write).\nThe session is identified by a unique session ID, and the Linux username is based on the session ID.\n\nThis endpoint requires the VM to be running. If the VM is not running, it will return a 404 error.\n",
+        "description": "Creates a new session on a running VM. A session represents an isolated Linux user, with their own container.\nA session has a single use token that the user can use to connect to the VM. This token has specific permissions (currently, read or write).\nThe session is identified by a unique session ID, and the Linux username is based on the session ID.\n\nThe Git user name and email can be configured via parameters.\n\nThis endpoint requires the VM to be running. If the VM is not running, it will return a 404 error.\n",
         "operationId": "vm/create_session",
         "parameters": [
           {

src/SandboxClient.ts

@@ -28,6 +28,34 @@ import {
 } from "./types";
 import { PitcherManagerResponse } from "@codesandbox/pitcher-client";
 
+export async function startVm(
+  apiClient: Client,
+  sandboxId: string,
+  startOpts?: StartSandboxOpts
+): Promise<PitcherManagerResponse> {
+  const startResult = await vmStart({
+    client: apiClient,
+    body: startOpts
+      ? {
+          ipcountry: startOpts.ipcountry,
+          tier: startOpts.vmTier?.name,
+          hibernation_timeout_seconds: startOpts.hibernationTimeoutSeconds,
+          automatic_wakeup_config: startOpts.automaticWakeupConfig,
+        }
+      : undefined,
+    path: {
+      id: sandboxId,
+    },
+  });
+
+  const response = handleResponse(
+    startResult,
+    `Failed to start sandbox ${sandboxId}`
+  );
+
+  return getStartResponse(response);
+}
+
 export class SandboxClient {
   get defaultTemplateId() {
     return getDefaultTemplateId(this.apiClient);
@@ -48,7 +76,7 @@ export class SandboxClient {
       // We do not want users to pass gitAccessToken on global user, because it
       // can be read by other users
       {
-        id: "clone-admin",
+        id: "clone-repo-user",
         permission: "write",
         ...(opts.config
           ? {
@@ -112,38 +140,11 @@ export class SandboxClient {
     );
   }
 
-  private async start(
-    sandboxId: string,
-    startOpts?: StartSandboxOpts
-  ): Promise<PitcherManagerResponse> {
-    const startResult = await vmStart({
-      client: this.apiClient,
-      body: startOpts
-        ? {
-            ipcountry: startOpts.ipcountry,
-            tier: startOpts.vmTier?.name,
-            hibernation_timeout_seconds: startOpts.hibernationTimeoutSeconds,
-            automatic_wakeup_config: startOpts.automaticWakeupConfig,
-          }
-        : undefined,
-      path: {
-        id: sandboxId,
-      },
-    });
-
-    const response = handleResponse(
-      startResult,
-      `Failed to start sandbox ${sandboxId}`
-    );
-
-    return getStartResponse(response);
-  }
-
   /**
    *
    */
   async resume(sandboxId: string) {
-    const startResponse = await this.start(sandboxId);
+    const startResponse = await startVm(this.apiClient, sandboxId);
     return new Sandbox(sandboxId, this.apiClient, startResponse);
   }
 
@@ -171,7 +172,7 @@ export class SandboxClient {
    */
   public async restart(sandboxId: string, opts?: StartSandboxOpts) {
     await this.shutdown(sandboxId);
-    const startResponse = await this.start(sandboxId, opts);
+    const startResponse = await startVm(this.apiClient, sandboxId, opts);
 
     return new Sandbox(sandboxId, this.apiClient, startResponse);
   }

src/api-clients/client/sdk.gen.ts

@@ -349,6 +349,8 @@ export const vmUpdateHibernationTimeout = <ThrowOnError extends boolean = false>
  * A session has a single use token that the user can use to connect to the VM. This token has specific permissions (currently, read or write).
  * The session is identified by a unique session ID, and the Linux username is based on the session ID.
  *
+ * The Git user name and email can be configured via parameters.
+ *
  * This endpoint requires the VM to be running. If the VM is not running, it will return a 404 error.
  *
  */

src/api-clients/client/types.gen.ts

@@ -523,6 +523,14 @@ export type VmCreateSessionRequest = {
      * GitHub token for the session
      */
     git_access_token?: string;
+    /**
+     * Git user email to configure for this session
+     */
+    git_user_email?: string;
+    /**
+     * Git user name to configure for this session
+     */
+    git_user_name?: string;
     /**
      * Permission level for the session
      */

src/bin/commands/build.ts

@@ -19,6 +19,7 @@ import {
 import { getDefaultTemplateId, handleResponse } from "../../utils/api";
 import { BASE_URL, getApiKey } from "../utils/constants";
 import { hashDirectory } from "../utils/hash";
+import { startVm } from "../../SandboxClient";
 
 export type BuildCommandArgs = {
   directory: string;
@@ -172,10 +173,10 @@ export const buildCommand: yargs.CommandModule<
               createSpinnerMessage("Starting sandbox...", sandboxId)
             );
 
-            const startResponse = await sdk.sandbox["start"](sandboxId, {
+            const startResponse = await startVm(apiClient, sandboxId, {
               vmTier: argv.vmTier ? VMTier.fromName(argv.vmTier) : undefined,
             });
-            let sandbox = new Sandbox(sandboxId, startResponse, apiClient);
+            let sandbox = new Sandbox(sandboxId, apiClient, startResponse);
             let session = await sandbox.connect();
 
             spinner.start(
@@ -227,7 +228,7 @@ export const buildCommand: yargs.CommandModule<
 
                 buffer.push(...output.split("\n"));
 
-                await step.waitForFinish();
+                await step.waitUntilComplete();
               } catch (error) {
                 spinner.fail(
                   createSpinnerMessage(

src/browser.ts

@@ -47,6 +47,8 @@ export async function connectToSandbox(options: {
   onFocusChange?: (cb: (isFocused: boolean) => void) => () => void;
   initStatusCb?: (event: protocol.system.InitStatus) => void;
 }): Promise<WebSocketSession> {
+  let env: Record<string, string> = {};
+
   const pitcherClient = await initPitcherClient(
     {
       appId: "sdk",
@@ -56,11 +58,19 @@ export async function connectToSandbox(options: {
         (() => {
           return () => {};
         }),
-      requestPitcherInstance: options.getSession,
+      requestPitcherInstance: async (id) => {
+        const session = await options.getSession(id);
+
+        if (session.env) {
+          env = session.env;
+        }
+
+        return session;
+      },
       subscriptions: DEFAULT_SUBSCRIPTIONS,
     },
     options.initStatusCb || (() => {})
   );
 
-  return new WebSocketSession(pitcherClient);
+  return new WebSocketSession(pitcherClient, () => env);
 }

src/sandbox.ts

@@ -1,12 +1,14 @@
 import {
   Disposable,
+  initPitcherClient,
   PitcherManagerResponse,
   type protocol as _protocol,
 } from "@codesandbox/pitcher-client";
-import type {
-  SandboxSession,
-  SessionCreateOptions,
-  SandboxBrowserSession,
+import {
+  type SandboxSession,
+  type SessionCreateOptions,
+  type SandboxBrowserSession,
+  DEFAULT_SUBSCRIPTIONS,
 } from "./types";
 import { Client } from "@hey-api/client-fetch";
 import {
@@ -18,6 +20,7 @@ import { handleResponse } from "./utils/api";
 import { VMTier } from "./VMTier";
 import { WebSocketSession } from "./sessions/WebSocketSession";
 import { RestSession } from "./sessions/RestSession";
+import { SandboxClient, startVm } from "./SandboxClient";
 
 export class Sandbox {
   get bootupType() {
@@ -32,20 +35,19 @@ export class Sandbox {
       this.pitcherManagerResponse.pitcherVersion
     );
   }
-  private defaultSession: SandboxSession;
-  constructor(
-    public id: string,
-    private apiClient: Client,
-    private pitcherManagerResponse: PitcherManagerResponse,
-    customSession?: SandboxSession
-  ) {
-    this.defaultSession = customSession || {
+  private get globalSession() {
+    return {
       sandboxId: this.id,
       pitcherToken: this.pitcherManagerResponse.pitcherToken,
       pitcherUrl: this.pitcherManagerResponse.pitcherURL,
       userWorkspacePath: this.pitcherManagerResponse.userWorkspacePath,
     };
   }
+  constructor(
+    public id: string,
+    private apiClient: Client,
+    private pitcherManagerResponse: PitcherManagerResponse
+  ) {}
 
   /**
    * Updates the specs that this sandbox runs on. It will dynamically scale the sandbox to the
@@ -91,6 +93,13 @@ export class Sandbox {
       body: {
         session_id: opts.id,
         permission: opts.permission ?? "write",
+        ...(opts.git
+          ? {
+              git_access_token: opts.git.accessToken,
+              git_user_email: opts.git.email,
+              git_user_name: opts.git.name,
+            }
+          : {}),
       },
       path: {
         id: this.id,
@@ -107,6 +116,7 @@ export class Sandbox {
       pitcherToken: handledResponse.pitcher_token,
       pitcherUrl: handledResponse.pitcher_url,
       userWorkspacePath: handledResponse.user_workspace_path,
+      env: opts.env,
     };
 
     return session;
@@ -115,17 +125,74 @@ export class Sandbox {
   async connect(
     customSession?: SessionCreateOptions
   ): Promise<WebSocketSession> {
-    const session = customSession
-      ? await this.createSession(customSession)
-      : this.defaultSession;
+    let hasConnected = false;
+    const pitcherClient = await initPitcherClient(
+      {
+        appId: "sdk",
+        instanceId: this.id,
+        onFocusChange() {
+          return () => {};
+        },
+        requestPitcherInstance: async () => {
+          // If we reconnect we have to resume the Sandbox and get new session details
+          if (hasConnected) {
+            this.pitcherManagerResponse = await startVm(
+              this.apiClient,
+              this.id
+            );
+          }
+
+          const session = customSession
+            ? await this.createSession(customSession)
+            : this.globalSession;
+
+          const headers = this.apiClient.getConfig().headers as Headers;
+
+          if (headers.get("x-pitcher-manager-url")) {
+            // This is a hack, we need to tell the global scheduler that the VM is running
+            // in a different cluster than the one it'd like to default to.
+
+            const preferredManager = headers
+              .get("x-pitcher-manager-url")
+              ?.replace("/api/v1", "")
+              .replace("https://", "");
+            const baseUrl = this.apiClient
+              .getConfig()
+              .baseUrl?.replace("api", "global-scheduler");
+
+            await fetch(
+              `${baseUrl}/api/v1/cluster/${session.sandboxId}?preferredManager=${preferredManager}`
+            ).then((res) => res.json());
+          }
+
+          hasConnected = true;
+
+          return {
+            bootupType: this.bootupType,
+            pitcherURL: session.pitcherUrl,
+            workspacePath: session.userWorkspacePath,
+            userWorkspacePath: session.userWorkspacePath,
+            pitcherManagerVersion:
+              this.pitcherManagerResponse.pitcherManagerVersion,
+            pitcherVersion: this.pitcherManagerResponse.pitcherVersion,
+            latestPitcherVersion:
+              this.pitcherManagerResponse.latestPitcherVersion,
+            pitcherToken: session.pitcherToken,
+            cluster: this.cluster,
+          };
+        },
+        subscriptions: DEFAULT_SUBSCRIPTIONS,
+      },
+      () => {}
+    );
 
-    return WebSocketSession.init(session, this.apiClient);
+    return new WebSocketSession(pitcherClient, () => customSession?.env ?? {});
   }
 
   async createRestSession(customSession?: SessionCreateOptions) {
     const session = customSession
       ? await this.createSession(customSession)
-      : this.defaultSession;
+      : this.globalSession;
 
     return new RestSession(session);
   }
@@ -135,10 +202,11 @@ export class Sandbox {
   ): Promise<SandboxBrowserSession> {
     const session = customSession
       ? await this.createSession(customSession)
-      : this.defaultSession;
+      : this.globalSession;
 
     return {
       id: this.id,
+      env: customSession?.env,
       bootupType: this.bootupType,
       cluster: this.cluster,
       latestPitcherVersion: this.pitcherManagerResponse.latestPitcherVersion,