Merge pull request #25 from OpenMined/chore/persist-settings

persist public url in settings

Author: shubham3121

backend/syftai_space/alembic/versions/e18675e6eecb_add_settings_table.py

@@ -0,0 +1,33 @@
+"""add settings table
+
+Revision ID: e18675e6eecb
+Revises: 9b73c6b77fa4
+Create Date: 2026-01-13 12:39:41.971893
+
+"""
+
+from collections.abc import Sequence
+
+import sqlalchemy as sa
+import sqlmodel  # noqa: F401 - Added for SQLModel support
+from alembic import op
+
+# revision identifiers, used by Alembic.
+revision: str = "e18675e6eecb"
+down_revision: str | None = "9b73c6b77fa4"
+branch_labels: str | Sequence[str] | None = None
+depends_on: str | Sequence[str] | None = None
+
+
+def upgrade() -> None:
+    op.create_table(
+        "settings",
+        sa.Column("id", sa.Integer(), nullable=False),
+        sa.Column("public_url", sa.String(), nullable=True),
+        sa.Column("updated_at", sa.DateTime(), nullable=False),
+        sa.PrimaryKeyConstraint("id"),
+    )
+
+
+def downgrade() -> None:
+    op.drop_table("settings")

backend/syftai_space/components/settings/__init__.py

@@ -1,13 +1,17 @@
 """Settings component for public URL management."""
 
+from syftai_space.components.settings.entities import Settings
 from syftai_space.components.settings.handlers import SettingsHandler
+from syftai_space.components.settings.repository import SettingsRepository
 from syftai_space.components.settings.schemas import (
     PublicUrlResponse,
     UpdatePublicUrlRequest,
 )
 
 __all__ = [
+    "Settings",
     "SettingsHandler",
+    "SettingsRepository",
     "PublicUrlResponse",
     "UpdatePublicUrlRequest",
 ]

backend/syftai_space/components/settings/entities.py

@@ -0,0 +1,17 @@
+"""Settings database entities."""
+
+from datetime import datetime, timezone
+
+from sqlmodel import Field, SQLModel
+
+
+class Settings(SQLModel, table=True):
+    """Application settings entity - singleton row (id=1)."""
+
+    __tablename__ = "settings"
+
+    id: int = Field(default=1, primary_key=True)
+    public_url: str | None = Field(
+        default=None, description="Public URL for the SyftAI Space"
+    )
+    updated_at: datetime = Field(default_factory=lambda: datetime.now(timezone.utc))

backend/syftai_space/components/settings/handlers.py

@@ -4,6 +4,7 @@
 from pydantic import HttpUrl
 
 from syftai_space.components.marketplaces.handlers import MarketplaceHandler
+from syftai_space.components.settings.repository import SettingsRepository
 from syftai_space.components.settings.schemas import PublicUrlResponse
 from syftai_space.components.shared.syfthub_client import SyftHubClient, SyftHubError
 from syftai_space.components.tenants.entities import Tenant
@@ -14,33 +15,37 @@ class SettingsHandler:
     """Handler for settings business logic."""
 
     def __init__(
-        self, marketplace_handler: MarketplaceHandler, config: AppSettings
+        self,
+        settings_repository: SettingsRepository,
+        marketplace_handler: MarketplaceHandler,
+        config: AppSettings,
     ) -> None:
         """Initialize the settings handler.
 
         Args:
+            settings_repository: Repository for settings persistence
             marketplace_handler: Marketplace handler for syncing to SyftHub
             config: Application settings
         """
+        self.settings_repository = settings_repository
         self.marketplace_handler = marketplace_handler
         self.config = config
 
     def get_public_url(self) -> PublicUrlResponse:
-        """Get the current public URL.
+        """Get the current public URL from database (source of truth).
 
         Returns:
             Public URL response
         """
-        return PublicUrlResponse(
-            public_url=str(self.config.public_url) if self.config.public_url else None
-        )
+        settings = self.settings_repository.get_settings()
+        return PublicUrlResponse(public_url=settings.public_url)
 
     def update_public_url(
         self, tenant: Tenant, new_url: HttpUrl | str
     ) -> PublicUrlResponse:
         """Update the public URL.
 
-        Updates the local config and syncs to SyftHub marketplace.
+        Updates the database (source of truth) and syncs to SyftHub marketplace.
 
         Args:
             tenant: Tenant context
