mirror of
https://github.com/OpenHands/OpenHands.git
synced 2025-12-26 05:48:36 +08:00
8074b261d3
Co-authored-by: openhands <openhands@all-hands.dev> Co-authored-by: Rohit Malhotra <rohitvinodmalhotra@gmail.com>
66 lines
2.3 KiB
Python
66 lines
2.3 KiB
Python
from __future__ import annotations
|
|
|
|
from abc import ABC, abstractmethod
|
|
from typing import Iterable
|
|
|
|
from openhands.core.config.app_config import AppConfig
|
|
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):
|
|
"""Storage for conversation metadata. 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, github_user_id: str
|
|
) -> bool:
|
|
"""Validate that conversation belongs to the current user."""
|
|
# TODO: remove github_user_id after transition to Keycloak is complete.
|
|
metadata = await self.get_metadata(conversation_id)
|
|
if (not metadata.user_id and not metadata.github_user_id) or (
|
|
metadata.user_id != user_id and metadata.github_user_id != github_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: AppConfig, user_id: str | None, github_user_id: str | None
|
|
) -> ConversationStore:
|
|
"""Get a store for the user represented by the token given"""
|