Skip to content

DeepTutor: Lifelong Personalized Tutoring. https://deeptutor.info/.

8.2 KB
Raw Blame
"""
Structural protocol for session stores.

Both SQLiteSessionStore and PocketBaseSessionStore satisfy this protocol,
allowing the rest of the codebase to be store-agnostic.
"""

from __future__ import annotations

from typing import Any, Protocol, runtime_checkable

# Internal admission fields shared by the store and turn runtime. The runtime
# consumes them before returning a public turn receipt (#1793).
SUBMISSION_REPLAY_FIELD = "_submission_replay"
SUBMISSION_USER_FIELD = "_submission_user_message_id"
SUBMISSION_ASSISTANT_FIELD = "_submission_assistant_message_id"
SUBMISSION_PREVIOUS_TURN_FIELD = "_submission_previous_turn_id"


class ActiveTurnConflict(RuntimeError):
    """A session already owns a turn that has not reached a terminal state.

    Named rather than a bare ``RuntimeError`` so a caller can tell "this
    session is busy" from any other runtime failure without matching on the
    message. Subclasses ``RuntimeError`` because every existing handler
    catches that, and the message is unchanged for the same reason.

    ``turn_id`` is the row that blocks the session, when the store knows it;
    the unique-index race reports the session instead, having lost the race
    to read it.
    """

    def __init__(self, message: str, *, turn_id: str = "") -> None:
        super().__init__(message)
        self.turn_id = turn_id


@runtime_checkable
class SessionRepository(Protocol):
    async def migrate_workspace_preferences(self) -> int: ...

    async def create_session(
        self,
        title: str | None = None,
        session_id: str | None = None,
    ) -> dict[str, Any]: ...

    async def get_session(self, session_id: str) -> dict[str, Any] | None: ...

    async def ensure_session(self, session_id: str | None = None) -> dict[str, Any]: ...

    async def import_legacy_session(
        self,
        session_id: str,
        title: str,
        created_at: float,
        updated_at: float,
        preferences: dict[str, Any],
        messages: list[dict[str, Any]],
    ) -> dict[str, Any]: ...

    async def list_sessions(
        self, limit: int = 50, offset: int = 0, *, workspace_id: str | None = None
    ) -> list[dict[str, Any]]: ...

    async def search_sessions(
        self, query: str, limit: int = 50, offset: int = 0
    ) -> dict[str, Any]: ...

    async def update_session_title(self, session_id: str, title: str) -> bool: ...

    async def soft_delete_session(self, session_id: str) -> bool: ...

    async def restore_session(self, session_id: str) -> bool: ...

    async def hard_delete_session(self, session_id: str) -> bool: ...

    async def list_deleted_sessions(
        self, limit: int = 50, offset: int = 0
    ) -> list[dict[str, Any]]: ...

    async def delete_session(self, session_id: str) -> bool: ...


@runtime_checkable
class TurnRepository(Protocol):
    async def begin_turn(
        self,
        session_id: str,
        capability: str = "",
        *,
        turn_id: str | None = None,
        owner_id: str = "",
        fencing_token: int = 0,
    ) -> dict[str, Any]: ...

    async def get_turn(self, turn_id: str) -> dict[str, Any] | None: ...

    async def get_active_turn(self, session_id: str) -> dict[str, Any] | None: ...

    async def list_active_turns(self, session_id: str) -> list[dict[str, Any]]: ...

    async def list_orphaned_failed_turns(self, session_id: str) -> list[dict[str, Any]]: ...

    async def list_nonterminal_turns(self) -> list[dict[str, Any]]: ...

    async def transition_turn(
        self,
        turn_id: str,
        status: str,
        *,
        expected_status: str | None = None,
        fencing_token: int | None = None,
        error: str = "",
        failure_code: str = "",
        retryable: bool = False,
    ) -> bool: ...

    async def append_events(
        self,
        turn_id: str,
        events: list[dict[str, Any]],
        *,
        fencing_token: int | None = None,
    ) -> list[dict[str, Any]]: ...

    async def get_events(self, turn_id: str, after_seq: int = 0) -> list[dict[str, Any]]: ...


