Merge pull request #97 from OpenMined/feat/auto-fetch-tunnel-credentials

feat: auto-fetch ngrok tunnel credentials from SyftHub

Author: itstauq

backend/syft_space/alembic/versions/a1b2c3d4e5f6_rename_ngrok_username_to_ngrok_domain.py

@@ -0,0 +1,35 @@
+"""rename ngrok_username to ngrok_domain
+
+Revision ID: a1b2c3d4e5f6
+Revises: 616fe141adf9
+Create Date: 2026-03-04 12:00:00.000000
+
+"""
+
+from collections.abc import Sequence
+
+import sqlalchemy as sa
+import sqlmodel
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "a1b2c3d4e5f6"
+down_revision: str | None = "616fe141adf9"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    op.add_column(
+        "settings",
+        sa.Column("ngrok_domain", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
+    )
+    op.drop_column("settings", "ngrok_username")
+
+
+def downgrade() -> None:
+    op.add_column(
+        "settings",
+        sa.Column("ngrok_username", sqlmodel.sql.sqltypes.AutoString(), nullable=True),
+    )
+    op.drop_column("settings", "ngrok_domain")

backend/syft_space/components/settings/__init__.py

@@ -4,7 +4,6 @@
 from syft_space.components.settings.handlers import SettingsHandler
 from syft_space.components.settings.repository import SettingsRepository
 from syft_space.components.settings.schemas import (
-    ProxyConfigRequest,
     ProxyStatusResponse,
     PublicUrlResponse,
     UpdatePublicUrlRequest,
@@ -14,7 +13,6 @@
     "Settings",
     "SettingsHandler",
     "SettingsRepository",
-    "ProxyConfigRequest",
     "ProxyStatusResponse",
     "PublicUrlResponse",
     "UpdatePublicUrlRequest",

backend/syft_space/components/settings/entities.py

@@ -18,7 +18,7 @@ class Settings(SQLModel, table=True):
     ngrok_token: str | None = Field(
         default=None, description="Ngrok authentication token for proxy tunnel"
     )
-    ngrok_username: str | None = Field(
-        default=None, description="Username for ngrok subdomain"
+    ngrok_domain: str | None = Field(
+        default=None, description="Domain for ngrok tunnel"
     )
     updated_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))

backend/syft_space/components/settings/handlers.py

@@ -134,15 +134,14 @@ async def get_proxy_status(self) -> ProxyStatusResponse:
             has_token=has_token,
         )
 
-    async def configure_proxy(self, tenant: Tenant, token: str) -> ProxyStatusResponse:
+    async def configure_proxy(self, tenant: Tenant) -> ProxyStatusResponse:
         """Configure the ngrok proxy tunnel.
 
-        Connects to ngrok with the provided token and persists the configuration.
-        Also syncs the public URL to the marketplace.
+        Delegates to ProxyService.connect_with_fallback() which tries stored
+        credentials first and falls back to fresh ones from SyftHub.
 
         Args:
             tenant: Tenant context for marketplace sync
-            token: Ngrok authentication token
 
         Returns:
             Proxy status response with connection status and public URL
@@ -156,7 +155,7 @@ async def configure_proxy(self, tenant: Tenant, token: str) -> ProxyStatusRespon
                 detail="Ngrok proxy service not configured",
             )
 
-        # Get default marketplace
+        # Get default marketplace (needed for URL sync)
         marketplace = await self.marketplace_repository.get_default(tenant.id)
 
         if not marketplace:
@@ -166,7 +165,12 @@ async def configure_proxy(self, tenant: Tenant, token: str) -> ProxyStatusRespon
             )
 
         try:
-            public_url = await self.proxy_service.connect(token, marketplace.username)
+            public_url = await self.proxy_service.connect()
+        except SyftHubError as e:
+            raise HTTPException(
+                status_code=e.status_code,
+                detail=f"Failed to fetch tunnel credentials: {e.message}",
+            ) from e
         except Exception as e:
             logger.exception(f"Failed to connect to ngrok: {e}")
             raise HTTPException(status_code=400, detail=str(e)) from e

backend/syft_space/components/settings/repository.py

@@ -48,14 +48,14 @@ async def update_ngrok_token(self, token: str | None) -> Settings:
         settings.updated_at = datetime.now(timezone.utc)
         return await self.update(settings)
 
-    async def get_ngrok_username(self) -> str | None:
-        """Get the stored ngrok username for subdomain."""
+    async def get_ngrok_domain(self) -> str | None:
+        """Get the stored ngrok domain for tunnel."""
         settings = await self.get_settings()
-        return settings.ngrok_username
+        return settings.ngrok_domain
 
-    async def update_ngrok_username(self, username: str | None) -> Settings:
-        """Update the ngrok username setting."""
+    async def update_ngrok_domain(self, domain: str | None) -> Settings:
+        """Update the ngrok domain setting."""
         settings = await self.get_settings()
-        settings.ngrok_username = username
+        settings.ngrok_domain = domain
         settings.updated_at = datetime.now(timezone.utc)
         return await self.update(settings)

backend/syft_space/components/settings/routes.py

@@ -4,7 +4,6 @@
 
 from syft_space.components.settings.handlers import SettingsHandler
 from syft_space.components.settings.schemas import (
-    ProxyConfigRequest,
     ProxyStatusResponse,
     PublicUrlResponse,
     UpdatePublicUrlRequest,
@@ -58,16 +57,15 @@ async def get_proxy_status(
 
     @router.post("/proxy", response_model=ProxyStatusResponse)
     async def configure_proxy(
-        request: ProxyConfigRequest,
         tenant: Tenant = Depends(get_tenant_dependency),
         handler: SettingsHandler = Depends(get_handler),
     ) -> ProxyStatusResponse:
         """Configure the ngrok proxy tunnel.
 
-        Connects to ngrok with the provided token and persists the configuration.
-        The tunnel will automatically reconnect on app restart.
+        Fetches tunnel credentials from SyftHub, connects to ngrok, and persists
+        the configuration. The tunnel will automatically reconnect on app restart.
         """
-        return await handler.configure_proxy(tenant, request.ngrok_token)
+        return await handler.configure_proxy(tenant)
 
     @router.delete("/proxy", response_model=ProxyStatusResponse)
     async def disconnect_proxy(

backend/syft_space/components/settings/schemas.py

@@ -24,23 +24,6 @@ class Config:
         }
 
 
-class ProxyConfigRequest(BaseModel):
-    """Request model for configuring the ngrok proxy."""
-
-    ngrok_token: str = Field(
-        ..., min_length=1, description="Ngrok authentication token"
-    )
-
-    class Config:
-        """Pydantic config."""
-
-        json_schema_extra = {
-            "example": {
-                "ngrok_token": "2abc123def456...",
-            }
-        }
-
-
 class ProxyStatusResponse(BaseModel):
     """Response model for proxy status."""