Skip to content

πŸ™Œ OpenHands: AI-Driven Development

refactor: remove OpenHandsConfig from settings and secrets stores (#14251)

Tim O'Farrell1a5a06174b63
diff --git a/enterprise/integrations/github/github_view.py b/enterprise/integrations/github/github_view.py
index 9cf3eab97d..b61985f958 100644
--- a/enterprise/integrations/github/github_view.py
+++ b/enterprise/integrations/github/github_view.py
@@ -135,7 +135,7 @@ class GithubIssue(ResolverViewInterface):
async def _get_user_secrets(self):
secrets_store = await SaasSecretsStore.get_instance(
- None, self.user_info.keycloak_user_id
+ self.user_info.keycloak_user_id
)
user_secrets = await secrets_store.load()
diff --git a/enterprise/integrations/gitlab/gitlab_view.py b/enterprise/integrations/gitlab/gitlab_view.py
index b46e4aa510..233fc0d11e 100644
--- a/enterprise/integrations/gitlab/gitlab_view.py
+++ b/enterprise/integrations/gitlab/gitlab_view.py
@@ -97,7 +97,7 @@ class GitlabIssue(ResolverViewInterface):
async def _get_user_secrets(self):
secrets_store = await SaasSecretsStore.get_instance(
- None, self.user_info.keycloak_user_id
+ self.user_info.keycloak_user_id
)
user_secrets = await secrets_store.load()
diff --git a/enterprise/server/auth/saas_user_auth.py b/enterprise/server/auth/saas_user_auth.py
index 04a8a7fbf4..1dabc31d8b 100644
--- a/enterprise/server/auth/saas_user_auth.py
+++ b/enterprise/server/auth/saas_user_auth.py
@@ -20,7 +20,6 @@ from server.auth.authorization import (
)
from server.auth.constants import BITBUCKET_DATA_CENTER_HOST
from server.auth.token_manager import TokenManager
-from server.config import get_config
from server.logger import logger
from server.rate_limit import RateLimiter, create_redis_rate_limiter
from sqlalchemy import delete, select
@@ -153,7 +152,7 @@ class SaasUserAuth(UserAuth):
secrets_store = self.secrets_store
if secrets_store:
return secrets_store
- secrets_store = await SaasSecretsStore.get_instance(None, self.user_id)
+ secrets_store = await SaasSecretsStore.get_instance(self.user_id)
self.secrets_store = secrets_store
return secrets_store
@@ -256,7 +255,7 @@ class SaasUserAuth(UserAuth):
settings_store = self.settings_store
if settings_store:
return settings_store
- settings_store = SaasSettingsStore(self.user_id, get_config())
+ settings_store = SaasSettingsStore(self.user_id)
self.settings_store = settings_store
return settings_store
diff --git a/enterprise/server/auth/token_manager.py b/enterprise/server/auth/token_manager.py
index 74db1c60eb..72473fc49f 100644
--- a/enterprise/server/auth/token_manager.py
+++ b/enterprise/server/auth/token_manager.py
@@ -38,7 +38,6 @@ from server.auth.email_validation import (
matches_base_email,
)
from server.auth.keycloak_manager import get_keycloak_admin, get_keycloak_openid
-from server.config import get_config
from server.logger import logger
from sqlalchemy import String as SQLString
from sqlalchemy import select, type_coerce
@@ -871,7 +870,7 @@ class TokenManager:
return token
async def store_offline_token(self, user_id: str, offline_token: str):
- token_store = await OfflineTokenStore.get_instance(get_config(), user_id)
+ token_store = await OfflineTokenStore.get_instance(user_id)
encrypted_tokens = self.encrypt_payload({'refresh_token': offline_token})
payload = {'tokens': encrypted_tokens}
await token_store.store_token(json.dumps(payload))
@@ -940,7 +939,7 @@ class TokenManager:
return active
async def load_offline_token(self, user_id: str) -> str | None:
- token_store = await OfflineTokenStore.get_instance(get_config(), user_id)
+ token_store = await OfflineTokenStore.get_instance(user_id)
payload = await token_store.load_token()
if not payload:
return None
diff --git a/enterprise/storage/offline_token_store.py b/enterprise/storage/offline_token_store.py
index 72e6aefdc6..76b5783ad6 100644
--- a/enterprise/storage/offline_token_store.py
+++ b/enterprise/storage/offline_token_store.py
@@ -7,13 +7,11 @@ from storage.database import a_session_maker
from storage.stored_offline_token import StoredOfflineToken
from openhands.app_server.utils.logger import openhands_logger as logger
-from openhands.core.config.openhands_config import OpenHandsConfig
@dataclass
class OfflineTokenStore:
user_id: str
- config: OpenHandsConfig
async def store_token(self, offline_token: str) -> None:
"""Store an offline token in the database."""
@@ -52,9 +50,11 @@ class OfflineTokenStore:
@classmethod
async def get_instance(
cls,
- config: OpenHandsConfig,
- user_id: str, # type: ignore[override]
+ user_id: str,
) -> OfflineTokenStore:
- """Get an instance of the OfflineTokenStore."""
+ """Get an instance of the OfflineTokenStore.
+
+ TODO: This method should be replaced with dependency injection.
+ """
logger.debug(f'offline_token_store.get_instance::{user_id}')
- return OfflineTokenStore(user_id, config)
+ return OfflineTokenStore(user_id)
diff --git a/enterprise/storage/saas_secrets_store.py b/enterprise/storage/saas_secrets_store.py
index af213f4019..91d3a2c5ee 100644
--- a/enterprise/storage/saas_secrets_store.py
+++ b/enterprise/storage/saas_secrets_store.py
@@ -119,9 +119,12 @@ class SaasSecretsStore(SecretsStore):
@classmethod
async def get_instance(
cls,
- config: object,
user_id: str, # type: ignore[override]
) -> SaasSecretsStore:
+ """Get a SaasSecretsStore instance for the given user.
+
+ TODO: This method should be replaced with dependency injection.
+ """
logger.debug(f'saas_secrets_store.get_instance::{user_id}')
from storage.encrypt_utils import get_jwt_service
diff --git a/enterprise/storage/saas_settings_store.py b/enterprise/storage/saas_settings_store.py
index 1cdcb43e5c..1a771219f2 100644
--- a/enterprise/storage/saas_settings_store.py
+++ b/enterprise/storage/saas_settings_store.py
@@ -25,13 +25,11 @@ from openhands.app_server.settings.settings_models import Settings
from openhands.app_server.settings.settings_store import SettingsStore
from openhands.app_server.utils.jsonpatch_compat import deep_merge
from openhands.app_server.utils.llm import is_openhands_model
-from openhands.core.config.openhands_config import OpenHandsConfig
@dataclass
class SaasSettingsStore(SettingsStore):
user_id: str
- config: OpenHandsConfig
async def _get_user_settings_by_keycloak_id_async(
self, keycloak_user_id: str, session=None
@@ -297,11 +295,14 @@ class SaasSettingsStore(SettingsStore):
@classmethod
async def get_instance(
cls,
- config: OpenHandsConfig,
user_id: str, # type: ignore[override]
) -> SaasSettingsStore:
+ """Get a SaasSettingsStore instance for the given user.
+
+ TODO: This method should be replaced with dependency injection.
+ """
logger.debug(f'saas_settings_store.get_instance::{user_id}')
- return SaasSettingsStore(user_id, config)
+ return SaasSettingsStore(user_id)
async def _ensure_api_key(
self, item: Settings, org_id: str, openhands_type: bool = False
diff --git a/enterprise/tests/unit/test_offline_token_store.py b/enterprise/tests/unit/test_offline_token_store.py
index 3d4dbe89f7..6110f25ca0 100644
--- a/enterprise/tests/unit/test_offline_token_store.py
+++ b/enterprise/tests/unit/test_offline_token_store.py
@@ -4,19 +4,14 @@ from storage.offline_token_store import OfflineTokenStore
from storage.stored_offline_token import StoredOfflineToken
-def mock_config():
- return None # Not used in tests
-
-
@pytest.mark.asyncio
-async def test_store_token_new_record(async_session_maker, mock_config):
+async def test_store_token_new_record(async_session_maker):
# Setup - inject the test session maker into the store module
import storage.offline_token_store as store_module
store_module.a_session_maker = async_session_maker
- token_store = OfflineTokenStore('test_user_id', mock_config)
+ token_store = OfflineTokenStore('test_user_id')
test_token = 'test_offline_token'
# Execute
@@ -36,13 +31,13 @@ async def test_store_token_new_record(async_session_maker, mock_config):
@pytest.mark.asyncio
-async def test_store_token_existing_record(async_session_maker, mock_config):
+async def test_store_token_existing_record(async_session_maker):
# Setup - inject the test session maker into the store module
import storage.offline_token_store as store_module
store_module.a_session_maker = async_session_maker
- token_store = OfflineTokenStore('test_user_id', mock_config)
+ token_store = OfflineTokenStore('test_user_id')
async with async_session_maker() as session:
session.add(
@@ -70,13 +65,13 @@ async def test_store_token_existing_record(async_session_maker, mock_config):
@pytest.mark.asyncio
-async def test_load_token_existing(async_session_maker, mock_config):
+async def test_load_token_existing(async_session_maker):
# Setup - inject the test session maker into the store module
import storage.offline_token_store as store_module
store_module.a_session_maker = async_session_maker
- token_store = OfflineTokenStore('test_user_id', mock_config)
+ token_store = OfflineTokenStore('test_user_id')
async with async_session_maker() as session:
session.add(
@@ -94,13 +89,13 @@ async def test_load_token_existing(async_session_maker, mock_config):
@pytest.mark.asyncio
-async def test_load_token_not_found(async_session_maker, mock_config):
+async def test_load_token_not_found(async_session_maker):
# Setup - inject the test session maker into the store module
import storage.offline_token_store as store_module
store_module.a_session_maker = async_session_maker
- token_store = OfflineTokenStore('nonexistent_user', mock_config)
+ token_store = OfflineTokenStore('nonexistent_user')
# Execute
result = await token_store.load_token()
@@ -110,12 +105,12 @@ async def test_load_token_not_found(async_session_maker, mock_config):
@pytest.mark.asyncio
-async def test_get_instance(mock_config):
+async def test_get_instance():
# Setup
test_user_id = 'test_user_id'
# Execute
- result = await OfflineTokenStore.get_instance(mock_config, test_user_id)
+ result = await OfflineTokenStore.get_instance(test_user_id)
# Verify
assert isinstance(result, OfflineTokenStore)
diff --git a/enterprise/tests/unit/test_saas_secrets_store.py b/enterprise/tests/unit/test_saas_secrets_store.py
index ba09758e5e..15b9b4316a 100644
--- a/enterprise/tests/unit/test_saas_secrets_store.py
+++ b/enterprise/tests/unit/test_saas_secrets_store.py
@@ -247,7 +247,7 @@ class TestSaasSecretsStore:
async def test_get_instance(self, jwt_svc):
# Test the get_instance class method
with patch('storage.encrypt_utils.get_jwt_service', return_value=jwt_svc):
- store = await SaasSecretsStore.get_instance(None, 'test-user-id')
+ store = await SaasSecretsStore.get_instance('test-user-id')
assert isinstance(store, SaasSecretsStore)
assert store.user_id == 'test-user-id'
assert store._jwt_svc is jwt_svc
diff --git a/enterprise/tests/unit/test_saas_settings_store.py b/enterprise/tests/unit/test_saas_settings_store.py
index 2672819269..711be3398f 100644
--- a/enterprise/tests/unit/test_saas_settings_store.py
+++ b/enterprise/tests/unit/test_saas_settings_store.py
@@ -6,7 +6,6 @@ from pydantic import SecretStr
from openhands.app_server.settings.settings_models import Settings
from openhands.app_server.settings.settings_models import Settings as DataSettings
-from openhands.core.config.openhands_config import OpenHandsConfig
def _agent_value(settings: Settings, key: str):
@@ -73,16 +72,7 @@ with patch('storage.database.a_session_maker'):
from storage.user_settings import UserSettings
-def mock_config():
- config = MagicMock(spec=OpenHandsConfig)
- config.jwt_secret = SecretStr('test_secret')
- config.file_store = 'google_cloud'
- config.file_store_path = 'bucket'
- return config
-
-
-def test_member_settings_persist_full_effective_agent_settings(mock_config):
+def test_member_settings_persist_full_effective_agent_settings():
settings = Settings()
settings.update(
{
@@ -119,8 +109,8 @@ def test_member_settings_persist_full_effective_agent_settings(mock_config):
@pytest.fixture
-def settings_store(async_session_maker, mock_config):
- store = SaasSettingsStore('5594c7b6-f959-4b81-92e9-b09c206f5081', mock_config)
+def settings_store(async_session_maker):
+ store = SaasSettingsStore('5594c7b6-f959-4b81-92e9-b09c206f5081')
store.a_session_maker = async_session_maker
# Patch the load method to read from UserSettings table directly (for testing)
@@ -318,9 +308,9 @@ async def test_encryption(settings_store):
@pytest.mark.asyncio
-async def test_ensure_api_key_keeps_valid_key(mock_config):
+async def test_ensure_api_key_keeps_valid_key():
"""When the existing key is valid, it should be kept unchanged."""
- store = SaasSettingsStore('test-user-id-123', mock_config)
+ store = SaasSettingsStore('test-user-id-123')
existing_key = 'sk-existing-key'
item = _make_settings(model='openhands/gpt-4', api_key=existing_key)
@@ -337,11 +327,9 @@ async def test_ensure_api_key_keeps_valid_key(mock_config):
@pytest.mark.asyncio
-async def test_ensure_api_key_generates_new_key_when_verification_fails(
- mock_config,
-):
+async def test_ensure_api_key_generates_new_key_when_verification_fails():
"""When verification fails, a new key should be generated."""
- store = SaasSettingsStore('test-user-id-123', mock_config)
+ store = SaasSettingsStore('test-user-id-123')
new_key = 'sk-new-key'
item = _make_settings(model='openhands/gpt-4', api_key='sk-invalid-key')
@@ -464,7 +452,7 @@ def org_with_multiple_members_fixture(session_maker):
@pytest.mark.asyncio
async def test_store_updates_org_defaults_and_all_members_for_shared_keys(
- session_maker, async_session_maker, mock_config, org_with_multiple_members_fixture
+ session_maker, async_session_maker, org_with_multiple_members_fixture
):
"""External provider keys should still sync as an org-wide shared snapshot."""
from sqlalchemy import select
@@ -475,7 +463,7 @@ async def test_store_updates_org_defaults_and_all_members_for_shared_keys(
org_id = fixture['org_id']
decrypt_value = fixture['decrypt_value']
- store = SaasSettingsStore(str(fixture['admin_user_id']), mock_config)
+ store = SaasSettingsStore(str(fixture['admin_user_id']))
new_settings = _make_settings(
model='anthropic/claude-sonnet-4',
base_url='https://api.anthropic.com/v1',
@@ -518,7 +506,7 @@ async def test_store_updates_org_defaults_and_all_members_for_shared_keys(
@pytest.mark.asyncio
async def test_store_keeps_openhands_managed_keys_member_specific(
- session_maker, async_session_maker, mock_config, org_with_multiple_members_fixture
+ session_maker, async_session_maker, org_with_multiple_members_fixture
):
"""Managed OpenHands keys should not be copied from one member to everyone else."""
from sqlalchemy import select
@@ -530,7 +518,7 @@ async def test_store_keeps_openhands_managed_keys_member_specific(
admin_user_id = str(fixture['admin_user_id'])
decrypt_value = fixture['decrypt_value']
- store = SaasSettingsStore(admin_user_id, mock_config)
+ store = SaasSettingsStore(admin_user_id)
new_settings = _make_settings(
model='openhands/claude-opus-4-5-20251101',
base_url=LITE_LLM_API_URL,
@@ -588,7 +576,7 @@ async def test_store_keeps_openhands_managed_keys_member_specific(
@pytest.mark.asyncio
async def test_store_saves_mcp_config_in_agent_settings(
- session_maker, async_session_maker, mock_config, org_with_multiple_members_fixture
+ session_maker, async_session_maker, org_with_multiple_members_fixture
):
"""mcp_config now flows through agent_settings / agent_settings_diff,
so it is persisted on both the org and all members."""
@@ -602,7 +590,7 @@ async def test_store_saves_mcp_config_in_agent_settings(
member1_user_id = str(fixture['member1_user_id'])
member2_user_id = str(fixture['member2_user_id'])
- store = SaasSettingsStore(admin_user_id, mock_config)
+ store = SaasSettingsStore(admin_user_id)
user_mcp_config = {
'mcpServers': {
'user1': {'url': 'https://user1-mcp-server.com', 'transport': 'sse'}
@@ -654,7 +642,7 @@ async def test_store_saves_mcp_config_in_agent_settings(
@pytest.mark.asyncio
async def test_store_skips_ensure_api_key_for_non_openhands_model_without_base_url(
- session_maker, async_session_maker, mock_config, org_with_multiple_members_fixture
+ session_maker, async_session_maker, org_with_multiple_members_fixture
):
"""When saving a non-OpenHands model with no base URL (basic view BYOR),
_ensure_api_key should NOT be called, preserving the user's custom API key.
@@ -664,7 +652,7 @@ async def test_store_skips_ensure_api_key_for_non_openhands_model_without_base_u
"""
fixture = org_with_multiple_members_fixture
admin_user_id = str(fixture['admin_user_id'])
- store = SaasSettingsStore(admin_user_id, mock_config)
+ store = SaasSettingsStore(admin_user_id)
settings = _make_settings(
model='openai/gpt-5.2',
@@ -682,12 +670,12 @@ async def test_store_skips_ensure_api_key_for_non_openhands_model_without_base_u
@pytest.mark.asyncio
async def test_store_calls_ensure_api_key_for_openhands_model_without_base_url(
- session_maker, async_session_maker, mock_config, org_with_multiple_members_fixture
+ session_maker, async_session_maker, org_with_multiple_members_fixture
):
"""OpenHands models still require proxy-key verification without a base URL."""
fixture = org_with_multiple_members_fixture
admin_user_id = str(fixture['admin_user_id'])
- store = SaasSettingsStore(admin_user_id, mock_config)
+ store = SaasSettingsStore(admin_user_id)
settings = _make_settings(
model='openhands/claude-opus-4-5-20251101',
@@ -705,12 +693,12 @@ async def test_store_calls_ensure_api_key_for_openhands_model_without_base_url(
@pytest.mark.asyncio
async def test_store_calls_ensure_api_key_when_base_url_is_litellm_proxy(
- session_maker, async_session_maker, mock_config, org_with_multiple_members_fixture
+ session_maker, async_session_maker, org_with_multiple_members_fixture
):
"""Explicit LiteLLM proxy usage should always verify/generate the API key."""
fixture = org_with_multiple_members_fixture
admin_user_id = str(fixture['admin_user_id'])
- store = SaasSettingsStore(admin_user_id, mock_config)
+ store = SaasSettingsStore(admin_user_id)
settings = _make_settings(
model='openai/gpt-5.2',
@@ -729,7 +717,7 @@ async def test_store_calls_ensure_api_key_when_base_url_is_litellm_proxy(
@pytest.mark.asyncio
async def test_store_and_load_mcp_config_via_agent_settings(
- async_session_maker, mock_config, org_with_multiple_members_fixture
+ async_session_maker, org_with_multiple_members_fixture
):
"""mcp_config is persisted inside agent_settings / agent_settings_diff and
round-trips correctly through store β†’ load."""
@@ -742,7 +730,7 @@ async def test_store_and_load_mcp_config_via_agent_settings(
},
}
- admin_store = SaasSettingsStore(admin_user_id, mock_config)
+ admin_store = SaasSettingsStore(admin_user_id)
admin_settings = DataSettings()
admin_settings.update(
@@ -778,7 +766,7 @@ async def test_store_and_load_mcp_config_via_agent_settings(
@pytest.mark.asyncio
async def test_store_and_load_llm_profiles_round_trip(
- async_session_maker, mock_config, org_with_multiple_members_fixture
+ async_session_maker, org_with_multiple_members_fixture
):
"""Saved llm_profiles must persist on the User row and round-trip through
store β†’ load. Without the user.llm_profiles column they are silently
@@ -787,7 +775,7 @@ async def test_store_and_load_llm_profiles_round_trip(
fixture = org_with_multiple_members_fixture
admin_user_id = str(fixture['admin_user_id'])
- admin_store = SaasSettingsStore(admin_user_id, mock_config)
+ admin_store = SaasSettingsStore(admin_user_id)
settings = DataSettings()
settings.update(
@@ -846,7 +834,7 @@ async def test_store_and_load_llm_profiles_round_trip(
@pytest.mark.asyncio
async def test_load_with_null_llm_profiles_column_uses_default_factory(
- async_session_maker, mock_config, org_with_multiple_members_fixture
+ async_session_maker, org_with_multiple_members_fixture
):
"""Rows predating the user.llm_profiles column read back as None.
Settings.llm_profiles is non-nullable (default_factory=LLMProfiles), so
@@ -857,7 +845,7 @@ async def test_load_with_null_llm_profiles_column_uses_default_factory(
fixture = org_with_multiple_members_fixture
admin_user_id = fixture['admin_user_id']
- admin_store = SaasSettingsStore(str(admin_user_id), mock_config)
+ admin_store = SaasSettingsStore(str(admin_user_id))
seed_settings = _make_settings(
model='anthropic/claude-sonnet-4-5-20250929',
@@ -887,7 +875,7 @@ async def test_load_with_null_llm_profiles_column_uses_default_factory(
@pytest.mark.asyncio
async def test_llm_profiles_are_encrypted_at_rest(
- async_session_maker, mock_config, org_with_multiple_members_fixture
+ async_session_maker, org_with_multiple_members_fixture
):
"""The raw value in the user.llm_profiles column must be ciphertext, not
a JSON dict β€” profile api_keys would otherwise leak in DB dumps,
@@ -900,7 +888,7 @@ async def test_llm_profiles_are_encrypted_at_rest(
fixture = org_with_multiple_members_fixture
admin_user_id = fixture['admin_user_id']
- admin_store = SaasSettingsStore(str(admin_user_id), mock_config)
+ admin_store = SaasSettingsStore(str(admin_user_id))
settings = DataSettings()
settings.update(
diff --git a/enterprise/tests/unit/test_saas_user_auth.py b/enterprise/tests/unit/test_saas_user_auth.py
index e66349a93a..605f4e7b85 100644
--- a/enterprise/tests/unit/test_saas_user_auth.py
+++ b/enterprise/tests/unit/test_saas_user_auth.py
@@ -77,12 +77,8 @@ def mock_config():
jwt_svc = JwtService(
keys=[EncryptionKey(kid='test', key=SecretStr('test_secret'), active=True)]
)
- with (
- patch('server.auth.saas_user_auth.get_config') as mock_get_config,
- patch('storage.encrypt_utils.get_jwt_service', return_value=jwt_svc),
- ):
- mock_cfg = mock_get_config.return_value
- yield mock_cfg
+ with patch('storage.encrypt_utils.get_jwt_service', return_value=jwt_svc):
+ yield
@pytest.mark.asyncio
@@ -1038,7 +1034,6 @@ class TestOpenHandsApiKey:
patch(
'server.auth.saas_user_auth.SaasSecretsStore'
) as mock_secrets_store_cls,
- patch('server.auth.saas_user_auth.get_config') as mock_get_config,
):
mock_user_store.get_user_by_id = AsyncMock(return_value=mock_user)
@@ -1054,8 +1049,6 @@ class TestOpenHandsApiKey:
return_value=mock_secrets_store
)
- mock_get_config.return_value = MagicMock()
-
# Act
result = await user_auth.get_secrets()
@@ -1096,7 +1089,6 @@ class TestOpenHandsApiKey:
patch(
'server.auth.saas_user_auth.SaasSecretsStore'
) as mock_secrets_store_cls,
- patch('server.auth.saas_user_auth.get_config') as mock_get_config,
):
mock_user_store.get_user_by_id = AsyncMock(return_value=mock_user)
@@ -1112,8 +1104,6 @@ class TestOpenHandsApiKey:
return_value=mock_secrets_store
)
- mock_get_config.return_value = MagicMock()
-
# Act - call get_secrets twice
result1 = await user_auth.get_secrets()
result2 = await user_auth.get_secrets()
@@ -1146,7 +1136,6 @@ class TestOpenHandsApiKey:
patch(
'server.auth.saas_user_auth.SaasSecretsStore'
) as mock_secrets_store_cls,
- patch('server.auth.saas_user_auth.get_config') as mock_get_config,
):
mock_user_store.get_user_by_id = AsyncMock(return_value=mock_user)
@@ -1162,8 +1151,6 @@ class TestOpenHandsApiKey:
return_value=mock_secrets_store
)
- mock_get_config.return_value = MagicMock()
-
# Act
result = await user_auth.get_secrets()
diff --git a/openhands/app_server/config.py b/openhands/app_server/config.py
index b1f4cce517..3188c8dce0 100644
--- a/openhands/app_server/config.py
+++ b/openhands/app_server/config.py
@@ -37,6 +37,8 @@ from openhands.app_server.event_callback.event_callback_service import (
EventCallbackService,
EventCallbackServiceInjector,
)
+from openhands.app_server.file_store.files import FileStore
+from openhands.app_server.file_store.local import LocalFileStore
from openhands.app_server.pending_messages.pending_message_service import (
PendingMessageService,
PendingMessageServiceInjector,
@@ -168,8 +170,14 @@ def _get_default_lifespan():
return OssAppLifespanService()
+def _get_default_file_store() -> FileStore:
+ """Create a default LocalFileStore using the default persistence directory."""
+ return LocalFileStore(root=str(get_default_persistence_dir()))
+
+
class AppServerConfig(OpenHandsModel):
persistence_dir: Path = Field(default_factory=get_default_persistence_dir)
+ file_store: FileStore = Field(default_factory=_get_default_file_store)
web_url: str | None = Field(
default_factory=get_default_web_url,
description='The URL where OpenHands is running (e.g., http://localhost:3000)',
diff --git a/openhands/app_server/secrets/file_secrets_store.py b/openhands/app_server/secrets/file_secrets_store.py
index 277170f60c..b4864c9481 100644
--- a/openhands/app_server/secrets/file_secrets_store.py
+++ b/openhands/app_server/secrets/file_secrets_store.py
@@ -3,12 +3,10 @@ from __future__ import annotations
import json
from dataclasses import dataclass
-from openhands.app_server.file_store import get_file_store
from openhands.app_server.file_store.files import FileStore
from openhands.app_server.secrets.secrets_models import Secrets
from openhands.app_server.secrets.secrets_store import SecretsStore
from openhands.app_server.utils.async_utils import call_sync_from_async
-from openhands.core.config.openhands_config import OpenHandsConfig
@dataclass
@@ -36,11 +34,12 @@ class FileSecretsStore(SecretsStore):
await call_sync_from_async(self.file_store.write, self.path, json_str)
@classmethod
- async def get_instance(
- cls, config: OpenHandsConfig, user_id: str | None
- ) -> FileSecretsStore:
- file_store = get_file_store(
- file_store_type=config.file_store,
- file_store_path=config.file_store_path,
- )
+ async def get_instance(cls, user_id: str | None) -> FileSecretsStore:
+ """Get a FileSecretsStore instance using the global config's file_store.
+
+ TODO: This method should be replaced with dependency injection.
+ """
+ from openhands.app_server.config import get_global_config
+
+ file_store = get_global_config().file_store
return FileSecretsStore(file_store)
diff --git a/openhands/app_server/secrets/secrets_store.py b/openhands/app_server/secrets/secrets_store.py
index 7af1f08727..5ea73354da 100644
--- a/openhands/app_server/secrets/secrets_store.py
+++ b/openhands/app_server/secrets/secrets_store.py
@@ -3,7 +3,6 @@ from __future__ import annotations
from abc import ABC, abstractmethod
from openhands.app_server.secrets.secrets_models import Secrets
-from openhands.core.config.openhands_config import OpenHandsConfig
class SecretsStore(ABC):
@@ -30,7 +29,8 @@ class SecretsStore(ABC):
@classmethod
@abstractmethod
- async def get_instance(
- cls, config: OpenHandsConfig, user_id: str | None
- ) -> SecretsStore:
- """Get a store for the user represented by the token given."""
+ async def get_instance(cls, user_id: str | None) -> SecretsStore:
+ """Get a store for the user represented by the token given.
+
+ TODO: This method should be replaced with dependency injection.
+ """
diff --git a/openhands/app_server/settings/file_settings_store.py b/openhands/app_server/settings/file_settings_store.py
index a40a5936c2..2b17ccf10a 100644
--- a/openhands/app_server/settings/file_settings_store.py
+++ b/openhands/app_server/settings/file_settings_store.py
@@ -3,12 +3,10 @@ from __future__ import annotations
import json
from dataclasses import dataclass
-from openhands.app_server.file_store import get_file_store
from openhands.app_server.file_store.files import FileStore
from openhands.app_server.settings.settings_models import Settings
from openhands.app_server.settings.settings_store import SettingsStore
from openhands.app_server.utils.async_utils import call_sync_from_async
-from openhands.core.config.openhands_config import OpenHandsConfig
@dataclass
@@ -37,11 +35,12 @@ class FileSettingsStore(SettingsStore):
await call_sync_from_async(self.file_store.write, self.path, json_str)
@classmethod
- async def get_instance(
- cls, config: OpenHandsConfig, user_id: str | None
- ) -> FileSettingsStore:
- file_store = get_file_store(
- file_store_type=config.file_store,
- file_store_path=config.file_store_path,
- )
+ async def get_instance(cls, user_id: str | None) -> FileSettingsStore:
+ """Get a FileSettingsStore instance using the global config's file_store.
+
+ TODO: This method should be replaced with dependency injection.
+ """
+ from openhands.app_server.config import get_global_config
+
+ file_store = get_global_config().file_store
return FileSettingsStore(file_store)
diff --git a/openhands/app_server/settings/settings_store.py b/openhands/app_server/settings/settings_store.py
index d240473b41..56d34def93 100644
--- a/openhands/app_server/settings/settings_store.py
+++ b/openhands/app_server/settings/settings_store.py
@@ -3,7 +3,6 @@ from __future__ import annotations
from abc import ABC, abstractmethod
from openhands.app_server.settings.settings_models import Settings
-from openhands.core.config.openhands_config import OpenHandsConfig
class SettingsStore(ABC):
@@ -30,7 +29,8 @@ class SettingsStore(ABC):
@classmethod
@abstractmethod
- async def get_instance(
- cls, config: OpenHandsConfig, user_id: str | None
- ) -> SettingsStore:
- """Get a store for the user represented by the token given."""
+ async def get_instance(cls, user_id: str | None) -> SettingsStore:
+ """Get a store for the user represented by the token given.
+
+ TODO: This method should be replaced with dependency injection.
+ """
diff --git a/openhands/app_server/user_auth/default_user_auth.py b/openhands/app_server/user_auth/default_user_auth.py
index e191cf8017..0709314d45 100644
--- a/openhands/app_server/user_auth/default_user_auth.py
+++ b/openhands/app_server/user_auth/default_user_auth.py
@@ -46,9 +46,7 @@ class DefaultUserAuth(UserAuth):
if settings_store:
return settings_store
user_id = await self.get_user_id()
- settings_store = await shared.SettingsStoreImpl.get_instance(
- shared.config, user_id
- )
+ settings_store = await shared.SettingsStoreImpl.get_instance(user_id)
if settings_store is None:
raise ValueError('Failed to get settings store instance')
self._settings_store = settings_store
@@ -68,9 +66,7 @@ class DefaultUserAuth(UserAuth):
if secrets_store:
return secrets_store
user_id = await self.get_user_id()
- secret_store = await shared.SecretsStoreImpl.get_instance(
- shared.config, user_id
- )
+ secret_store = await shared.SecretsStoreImpl.get_instance(user_id)
if secret_store is None:
raise ValueError('Failed to get secrets store instance')
self._secrets_store = secret_store
diff --git a/tests/unit/storage/settings/test_file_settings_store.py b/tests/unit/storage/settings/test_file_settings_store.py
index a5a387b459..cc68f7bfe7 100644
--- a/tests/unit/storage/settings/test_file_settings_store.py
+++ b/tests/unit/storage/settings/test_file_settings_store.py
@@ -7,7 +7,6 @@ from pydantic import SecretStr
from openhands.app_server.file_store.files import FileStore
from openhands.app_server.settings.file_settings_store import FileSettingsStore
from openhands.app_server.settings.settings_models import Settings
-from openhands.core.config.openhands_config import OpenHandsConfig
from openhands.sdk.llm import LLM
from openhands.sdk.settings import AgentSettings, ConversationSettings
@@ -99,19 +98,15 @@ async def test_store_and_load_data(file_settings_store):
@pytest.mark.asyncio
async def test_get_instance():
- config = OpenHandsConfig(file_store='local', file_store_path='/test/path')
+ mock_store = MagicMock(spec=FileStore)
- with patch(
- 'openhands.app_server.settings.file_settings_store.get_file_store'
- ) as mock_get_store:
- mock_store = MagicMock(spec=FileStore)
- mock_get_store.return_value = mock_store
+ with patch('openhands.app_server.config.get_global_config') as mock_get_config:
+ mock_config = MagicMock()
+ mock_config.file_store = mock_store
+ mock_get_config.return_value = mock_config
- store = await FileSettingsStore.get_instance(config, None)
+ store = await FileSettingsStore.get_instance(None)
assert isinstance(store, FileSettingsStore)
assert store.file_store == mock_store
- mock_get_store.assert_called_once_with(
- file_store_type='local',
- file_store_path='/test/path',
- )
+ mock_get_config.assert_called_once()