π OpenHands: AI-Driven Development
Remove ConversationStore interface and implementations (V1 migration cleanup) (#14147)
Tim O'Farrellc22c03eeb62d
diff --git a/enterprise/integrations/github/github_view.py b/enterprise/integrations/github/github_view.pyindex d481be8a8a..6a64ad67b1 100644--- a/enterprise/integrations/github/github_view.py+++ b/enterprise/integrations/github/github_view.py@@ -152,7 +152,6 @@ class GithubIssue(ResolverViewInterface):)# All conversations use V1 app conversation service- # V1 conversations are stored in a separate table, not in SaasConversationStoreself.conversation_id = uuid4().hexreturn ConversationMetadata(conversation_id=self.conversation_id,diff --git a/enterprise/integrations/gitlab/gitlab_view.py b/enterprise/integrations/gitlab/gitlab_view.pyindex 1d0fc32f57..d4295c3361 100644--- a/enterprise/integrations/gitlab/gitlab_view.py+++ b/enterprise/integrations/gitlab/gitlab_view.py@@ -114,7 +114,6 @@ class GitlabIssue(ResolverViewInterface):)# All conversations use V1 app conversation service- # V1 conversations are stored in a separate table, not in SaasConversationStoreself.conversation_id = uuid4().hexreturn ConversationMetadata(conversation_id=self.conversation_id,diff --git a/enterprise/server/config.py b/enterprise/server/config.pyindex 402eda0bfb..ea24a70981 100644--- a/enterprise/server/config.py+++ b/enterprise/server/config.py@@ -72,9 +72,6 @@ class SaaSServerConfig(ServerConfig):auth_url: str | None = os.environ.get('AUTH_URL')settings_store_class: str = 'storage.saas_settings_store.SaasSettingsStore'secret_store_class: str = 'storage.saas_secrets_store.SaasSecretsStore'- conversation_store_class: str = (- 'storage.saas_conversation_store.SaasConversationStore'- )monitoring_listener_class: str = ('server.saas_monitoring_listener.SaaSMonitoringListener')diff --git a/enterprise/storage/saas_conversation_store.py b/enterprise/storage/saas_conversation_store.pydeleted file mode 100644index 2e4f68ba86..0000000000--- a/enterprise/storage/saas_conversation_store.py+++ /dev/null@@ -1,280 +0,0 @@-from __future__ import annotations--import dataclasses-import logging-from dataclasses import dataclass-from datetime import UTC-from typing import TYPE_CHECKING, Callable, ContextManager-from uuid import UUID--from storage.database import session_maker--if TYPE_CHECKING:- from sqlalchemy.orm import Session-from storage.stored_conversation_metadata import StoredConversationMetadata-from storage.stored_conversation_metadata_saas import StoredConversationMetadataSaas-from storage.user_store import UserStore--from openhands.core.config.openhands_config import OpenHandsConfig-from openhands.integrations.provider import ProviderType-from openhands.storage.conversation.conversation_store import ConversationStore-from openhands.storage.data_models.conversation_metadata import (- ConversationMetadata,- ConversationTrigger,-)-from openhands.storage.data_models.conversation_metadata_result_set import (- ConversationMetadataResultSet,-)-from openhands.utils.async_utils import call_sync_from_async-from openhands.utils.search_utils import offset_to_page_id, page_id_to_offset--logger = logging.getLogger(__name__)---@dataclass-class SaasConversationStore(ConversationStore):- user_id: str- session_maker: Callable[[], ContextManager[Session]]- org_id: UUID | None = None # will be fetched automatically-- def __init__(- self,- user_id: str,- org_id: UUID | None,- session_maker: Callable[[], ContextManager[Session]],- resolver_org_id: UUID | None = None,- ):- self.user_id = user_id- self.org_id = org_id- self.session_maker = session_maker- self.resolver_org_id = resolver_org_id-- def _select_by_id(self, session, conversation_id: str):- # Join StoredConversationMetadata with ConversationMetadataSaas to filter by user/org- query = (- session.query(StoredConversationMetadata)- .join(- StoredConversationMetadataSaas,- StoredConversationMetadata.conversation_id- == StoredConversationMetadataSaas.conversation_id,- )- .filter(StoredConversationMetadataSaas.user_id == UUID(self.user_id))- .filter(StoredConversationMetadata.conversation_id == conversation_id)- .filter(StoredConversationMetadata.conversation_version == 'V0')- )-- if self.org_id is not None:- query = query.filter(StoredConversationMetadataSaas.org_id == self.org_id)-- return query-- def _to_external_model(- self, conversation_metadata: StoredConversationMetadata- ) -> ConversationMetadata:- kwargs = {- c.name: getattr(conversation_metadata, c.name)- for c in StoredConversationMetadata.__table__.columns- }- # TODO: I'm not sure why the timezone is not set on the dates coming back out of the db- kwargs['created_at'] = kwargs['created_at'].replace(tzinfo=UTC)- kwargs['last_updated_at'] = kwargs['last_updated_at'].replace(tzinfo=UTC)- if kwargs['trigger']:- kwargs['trigger'] = ConversationTrigger(kwargs['trigger'])- if kwargs['git_provider'] and isinstance(kwargs['git_provider'], str):- # Convert string to ProviderType enum- kwargs['git_provider'] = ProviderType(kwargs['git_provider'])-- kwargs['user_id'] = self.user_id-- # Remove V1 attributes- kwargs.pop('max_budget_per_task', None)- kwargs.pop('cache_read_tokens', None)- kwargs.pop('cache_write_tokens', None)- kwargs.pop('reasoning_tokens', None)- kwargs.pop('context_window', None)- kwargs.pop('per_turn_token', None)- kwargs.pop('parent_conversation_id', None)- kwargs.pop('public')-- return ConversationMetadata(**kwargs)-- async def save_metadata(self, metadata: ConversationMetadata):- kwargs = dataclasses.asdict(metadata)-- # Remove user_id and org_id from kwargs since they're no longer in StoredConversationMetadata- kwargs.pop('user_id', None)- kwargs.pop('org_id', None)-- # Convert ProviderType enum to string for storage- if kwargs.get('git_provider') is not None:- kwargs['git_provider'] = (- kwargs['git_provider'].value- if hasattr(kwargs['git_provider'], 'value')- else kwargs['git_provider']- )-- stored_metadata = StoredConversationMetadata(**kwargs)-- # Override with resolver org_id if set (from git org claim resolution),- # same pattern as V1's save_app_conversation_info in- # saas_app_conversation_info_injector.py- org_id = self.org_id- if self.resolver_org_id is not None:- org_id = self.resolver_org_id-- def _save_metadata():- with self.session_maker() as session:- # Save the main conversation metadata- session.merge(stored_metadata)-- # Create or update the SaaS metadata record- saas_metadata = (- session.query(StoredConversationMetadataSaas)- .filter(- StoredConversationMetadataSaas.conversation_id- == stored_metadata.conversation_id- )- .first()- )-- if not saas_metadata:- saas_metadata = StoredConversationMetadataSaas(- conversation_id=stored_metadata.conversation_id,- user_id=UUID(self.user_id),- org_id=org_id,- )- session.add(saas_metadata)- else:- # Validate- expected_user_id = UUID(self.user_id)- expected_org_id = org_id-- if saas_metadata.user_id != expected_user_id:- raise ValueError(- f'Existing user_id ({saas_metadata.user_id}) does not match expected value ({expected_user_id}).'- )-- if expected_org_id and saas_metadata.org_id != expected_org_id:- raise ValueError(- f'Existing org_id ({saas_metadata.org_id}) does not match expected value ({expected_org_id}).'- )-- session.commit()-- await call_sync_from_async(_save_metadata)-- async def get_metadata(self, conversation_id: str) -> ConversationMetadata:- def _get_metadata():- with self.session_maker() as session:- conversation_metadata = self._select_by_id(- session, conversation_id- ).first()- if not conversation_metadata:- raise FileNotFoundError(conversation_id)- return self._to_external_model(conversation_metadata)-- return await call_sync_from_async(_get_metadata)-- async def delete_metadata(self, conversation_id: str) -> None:- def _delete_metadata():- with self.session_maker() as session:- saas_record = (- session.query(StoredConversationMetadataSaas)- .filter(- StoredConversationMetadataSaas.conversation_id- == conversation_id,- StoredConversationMetadataSaas.user_id == UUID(self.user_id),- StoredConversationMetadataSaas.org_id == self.org_id,- )- .first()- )-- if saas_record:- # Delete both records, but only if the SaaS one exists- session.query(StoredConversationMetadata).filter(- StoredConversationMetadata.conversation_id == conversation_id,- ).delete()-- session.delete(saas_record)-- session.commit()- else:- # No SaaS record found β skip deleting main metadata- session.rollback()-- await call_sync_from_async(_delete_metadata)-- async def exists(self, conversation_id: str) -> bool:- def _exists():- with self.session_maker() as session:- result = self._select_by_id(session, conversation_id).scalar()- return bool(result)-- return await call_sync_from_async(_exists)-- async def search(- self,- page_id: str | None = None,- limit: int = 20,- ) -> ConversationMetadataResultSet:- offset = page_id_to_offset(page_id)-- def _search():- with self.session_maker() as session:- stored_conversations = (- session.query(StoredConversationMetadata)- .join(- StoredConversationMetadataSaas,- StoredConversationMetadata.conversation_id- == StoredConversationMetadataSaas.conversation_id,- )- .filter(- StoredConversationMetadataSaas.user_id == UUID(self.user_id)- )- .filter(StoredConversationMetadataSaas.org_id == self.org_id)- .filter(StoredConversationMetadata.conversation_version == 'V0')- .order_by(StoredConversationMetadata.created_at.desc())- .offset(offset)- .limit(limit + 1)- .all()- )- conversations = [- self._to_external_model(c) for c in stored_conversations- ]- current_page_size = len(conversations)- next_page_id = offset_to_page_id(- offset + limit, current_page_size > limit- )- return ConversationMetadataResultSet(- conversations[:limit], next_page_id- )-- return await call_sync_from_async(_search)-- @classmethod- async def get_instance(- cls,- config: OpenHandsConfig,- user_id: str, # type: ignore[override]- ) -> ConversationStore:- # Use async version since callers now use asyncio.run_coroutine_threadsafe()- # to dispatch to the main event loop where asyncpg connections work properly.- user = await UserStore.get_user_by_id(user_id)- org_id = user.current_org_id if user else None- return SaasConversationStore(user_id, org_id, session_maker)-- @classmethod- async def get_resolver_instance(- cls,- config: OpenHandsConfig,- user_id: str,- resolver_org_id: UUID | None = None,- ) -> 'SaasConversationStore':- """Get a store for resolver conversations with explicit org routing.-- Unlike get_instance, this accepts a resolver_org_id that overrides- the user's default org when saving conversation metadata.- """- user = await UserStore.get_user_by_id(user_id)- org_id = user.current_org_id if user else None- return SaasConversationStore(user_id, org_id, session_maker, resolver_org_id)diff --git a/enterprise/tests/unit/test_saas_conversation_store.py b/enterprise/tests/unit/test_saas_conversation_store.pydeleted file mode 100644index 38eed9b514..0000000000--- a/enterprise/tests/unit/test_saas_conversation_store.py+++ /dev/null@@ -1,338 +0,0 @@-from datetime import UTC, datetime-from unittest.mock import AsyncMock, MagicMock, patch-from uuid import UUID--import pytest-from storage.saas_conversation_store import SaasConversationStore-from storage.user import User--from openhands.core.config.openhands_config import OpenHandsConfig-from openhands.storage.data_models.conversation_metadata import ConversationMetadata--[email protected](autouse=True)-def mock_call_sync_from_async():- """Replace call_sync_from_async with a direct call"""-- def _direct_call(func):- return func()-- with patch(- 'storage.saas_conversation_store.call_sync_from_async', side_effect=_direct_call- ):- yield--[email protected](autouse=True)-def mock_user_store():- """Mock UserStore.get_user_by_id to return a mock user"""- mock_user = MagicMock(spec=User)- mock_user.current_org_id = UUID('5594c7b6-f959-4b81-92e9-b09c206f5081')-- with patch('storage.user_store.UserStore.get_user_by_id', return_value=mock_user):- yield---async def test_save_and_get(session_maker):- store = SaasConversationStore(- '5594c7b6-f959-4b81-92e9-b09c206f5081',- UUID('5594c7b6-f959-4b81-92e9-b09c206f5081'),- session_maker,- )- metadata = ConversationMetadata(- conversation_id='my-conversation-id',- user_id='5594c7b6-f959-4b81-92e9-b09c206f5081',- selected_repository='my-repo',- selected_branch=None,- created_at=datetime.now(UTC),- last_updated_at=datetime.now(UTC),- accumulated_cost=10.5,- prompt_tokens=1000,- completion_tokens=500,- total_tokens=1500,- )- await store.save_metadata(metadata)- loaded = await store.get_metadata('my-conversation-id')- assert loaded.conversation_id == metadata.conversation_id- assert loaded.selected_repository == metadata.selected_repository- assert loaded.accumulated_cost == metadata.accumulated_cost- assert loaded.prompt_tokens == metadata.prompt_tokens- assert loaded.completion_tokens == metadata.completion_tokens- assert loaded.total_tokens == metadata.total_tokens---async def test_search(session_maker):- store = SaasConversationStore(- '5594c7b6-f959-4b81-92e9-b09c206f5081',- UUID('5594c7b6-f959-4b81-92e9-b09c206f5081'),- session_maker,- )-- # Create test conversations with different timestamps- conversations = [- ConversationMetadata(- conversation_id=f'conv-{i}',- user_id='5594c7b6-f959-4b81-92e9-b09c206f5081',- selected_repository='repo',- selected_branch=None,- created_at=datetime(2024, 1, i + 1, tzinfo=UTC),- last_updated_at=datetime(2024, 1, i + 1, tzinfo=UTC),- )- for i in range(5)- ]-- # Save conversations- for conv in conversations:- await store.save_metadata(conv)-- # Test basic search - should return all valid conversations sorted by created_at- result = await store.search(limit=10)- assert len(result.results) == 5- assert [c.conversation_id for c in result.results] == [- 'conv-4',- 'conv-3',- 'conv-2',- 'conv-1',- 'conv-0',- ]- assert result.next_page_id is None-- # Test pagination- result = await store.search(limit=2)- assert len(result.results) == 2- assert [c.conversation_id for c in result.results] == ['conv-4', 'conv-3']- assert result.next_page_id is not None-- # Test next page- result = await store.search(page_id=result.next_page_id, limit=2)- assert len(result.results) == 2- assert [c.conversation_id for c in result.results] == ['conv-2', 'conv-1']---async def test_delete_metadata(session_maker):- store = SaasConversationStore(- '5594c7b6-f959-4b81-92e9-b09c206f5081',- UUID('5594c7b6-f959-4b81-92e9-b09c206f5081'),- session_maker,- )- metadata = ConversationMetadata(- conversation_id='to-delete',- user_id='5594c7b6-f959-4b81-92e9-b09c206f5081',- selected_repository='repo',- selected_branch=None,- created_at=datetime.now(UTC),- last_updated_at=datetime.now(UTC),- )- await store.save_metadata(metadata)- assert await store.exists('to-delete')-- await store.delete_metadata('to-delete')- with pytest.raises(FileNotFoundError):- await store.get_metadata('to-delete')- assert not await store.exists('to-delete')---async def test_get_nonexistent_metadata(session_maker):- store = SaasConversationStore(- '5594c7b6-f959-4b81-92e9-b09c206f5081',- UUID('5594c7b6-f959-4b81-92e9-b09c206f5081'),- session_maker,- )- with pytest.raises(FileNotFoundError):- await store.get_metadata('nonexistent-id')---async def test_exists(session_maker):- store = SaasConversationStore(- '5594c7b6-f959-4b81-92e9-b09c206f5081',- UUID('5594c7b6-f959-4b81-92e9-b09c206f5081'),- session_maker,- )- metadata = ConversationMetadata(- conversation_id='exists-test',- user_id='5594c7b6-f959-4b81-92e9-b09c206f5081',- selected_repository='repo',- selected_branch='test-branch',- created_at=datetime.now(UTC),- last_updated_at=datetime.now(UTC),- )- assert not await store.exists('exists-test')- await store.save_metadata(metadata)- assert await store.exists('exists-test')---class TestGetInstance:- """Tests for SaasConversationStore.get_instance method.-- The get_instance method uses async UserStore.get_user_by_id because- callers now use asyncio.run_coroutine_threadsafe() to dispatch to the main- event loop where asyncpg connections work properly.- """-- @pytest.mark.asyncio- async def test_get_instance_uses_async_get_user_by_id(self):- """Verify get_instance calls the async get_user_by_id for proper event loop handling."""- # Arrange- user_id = '5594c7b6-f959-4b81-92e9-b09c206f5081'- mock_user = MagicMock(spec=User)- mock_user.current_org_id = UUID(user_id)- mock_config = MagicMock(spec=OpenHandsConfig)-- with patch(- 'storage.saas_conversation_store.UserStore.get_user_by_id',- AsyncMock(return_value=mock_user),- ) as mock_async_get_user, patch(- 'storage.saas_conversation_store.session_maker'- ):- # Act- store = await SaasConversationStore.get_instance(mock_config, user_id)-- # Assert- mock_async_get_user.assert_called_once_with(user_id)- assert store.user_id == user_id- assert store.org_id == mock_user.current_org_id-- @pytest.mark.asyncio- async def test_get_instance_handles_none_user(self):- """Verify get_instance handles case when user is not found."""- # Arrange- user_id = '5594c7b6-f959-4b81-92e9-b09c206f5081'- mock_config = MagicMock(spec=OpenHandsConfig)-- with patch(- 'storage.saas_conversation_store.UserStore.get_user_by_id',- AsyncMock(return_value=None),- ), patch('storage.saas_conversation_store.session_maker'):- # Act- store = await SaasConversationStore.get_instance(mock_config, user_id)-- # Assert- assert store.user_id == user_id- assert store.org_id is None-- @pytest.mark.asyncio- async def test_get_resolver_instance_passes_resolver_org_id(self):- """Verify get_resolver_instance forwards resolver_org_id to the store."""- # Arrange- user_id = '5594c7b6-f959-4b81-92e9-b09c206f5081'- resolver_org_id = UUID('aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa')- mock_user = MagicMock(spec=User)- mock_user.current_org_id = UUID(user_id)- mock_config = MagicMock(spec=OpenHandsConfig)-- with patch(- 'storage.saas_conversation_store.UserStore.get_user_by_id',- AsyncMock(return_value=mock_user),- ), patch('storage.saas_conversation_store.session_maker'):- # Act- store = await SaasConversationStore.get_resolver_instance(- mock_config, user_id, resolver_org_id=resolver_org_id- )-- # Assert- assert store.resolver_org_id == resolver_org_id-- @pytest.mark.asyncio- async def test_get_instance_does_not_have_resolver_org_id(self):- """Verify get_instance does not set resolver_org_id (it's not a resolver path)."""- # Arrange- user_id = '5594c7b6-f959-4b81-92e9-b09c206f5081'- mock_user = MagicMock(spec=User)- mock_user.current_org_id = UUID(user_id)- mock_config = MagicMock(spec=OpenHandsConfig)-- with patch(- 'storage.saas_conversation_store.UserStore.get_user_by_id',- AsyncMock(return_value=mock_user),- ), patch('storage.saas_conversation_store.session_maker'):- # Act- store = await SaasConversationStore.get_instance(mock_config, user_id)-- # Assert- assert store.resolver_org_id is None---class TestResolverOrgIdRouting:- """Tests for resolver_org_id overriding org_id in save_metadata."""-- @pytest.mark.asyncio- async def test_save_metadata_uses_resolver_org_id_over_default(self, session_maker):- """When resolver_org_id is set, save_metadata stores it instead of the default org_id."""- # Arrange- user_id = '5594c7b6-f959-4b81-92e9-b09c206f5081'- default_org_id = UUID('5594c7b6-f959-4b81-92e9-b09c206f5081')- resolver_org_id = UUID('aaaaaaaa-aaaa-aaaa-aaaa-aaaaaaaaaaaa')- store = SaasConversationStore(- user_id, default_org_id, session_maker, resolver_org_id=resolver_org_id- )- metadata = ConversationMetadata(- conversation_id='resolver-routed-conv',- user_id=user_id,- selected_repository='ClaimedOrg/repo',- selected_branch=None,- created_at=datetime.now(UTC),- last_updated_at=datetime.now(UTC),- )-- # Act- await store.save_metadata(metadata)-- # Assert - verify the SaaS metadata record has the resolver org, not the default- from storage.stored_conversation_metadata_saas import (- StoredConversationMetadataSaas,- )-- with session_maker() as session:- saas_record = (- session.query(StoredConversationMetadataSaas)- .filter(- StoredConversationMetadataSaas.conversation_id- == 'resolver-routed-conv'- )- .first()- )- assert saas_record is not None- assert saas_record.org_id == resolver_org_id- assert saas_record.org_id != default_org_id-- @pytest.mark.asyncio- async def test_save_metadata_uses_default_org_when_no_resolver_org(- self, session_maker- ):- """When resolver_org_id is None, save_metadata uses the default org_id."""- # Arrange- user_id = '5594c7b6-f959-4b81-92e9-b09c206f5081'- default_org_id = UUID('5594c7b6-f959-4b81-92e9-b09c206f5081')- store = SaasConversationStore(user_id, default_org_id, session_maker)- metadata = ConversationMetadata(- conversation_id='default-org-conv',- user_id=user_id,- selected_repository='PersonalOrg/repo',- selected_branch=None,- created_at=datetime.now(UTC),- last_updated_at=datetime.now(UTC),- )-- # Act- await store.save_metadata(metadata)-- # Assert- from storage.stored_conversation_metadata_saas import (- StoredConversationMetadataSaas,- )-- with session_maker() as session:- saas_record = (- session.query(StoredConversationMetadataSaas)- .filter(- StoredConversationMetadataSaas.conversation_id == 'default-org-conv'- )- .first()- )- assert saas_record is not None- assert saas_record.org_id == default_org_iddiff --git a/openhands/app_server/utils/import_utils.py b/openhands/app_server/utils/import_utils.pyindex 325416d309..c754ac810b 100644--- a/openhands/app_server/utils/import_utils.py+++ b/openhands/app_server/utils/import_utils.py@@ -70,7 +70,7 @@ def get_impl(cls: type[T], impl_name: str | None) -> type[T]:Common Use Cases:- Server components (ConversationService, UserAuth, etc.)- - Storage implementations (ConversationStore, SettingsStore, etc.)+ - Storage implementations (SettingsStore, SecretsStore, etc.)- Service integrations (GitHub, GitLab, Bitbucket, Azure DevOps services)The implementation is cached to avoid repeated imports of the same class.diff --git a/openhands/server/config/server_config.py b/openhands/server/config/server_config.pyindex b4dd2d66ea..2c1d53df90 100644--- a/openhands/server/config/server_config.py+++ b/openhands/server/config/server_config.py@@ -27,9 +27,6 @@ class ServerConfig(ServerConfigInterface):secret_store_class: str = ('openhands.storage.secrets.file_secrets_store.FileSecretsStore')- conversation_store_class: str = (- 'openhands.storage.conversation.file_conversation_store.FileConversationStore'- )monitoring_listener_class: str = 'openhands.server.monitoring.MonitoringListener'user_auth_class: str = ('openhands.server.user_auth.default_user_auth.DefaultUserAuth'diff --git a/openhands/server/shared.py b/openhands/server/shared.pyindex 78da2c3c83..378cba26ce 100644--- a/openhands/server/shared.py+++ b/openhands/server/shared.py@@ -17,7 +17,6 @@ from openhands.server.config.server_config import ServerConfig, load_server_conffrom openhands.server.monitoring import MonitoringListenerfrom openhands.server.types import ServerConfigInterfacefrom openhands.storage import get_file_store-from openhands.storage.conversation.conversation_store import ConversationStorefrom openhands.storage.files import FileStorefrom openhands.storage.secrets.secrets_store import SecretsStorefrom openhands.storage.settings.settings_store import SettingsStore@@ -66,8 +65,3 @@ monitoring_listener = MonitoringListenerImpl.get_instance(config)SettingsStoreImpl = get_impl(SettingsStore, server_config.settings_store_class)SecretsStoreImpl = get_impl(SecretsStore, server_config.secret_store_class)--ConversationStoreImpl = get_impl(- ConversationStore,- server_config.conversation_store_class,-)diff --git a/openhands/storage/conversation/conversation_store.py b/openhands/storage/conversation/conversation_store.pydeleted file mode 100644index 76059c8263..0000000000--- a/openhands/storage/conversation/conversation_store.py+++ /dev/null@@ -1,71 +0,0 @@-from __future__ import annotations--from abc import ABC, abstractmethod-from typing import Iterable--from openhands.core.config.openhands_config import OpenHandsConfig-from openhands.storage.data_models.conversation_metadata import ConversationMetadata-from openhands.storage.data_models.conversation_metadata_result_set import (- ConversationMetadataResultSet,-)-from openhands.utils.async_utils import wait_all---class ConversationStore(ABC):- """Abstract base class for conversation metadata storage.-- This is an extension point in OpenHands that allows applications to customize how- conversation metadata is stored. Applications can substitute their own implementation by:- 1. Creating a class that inherits from ConversationStore- 2. Implementing all required methods- 3. Setting server_config.conversation_store_class to the fully qualified name of the class-- The class is instantiated via get_impl() in openhands.server.shared.py.-- The implementation may or may not support multiple users depending on the environment.- """-- @abstractmethod- async def save_metadata(self, metadata: ConversationMetadata) -> None:- """Store conversation metadata."""-- @abstractmethod- async def get_metadata(self, conversation_id: str) -> ConversationMetadata:- """Load conversation metadata."""-- async def validate_metadata(self, conversation_id: str, user_id: str) -> bool:- """Validate that conversation belongs to the current user."""- metadata = await self.get_metadata(conversation_id)- if not metadata.user_id or metadata.user_id != user_id:- return False- else:- return True-- @abstractmethod- async def delete_metadata(self, conversation_id: str) -> None:- """Delete conversation metadata."""-- @abstractmethod- async def exists(self, conversation_id: str) -> bool:- """Check if conversation exists."""-- @abstractmethod- async def search(- self,- page_id: str | None = None,- limit: int = 20,- ) -> ConversationMetadataResultSet:- """Search conversations."""-- async def get_all_metadata(- self, conversation_ids: Iterable[str]- ) -> list[ConversationMetadata]:- """Get metadata for multiple conversations in parallel."""- return await wait_all([self.get_metadata(cid) for cid in conversation_ids])-- @classmethod- @abstractmethod- async def get_instance(- cls, config: OpenHandsConfig, user_id: str | None- ) -> ConversationStore:- """Get a store for the user represented by the token given."""diff --git a/openhands/storage/conversation/file_conversation_store.py b/openhands/storage/conversation/file_conversation_store.pydeleted file mode 100644index 5127890a00..0000000000--- a/openhands/storage/conversation/file_conversation_store.py+++ /dev/null@@ -1,122 +0,0 @@-from __future__ import annotations--import json-from dataclasses import dataclass-from pathlib import Path--from pydantic import TypeAdapter--from openhands.core.config.openhands_config import OpenHandsConfig-from openhands.core.logger import openhands_logger as logger-from openhands.storage import get_file_store-from openhands.storage.conversation.conversation_store import ConversationStore-from openhands.storage.data_models.conversation_metadata import ConversationMetadata-from openhands.storage.data_models.conversation_metadata_result_set import (- ConversationMetadataResultSet,-)-from openhands.storage.files import FileStore-from openhands.storage.locations import (- CONVERSATION_BASE_DIR,- get_conversation_metadata_filename,-)-from openhands.utils.async_utils import call_sync_from_async-from openhands.utils.search_utils import offset_to_page_id, page_id_to_offset--conversation_metadata_type_adapter = TypeAdapter(ConversationMetadata)---@dataclass-class FileConversationStore(ConversationStore):- file_store: FileStore-- async def save_metadata(self, metadata: ConversationMetadata) -> None:- json_str = conversation_metadata_type_adapter.dump_json(metadata)- path = self.get_conversation_metadata_filename(metadata.conversation_id)- await call_sync_from_async(self.file_store.write, path, json_str)-- async def get_metadata(self, conversation_id: str) -> ConversationMetadata:- path = self.get_conversation_metadata_filename(conversation_id)- json_str = await call_sync_from_async(self.file_store.read, path)-- # Validate the JSON- json_obj = json.loads(json_str)- if 'created_at' not in json_obj:- raise FileNotFoundError(path)-- # Remove github_user_id if it exists- if 'github_user_id' in json_obj:- json_obj.pop('github_user_id')-- result = conversation_metadata_type_adapter.validate_python(json_obj)- return result-- async def delete_metadata(self, conversation_id: str) -> None:- path = str(- Path(self.get_conversation_metadata_filename(conversation_id)).parent- )- await call_sync_from_async(self.file_store.delete, path)-- async def exists(self, conversation_id: str) -> bool:- path = self.get_conversation_metadata_filename(conversation_id)- try:- await call_sync_from_async(self.file_store.read, path)- return True- except FileNotFoundError:- return False-- async def search(- self,- page_id: str | None = None,- limit: int = 20,- ) -> ConversationMetadataResultSet:- conversations: list[ConversationMetadata] = []- metadata_dir = self.get_conversation_metadata_dir()- try:- conversation_ids = [- Path(path).name- for path in self.file_store.list(metadata_dir)- if not Path(path).name.startswith('.')- ]- except FileNotFoundError:- return ConversationMetadataResultSet([])- num_conversations = len(conversation_ids)- start = page_id_to_offset(page_id)- end = min(limit + start, num_conversations)- conversations = []- for conversation_id in conversation_ids:- try:- conversations.append(await self.get_metadata(conversation_id))- except Exception:- logger.warning(- f'Could not load conversation metadata: {conversation_id}'- )- conversations.sort(key=_sort_key, reverse=True)- conversations = conversations[start:end]- next_page_id = offset_to_page_id(end, end < num_conversations)- return ConversationMetadataResultSet(conversations, next_page_id)-- def get_conversation_metadata_dir(self) -> str:- return CONVERSATION_BASE_DIR-- def get_conversation_metadata_filename(self, conversation_id: str) -> str:- return get_conversation_metadata_filename(conversation_id)-- @classmethod- async def get_instance(- cls, config: OpenHandsConfig, user_id: str | None- ) -> FileConversationStore:- file_store = get_file_store(- file_store_type=config.file_store,- file_store_path=config.file_store_path,- file_store_web_hook_url=config.file_store_web_hook_url,- file_store_web_hook_headers=config.file_store_web_hook_headers,- file_store_web_hook_batch=config.file_store_web_hook_batch,- )- return FileConversationStore(file_store)---def _sort_key(conversation: ConversationMetadata) -> str:- created_at = conversation.created_at- if created_at:- return created_at.isoformat() # YYYY-MM-DDTHH:MM:SS for sorting- return ''diff --git a/openhands/utils/import_utils.py b/openhands/utils/import_utils.pyindex 0b119f9474..0f263d6cb5 100644--- a/openhands/utils/import_utils.py+++ b/openhands/utils/import_utils.py@@ -65,7 +65,7 @@ def get_impl(cls: type[T], impl_name: str | None) -> type[T]:Common Use Cases:- Server components (UserAuth, MonitoringListener, etc.)- - Storage implementations (ConversationStore, SettingsStore, SecretsStore, etc.)+ - Storage implementations (SettingsStore, SecretsStore, etc.)- Service integrations (GitHub, GitLab, Bitbucket, Azure DevOps services)The implementation is cached to avoid repeated imports of the same class.diff --git a/tests/unit/storage/conversation/test_file_conversation_store.py b/tests/unit/storage/conversation/test_file_conversation_store.pydeleted file mode 100644index 8ec3b2c1b8..0000000000--- a/tests/unit/storage/conversation/test_file_conversation_store.py+++ /dev/null@@ -1,202 +0,0 @@-import json--import pytest--from openhands.storage.conversation.file_conversation_store import FileConversationStore-from openhands.storage.data_models.conversation_metadata import ConversationMetadata-from openhands.storage.locations import get_conversation_metadata_filename-from openhands.storage.memory import InMemoryFileStore---async def test_load_store():- store = FileConversationStore(InMemoryFileStore({}))- expected = ConversationMetadata(- conversation_id='some-conversation-id',- user_id='some-user-id',- selected_repository='some-repo',- title="Let's talk about trains",- )- await store.save_metadata(expected)- found = await store.get_metadata('some-conversation-id')- assert expected == found---async def test_load_int_user_id():- store = FileConversationStore(- InMemoryFileStore(- {- get_conversation_metadata_filename('some-conversation-id'): json.dumps(- {- 'conversation_id': 'some-conversation-id',- 'user_id': '67890',- 'selected_repository': 'some-repo',- 'title': "Let's talk about trains",- 'created_at': '2025-01-16T19:51:04.886331Z',- }- )- }- )- )- found = await store.get_metadata('some-conversation-id')- assert found.user_id == '67890'---async def test_search_empty():- store = FileConversationStore(InMemoryFileStore({}))- result = await store.search()- assert len(result.results) == 0- assert result.next_page_id is None---async def test_search_basic():- # Create test data with 3 conversations at different dates- store = FileConversationStore(- InMemoryFileStore(- {- get_conversation_metadata_filename('conv1'): json.dumps(- {- 'conversation_id': 'conv1',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'First conversation',- 'created_at': '2025-01-16T19:51:04Z',- }- ),- get_conversation_metadata_filename('conv2'): json.dumps(- {- 'conversation_id': 'conv2',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'Second conversation',- 'created_at': '2025-01-17T19:51:04Z',- }- ),- get_conversation_metadata_filename('conv3'): json.dumps(- {- 'conversation_id': 'conv3',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'Third conversation',- 'created_at': '2025-01-15T19:51:04Z',- }- ),- }- )- )-- result = await store.search()- assert len(result.results) == 3- # Should be sorted by date, newest first- assert result.results[0].conversation_id == 'conv2'- assert result.results[1].conversation_id == 'conv1'- assert result.results[2].conversation_id == 'conv3'- assert result.next_page_id is None---async def test_search_pagination():- # Create test data with 5 conversations- store = FileConversationStore(- InMemoryFileStore(- {- get_conversation_metadata_filename(f'conv{i}'): json.dumps(- {- 'conversation_id': f'conv{i}',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': f'ServerConversation {i}',- 'created_at': f'2025-01-{15 + i}T19:51:04Z',- }- )- for i in range(1, 6)- }- )- )-- # Test with limit of 2- result = await store.search(limit=2)- assert len(result.results) == 2- assert result.results[0].conversation_id == 'conv5' # newest first- assert result.results[1].conversation_id == 'conv4'- assert result.next_page_id is not None-- # Get next page using the next_page_id- result2 = await store.search(page_id=result.next_page_id, limit=2)- assert len(result2.results) == 2- assert result2.results[0].conversation_id == 'conv3'- assert result2.results[1].conversation_id == 'conv2'- assert result2.next_page_id is not None-- # Get last page- result3 = await store.search(page_id=result2.next_page_id, limit=2)- assert len(result3.results) == 1- assert result3.results[0].conversation_id == 'conv1'- assert result3.next_page_id is None---async def test_search_with_invalid_conversation():- # Test handling of invalid conversation data- store = FileConversationStore(- InMemoryFileStore(- {- get_conversation_metadata_filename('conv1'): json.dumps(- {- 'conversation_id': 'conv1',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'Valid conversation',- 'created_at': '2025-01-16T19:51:04Z',- }- ),- get_conversation_metadata_filename(- 'conv2'- ): 'invalid json', # Invalid conversation- }- )- )-- result = await store.search()- # Should return only the valid conversation- assert len(result.results) == 1- assert result.results[0].conversation_id == 'conv1'- assert result.next_page_id is None---async def test_get_all_metadata():- store = FileConversationStore(- InMemoryFileStore(- {- get_conversation_metadata_filename('conv1'): json.dumps(- {- 'conversation_id': 'conv1',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'First conversation',- 'created_at': '2025-01-16T19:51:04Z',- }- ),- get_conversation_metadata_filename('conv2'): json.dumps(- {- 'conversation_id': 'conv2',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'Second conversation',- 'created_at': '2025-01-17T19:51:04Z',- }- ),- }- )- )-- results = await store.get_all_metadata(['conv1', 'conv2'])- assert len(results) == 2- assert results[0].conversation_id == 'conv1'- assert results[0].title == 'First conversation'- assert results[1].conversation_id == 'conv2'- assert results[1].title == 'Second conversation'diff --git a/tests/unit/utils/test_search_utils.py b/tests/unit/utils/test_search_utils.pyindex 06f315b5f4..0de05ab0cd 100644--- a/tests/unit/utils/test_search_utils.py+++ b/tests/unit/utils/test_search_utils.py@@ -1,13 +1,21 @@-import json+from dataclasses import dataclassimport pytest-from openhands.storage.conversation.file_conversation_store import FileConversationStore-from openhands.storage.locations import get_conversation_metadata_filename-from openhands.storage.memory import InMemoryFileStorefrom openhands.utils.search_utils import iterate, offset_to_page_id, page_id_to_offset+@dataclass+class MockItem:+ id: str+++@dataclass+class MockResultSet:+ results: list[MockItem]+ next_page_id: str | None = None++def test_offset_to_page_id():# Test with has_next=Trueassert bool(offset_to_page_id(10, True))@@ -33,112 +41,47 @@ def test_bidirectional_conversion():@pytest.mark.asyncioasync def test_iterate_empty():- store = FileConversationStore(InMemoryFileStore({}))+ async def mock_search(page_id=None, limit=20):+ return MockResultSet(results=[])+results = []- async for result in iterate(store.search):+ async for result in iterate(mock_search):results.append(result)assert len(results) == 0@pytest.mark.asyncioasync def test_iterate_single_page():- store = FileConversationStore(- InMemoryFileStore(- {- get_conversation_metadata_filename('conv1'): json.dumps(- {- 'conversation_id': 'conv1',- 'github_user_id': '123',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'First conversation',- 'created_at': '2025-01-16T19:51:04Z',- }- ),- get_conversation_metadata_filename('conv2'): json.dumps(- {- 'conversation_id': 'conv2',- 'github_user_id': '123',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'Second conversation',- 'created_at': '2025-01-17T19:51:04Z',- }- ),- }- )- )+ items = [MockItem(id='item1'), MockItem(id='item2')]++ async def mock_search(page_id=None, limit=20):+ return MockResultSet(results=items, next_page_id=None)results = []- async for result in iterate(store.search):+ async for result in iterate(mock_search):results.append(result)assert len(results) == 2- assert results[0].conversation_id == 'conv2' # newest first- assert results[1].conversation_id == 'conv1'+ assert results[0].id == 'item1'+ assert results[1].id == 'item2'@pytest.mark.asyncioasync def test_iterate_multiple_pages():- # Create test data with 5 conversations- store = FileConversationStore(- InMemoryFileStore(- {- get_conversation_metadata_filename(f'conv{i}'): json.dumps(- {- 'conversation_id': f'conv{i}',- 'github_user_id': '123',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': f'ServerConversation {i}',- 'created_at': f'2025-01-{15 + i}T19:51:04Z',- }- )- for i in range(1, 6)- }- )- )-- results = []- async for result in iterate(store.search, limit=2):- results.append(result)-- assert len(results) == 5- # Should be sorted by date, newest first- assert [r.conversation_id for r in results] == [- 'conv5',- 'conv4',- 'conv3',- 'conv2',- 'conv1',- ]+ # Create test data with 5 items split across pages+ all_items = [MockItem(id=f'item{i}') for i in range(1, 6)]--async def test_iterate_with_invalid_conversation():- store = FileConversationStore(- InMemoryFileStore(- {- get_conversation_metadata_filename('conv1'): json.dumps(- {- 'conversation_id': 'conv1',- 'github_user_id': '123',- 'user_id': '123',- 'selected_repository': 'repo1',- 'title': 'Valid conversation',- 'created_at': '2025-01-16T19:51:04Z',- }- ),- get_conversation_metadata_filename(- 'conv2'- ): 'invalid json', # Invalid conversation- }- )- )+ async def mock_search(page_id=None, limit=2):+ offset = page_id_to_offset(page_id)+ end = min(offset + limit, len(all_items))+ items = all_items[offset:end]+ has_next = end < len(all_items)+ next_page = offset_to_page_id(end, has_next)+ return MockResultSet(results=items, next_page_id=next_page)results = []- async for result in iterate(store.search):+ async for result in iterate(mock_search, limit=2):results.append(result)- assert len(results) == 1- assert results[0].conversation_id == 'conv1'+ assert len(results) == 5+ assert [r.id for r in results] == ['item1', 'item2', 'item3', 'item4', 'item5']