@runtime_checkable
class MessageRepository(Protocol):
    async def usage_records(self, start_at: float, end_at: float) -> list[dict[str, Any]]: ...

    async def add_message(
        self,
        session_id: str,
        role: str,
        content: str,
        capability: str = "",
        events: list[dict[str, Any]] | None = None,
        attachments: list[dict[str, Any]] | None = None,
        metadata: dict[str, Any] | None = None,
        parent_message_id: int | str | None = None,
    ) -> int | str: ...

    async def get_messages(self, session_id: str) -> list[dict[str, Any]]: ...


@runtime_checkable
class SessionStoreProtocol(SessionRepository, TurnRepository, MessageRepository, Protocol):
    async def migrate_workspace_preferences(self) -> int: ...

    async def create_session(
        self,
        title: str | None = None,
        session_id: str | None = None,
    ) -> dict[str, Any]: ...

    async def get_session(self, session_id: str) -> dict[str, Any] | None: ...

    async def ensure_session(
        self,
        session_id: str | None = None,
    ) -> dict[str, Any]: ...

    async def create_turn(self, session_id: str, capability: str = "") -> dict[str, Any]: ...

    async def get_turn(self, turn_id: str) -> dict[str, Any] | None: ...

    async def get_active_turn(self, session_id: str) -> dict[str, Any] | None: ...

    async def list_active_turns(self, session_id: str) -> list[dict[str, Any]]: ...

    async def list_orphaned_failed_turns(self, session_id: str) -> list[dict[str, Any]]: ...

    async def update_turn_status(self, turn_id: str, status: str, error: str = "") -> bool: ...

    async def append_turn_event(self, turn_id: str, event: dict[str, Any]) -> dict[str, Any]: ...

    async def get_turn_events(self, turn_id: str, after_seq: int = 0) -> list[dict[str, Any]]: ...

    async def link_turn_message(self, turn_id: str, assistant_message_id: int | str) -> bool: ...

    async def get_message_trace(
        self,
        session_id: str,
        message_id: int | str,
        after_seq: int = 0,
        limit: int | None = None,
    ) -> dict[str, Any] | None: ...

    async def update_session_title(self, session_id: str, title: str) -> bool: ...

    async def soft_delete_session(self, session_id: str) -> bool: ...

    async def restore_session(self, session_id: str) -> bool: ...

    async def hard_delete_session(self, session_id: str) -> bool: ...

    async def list_deleted_sessions(
        self, limit: int = 50, offset: int = 0
    ) -> list[dict[str, Any]]: ...

    async def delete_session(self, session_id: str) -> bool: ...

    async def add_message(
        self,
        session_id: str,
        role: str,
        content: str,
        capability: str = "",
        events: list[dict[str, Any]] | None = None,
        attachments: list[dict[str, Any]] | None = None,
        metadata: dict[str, Any] | None = None,
        parent_message_id: int | str | None = None,
    ) -> int | str: ...

    async def delete_message(self, message_id: int | str) -> bool: ...

    async def get_last_message(
        self, session_id: str, role: str | None = None
    ) -> dict[str, Any] | None: ...

    async def get_messages(self, session_id: str) -> list[dict[str, Any]]: ...

    async def get_messages_for_context(
        self, session_id: str, leaf_message_id: int | None = None
    ) -> list[dict[str, Any]]: ...

    async def list_sessions(
        self,
        limit: int = 50,
        offset: int = 0,
        *,
        workspace_id: str | None = None,
    ) -> list[dict[str, Any]]: ...

    async def search_sessions(
        self,
        query: str,
        limit: int = 50,
        offset: int = 0,
    ) -> dict[str, Any]: ...

    async def get_session_summaries(
        self,
        session_ids: list[str],
    ) -> list[dict[str, Any]]: ...

    async def update_summary(
        self, session_id: str, summary: str, up_to_msg_id: int | str
    ) -> bool: ...

    async def update_session_preferences(
        self, session_id: str, preferences: dict[str, Any], *, touch: bool = True
    ) -> bool: ...

    async def get_session_with_messages(self, session_id: str) -> dict[str, Any] | None: ...


__all__ = [
    "MessageRepository",
    "SessionRepository",
    "SessionStoreProtocol",
    "TurnRepository",
]