@@ -52,19 +57,18 @@ def update_public_url(
         Raises:
             HTTPException: If sync to marketplace fails
         """
-        # Convert to HttpUrl if str, then store
-        if isinstance(new_url, str):
-            new_url = HttpUrl(new_url)
+        # Convert to string for storage
+        url_str = str(new_url) if new_url else None
 
-        # Update local config
-        self.config.public_url = new_url
+        # Update database (source of truth)
+        self.settings_repository.update_public_url(url_str)
 
         # Sync to SyftHub if marketplace is configured
         try:
             marketplace = self.marketplace_handler.get_default_marketplace(tenant)
             with SyftHubClient(str(marketplace.url)) as syfthub:
                 syfthub.login(marketplace.email, marketplace.password)
-                syfthub.update_profile(domain=str(new_url))
+                syfthub.update_profile(domain=url_str)
         except HTTPException as e:
             if e.status_code == 404:
                 # No marketplace configured, just update local config
@@ -77,4 +81,12 @@ def update_public_url(
                 detail=f"Failed to sync public URL to marketplace: {e.message}",
             ) from e
 
-        return PublicUrlResponse(public_url=str(new_url))
+        return PublicUrlResponse(public_url=url_str)
+
+    def initialize_from_config(self) -> None:
+        """Initialize settings from config on startup.
+
+        If SYFT_PUBLIC_URL env var is set, it overwrites the database value.
+        """
+        if self.config.public_url:
+            self.settings_repository.update_public_url(str(self.config.public_url))

backend/syftai_space/components/settings/repository.py

@@ -0,0 +1,27 @@
+"""Settings repository for database operations."""
+
+from datetime import datetime, timezone
+
+from syftai_space.components.settings.entities import Settings
+from syftai_space.components.shared.database import BaseRepository, Database
+
+
+class SettingsRepository(BaseRepository[Settings]):
+    """Repository for Settings CRUD operations."""
+
+    def __init__(self, db: Database):
+        super().__init__(db, Settings)
+
+    def get_settings(self) -> Settings:
+        """Get the singleton settings row, creating if not exists."""
+        settings = self.get_by_id(1)
+        if not settings:
+            settings = self.create(Settings(id=1))
+        return settings
+
+    def update_public_url(self, url: str | None) -> Settings:
+        """Update the public_url setting."""
+        settings = self.get_settings()
+        settings.public_url = url
+        settings.updated_at = datetime.now(timezone.utc)
+        return self.update(settings)

backend/syftai_space/main.py

@@ -72,6 +72,7 @@
 from syftai_space.components.settings.handlers import SettingsHandler
 
 # Import settings components
+from syftai_space.components.settings.repository import SettingsRepository
 from syftai_space.components.settings.routes import build_settings_routes
 
 # Import database
@@ -110,7 +111,11 @@ async def lifespan(app: FastAPI):
             logger.info(f"📡 Public URL: {public_url}")
             logger.info(f"🔗 Local URL: http://localhost:{port}")
             logger.info("=" * 70 + "\n")
-            app_settings.public_url = public_url
+
+            # Update database via settings handler (source of truth)
+            settings_handler = getattr(app.state, "settings_handler", None)
+            if settings_handler:
+                settings_handler.settings_repository.update_public_url(public_url)
 
         except Exception as e:
             logger.error(f"⚠️  Warning: Failed to start ngrok tunnel: {e}")
@@ -243,7 +248,15 @@ async def lifespan(app: FastAPI):
     marketplace_repository=marketplace_repository,
 )
 tenant_handler = TenantHandler(tenant_repository)
-settings_handler = SettingsHandler(marketplace_handler, app_settings)
+
+# Initialize settings repository and handler
+settings_repository = SettingsRepository(database)
+settings_handler = SettingsHandler(
+    settings_repository, marketplace_handler, app_settings
+)
+
+# Initialize settings from config on startup (env var overwrites DB if set)
+settings_handler.initialize_from_config()
 
 # Initialize ingestion manager and handler
 ingestion_manager = IngestionManager(
@@ -260,6 +273,7 @@ async def lifespan(app: FastAPI):
 provisioner_manager = ProvisionerManager(dataset_handler)
 app.state.provisioner_manager = provisioner_manager
 app.state.ingestion_manager = ingestion_manager
+app.state.settings_handler = settings_handler
 
 # Add tenant middleware (after CORS, before routes)
 app.add_middleware(TenantMiddleware, tenant_repository=tenant_repository)