Skip to content

armgit / E2B

Public Imported from GitHub
0

Open-source, secure environment with real-world tools for enterprise-grade agents.

Fix/python envd stable transport (#1368)

Matt Brockman4b9cc043dc31
diff --git a/.changeset/sharp-sandboxes-sip.md b/.changeset/sharp-sandboxes-sip.md
new file mode 100644
index 000000000..5b04b57aa
--- /dev/null
+++ b/.changeset/sharp-sandboxes-sip.md
@@ -0,0 +1,5 @@
+---
+"@e2b/python-sdk": patch
+---
+
+Use the stable sandbox host for envd requests on supported E2B domains and give envd traffic a separate HTTP transport cache from API traffic. Sync envd transports are cached per thread to avoid sharing a single HTTP/2 connection across threaded sync workloads.
diff --git a/packages/python-sdk/e2b/api/client_async/__init__.py b/packages/python-sdk/e2b/api/client_async/__init__.py
index 3aa70fcd6..85300f590 100644
--- a/packages/python-sdk/e2b/api/client_async/__init__.py
+++ b/packages/python-sdk/e2b/api/client_async/__init__.py
@@ -52,3 +52,25 @@ def get_transport(
AsyncTransportWithLogger._instances[loop_id] = transport
return transport
+
+
+class AsyncEnvdTransportWithLogger(AsyncTransportWithLogger):
+ _instances: Dict[Tuple[int, bool], "AsyncEnvdTransportWithLogger"] = {}
+
+
+def get_envd_transport(
+ config: ConnectionConfig, http2: bool = True
+) -> AsyncEnvdTransportWithLogger:
+ loop_id = (id(asyncio.get_running_loop()), http2)
+
+ if loop_id in AsyncEnvdTransportWithLogger._instances:
+ return AsyncEnvdTransportWithLogger._instances[loop_id]
+
+ transport = AsyncEnvdTransportWithLogger(
+ limits=limits,
+ proxy=config.proxy,
+ http2=http2,
+ )
+
+ AsyncEnvdTransportWithLogger._instances[loop_id] = transport
+ return transport
diff --git a/packages/python-sdk/e2b/api/client_sync/__init__.py b/packages/python-sdk/e2b/api/client_sync/__init__.py
index 6a41b4f81..0e444df63 100644
--- a/packages/python-sdk/e2b/api/client_sync/__init__.py
+++ b/packages/python-sdk/e2b/api/client_sync/__init__.py
@@ -2,6 +2,7 @@ from typing import Dict
import httpx
import logging
+import threading
from e2b.api import ApiClient, limits
from e2b.connection_config import ConnectionConfig
@@ -47,3 +48,27 @@ def get_transport(config: ConnectionConfig, http2: bool = True) -> TransportWith
)
TransportWithLogger._instances[http2] = transport
return transport
+
+
+class EnvdTransportWithLogger(TransportWithLogger):
+ _thread_local = threading.local()
+
+
+def get_envd_transport(
+ config: ConnectionConfig, http2: bool = True
+) -> EnvdTransportWithLogger:
+ instances: Dict[bool, EnvdTransportWithLogger] = getattr(
+ EnvdTransportWithLogger._thread_local, "instances", {}
+ )
+ cached = instances.get(http2)
+ if cached is not None:
+ return cached
+
+ transport = EnvdTransportWithLogger(
+ limits=limits,
+ proxy=config.proxy,
+ http2=http2,
+ )
+ instances[http2] = transport
+ EnvdTransportWithLogger._thread_local.instances = instances
+ return transport
diff --git a/packages/python-sdk/e2b/connection_config.py b/packages/python-sdk/e2b/connection_config.py
index 987d5c9e3..4189ccf31 100644
--- a/packages/python-sdk/e2b/connection_config.py
+++ b/packages/python-sdk/e2b/connection_config.py
@@ -6,6 +6,7 @@ from httpx._types import ProxyTypes
from typing_extensions import Unpack
from e2b.api.metadata import package_version
+from e2b.sandbox_domains import is_supported_sandbox_domain
REQUEST_TIMEOUT: float = 60.0 # 60 seconds
@@ -140,7 +141,23 @@ class ConnectionConfig:
if self._sandbox_url:
return self._sandbox_url # type: ignore[return-value]
- return f"{'http' if self.debug else 'https'}://{self.get_host(sandbox_id, sandbox_domain, self.envd_port)}"
+ if self.debug:
+ return f"http://{self.get_host(sandbox_id, sandbox_domain, self.envd_port)}"
+
+ sandbox_domain = sandbox_domain or self.domain
+ if is_supported_sandbox_domain(sandbox_domain):
+ return f"https://sandbox.{sandbox_domain}"
+
+ return f"https://{self.get_host(sandbox_id, sandbox_domain, self.envd_port)}"
+
+ def get_sandbox_direct_url(self, sandbox_id: str, sandbox_domain: str) -> str:
+ if self._sandbox_url:
+ return self._sandbox_url # type: ignore[return-value]
+
+ if self.debug:
+ return f"http://{self.get_host(sandbox_id, sandbox_domain, self.envd_port)}"
+
+ return f"https://{self.get_host(sandbox_id, sandbox_domain, self.envd_port)}"
def get_host(self, sandbox_id: str, sandbox_domain: str, port: int) -> str:
"""
diff --git a/packages/python-sdk/e2b/sandbox/main.py b/packages/python-sdk/e2b/sandbox/main.py
index d9e42645a..813698bf4 100644
--- a/packages/python-sdk/e2b/sandbox/main.py
+++ b/packages/python-sdk/e2b/sandbox/main.py
@@ -45,6 +45,9 @@ class SandboxBase:
self.__envd_api_url = self.connection_config.get_sandbox_url(
self.sandbox_id, self.sandbox_domain
)
+ self.__envd_direct_url = self.connection_config.get_sandbox_direct_url(
+ self.sandbox_id, self.sandbox_domain
+ )
self.__mcp_token: Optional[str] = None
@property
@@ -80,6 +83,10 @@ class SandboxBase:
def envd_api_url(self) -> str:
return self.__envd_api_url
+ @property
+ def envd_direct_url(self) -> str:
+ return self.__envd_direct_url
+
@property
def sandbox_id(self) -> str:
"""
@@ -94,7 +101,7 @@ class SandboxBase:
signature: Optional[str] = None,
signature_expiration: Optional[int] = None,
) -> str:
- url = urllib.parse.urljoin(self.envd_api_url, ENVD_API_FILES_ROUTE)
+ url = urllib.parse.urljoin(self.envd_direct_url, ENVD_API_FILES_ROUTE)
query = {"path": path} if path else {}
if user:
diff --git a/packages/python-sdk/e2b/sandbox_async/main.py b/packages/python-sdk/e2b/sandbox_async/main.py
index 74e74dfa5..1c8ce0786 100644
--- a/packages/python-sdk/e2b/sandbox_async/main.py
+++ b/packages/python-sdk/e2b/sandbox_async/main.py
@@ -10,7 +10,7 @@ from packaging.version import Version
from typing_extensions import Self, Unpack
from e2b.api.client.types import Unset
-from e2b.api.client_async import get_transport
+from e2b.api.client_async import get_envd_transport as get_transport
from e2b.connection_config import ApiParams, ConnectionConfig
from e2b.envd.api import ENVD_API_HEALTH_ROUTE, ahandle_envd_api_exception
from e2b.envd.versions import ENVD_DEBUG_FALLBACK
@@ -844,7 +844,10 @@ class AsyncSandbox(SandboxApi):
**opts,
)
- sandbox_headers = {}
+ sandbox_headers = {
+ "E2b-Sandbox-Id": sandbox.sandbox_id,
+ "E2b-Sandbox-Port": str(ConnectionConfig.envd_port),
+ }
envd_access_token = sandbox.envd_access_token
if envd_access_token is not None and not isinstance(envd_access_token, Unset):
sandbox_headers["X-Access-Token"] = envd_access_token
diff --git a/packages/python-sdk/e2b/sandbox_domains.py b/packages/python-sdk/e2b/sandbox_domains.py
new file mode 100644
index 000000000..0ac5faefd
--- /dev/null
+++ b/packages/python-sdk/e2b/sandbox_domains.py
@@ -0,0 +1,5 @@
+SUPPORTED_SANDBOX_DOMAINS = ("e2b.app", "e2b.dev", "e2b.pro", "e2b-staging.dev")
+
+
+def is_supported_sandbox_domain(sandbox_domain: str) -> bool:
+ return sandbox_domain in SUPPORTED_SANDBOX_DOMAINS
diff --git a/packages/python-sdk/e2b/sandbox_sync/main.py b/packages/python-sdk/e2b/sandbox_sync/main.py
index 6f2a03625..e21abe112 100644
--- a/packages/python-sdk/e2b/sandbox_sync/main.py
+++ b/packages/python-sdk/e2b/sandbox_sync/main.py
@@ -10,7 +10,7 @@ from packaging.version import Version
from typing_extensions import Self, Unpack
from e2b.api.client.types import Unset
-from e2b.api.client_sync import get_transport
+from e2b.api.client_sync import get_envd_transport as get_transport
from e2b.connection_config import ApiParams, ConnectionConfig
from e2b.envd.api import ENVD_API_HEALTH_ROUTE, handle_envd_api_exception
from e2b.envd.versions import ENVD_DEBUG_FALLBACK
@@ -840,7 +840,10 @@ class Sandbox(SandboxApi):
**opts,
)
- sandbox_headers = {}
+ sandbox_headers = {
+ "E2b-Sandbox-Id": sandbox.sandbox_id,
+ "E2b-Sandbox-Port": str(ConnectionConfig.envd_port),
+ }
envd_access_token = sandbox.envd_access_token
if envd_access_token is not None and not isinstance(envd_access_token, Unset):
sandbox_headers["X-Access-Token"] = envd_access_token
diff --git a/packages/python-sdk/tests/async/sandbox_async/test_config_propagation.py b/packages/python-sdk/tests/async/sandbox_async/test_config_propagation.py
index d44f93db6..2f2f60ed3 100644
--- a/packages/python-sdk/tests/async/sandbox_async/test_config_propagation.py
+++ b/packages/python-sdk/tests/async/sandbox_async/test_config_propagation.py
@@ -88,3 +88,26 @@ async def test_pause_applies_overrides(monkeypatch, test_api_key):
assert mock_pause.call_args.kwargs["debug"] == BASE_DEBUG
assert mock_pause.call_args.kwargs["headers"]["X-Test"] == BASE_HEADERS["X-Test"]
assert mock_pause.call_args.kwargs["headers"]["X-Extra"] == "1"
+
+
+async def test_connect_sets_stable_host_routing_headers(monkeypatch, test_api_key):
+ mock_connect = AsyncMock(
+ return_value=SimpleNamespace(
+ sandbox_id="sbx-test",
+ domain="e2b.app",
+ envd_version="0.4.0",
+ envd_access_token="tok",
+ traffic_access_token="traffic",
+ )
+ )
+ monkeypatch.setattr(sandbox_async_main.SandboxApi, "_cls_connect", mock_connect)
+
+ sandbox = await AsyncSandbox.connect("sbx-test", api_key=test_api_key)
+
+ assert sandbox.envd_api_url == "https://sandbox.e2b.app"
+ assert sandbox.connection_config.sandbox_headers["E2b-Sandbox-Id"] == "sbx-test"
+ assert sandbox.connection_config.sandbox_headers["E2b-Sandbox-Port"] == str(
+ ConnectionConfig.envd_port
+ )
+ assert sandbox.connection_config.sandbox_headers["X-Access-Token"] == "tok"
diff --git a/packages/python-sdk/tests/sync/sandbox_sync/test_config_propagation.py b/packages/python-sdk/tests/sync/sandbox_sync/test_config_propagation.py
index 508c2f01c..f458024f5 100644
--- a/packages/python-sdk/tests/sync/sandbox_sync/test_config_propagation.py
+++ b/packages/python-sdk/tests/sync/sandbox_sync/test_config_propagation.py
@@ -84,3 +84,26 @@ def test_pause_applies_overrides(monkeypatch, test_api_key):
assert mock_pause.call_args.kwargs["debug"] == BASE_DEBUG
assert mock_pause.call_args.kwargs["headers"]["X-Test"] == BASE_HEADERS["X-Test"]
assert mock_pause.call_args.kwargs["headers"]["X-Extra"] == "1"
+
+
+def test_connect_sets_stable_host_routing_headers(monkeypatch, test_api_key):
+ mock_connect = Mock(
+ return_value=SimpleNamespace(
+ sandbox_id="sbx-test",
+ domain="e2b.app",
+ envd_version="0.4.0",
+ envd_access_token="tok",
+ traffic_access_token="traffic",
+ )
+ )
+ monkeypatch.setattr(sandbox_sync_main.SandboxApi, "_cls_connect", mock_connect)
+
+ sandbox = Sandbox.connect("sbx-test", api_key=test_api_key)
+
+ assert sandbox.envd_api_url == "https://sandbox.e2b.app"
+ assert sandbox.connection_config.sandbox_headers["E2b-Sandbox-Id"] == "sbx-test"
+ assert sandbox.connection_config.sandbox_headers["E2b-Sandbox-Port"] == str(
+ ConnectionConfig.envd_port
+ )
+ assert sandbox.connection_config.sandbox_headers["X-Access-Token"] == "tok"
diff --git a/packages/python-sdk/tests/test_api_client_transport.py b/packages/python-sdk/tests/test_api_client_transport.py
index 3bbe1d4e3..4a6b0dc48 100644
--- a/packages/python-sdk/tests/test_api_client_transport.py
+++ b/packages/python-sdk/tests/test_api_client_transport.py
@@ -1,12 +1,15 @@
import asyncio
+from concurrent.futures import ThreadPoolExecutor
import pytest
-from e2b.api.client_async import AsyncTransportWithLogger
+from e2b.api.client_async import AsyncEnvdTransportWithLogger, AsyncTransportWithLogger
from e2b.api.client_async import get_api_client as get_async_api_client
+from e2b.api.client_async import get_envd_transport as get_async_envd_transport
from e2b.api.client_async import get_transport as get_async_transport
-from e2b.api.client_sync import TransportWithLogger
+from e2b.api.client_sync import EnvdTransportWithLogger, TransportWithLogger
from e2b.api.client_sync import get_api_client as get_sync_api_client
+from e2b.api.client_sync import get_envd_transport as get_sync_envd_transport
from e2b.api.client_sync import get_transport as get_sync_transport
from e2b.connection_config import ConnectionConfig
@@ -49,6 +52,44 @@ def test_sync_get_transport_http2_opt_out_returns_distinct_instance(test_api_key
TransportWithLogger._instances.clear()
+def test_sync_envd_transport_uses_separate_cache(test_api_key):
+ TransportWithLogger._instances.clear()
+ EnvdTransportWithLogger._thread_local.instances = {}
+ config = ConnectionConfig(api_key=test_api_key)
+
+ try:
+ api_transport = get_sync_transport(config)
+ envd_transport = get_sync_envd_transport(config)
+
+ assert api_transport is not envd_transport
+ assert get_sync_transport(config) is api_transport
+ assert get_sync_envd_transport(config) is envd_transport
+ assert envd_transport._pool._http2 is True
+ finally:
+ TransportWithLogger._instances.clear()
+ EnvdTransportWithLogger._thread_local.instances = {}
+
+
+def test_sync_envd_transport_cache_is_thread_local(test_api_key):
+ EnvdTransportWithLogger._thread_local.instances = {}
+ config = ConnectionConfig(api_key=test_api_key)
+
+ def get_thread_transport():
+ return get_sync_envd_transport(config)
+
+ try:
+ main_transport = get_sync_envd_transport(config)
+ with ThreadPoolExecutor(max_workers=1) as executor:
+ thread_transport = executor.submit(get_thread_transport).result()
+
+ assert main_transport is get_sync_envd_transport(config)
+ assert thread_transport is not main_transport
+ assert main_transport._pool._http2 is True
+ assert thread_transport._pool._http2 is True
+ finally:
+ EnvdTransportWithLogger._thread_local.instances = {}
+
+
@pytest.mark.asyncio
async def test_async_api_client_proxy_uses_explicit_transport(test_api_key):
AsyncTransportWithLogger._instances.clear()
@@ -92,3 +133,22 @@ async def test_async_get_transport_http2_opt_out_returns_distinct_instance(
assert get_async_transport(config, http2=False) is http1_transport
finally:
AsyncTransportWithLogger._instances.clear()
+
+
+async def test_async_envd_transport_uses_separate_cache(test_api_key):
+ AsyncTransportWithLogger._instances.clear()
+ AsyncEnvdTransportWithLogger._instances.clear()
+ config = ConnectionConfig(api_key=test_api_key)
+
+ try:
+ api_transport = get_async_transport(config)
+ envd_transport = get_async_envd_transport(config)
+
+ assert api_transport is not envd_transport
+ assert get_async_transport(config) is api_transport
+ assert get_async_envd_transport(config) is envd_transport
+ assert envd_transport._pool._http2 is True
+ finally:
+ AsyncTransportWithLogger._instances.clear()
+ AsyncEnvdTransportWithLogger._instances.clear()
diff --git a/packages/python-sdk/tests/test_connection_config.py b/packages/python-sdk/tests/test_connection_config.py
index 1411daeeb..85f108fe8 100644
--- a/packages/python-sdk/tests/test_connection_config.py
+++ b/packages/python-sdk/tests/test_connection_config.py
@@ -3,6 +3,7 @@ from e2b import ConnectionConfig
def test_api_url_defaults_correctly(monkeypatch):
monkeypatch.setenv("E2B_DOMAIN", "")
+ monkeypatch.delenv("E2B_API_URL", raising=False)
config = ConnectionConfig()
assert config.api_url == "https://api.e2b.app"
@@ -25,3 +26,71 @@ def test_api_url_has_correct_priority(monkeypatch):
config = ConnectionConfig(api_url="http://localhost:8080")
assert config.api_url == "http://localhost:8080"
+
+
+def test_sandbox_url_uses_stable_host_for_supported_domain():
+ config = ConnectionConfig(domain="e2b.app")
+
+ assert config.get_sandbox_url("sandbox-id", "e2b.app") == "https://sandbox.e2b.app"
+
+
+def test_sandbox_url_uses_stable_host_for_supported_non_prod_domain():
+ config = ConnectionConfig(domain="e2b.dev")
+
+ assert config.get_sandbox_url("sandbox-id", "e2b.dev") == "https://sandbox.e2b.dev"
+
+
+def test_sandbox_url_uses_explicit_url_first():
+ config = ConnectionConfig(sandbox_url="https://sandbox.example.com")
+
+ assert (
+ config.get_sandbox_url("sandbox-id", "e2b.app") == "https://sandbox.example.com"
+ )
+
+
+def test_sandbox_url_falls_back_to_per_sandbox_host_for_custom_domain():
+ config = ConnectionConfig(domain="custom.example")
+
+ assert (
+ config.get_sandbox_url("sandbox-id", "custom.example")
+ == "https://49983-sandbox-id.custom.example"
+ )
+
+
+def test_sandbox_url_falls_back_to_per_sandbox_host_for_unsupported_subdomain():
+ config = ConnectionConfig(domain="e2b.dev")
+
+ assert (
+ config.get_sandbox_url("sandbox-id", "sandbox.e2b.dev")
+ == "https://49983-sandbox-id.sandbox.e2b.dev"
+ )
+
+
+def test_sandbox_url_debug_uses_localhost():
+ config = ConnectionConfig(debug=True)
+
+ assert config.get_sandbox_url("sandbox-id", "e2b.app") == "http://localhost:49983"
+
+
+def test_get_host_keeps_per_sandbox_host_for_supported_domain():
+ config = ConnectionConfig(domain="e2b.app")
+
+ assert config.get_host("sandbox-id", "e2b.app", 8888) == "8888-sandbox-id.e2b.app"
+
+
+def test_sandbox_direct_url_keeps_per_sandbox_host_for_supported_domain():
+ config = ConnectionConfig(domain="e2b.app")
+
+ assert (
+ config.get_sandbox_direct_url("sandbox-id", "e2b.app")
+ == "https://49983-sandbox-id.e2b.app"
+ )
+
+
+def test_sandbox_direct_url_uses_explicit_url_first():
+ config = ConnectionConfig(sandbox_url="https://sandbox.example.com")
+
+ assert (
+ config.get_sandbox_direct_url("sandbox-id", "e2b.app")
+ == "https://sandbox.example.com"
+ )
diff --git a/packages/python-sdk/tests/test_sandbox_urls.py b/packages/python-sdk/tests/test_sandbox_urls.py
new file mode 100644
index 000000000..0106e487d
--- /dev/null
+++ b/packages/python-sdk/tests/test_sandbox_urls.py
@@ -0,0 +1,26 @@
+from packaging.version import Version
+
+from e2b.connection_config import ConnectionConfig
+from e2b.sandbox.main import SandboxBase
+
+
+def test_file_urls_use_direct_sandbox_host_when_envd_api_uses_stable_host():
+ sandbox = SandboxBase(
+ sandbox_id="sandbox-id",
+ sandbox_domain="e2b.app",
+ envd_version=Version("0.4.0"),
+ envd_access_token=None,
+ traffic_access_token=None,
+ connection_config=ConnectionConfig(domain="e2b.app"),
+ )
+
+ assert sandbox.envd_api_url == "https://sandbox.e2b.app"
+ assert sandbox.envd_direct_url == "https://49983-sandbox-id.e2b.app"
+ assert (
+ sandbox.download_url("/tmp/a.txt")
+ == "https://49983-sandbox-id.e2b.app/files?path=%2Ftmp%2Fa.txt"
+ )
+ assert (
+ sandbox.upload_url("/tmp/a.txt")
+ == "https://49983-sandbox-id.e2b.app/files?path=%2Ftmp%2Fa.txt"
+ )