support local dev for envd in typescript

Author: djeebus

.eslintrc.cjs

@@ -22,5 +22,6 @@ module.exports = {
     quotes: ['error', 'single', { avoidEscape: true }],
     // No extra semicolon
     '@stylistic/ts/semi': ['error', 'never'],
+    'object-curly-spacing': ['error', 'always'],
   },
 }

packages/cli/.envrc

@@ -0,0 +1,3 @@
+source_up
+
+dotenv ../../../.env.local

packages/cli/package.json

@@ -86,7 +86,7 @@
     "commander": "^11.1.0",
     "console-table-printer": "^2.11.2",
     "dockerfile-ast": "^0.6.1",
-    "e2b": "^2.3.4",
+    "e2b": "^2.6.4",
     "handlebars": "^4.7.8",
     "inquirer": "^9.2.12",
     "open": "^9.1.0",

packages/js-sdk/src/connectionConfig.ts

@@ -1,5 +1,5 @@
-import { Logger } from './logs'
-import { getEnvVar, version } from './api/metadata'
+import {Logger} from './logs'
+import {getEnvVar, version} from './api/metadata'
 import {sandboxTest} from "../tests/setup";
 
 export const REQUEST_TIMEOUT_MS = 60_000 // 60 seconds
@@ -69,6 +69,8 @@ export interface ConnectionOpts {
  * Configuration for connecting to the API.
  */
 export class ConnectionConfig {
+  public static envdPort = 49983
+
   readonly debug: boolean
   readonly domain: string
   readonly apiUrl: string
@@ -127,12 +129,21 @@ export class ConnectionConfig {
     return timeout ? AbortSignal.timeout(timeout) : undefined
   }
 
-  getSandboxUrl(sandboxId: string, sandboxDomain: string): string {
-    if (this.sandboxUrl) {
-      return this.sandboxUrl
+  getSandboxUrl(sandboxId: string, opts: { sandboxDomain: string, envdPort: number }) {
+    const sandboxUrl = ConnectionConfig.sandboxUrl
+    if (sandboxUrl) {
+      return sandboxUrl
+    }
+
+    return `${this.debug ? 'http' : 'https'}://${this.getHost(sandboxId, opts.envdPort, opts.sandboxDomain)}`
+  }
+
+  getHost(sandboxId: string, port: number, sandboxDomain: string) {
+    if (this.debug) {
+      return `localhost:${port}`
     }
 
-    return `${this.debug ? "http" : "https"}://${this.getHost(sandboxId, sandboxDomain)}`
+    return `${port}-${sandboxId}.${sandboxDomain ?? this.domain}`
   }
 }
 

packages/js-sdk/src/sandbox/index.ts

@@ -123,9 +123,15 @@ export class Sandbox extends SandboxApi {
     this.sandboxDomain = opts.sandboxDomain ?? this.connectionConfig.domain
 
     this.envdAccessToken = opts.envdAccessToken
-    this.envdApiUrl = `${
-      this.connectionConfig.debug ? 'http' : 'https'
-    }://${this.getHost(this.envdPort)}`
+    this.envdApiUrl = this.connectionConfig.getSandboxUrl(this.sandboxId, {
+      sandboxDomain: this.sandboxDomain,
+      envdPort: this.envdPort
+    })
+
+    const sandboxHeaders = {
+      'E2b-Sandbox-Id': this.sandboxId,
+      'E2b-Sandbox-Port': this.envdPort.toString(),
+    }
 
     const rpcTransport = createConnectTransport({
       baseUrl: this.envdApiUrl,
@@ -141,6 +147,9 @@ export class Sandbox extends SandboxApi {
         new Headers(options?.headers).forEach((value, key) =>
           headers.append(key, value)
         )
+        new Headers(sandboxHeaders).forEach((value, key) =>
+          headers.append(key, value)
+        )
 
         if (this.envdAccessToken) {
           headers.append('X-Access-Token', this.envdAccessToken)
@@ -238,15 +247,15 @@ export class Sandbox extends SandboxApi {
     const { template, sandboxOpts } =
       typeof templateOrOpts === 'string'
         ? {
-            template: templateOrOpts,
-            sandboxOpts: opts,
-          }
+          template: templateOrOpts,
+          sandboxOpts: opts,
+        }
         : {
-            template: templateOrOpts?.mcp
-              ? this.defaultMcpTemplate
-              : this.defaultTemplate,
-            sandboxOpts: templateOrOpts,
-          }
+          template: templateOrOpts?.mcp
+            ? this.defaultMcpTemplate
+            : this.defaultTemplate,
+          sandboxOpts: templateOrOpts,
+        }
 
     const config = new ConnectionConfig(sandboxOpts)
     if (config.debug) {
@@ -333,15 +342,15 @@ export class Sandbox extends SandboxApi {
     const { template, sandboxOpts } =
       typeof templateOrOpts === 'string'
         ? {
-            template: templateOrOpts,
-            sandboxOpts: opts,
-          }
+          template: templateOrOpts,
+          sandboxOpts: opts,
+        }
         : {
-            template: templateOrOpts?.mcp
-              ? this.defaultMcpTemplate
-              : this.defaultTemplate,
-            sandboxOpts: templateOrOpts,
-          }
+          template: templateOrOpts?.mcp
+            ? this.defaultMcpTemplate
+            : this.defaultTemplate,
+          sandboxOpts: templateOrOpts,
+        }
 
     const config = new ConnectionConfig(sandboxOpts)
     if (config.debug) {
@@ -482,11 +491,7 @@ export class Sandbox extends SandboxApi {
    * ```
    */
   getHost(port: number) {
-    if (this.connectionConfig.debug) {
-      return `localhost:${port}`
-    }
-
-    return `${port}-${this.sandboxId}.${this.sandboxDomain}`
+    return this.connectionConfig.getHost(this.sandboxId, port, this.sandboxDomain)
   }
 
   /**
@@ -732,7 +737,7 @@ export class Sandbox extends SandboxApi {
       if (compareVersions(this.envdApi.version, '0.1.5') < 0) {
         throw new SandboxError(
           'You need to update the template to use the new SDK. ' +
-            'You can do this by running `e2b template build` in the directory with the template.'
+          'You can do this by running `e2b template build` in the directory with the template.'
         )
       }