Skip to content

πŸ™Œ OpenHands: AI-Driven Development

Filter out ConversationStateUpdateEvent from shared-events endpoints (#13888)

Graham Neubig4f81d2ae7a98
diff --git a/enterprise/server/sharing/shared_event_router.py b/enterprise/server/sharing/shared_event_router.py
index 9ff6abaf67..e986ad682c 100644
--- a/enterprise/server/sharing/shared_event_router.py
+++ b/enterprise/server/sharing/shared_event_router.py
@@ -1,4 +1,12 @@
-"""Shared Event router for OpenHands Server."""
+"""Shared Event router for OpenHands Server.
+
+All endpoints in this router are unauthenticated β€” shared conversations are
+public. To avoid returning internal system state that the viewer does not
+need, ``ConversationStateUpdateEvent`` instances are filtered out before the
+response is sent. The shared-conversation frontend only renders messages,
+actions, observations, errors, and hook-execution events; state snapshots
+are consumed exclusively by the authenticated WebSocket path.
+"""
from datetime import datetime
from typing import Annotated
@@ -13,9 +21,15 @@ from server.sharing.shared_event_service import (
from openhands.agent_server.models import EventPage, EventSortOrder
from openhands.app_server.event_callback.event_callback_models import EventKind
from openhands.sdk import Event
+from openhands.sdk.event.conversation_state import ConversationStateUpdateEvent
from openhands.utils.environment import StorageProvider, get_storage_provider
+def _is_viewable(event: Event) -> bool:
+ """Return True if *event* should be included in public shared responses."""
+ return not isinstance(event, ConversationStateUpdateEvent)
+
+
def get_shared_event_service_injector() -> SharedEventServiceInjector:
"""Get the appropriate SharedEventServiceInjector based on configuration.
@@ -88,7 +102,7 @@ async def search_shared_events(
shared_event_service: SharedEventService = shared_event_service_dependency,
) -> EventPage:
"""Search / List events for a shared conversation."""
- return await shared_event_service.search_shared_events(
+ page = await shared_event_service.search_shared_events(
conversation_id=UUID(conversation_id),
kind__eq=kind__eq,
timestamp__gte=timestamp__gte,
@@ -97,6 +111,10 @@ async def search_shared_events(
page_id=page_id,
limit=limit,
)
+ return EventPage(
+ items=[e for e in page.items if _is_viewable(e)],
+ next_page_id=page.next_page_id,
+ )
@router.get('/count')
@@ -147,7 +165,7 @@ async def batch_get_shared_events(
events = await shared_event_service.batch_get_shared_events(
UUID(conversation_id), event_ids
)
- return events
+ return [e if e is not None and _is_viewable(e) else None for e in events]
@router.get('/{conversation_id}/{event_id}')
@@ -157,6 +175,9 @@ async def get_shared_event(
shared_event_service: SharedEventService = shared_event_service_dependency,
) -> Event | None:
"""Get a single event from a shared conversation by conversation_id and event_id."""
- return await shared_event_service.get_shared_event(
+ event = await shared_event_service.get_shared_event(
UUID(conversation_id), UUID(event_id)
)
+ if event is not None and not _is_viewable(event):
+ return None
+ return event
diff --git a/enterprise/tests/unit/test_sharing/test_shared_event_filtering.py b/enterprise/tests/unit/test_sharing/test_shared_event_filtering.py
new file mode 100644
index 0000000000..b91babcfcb
--- /dev/null
+++ b/enterprise/tests/unit/test_sharing/test_shared_event_filtering.py
@@ -0,0 +1,190 @@
+"""Tests for ConversationStateUpdateEvent filtering in shared_event_router.
+
+The shared-events endpoints are unauthenticated, so internal system state
+(ConversationStateUpdateEvent) must not be returned. The frontend shared-
+conversation viewer never renders these events β€” it only uses messages,
+actions, observations, errors, and hook-execution events.
+"""
+
+from __future__ import annotations
+
+from unittest.mock import AsyncMock
+from uuid import uuid4
+
+import pytest
+from server.sharing.shared_event_router import (
+ _is_viewable,
+ batch_get_shared_events,
+ get_shared_event,
+ search_shared_events,
+)
+
+from openhands.agent_server.models import EventPage
+from openhands.sdk.event.conversation_state import ConversationStateUpdateEvent
+from openhands.sdk.event.llm_convertible import MessageEvent
+from openhands.sdk.llm import Message, TextContent
+
+# ---------------------------------------------------------------------------
+# Fixtures / helpers
+# ---------------------------------------------------------------------------
+
+
+def _make_message_event() -> MessageEvent:
+ return MessageEvent(
+ source='user',
+ llm_message=Message(role='user', content=[TextContent(text='Hello')]),
+ )
+
+
+def _make_state_event(
+ key: str = 'full_state', value: dict | str = 'idle'
+) -> ConversationStateUpdateEvent:
+ return ConversationStateUpdateEvent(key=key, value=value)
+
+
+# ---------------------------------------------------------------------------
+# _is_viewable
+# ---------------------------------------------------------------------------
+
+
+class TestIsViewable:
+ def test_message_event_is_viewable(self):
+ assert _is_viewable(_make_message_event()) is True
+
+ def test_full_state_event_is_not_viewable(self):
+ assert _is_viewable(_make_state_event('full_state', {'agent': {}})) is False
+
+ def test_execution_status_event_is_not_viewable(self):
+ assert _is_viewable(_make_state_event('execution_status', 'running')) is False
+
+ def test_stats_event_is_not_viewable(self):
+ assert _is_viewable(_make_state_event('stats', {})) is False
+
+
+# ---------------------------------------------------------------------------
+# search_shared_events
+# ---------------------------------------------------------------------------
+
+
+class TestSearchSharedEvents:
+ @pytest.mark.asyncio
+ async def test_filters_out_state_events(self):
+ msg = _make_message_event()
+ state = _make_state_event()
+ mock_service = AsyncMock()
+ mock_service.search_shared_events.return_value = EventPage(
+ items=[msg, state, msg], next_page_id=None
+ )
+
+ result = await search_shared_events(
+ conversation_id=uuid4().hex,
+ shared_event_service=mock_service,
+ )
+
+ assert len(result.items) == 2
+ assert all(
+ not isinstance(e, ConversationStateUpdateEvent) for e in result.items
+ )
+
+ @pytest.mark.asyncio
+ async def test_preserves_next_page_id(self):
+ mock_service = AsyncMock()
+ mock_service.search_shared_events.return_value = EventPage(
+ items=[_make_state_event()], next_page_id='abc'
+ )
+
+ result = await search_shared_events(
+ conversation_id=uuid4().hex,
+ shared_event_service=mock_service,
+ )
+
+ assert result.next_page_id == 'abc'
+ assert result.items == []
+
+ @pytest.mark.asyncio
+ async def test_empty_page_unchanged(self):
+ mock_service = AsyncMock()
+ mock_service.search_shared_events.return_value = EventPage(
+ items=[], next_page_id=None
+ )
+
+ result = await search_shared_events(
+ conversation_id=uuid4().hex,
+ shared_event_service=mock_service,
+ )
+
+ assert result.items == []
+ assert result.next_page_id is None
+
+
+# ---------------------------------------------------------------------------
+# batch_get_shared_events
+# ---------------------------------------------------------------------------
+
+
+class TestBatchGetSharedEvents:
+ @pytest.mark.asyncio
+ async def test_replaces_state_events_with_none(self):
+ msg = _make_message_event()
+ state = _make_state_event()
+ mock_service = AsyncMock()
+ mock_service.batch_get_shared_events.return_value = [msg, state, None]
+
+ result = await batch_get_shared_events(
+ conversation_id=uuid4().hex,
+ id=[uuid4().hex, uuid4().hex, uuid4().hex],
+ shared_event_service=mock_service,
+ )
+
+ assert len(result) == 3
+ assert result[0] is msg
+ assert result[1] is None # state event replaced with None
+ assert result[2] is None # originally None stays None
+
+
+# ---------------------------------------------------------------------------
+# get_shared_event
+# ---------------------------------------------------------------------------
+
+
+class TestGetSharedEvent:
+ @pytest.mark.asyncio
+ async def test_returns_message_event(self):
+ msg = _make_message_event()
+ mock_service = AsyncMock()
+ mock_service.get_shared_event.return_value = msg
+
+ result = await get_shared_event(
+ conversation_id=uuid4().hex,
+ event_id=uuid4().hex,
+ shared_event_service=mock_service,
+ )
+
+ assert result is msg
+
+ @pytest.mark.asyncio
+ async def test_returns_none_for_state_event(self):
+ state = _make_state_event()
+ mock_service = AsyncMock()
+ mock_service.get_shared_event.return_value = state
+
+ result = await get_shared_event(
+ conversation_id=uuid4().hex,
+ event_id=uuid4().hex,
+ shared_event_service=mock_service,
+ )
+
+ assert result is None
+
+ @pytest.mark.asyncio
+ async def test_returns_none_when_not_found(self):
+ mock_service = AsyncMock()
+ mock_service.get_shared_event.return_value = None
+
+ result = await get_shared_event(
+ conversation_id=uuid4().hex,
+ event_id=uuid4().hex,
+ shared_event_service=mock_service,
+ )
+
+ assert result is None