Skip to content

πŸ™Œ OpenHands: AI-Driven Development

APP-1197 Migrate settings endpoints to V1 API (/api/v1/settings) (#13759)

Tim O'Farrelle38eda4ac970
diff --git a/enterprise/server/routes/feedback.py b/enterprise/server/routes/feedback.py
index f8ce971808..d7976e308a 100644
--- a/enterprise/server/routes/feedback.py
+++ b/enterprise/server/routes/feedback.py
@@ -7,8 +7,8 @@ from storage.database import a_session_maker
from storage.feedback import ConversationFeedback
from storage.stored_conversation_metadata_saas import StoredConversationMetadataSaas
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.events.event_store import EventStore
-from openhands.server.dependencies import get_dependencies
from openhands.server.shared import file_store
from openhands.server.user_auth import get_user_id
diff --git a/enterprise/server/routes/user.py b/enterprise/server/routes/user.py
index 54fc93388a..610775f354 100644
--- a/enterprise/server/routes/user.py
+++ b/enterprise/server/routes/user.py
@@ -7,6 +7,7 @@ from server.auth.token_manager import TokenManager
from storage.user_store import UserStore
from utils.identity import resolve_display_name
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.integrations.provider import (
PROVIDER_TOKEN_TYPE,
ProviderHandler,
@@ -23,7 +24,6 @@ from openhands.microagent.types import (
MicroagentContentResponse,
MicroagentResponse,
)
-from openhands.server.dependencies import get_dependencies
from openhands.server.routes.git import (
get_repository_branches,
get_repository_microagent_content,
diff --git a/openhands/app_server/app_conversation/app_conversation_router.py b/openhands/app_server/app_conversation/app_conversation_router.py
index 02fb97986d..5a54137ddf 100644
--- a/openhands/app_server/app_conversation/app_conversation_router.py
+++ b/openhands/app_server/app_conversation/app_conversation_router.py
@@ -65,12 +65,12 @@ from openhands.app_server.services.httpx_client_injector import (
from openhands.app_server.services.injector import InjectorState
from openhands.app_server.user.specifiy_user_context import USER_CONTEXT_ATTR
from openhands.app_server.user.user_context import UserContext
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.app_server.utils.docker_utils import (
replace_localhost_hostname_for_docker,
)
from openhands.sdk.context.skills import KeywordTrigger, TaskTrigger
from openhands.sdk.workspace.remote.async_remote_workspace import AsyncRemoteWorkspace
-from openhands.server.dependencies import get_dependencies
# Handle anext compatibility for Python < 3.10
if sys.version_info >= (3, 10):
diff --git a/openhands/app_server/event/event_router.py b/openhands/app_server/event/event_router.py
index ae525d3e04..04f3151a24 100644
--- a/openhands/app_server/event/event_router.py
+++ b/openhands/app_server/event/event_router.py
@@ -10,8 +10,8 @@ from openhands.agent_server.models import EventPage, EventSortOrder
from openhands.app_server.config import depends_event_service
from openhands.app_server.event.event_service import EventService
from openhands.app_server.event_callback.event_callback_models import EventKind
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.sdk import Event
-from openhands.server.dependencies import get_dependencies
# We use the get_dependencies method here to signal to the OpenAPI docs that this endpoint
# is protected. The actual protection is provided by SetAuthCookieMiddleware
diff --git a/openhands/app_server/pending_messages/pending_message_router.py b/openhands/app_server/pending_messages/pending_message_router.py
index 7c78e2d6eb..78e9f7a6ce 100644
--- a/openhands/app_server/pending_messages/pending_message_router.py
+++ b/openhands/app_server/pending_messages/pending_message_router.py
@@ -13,7 +13,7 @@ from openhands.app_server.pending_messages.pending_message_models import (
from openhands.app_server.pending_messages.pending_message_service import (
PendingMessageService,
)
-from openhands.server.dependencies import get_dependencies
+from openhands.app_server.utils.dependencies import get_dependencies
logger = logging.getLogger(__name__)
diff --git a/openhands/app_server/sandbox/sandbox_router.py b/openhands/app_server/sandbox/sandbox_router.py
index 54dedecfbb..4d5df8b6a3 100644
--- a/openhands/app_server/sandbox/sandbox_router.py
+++ b/openhands/app_server/sandbox/sandbox_router.py
@@ -19,7 +19,7 @@ from openhands.app_server.sandbox.sandbox_service import (
)
from openhands.app_server.sandbox.session_auth import validate_session_key
from openhands.app_server.user.auth_user_context import AuthUserContext
-from openhands.server.dependencies import get_dependencies
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.server.user_auth.user_auth import (
get_for_user as get_user_auth_for_user,
)
diff --git a/openhands/app_server/sandbox/sandbox_spec_router.py b/openhands/app_server/sandbox/sandbox_spec_router.py
index 1a1f98bb96..baed63016f 100644
--- a/openhands/app_server/sandbox/sandbox_spec_router.py
+++ b/openhands/app_server/sandbox/sandbox_spec_router.py
@@ -12,7 +12,7 @@ from openhands.app_server.sandbox.sandbox_spec_models import (
from openhands.app_server.sandbox.sandbox_spec_service import (
SandboxSpecService,
)
-from openhands.server.dependencies import get_dependencies
+from openhands.app_server.utils.dependencies import get_dependencies
# We use the get_dependencies method here to signal to the OpenAPI docs that this endpoint
# is protected. The actual protection is provided by SetAuthCookieMiddleware
diff --git a/openhands/app_server/settings/settings_router.py b/openhands/app_server/settings/settings_router.py
new file mode 100644
index 0000000000..81dc2d7329
--- /dev/null
+++ b/openhands/app_server/settings/settings_router.py
@@ -0,0 +1,268 @@
+"""Settings router for OpenHands App Server.
+
+This module provides the V1 API routes for user settings under /api/v1/settings.
+"""
+
+import os
+
+from fastapi import APIRouter, Depends, status
+from fastapi.responses import JSONResponse
+
+from openhands.app_server.utils.dependencies import get_dependencies
+from openhands.core.logger import openhands_logger as logger
+from openhands.integrations.provider import (
+ PROVIDER_TOKEN_TYPE,
+ ProviderType,
+)
+from openhands.server.routes.secrets import invalidate_legacy_secrets_store
+from openhands.server.settings import (
+ GETSettingsModel,
+)
+from openhands.server.shared import config
+from openhands.server.user_auth import (
+ get_provider_tokens,
+ get_secrets_store,
+ get_user_settings,
+ get_user_settings_store,
+)
+from openhands.storage.data_models.settings import Settings
+from openhands.storage.secrets.secrets_store import SecretsStore
+from openhands.storage.settings.settings_store import SettingsStore
+from openhands.utils.llm import get_provider_api_base, is_openhands_model
+
+LITE_LLM_API_URL = os.environ.get(
+ 'LITE_LLM_API_URL', 'https://llm-proxy.app.all-hands.dev'
+)
+
+# Create router with /api/v1/settings prefix
+router = APIRouter(
+ prefix='/settings',
+ tags=['Settings'],
+ dependencies=get_dependencies(),
+)
+
+
+async def store_llm_settings(
+ settings: Settings, existing_settings: Settings
+) -> Settings:
+ """Merge LLM settings with existing settings."""
+ if not existing_settings:
+ return settings
+
+ # Preserve unset LLM settings
+ settings.llm_api_key = settings.llm_api_key or existing_settings.llm_api_key
+ settings.llm_model = settings.llm_model or existing_settings.llm_model
+
+ if settings.llm_base_url is None:
+ # Not provided at all (e.g. MCP config save) - preserve existing or auto-detect
+ if existing_settings.llm_base_url:
+ settings.llm_base_url = existing_settings.llm_base_url
+ elif is_openhands_model(settings.llm_model):
+ # OpenHands models use the LiteLLM proxy
+ settings.llm_base_url = LITE_LLM_API_URL
+ elif settings.llm_model:
+ # For non-openhands models, try to get URL from litellm
+ try:
+ api_base = get_provider_api_base(settings.llm_model)
+ if api_base:
+ settings.llm_base_url = api_base
+ else:
+ logger.debug(
+ f'No api_base found in litellm for model: {settings.llm_model}'
+ )
+ except Exception as e:
+ logger.error(
+ f'Failed to get api_base from litellm for model {settings.llm_model}: {e}'
+ )
+ elif settings.llm_base_url == '':
+ # Explicitly cleared by the user (basic view save or advanced view clear)
+ settings.llm_base_url = None
+
+ settings.search_api_key = (
+ settings.search_api_key or existing_settings.search_api_key
+ )
+ return settings
+
+
+def convert_to_settings(settings_with_token_data: Settings) -> Settings:
+ """Convert settings with token data to Settings model."""
+ settings_data = settings_with_token_data.model_dump()
+
+ # Filter out additional fields from `SettingsWithTokenData`
+ filtered_settings_data = {
+ key: value
+ for key, value in settings_data.items()
+ if key in Settings.model_fields # Ensures only `Settings` fields are included
+ }
+
+ # Convert the API keys to `SecretStr` instances
+ filtered_settings_data['llm_api_key'] = settings_with_token_data.llm_api_key
+ filtered_settings_data['search_api_key'] = settings_with_token_data.search_api_key
+
+ # Create a new Settings instance
+ settings = Settings(**filtered_settings_data)
+ return settings
+
+
+# NOTE: We use response_model=None for endpoints that return JSONResponse directly.
+# This is because FastAPI's response_model expects a Pydantic model, but we're returning
+# a response object directly. We document the possible responses using the 'responses'
+# parameter and maintain proper type annotations for mypy.
+ '',
+ response_model=GETSettingsModel,
+ responses={
+ 404: {'description': 'Settings not found', 'model': dict},
+ 401: {'description': 'Invalid token', 'model': dict},
+ },
+)
+async def load_settings(
+ provider_tokens: PROVIDER_TOKEN_TYPE | None = Depends(get_provider_tokens),
+ settings_store: SettingsStore = Depends(get_user_settings_store),
+ settings: Settings = Depends(get_user_settings),
+ secrets_store: SecretsStore = Depends(get_secrets_store),
+) -> GETSettingsModel | JSONResponse:
+ """Load user settings.
+
+ Retrieves the settings for the authenticated user, including LLM configuration,
+ provider tokens, and other user preferences.
+
+ Returns:
+ GETSettingsModel: The user settings with token data
+
+ Raises:
+ 404: Settings not found
+ 401: Invalid token
+ """
+ try:
+ if not settings:
+ return JSONResponse(
+ status_code=status.HTTP_404_NOT_FOUND,
+ content={'error': 'Settings not found'},
+ )
+
+ # On initial load, user secrets may not be populated with values migrated from settings store
+ user_secrets = await invalidate_legacy_secrets_store(
+ settings, settings_store, secrets_store
+ )
+
+ # If invalidation is successful, then the returned user secrets holds the most recent values
+ git_providers = (
+ user_secrets.provider_tokens if user_secrets else provider_tokens
+ )
+
+ provider_tokens_set: dict[ProviderType, str | None] = {}
+ if git_providers:
+ for provider_type, provider_token in git_providers.items():
+ if provider_token.token or provider_token.user_id:
+ provider_tokens_set[provider_type] = provider_token.host
+
+ settings_with_token_data = GETSettingsModel(
+ **settings.model_dump(exclude={'secrets_store'}),
+ llm_api_key_set=settings.llm_api_key is not None
+ and bool(settings.llm_api_key),
+ search_api_key_set=settings.search_api_key is not None
+ and bool(settings.search_api_key),
+ provider_tokens_set=provider_tokens_set,
+ )
+
+ # If the base url matches the default for the provider, we don't send it
+ # So that the frontend can display basic mode
+ if is_openhands_model(settings.llm_model):
+ if settings.llm_base_url == LITE_LLM_API_URL:
+ settings_with_token_data.llm_base_url = None
+ elif settings.llm_model and settings.llm_base_url == get_provider_api_base(
+ settings.llm_model
+ ):
+ settings_with_token_data.llm_base_url = None
+
+ settings_with_token_data.llm_api_key = None
+ settings_with_token_data.search_api_key = None
+ settings_with_token_data.sandbox_api_key = None
+ return settings_with_token_data
+ except Exception as e:
+ logger.warning(f'Invalid token: {e}')
+ # Get user_id from settings if available
+ user_id = getattr(settings, 'user_id', 'unknown') if settings else 'unknown'
+ logger.info(
+ f'Returning 401 Unauthorized - Invalid token for user_id: {user_id}'
+ )
+ return JSONResponse(
+ status_code=status.HTTP_401_UNAUTHORIZED,
+ content={'error': 'Invalid token'},
+ )
+
+
+ '',
+ response_model=None,
+ responses={
+ 200: {'description': 'Settings stored successfully', 'model': dict},
+ 500: {'description': 'Error storing settings', 'model': dict},
+ },
+)
+async def store_settings(
+ settings: Settings,
+ settings_store: SettingsStore = Depends(get_user_settings_store),
+) -> JSONResponse:
+ """Store user settings.
+
+ Saves the user settings including LLM configuration, provider tokens,
+ and other user preferences.
+
+ Returns:
+ 200: Settings stored successfully
+ 500: Error storing settings
+ """
+ # Check provider tokens are valid
+ try:
+ existing_settings = await settings_store.load()
+
+ # Convert to Settings model and merge with existing settings
+ if existing_settings:
+ settings = await store_llm_settings(settings, existing_settings)
+
+ # Keep existing analytics consent if not provided
+ if settings.user_consents_to_analytics is None:
+ settings.user_consents_to_analytics = (
+ existing_settings.user_consents_to_analytics
+ )
+
+ # Keep existing disabled_skills if not provided
+ if settings.disabled_skills is None:
+ settings.disabled_skills = existing_settings.disabled_skills
+
+ # Update sandbox config with new settings
+ if settings.remote_runtime_resource_factor is not None:
+ config.sandbox.remote_runtime_resource_factor = (
+ settings.remote_runtime_resource_factor
+ )
+
+ # Update git configuration with new settings
+ git_config_updated = False
+ if settings.git_user_name is not None:
+ config.git_user_name = settings.git_user_name
+ git_config_updated = True
+ if settings.git_user_email is not None:
+ config.git_user_email = settings.git_user_email
+ git_config_updated = True
+
+ # Note: Git configuration will be applied when new sessions are initialized
+ # Existing sessions will continue with their current git configuration
+ if git_config_updated:
+ logger.info(
+ f'Updated global git configuration: name={config.git_user_name}, email={config.git_user_email}'
+ )
+
+ settings = convert_to_settings(settings)
+ await settings_store.store(settings)
+ return JSONResponse(
+ status_code=status.HTTP_200_OK,
+ content={'message': 'Settings stored'},
+ )
+ except Exception as e:
+ logger.warning(f'Something went wrong storing settings: {e}')
+ return JSONResponse(
+ status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
+ content={'error': 'Something went wrong storing settings'},
+ )
diff --git a/openhands/app_server/user/skills_router.py b/openhands/app_server/user/skills_router.py
index 398deaa9a9..2e192e7a29 100644
--- a/openhands/app_server/user/skills_router.py
+++ b/openhands/app_server/user/skills_router.py
@@ -5,9 +5,9 @@ import yaml
from fastapi import APIRouter, Query
from pydantic import BaseModel
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.core.logger import openhands_logger as logger
from openhands.memory.memory import GLOBAL_MICROAGENTS_DIR, USER_MICROAGENTS_DIR
-from openhands.server.dependencies import get_dependencies
router = APIRouter(prefix='/skills', tags=['Skills'], dependencies=get_dependencies())
diff --git a/openhands/app_server/user/user_router.py b/openhands/app_server/user/user_router.py
index 3cee936bde..4d4353eb2b 100644
--- a/openhands/app_server/user/user_router.py
+++ b/openhands/app_server/user/user_router.py
@@ -9,7 +9,7 @@ from openhands.app_server.config import depends_user_context
from openhands.app_server.sandbox.session_auth import validate_session_key
from openhands.app_server.user.user_context import UserContext
from openhands.app_server.user.user_models import UserInfo
-from openhands.server.dependencies import get_dependencies
+from openhands.app_server.utils.dependencies import get_dependencies
_logger = logging.getLogger(__name__)
diff --git a/openhands/server/dependencies.py b/openhands/app_server/utils/dependencies.py
similarity index 61%
rename from openhands/server/dependencies.py
rename to openhands/app_server/utils/dependencies.py
index c4141c7c0b..8ca238a94d 100644
--- a/openhands/server/dependencies.py
+++ b/openhands/app_server/utils/dependencies.py
@@ -1,11 +1,3 @@
-# IMPORTANT: LEGACY V0 CODE - Deprecated since version 1.0.0, scheduled for removal April 1, 2026
-# This file is part of the legacy (V0) implementation of OpenHands and will be removed soon as we complete the migration to V1.
-# OpenHands V1 uses the Software Agent SDK for the agentic core and runs a new application server. Please refer to:
-# - V1 agentic core (SDK): https://github.com/OpenHands/software-agent-sdk
-# - V1 application server (in this repo): openhands/app_server/
-# Unless you are working on deprecation, please avoid extending this legacy file and consult the V1 codepaths above.
-# Tag: Legacy-V0
-# This module belongs to the old V0 web server. The V1 application server lives under openhands/app_server/.
import os
from fastapi import Depends, HTTPException, status
diff --git a/openhands/app_server/v1_router.py b/openhands/app_server/v1_router.py
index 4c18ef6932..4cda2d9214 100644
--- a/openhands/app_server/v1_router.py
+++ b/openhands/app_server/v1_router.py
@@ -9,6 +9,9 @@ from openhands.app_server.pending_messages.pending_message_router import (
router as pending_message_router,
)
from openhands.app_server.sandbox import sandbox_router, sandbox_spec_router
+from openhands.app_server.settings.settings_router import (
+ router as settings_router,
+)
from openhands.app_server.user import skills_router, user_router
from openhands.app_server.web_client import web_client_router
@@ -19,6 +22,7 @@ router.include_router(app_conversation_router.router)
router.include_router(pending_message_router)
router.include_router(sandbox_router.router)
router.include_router(sandbox_spec_router.router)
+router.include_router(settings_router)
router.include_router(user_router.router)
router.include_router(skills_router.router)
router.include_router(webhook_router.router)
diff --git a/openhands/server/routes/conversation.py b/openhands/server/routes/conversation.py
index a44a3ca221..5dd3970efe 100644
--- a/openhands/server/routes/conversation.py
+++ b/openhands/server/routes/conversation.py
@@ -19,6 +19,7 @@ from openhands.app_server.app_conversation.app_conversation_models import (
AppConversationInfo,
)
from openhands.app_server.config import depends_app_conversation_info_service
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.core.logger import openhands_logger as logger
from openhands.events.action.message import MessageAction
from openhands.events.event_filter import EventFilter
@@ -27,7 +28,6 @@ from openhands.events.serialization.event import event_to_dict
from openhands.memory.memory import Memory
from openhands.microagent.types import InputMetadata
from openhands.runtime.base import Runtime
-from openhands.server.dependencies import get_dependencies
from openhands.server.session.conversation import ServerConversation
from openhands.server.shared import conversation_manager, file_store
from openhands.server.user_auth import get_user_id
diff --git a/openhands/server/routes/feedback.py b/openhands/server/routes/feedback.py
index 30a243eb56..468ff03c61 100644
--- a/openhands/server/routes/feedback.py
+++ b/openhands/server/routes/feedback.py
@@ -9,12 +9,12 @@
from fastapi import APIRouter, Depends, Request, status
from fastapi.responses import JSONResponse
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.core.logger import openhands_logger as logger
from openhands.events.async_event_store_wrapper import AsyncEventStoreWrapper
from openhands.events.event_filter import EventFilter
from openhands.events.serialization import event_to_dict
from openhands.server.data_models.feedback import FeedbackDataModel, store_feedback
-from openhands.server.dependencies import get_dependencies
from openhands.server.session.conversation import ServerConversation
from openhands.server.utils import get_conversation
from openhands.utils.async_utils import call_sync_from_async
diff --git a/openhands/server/routes/files.py b/openhands/server/routes/files.py
index 403a65cfca..bbe17ef769 100644
--- a/openhands/server/routes/files.py
+++ b/openhands/server/routes/files.py
@@ -14,10 +14,10 @@ from fastapi import APIRouter, Depends, HTTPException, UploadFile, status
from fastapi.responses import FileResponse, JSONResponse
from starlette.background import BackgroundTask
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.core.exceptions import AgentRuntimeUnavailableError
from openhands.core.logger import openhands_logger as logger
from openhands.runtime.base import Runtime
-from openhands.server.dependencies import get_dependencies
from openhands.server.file_config import FILES_TO_IGNORE
from openhands.server.files import POSTUploadFilesModel
from openhands.server.session.conversation import ServerConversation
diff --git a/openhands/server/routes/git.py b/openhands/server/routes/git.py
index 411d90ba79..bce73549fb 100644
--- a/openhands/server/routes/git.py
+++ b/openhands/server/routes/git.py
@@ -13,6 +13,7 @@ from fastapi import APIRouter, Depends, Query, status
from fastapi.responses import JSONResponse
from pydantic import SecretStr
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.core.logger import openhands_logger as logger
from openhands.integrations.provider import (
PROVIDER_TOKEN_TYPE,
@@ -32,7 +33,6 @@ from openhands.microagent.types import (
MicroagentContentResponse,
MicroagentResponse,
)
-from openhands.server.dependencies import get_dependencies
from openhands.server.shared import server_config
from openhands.server.user_auth import (
get_access_token,
diff --git a/openhands/server/routes/manage_conversations.py b/openhands/server/routes/manage_conversations.py
index 19b87884aa..7f464845b2 100644
--- a/openhands/server/routes/manage_conversations.py
+++ b/openhands/server/routes/manage_conversations.py
@@ -47,6 +47,7 @@ from openhands.app_server.services.db_session_injector import set_db_session_kee
from openhands.app_server.services.httpx_client_injector import (
set_httpx_client_keep_open,
)
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.core.config.llm_config import LLMConfig
from openhands.core.config.mcp_config import MCPConfig
from openhands.core.logger import openhands_logger as logger
@@ -77,7 +78,6 @@ from openhands.server.data_models.conversation_info import ConversationInfo
from openhands.server.data_models.conversation_info_result_set import (
ConversationInfoResultSet,
)
-from openhands.server.dependencies import get_dependencies
from openhands.server.services.conversation_service import (
create_new_conversation,
setup_init_conversation_settings,
diff --git a/openhands/server/routes/public.py b/openhands/server/routes/public.py
index 0b3fa72150..49dab2f36c 100644
--- a/openhands/server/routes/public.py
+++ b/openhands/server/routes/public.py
@@ -11,9 +11,9 @@ from typing import Any
from fastapi import APIRouter, Depends, Request
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.controller.agent import Agent
from openhands.security.options import SecurityAnalyzers
-from openhands.server.dependencies import get_dependencies
from openhands.server.shared import config, server_config
from openhands.utils.llm import ModelsResponse, get_supported_llm_models
diff --git a/openhands/server/routes/secrets.py b/openhands/server/routes/secrets.py
index 033471cc6b..936ff9cf31 100644
--- a/openhands/server/routes/secrets.py
+++ b/openhands/server/routes/secrets.py
@@ -9,11 +9,11 @@
from fastapi import APIRouter, Depends, status
from fastapi.responses import JSONResponse
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.core.logger import openhands_logger as logger
from openhands.integrations.provider import PROVIDER_TOKEN_TYPE, CustomSecret
from openhands.integrations.service_types import ProviderType
from openhands.integrations.utils import validate_provider_token
-from openhands.server.dependencies import get_dependencies
from openhands.server.settings import (
CustomSecretModel,
CustomSecretWithoutValueModel,
diff --git a/openhands/server/routes/security.py b/openhands/server/routes/security.py
index 5ff1bfdd70..ea9eb8a565 100644
--- a/openhands/server/routes/security.py
+++ b/openhands/server/routes/security.py
@@ -15,7 +15,7 @@ from fastapi import (
status,
)
-from openhands.server.dependencies import get_dependencies
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.server.session.conversation import ServerConversation
from openhands.server.utils import get_conversation
diff --git a/openhands/server/routes/settings.py b/openhands/server/routes/settings.py
index 9562df1cc1..f53d978269 100644
--- a/openhands/server/routes/settings.py
+++ b/openhands/server/routes/settings.py
@@ -8,20 +8,22 @@
# This module belongs to the old V0 web server. The V1 application server lives under openhands/app_server/.
import os
-from fastapi import APIRouter, Depends, status
+from fastapi import APIRouter, Depends
from fastapi.responses import JSONResponse
-from openhands.core.logger import openhands_logger as logger
+from openhands.app_server.settings.settings_router import (
+ load_settings as v1_load_settings,
+)
+from openhands.app_server.settings.settings_router import (
+ store_settings as v1_store_settings,
+)
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.integrations.provider import (
PROVIDER_TOKEN_TYPE,
- ProviderType,
)
-from openhands.server.dependencies import get_dependencies
-from openhands.server.routes.secrets import invalidate_legacy_secrets_store
from openhands.server.settings import (
GETSettingsModel,
)
-from openhands.server.shared import config
from openhands.server.user_auth import (
get_provider_tokens,
get_secrets_store,
@@ -31,7 +33,6 @@ from openhands.server.user_auth import (
from openhands.storage.data_models.settings import Settings
from openhands.storage.secrets.secrets_store import SecretsStore
from openhands.storage.settings.settings_store import SettingsStore
-from openhands.utils.llm import get_provider_api_base, is_openhands_model
LITE_LLM_API_URL = os.environ.get(
'LITE_LLM_API_URL', 'https://llm-proxy.app.all-hands.dev'
@@ -47,6 +48,7 @@ app = APIRouter(prefix='/api', dependencies=get_dependencies())
404: {'description': 'Settings not found', 'model': dict},
401: {'description': 'Invalid token', 'model': dict},
},
+ deprecated=True,
)
async def load_settings(
provider_tokens: PROVIDER_TOKEN_TYPE | None = Depends(get_provider_tokens),
@@ -54,110 +56,11 @@ async def load_settings(
settings: Settings = Depends(get_user_settings),
secrets_store: SecretsStore = Depends(get_secrets_store),
) -> GETSettingsModel | JSONResponse:
- try:
- if not settings:
- return JSONResponse(
- status_code=status.HTTP_404_NOT_FOUND,
- content={'error': 'Settings not found'},
- )
-
- # On initial load, user secrets may not be populated with values migrated from settings store
- user_secrets = await invalidate_legacy_secrets_store(
- settings, settings_store, secrets_store
- )
-
- # If invalidation is successful, then the returned user secrets holds the most recent values
- git_providers = (
- user_secrets.provider_tokens if user_secrets else provider_tokens
- )
-
- provider_tokens_set: dict[ProviderType, str | None] = {}
- if git_providers:
- for provider_type, provider_token in git_providers.items():
- if provider_token.token or provider_token.user_id:
- provider_tokens_set[provider_type] = provider_token.host
-
- settings_with_token_data = GETSettingsModel(
- **settings.model_dump(exclude={'secrets_store'}),
- llm_api_key_set=settings.llm_api_key is not None
- and bool(settings.llm_api_key),
- search_api_key_set=settings.search_api_key is not None
- and bool(settings.search_api_key),
- provider_tokens_set=provider_tokens_set,
- )
+ return await v1_load_settings(
+ provider_tokens, settings_store, settings, secrets_store
+ )
- # If the base url matches the default for the provider, we don't send it
- # So that the frontend can display basic mode
- if is_openhands_model(settings.llm_model):
- if settings.llm_base_url == LITE_LLM_API_URL:
- settings_with_token_data.llm_base_url = None
- elif settings.llm_model and settings.llm_base_url == get_provider_api_base(
- settings.llm_model
- ):
- settings_with_token_data.llm_base_url = None
- settings_with_token_data.llm_api_key = None
- settings_with_token_data.search_api_key = None
- settings_with_token_data.sandbox_api_key = None
- return settings_with_token_data
- except Exception as e:
- logger.warning(f'Invalid token: {e}')
- # Get user_id from settings if available
- user_id = getattr(settings, 'user_id', 'unknown') if settings else 'unknown'
- logger.info(
- f'Returning 401 Unauthorized - Invalid token for user_id: {user_id}'
- )
- return JSONResponse(
- status_code=status.HTTP_401_UNAUTHORIZED,
- content={'error': 'Invalid token'},
- )
-
-
-async def store_llm_settings(
- settings: Settings, existing_settings: Settings
-) -> Settings:
- # Convert to Settings model and merge with existing settings
- if existing_settings:
- # Keep existing LLM settings if not provided
- if settings.llm_api_key is None:
- settings.llm_api_key = existing_settings.llm_api_key
- if settings.llm_model is None:
- settings.llm_model = existing_settings.llm_model
- if settings.llm_base_url is None:
- # Not provided at all (e.g. MCP config save) - preserve existing or auto-detect
- if existing_settings.llm_base_url:
- settings.llm_base_url = existing_settings.llm_base_url
- elif is_openhands_model(settings.llm_model):
- # OpenHands models use the LiteLLM proxy
- settings.llm_base_url = LITE_LLM_API_URL
- elif settings.llm_model:
- # For non-openhands models, try to get URL from litellm
- try:
- api_base = get_provider_api_base(settings.llm_model)
- if api_base:
- settings.llm_base_url = api_base
- else:
- logger.debug(
- f'No api_base found in litellm for model: {settings.llm_model}'
- )
- except Exception as e:
- logger.error(
- f'Failed to get api_base from litellm for model {settings.llm_model}: {e}'
- )
- elif settings.llm_base_url == '':
- # Explicitly cleared by the user (basic view save or advanced view clear)
- settings.llm_base_url = None
- # Keep search API key if missing or empty
- if not settings.search_api_key:
- settings.search_api_key = existing_settings.search_api_key
-
- return settings
-
-
-# NOTE: We use response_model=None for endpoints that return JSONResponse directly.
-# This is because FastAPI's response_model expects a Pydantic model, but we're returning
-# a response object directly. We document the possible responses using the 'responses'
-# parameter and maintain proper type annotations for mypy.
@app.post(
'/settings',
response_model=None,
@@ -165,79 +68,10 @@ async def store_llm_settings(
200: {'description': 'Settings stored successfully', 'model': dict},
500: {'description': 'Error storing settings', 'model': dict},
},
+ deprecated=True,
)
async def store_settings(
settings: Settings,
settings_store: SettingsStore = Depends(get_user_settings_store),
) -> JSONResponse:
- # Check provider tokens are valid
- try:
- existing_settings = await settings_store.load()
-
- # Convert to Settings model and merge with existing settings
- if existing_settings:
- settings = await store_llm_settings(settings, existing_settings)
-
- # Keep existing analytics consent if not provided
- if settings.user_consents_to_analytics is None:
- settings.user_consents_to_analytics = (
- existing_settings.user_consents_to_analytics
- )
-
- # Keep existing disabled_skills if not provided
- if settings.disabled_skills is None:
- settings.disabled_skills = existing_settings.disabled_skills
-
- # Update sandbox config with new settings
- if settings.remote_runtime_resource_factor is not None:
- config.sandbox.remote_runtime_resource_factor = (
- settings.remote_runtime_resource_factor
- )
-
- # Update git configuration with new settings
- git_config_updated = False
- if settings.git_user_name is not None:
- config.git_user_name = settings.git_user_name
- git_config_updated = True
- if settings.git_user_email is not None:
- config.git_user_email = settings.git_user_email
- git_config_updated = True
-
- # Note: Git configuration will be applied when new sessions are initialized
- # Existing sessions will continue with their current git configuration
- if git_config_updated:
- logger.info(
- f'Updated global git configuration: name={config.git_user_name}, email={config.git_user_email}'
- )
-
- settings = convert_to_settings(settings)
- await settings_store.store(settings)
- return JSONResponse(
- status_code=status.HTTP_200_OK,
- content={'message': 'Settings stored'},
- )
- except Exception as e:
- logger.warning(f'Something went wrong storing settings: {e}')
- return JSONResponse(
- status_code=status.HTTP_500_INTERNAL_SERVER_ERROR,
- content={'error': 'Something went wrong storing settings'},
- )
-
-
-def convert_to_settings(settings_with_token_data: Settings) -> Settings:
- settings_data = settings_with_token_data.model_dump()
-
- # Filter out additional fields from `SettingsWithTokenData`
- filtered_settings_data = {
- key: value
- for key, value in settings_data.items()
- if key in Settings.model_fields # Ensures only `Settings` fields are included
- }
-
- # Convert the API keys to `SecretStr` instances
- filtered_settings_data['llm_api_key'] = settings_with_token_data.llm_api_key
- filtered_settings_data['search_api_key'] = settings_with_token_data.search_api_key
-
- # Create a new Settings instance
- settings = Settings(**filtered_settings_data)
- return settings
+ return await v1_store_settings(settings, settings_store)
diff --git a/openhands/server/routes/trajectory.py b/openhands/server/routes/trajectory.py
index 047a9e5dfd..6fd8685fdc 100644
--- a/openhands/server/routes/trajectory.py
+++ b/openhands/server/routes/trajectory.py
@@ -9,12 +9,12 @@
from fastapi import APIRouter, Depends, status
from fastapi.responses import JSONResponse
+from openhands.app_server.utils.dependencies import get_dependencies
from openhands.core.logger import openhands_logger as logger
from openhands.events.async_event_store_wrapper import AsyncEventStoreWrapper
from openhands.events.event_filter import EventFilter
from openhands.events.event_store import EventStore
from openhands.events.serialization import event_to_trajectory
-from openhands.server.dependencies import get_dependencies
from openhands.server.shared import file_store
from openhands.server.utils import get_conversation_metadata
from openhands.storage.data_models.conversation_metadata import ConversationMetadata
diff --git a/tests/unit/app_server/test_event_router.py b/tests/unit/app_server/test_event_router.py
index a3b94dd0ff..e5abfeb25c 100644
--- a/tests/unit/app_server/test_event_router.py
+++ b/tests/unit/app_server/test_event_router.py
@@ -12,7 +12,7 @@ from fastapi import FastAPI, HTTPException, status
from fastapi.testclient import TestClient
from openhands.app_server.event.event_router import batch_get_events, router
-from openhands.server.dependencies import check_session_api_key
+from openhands.app_server.utils.dependencies import check_session_api_key
def _make_mock_event_service(search_return=None, batch_get_return=None):
diff --git a/tests/unit/app_server/test_sandbox_secrets_router.py b/tests/unit/app_server/test_sandbox_secrets_router.py
index 5976098bc1..5d9543f34e 100644
--- a/tests/unit/app_server/test_sandbox_secrets_router.py
+++ b/tests/unit/app_server/test_sandbox_secrets_router.py
@@ -413,7 +413,7 @@ def _build_integration_test_app(
router as sandbox_router,
)
from openhands.app_server.user.user_router import router as user_router
- from openhands.server.dependencies import check_session_api_key
+ from openhands.app_server.utils.dependencies import check_session_api_key
app = FastAPI()
diff --git a/tests/unit/server/routes/test_settings_api.py b/tests/unit/app_server/test_settings_api.py
similarity index 86%
rename from tests/unit/server/routes/test_settings_api.py
rename to tests/unit/app_server/test_settings_api.py
index f812f04467..7c9b91ac19 100644
--- a/tests/unit/server/routes/test_settings_api.py
+++ b/tests/unit/app_server/test_settings_api.py
@@ -65,7 +65,7 @@ def test_client():
# Create a test client
with (
patch.dict(os.environ, {'SESSION_API_KEY': ''}, clear=False),
- patch('openhands.server.dependencies._SESSION_API_KEY', None),
+ patch('openhands.app_server.utils.dependencies._SESSION_API_KEY', None),
patch(
'openhands.server.user_auth.user_auth.UserAuth.get_instance',
return_value=MockUserAuth(),
@@ -96,13 +96,13 @@ async def test_settings_api_endpoints(test_client):
}
# Make the POST request to store settings
- response = test_client.post('/api/settings', json=settings_data)
+ response = test_client.post('/api/v1/settings', json=settings_data)
# We're not checking the exact response, just that it doesn't error
assert response.status_code == 200
# Test the GET settings endpoint
- response = test_client.get('/api/settings')
+ response = test_client.get('/api/v1/settings')
assert response.status_code == 200
# Test updating with partial settings
@@ -112,7 +112,7 @@ async def test_settings_api_endpoints(test_client):
'llm_api_key': None, # Should preserve existing value
}
- response = test_client.post('/api/settings', json=partial_settings)
+ response = test_client.post('/api/v1/settings', json=partial_settings)
assert response.status_code == 200
# Test the unset-provider-tokens endpoint
@@ -128,11 +128,11 @@ async def test_search_api_key_preservation(test_client):
'search_api_key': 'initial-secret-key',
'llm_model': 'gpt-4',
}
- response = test_client.post('/api/settings', json=initial_settings)
+ response = test_client.post('/api/v1/settings', json=initial_settings)
assert response.status_code == 200
# Verify key is set
- response = test_client.get('/api/settings')
+ response = test_client.get('/api/v1/settings')
assert response.status_code == 200
assert response.json()['search_api_key_set'] is True
@@ -142,11 +142,11 @@ async def test_search_api_key_preservation(test_client):
'search_api_key': '', # The frontend sends an empty string here
'llm_model': 'claude-3-opus',
}
- response = test_client.post('/api/settings', json=update_settings)
+ response = test_client.post('/api/v1/settings', json=update_settings)
assert response.status_code == 200
# 3. Verify the key was NOT wiped out (The Critical Check)
- response = test_client.get('/api/settings')
+ response = test_client.get('/api/v1/settings')
assert response.status_code == 200
# If the bug was present, this would be False
assert response.json()['search_api_key_set'] is True
@@ -163,11 +163,11 @@ async def test_disabled_skills_persistence(test_client):
'llm_api_key': 'test-key',
'disabled_skills': ['skill_a', 'skill_b'],
}
- response = test_client.post('/api/settings', json=settings_data)
+ response = test_client.post('/api/v1/settings', json=settings_data)
assert response.status_code == 200
# 2. Retrieve and verify
- response = test_client.get('/api/settings')
+ response = test_client.get('/api/v1/settings')
assert response.status_code == 200
data = response.json()
assert data['disabled_skills'] == ['skill_a', 'skill_b']
@@ -176,10 +176,10 @@ async def test_disabled_skills_persistence(test_client):
update_settings = {
'disabled_skills': ['skill_c'],
}
- response = test_client.post('/api/settings', json=update_settings)
+ response = test_client.post('/api/v1/settings', json=update_settings)
assert response.status_code == 200
- response = test_client.get('/api/settings')
+ response = test_client.get('/api/v1/settings')
assert response.status_code == 200
data = response.json()
assert data['disabled_skills'] == ['skill_c']
@@ -188,10 +188,10 @@ async def test_disabled_skills_persistence(test_client):
update_settings = {
'disabled_skills': [],
}
- response = test_client.post('/api/settings', json=update_settings)
+ response = test_client.post('/api/v1/settings', json=update_settings)
assert response.status_code == 200
- response = test_client.get('/api/settings')
+ response = test_client.get('/api/v1/settings')
assert response.status_code == 200
data = response.json()
assert data['disabled_skills'] == []
diff --git a/tests/unit/server/routes/test_get_repository_microagents.py b/tests/unit/server/routes/test_get_repository_microagents.py
index b68931d983..98084f2fef 100644
--- a/tests/unit/server/routes/test_get_repository_microagents.py
+++ b/tests/unit/server/routes/test_get_repository_microagents.py
@@ -9,13 +9,13 @@ from fastapi.testclient import TestClient
from httpcore import Request
from pydantic import SecretStr
+from openhands.app_server.utils.dependencies import check_session_api_key
from openhands.integrations.provider import ProviderToken, ProviderType
from openhands.integrations.service_types import (
AuthenticationError,
Repository,
)
from openhands.microagent.types import MicroagentContentResponse
-from openhands.server.dependencies import check_session_api_key
from openhands.server.routes.git import app as git_app
from openhands.server.user_auth import (
get_access_token,
diff --git a/tests/unit/server/routes/test_secrets_api.py b/tests/unit/server/routes/test_secrets_api.py
index 59c978b05b..b8f8688f6d 100644
--- a/tests/unit/server/routes/test_secrets_api.py
+++ b/tests/unit/server/routes/test_secrets_api.py
@@ -31,7 +31,7 @@ def test_client():
# Mock SESSION_API_KEY to None to disable authentication in tests
with patch.dict(os.environ, {'SESSION_API_KEY': ''}, clear=False):
# Clear the SESSION_API_KEY to disable auth dependency
- with patch('openhands.server.dependencies._SESSION_API_KEY', None):
+ with patch('openhands.app_server.utils.dependencies._SESSION_API_KEY', None):
yield TestClient(app)
diff --git a/tests/unit/server/routes/test_settings_store_functions.py b/tests/unit/server/routes/test_settings_store_functions.py
index 48bc79a280..dedee12faf 100644
--- a/tests/unit/server/routes/test_settings_store_functions.py
+++ b/tests/unit/server/routes/test_settings_store_functions.py
@@ -6,6 +6,7 @@ from fastapi import FastAPI
from fastapi.testclient import TestClient
from pydantic import SecretStr
+from openhands.app_server.settings.settings_router import store_llm_settings
from openhands.core.config.mcp_config import MCPConfig, MCPStdioServerConfig
from openhands.integrations.provider import ProviderToken
from openhands.integrations.service_types import ProviderType
@@ -15,7 +16,6 @@ from openhands.server.routes.secrets import (
from openhands.server.routes.secrets import (
check_provider_tokens,
)
-from openhands.server.routes.settings import store_llm_settings
from openhands.server.settings import POSTProviderModel
from openhands.storage import get_file_store
from openhands.storage.data_models.secrets import Secrets
@@ -39,7 +39,7 @@ def test_client():
with (
patch.dict(os.environ, {'SESSION_API_KEY': ''}, clear=False),
- patch('openhands.server.dependencies._SESSION_API_KEY', None),
+ patch('openhands.app_server.utils.dependencies._SESSION_API_KEY', None),
patch(
'openhands.server.routes.secrets.check_provider_tokens',
AsyncMock(return_value=''),
@@ -339,7 +339,7 @@ async def test_store_llm_settings_litellm_error_logged():
)
# The function should not raise even if litellm fails
- with patch('openhands.server.routes.settings.logger') as mock_logger:
+ with patch('openhands.app_server.settings.settings_router.logger') as mock_logger:
result = await store_llm_settings(settings, existing_settings)
# llm_base_url should remain None since litellm couldn't find the model
diff --git a/tests/unit/server/routes/test_skills_api.py b/tests/unit/server/routes/test_skills_api.py
index 06ac195bcc..e6467d801f 100644
--- a/tests/unit/server/routes/test_skills_api.py
+++ b/tests/unit/server/routes/test_skills_api.py
@@ -65,7 +65,7 @@ class MockUserAuth(UserAuth):
def test_client():
with (
patch.dict(os.environ, {'SESSION_API_KEY': ''}, clear=False),
- patch('openhands.server.dependencies._SESSION_API_KEY', None),
+ patch('openhands.app_server.utils.dependencies._SESSION_API_KEY', None),
patch(
'openhands.server.user_auth.user_auth.UserAuth.get_instance',
return_value=MockUserAuth(),
diff --git a/tests/unit/storage/data_models/test_settings.py b/tests/unit/storage/data_models/test_settings.py
index 621baf1b2c..868eeeda77 100644
--- a/tests/unit/storage/data_models/test_settings.py
+++ b/tests/unit/storage/data_models/test_settings.py
@@ -3,11 +3,11 @@ from unittest.mock import patch
from pydantic import SecretStr
+from openhands.app_server.settings.settings_router import convert_to_settings
from openhands.core.config.llm_config import LLMConfig
from openhands.core.config.openhands_config import OpenHandsConfig
from openhands.core.config.sandbox_config import SandboxConfig
from openhands.core.config.security_config import SecurityConfig
-from openhands.server.routes.settings import convert_to_settings
from openhands.storage.data_models.settings import Settings