π OpenHands: AI-Driven Development
feat(app-server): add repo/branch to Laminar trace metadata (#15059)
simonrosenberg7b8b26266b6d
diff --git a/openhands/app_server/app_conversation/live_status_app_conversation_service.py b/openhands/app_server/app_conversation/live_status_app_conversation_service.pyindex ffbc8ab41d..32265bd620 100644--- a/openhands/app_server/app_conversation/live_status_app_conversation_service.py+++ b/openhands/app_server/app_conversation/live_status_app_conversation_service.py@@ -429,6 +429,7 @@ class LiveStatusAppConversationService(AppConversationServiceBase):trigger=request.trigger,remote_workspace=remote_workspace,selected_repository=request.selected_repository,+ selected_branch=request.selected_branch,plugins=request.plugins,api_secrets=request.secrets,)@@ -1518,6 +1519,56 @@ class LiveStatusAppConversationService(AppConversationServiceBase):httpx_client=self.httpx_client,)+ @staticmethod+ async def _resolve_head_commit(+ remote_workspace: AsyncRemoteWorkspace, project_dir: str+ ) -> str:+ """Best-effort post-clone HEAD sha for the Laminar trace; '' on failure.++ ``--verify --quiet`` guarantees stdout is a validated object id (never+ the literal ``HEAD`` an unborn repo would echo) and fails silently+ rather than logging a ``fatal:`` line. The short timeout keeps this+ trace-only lookup from delaying conversation startup if the workspace is+ unresponsive β the metadata is simply dropped instead.+ """+ try:+ result = await remote_workspace.execute_command(+ 'git rev-parse --verify --quiet HEAD', project_dir, timeout=10.0+ )+ except Exception as e:+ _logger.debug('HEAD commit lookup for trace metadata failed: %s', e)+ return ''+ return result.stdout.strip() if not result.exit_code else ''++ async def _build_observability_metadata(+ self,+ remote_workspace: AsyncRemoteWorkspace | None,+ project_dir: str,+ selected_repository: str | None,+ selected_branch: str | None,+ git_provider: ProviderType | None,+ ) -> dict[str, str]:+ """Repo identity for the Laminar trace so trajectories are searchable+ by repo / branch / commit (the trace UI has no DB to join against).++ Shared by the OpenHands and ACP request builders. The commit is the+ post-clone HEAD, resolved best-effort from the (already-cloned)+ workspace; omitted entirely for a repo-less conversation.+ """+ commit = ''+ if selected_repository and remote_workspace is not None:+ commit = await self._resolve_head_commit(remote_workspace, project_dir)+ return {+ key: value+ for key, value in (+ ('repo', selected_repository),+ ('branch', selected_branch),+ ('git_provider', git_provider.value if git_provider else None),+ ('commit', commit),+ )+ if value+ }+async def _build_start_conversation_request_for_user(self,sandbox: SandboxInfo,@@ -1531,6 +1582,7 @@ class LiveStatusAppConversationService(AppConversationServiceBase):trigger: ConversationTrigger | None = None,remote_workspace: AsyncRemoteWorkspace | None = None,selected_repository: str | None = None,+ selected_branch: str | None = None,plugins: list[PluginSpec] | None = None,api_secrets: dict[str, SecretStr] | None = None,) -> StartConversationRequest:@@ -1573,7 +1625,10 @@ class LiveStatusAppConversationService(AppConversationServiceBase):system_message_suffix=system_message_suffix,trigger=trigger,working_dir=working_dir,+ git_provider=git_provider,selected_repository=selected_repository,+ selected_branch=selected_branch,+ remote_workspace=remote_workspace,plugins=plugins,api_secrets=api_secrets,)@@ -1764,8 +1819,18 @@ class LiveStatusAppConversationService(AppConversationServiceBase):# injects it directly into the JSON body as a forward-compatible# fallback.laminar_user_id = await self.user_context.get_user_email() or user.id+ observability_metadata = await self._build_observability_metadata(+ remote_workspace,+ project_dir,+ selected_repository,+ selected_branch,+ git_provider,+ )+ create_kwargs: dict[str, Any] = {'agent': agent, 'user_id': laminar_user_id}+ if observability_metadata:+ create_kwargs['observability_metadata'] = observability_metadatarequest = conv_settings.create_request(- StartConversationRequest, agent=agent, user_id=laminar_user_id+ StartConversationRequest, **create_kwargs)# --- skills (require remote workspace) ------------------------------@@ -1818,7 +1883,10 @@ class LiveStatusAppConversationService(AppConversationServiceBase):working_dir: str,system_message_suffix: str | None = None,trigger: ConversationTrigger | None = None,+ git_provider: ProviderType | None = None,selected_repository: str | None = None,+ selected_branch: str | None = None,+ remote_workspace: AsyncRemoteWorkspace | None = None,plugins: list[PluginSpec] | None = None,api_secrets: dict[str, SecretStr] | None = None,) -> StartConversationRequest:@@ -1841,7 +1909,11 @@ class LiveStatusAppConversationService(AppConversationServiceBase):working_dir: Working directory pathsystem_message_suffix: Optional suffix for system message.trigger: Optional conversation trigger.+ git_provider: Optional git provider typeselected_repository: Optional repository name+ selected_branch: Optional branch name+ remote_workspace: Optional remote workspace instance, used to+ resolve the HEAD commit for the Laminar trace metadata.plugins: Optional list of plugins to loadapi_secrets: Optional secrets passed directly via the API."""@@ -1957,12 +2029,21 @@ class LiveStatusAppConversationService(AppConversationServiceBase):# prefer email over the internal id so Laminar traces are immediately# attributable, falling back to ``user.id`` when no email is available.laminar_user_id = await self.user_context.get_user_email() or user.id- return conv_settings.create_request(- StartConversationRequest,- agent=acp_agent,- user_id=laminar_user_id,- secrets=secrets,+ observability_metadata = await self._build_observability_metadata(+ remote_workspace,+ project_dir,+ selected_repository,+ selected_branch,+ git_provider,)+ create_kwargs: dict[str, Any] = {+ 'agent': acp_agent,+ 'user_id': laminar_user_id,+ 'secrets': secrets,+ }+ if observability_metadata:+ create_kwargs['observability_metadata'] = observability_metadata+ return conv_settings.create_request(StartConversationRequest, **create_kwargs)async def _process_pending_messages(self,diff --git a/tests/unit/app_server/test_live_status_app_conversation_service.py b/tests/unit/app_server/test_live_status_app_conversation_service.pyindex a84d0dba4b..5d47864016 100644--- a/tests/unit/app_server/test_live_status_app_conversation_service.py+++ b/tests/unit/app_server/test_live_status_app_conversation_service.py@@ -1068,6 +1068,187 @@ class TestLiveStatusAppConversationService:self.mock_user, 'gpt-4', test_conversation_id)+ @patch(+ 'openhands.app_server.app_conversation.live_status_app_conversation_service.get_default_tools',+ return_value=[],+ )+ @pytest.mark.asyncio+ async def test_build_request_populates_observability_metadata(self, _mock_tools):+ """Repo / branch / provider land on the request's observability_metadata+ so the agent-server attaches them to the Laminar trace. With no+ remote_workspace the commit can't be resolved, so it is omitted."""+ self.mock_user_context.get_user_info.return_value = self.mock_user+ self.service._setup_secrets_for_git_providers = AsyncMock(return_value={})+ self.service._configure_llm_and_mcp = AsyncMock(+ return_value=(LLM(model='gpt-4', api_key=SecretStr('k')), {})+ )++ result = await self.service._build_start_conversation_request_for_user(+ sandbox=self.mock_sandbox,+ conversation_id=uuid4(),+ initial_message=None,+ system_message_suffix=None,+ git_provider=ProviderType.GITHUB,+ working_dir='/test/dir',+ remote_workspace=None,+ selected_repository='test/repo',+ selected_branch='feature-x',+ )++ assert result.observability_metadata == {+ 'repo': 'test/repo',+ 'branch': 'feature-x',+ 'git_provider': 'github',+ }++ @patch(+ 'openhands.app_server.app_conversation.live_status_app_conversation_service.get_default_tools',+ return_value=[],+ )+ @pytest.mark.asyncio+ async def test_build_request_observability_metadata_includes_commit(+ self, _mock_tools+ ):+ """The post-clone HEAD sha is resolved from the workspace and added."""+ self.mock_user_context.get_user_info.return_value = self.mock_user+ real_llm = LLM(model='gpt-4', api_key=SecretStr('k'))+ mock_agent = Mock(spec=Agent)+ mock_agent.llm = real_llm+ mock_agent.condenser = None+ self.service._setup_secrets_for_git_providers = AsyncMock(return_value={})+ self.service._configure_llm_and_mcp = AsyncMock(return_value=(real_llm, {}))+ self.service._load_skills_and_update_agent = AsyncMock(return_value=mock_agent)++ remote_workspace = Mock(spec=AsyncRemoteWorkspace)+ remote_workspace.execute_command = AsyncMock(+ return_value=SimpleNamespace(exit_code=0, stdout='abc123sha\n')+ )++ result = await self.service._build_start_conversation_request_for_user(+ sandbox=self.mock_sandbox,+ conversation_id=uuid4(),+ initial_message=None,+ system_message_suffix=None,+ git_provider=ProviderType.GITHUB,+ working_dir='/test/dir',+ remote_workspace=remote_workspace,+ selected_repository='test/repo',+ selected_branch='feature-x',+ )++ assert result.observability_metadata == {+ 'repo': 'test/repo',+ 'branch': 'feature-x',+ 'git_provider': 'github',+ 'commit': 'abc123sha',+ }+ remote_workspace.execute_command.assert_awaited_once_with(+ 'git rev-parse --verify --quiet HEAD', '/test/dir/repo', timeout=10.0+ )++ @patch(+ 'openhands.app_server.app_conversation.live_status_app_conversation_service.get_default_tools',+ return_value=[],+ )+ @pytest.mark.asyncio+ async def test_build_request_commit_resolution_is_best_effort(self, _mock_tools):+ """A failed HEAD lookup leaves commit out without breaking the build."""+ self.mock_user_context.get_user_info.return_value = self.mock_user+ real_llm = LLM(model='gpt-4', api_key=SecretStr('k'))+ mock_agent = Mock(spec=Agent)+ mock_agent.llm = real_llm+ mock_agent.condenser = None+ self.service._setup_secrets_for_git_providers = AsyncMock(return_value={})+ self.service._configure_llm_and_mcp = AsyncMock(return_value=(real_llm, {}))+ self.service._load_skills_and_update_agent = AsyncMock(return_value=mock_agent)++ remote_workspace = Mock(spec=AsyncRemoteWorkspace)+ remote_workspace.execute_command = AsyncMock(side_effect=RuntimeError('boom'))++ result = await self.service._build_start_conversation_request_for_user(+ sandbox=self.mock_sandbox,+ conversation_id=uuid4(),+ initial_message=None,+ system_message_suffix=None,+ git_provider=None,+ working_dir='/test/dir',+ remote_workspace=remote_workspace,+ selected_repository='test/repo',+ )++ assert result.observability_metadata == {'repo': 'test/repo'}++ @patch(+ 'openhands.app_server.app_conversation.live_status_app_conversation_service.get_default_tools',+ return_value=[],+ )+ @pytest.mark.asyncio+ async def test_build_request_no_repo_omits_observability_metadata(+ self, _mock_tools+ ):+ """A repo-less conversation adds no repo metadata to the trace."""+ self.mock_user_context.get_user_info.return_value = self.mock_user+ self.service._setup_secrets_for_git_providers = AsyncMock(return_value={})+ self.service._configure_llm_and_mcp = AsyncMock(+ return_value=(LLM(model='gpt-4', api_key=SecretStr('k')), {})+ )++ result = await self.service._build_start_conversation_request_for_user(+ sandbox=self.mock_sandbox,+ conversation_id=uuid4(),+ initial_message=None,+ system_message_suffix=None,+ git_provider=None,+ working_dir='/test/dir',+ remote_workspace=None,+ selected_repository=None,+ )++ assert result.observability_metadata == {}++ @pytest.mark.asyncio+ async def test_build_request_routes_acp_user_to_observability_metadata(self):+ """End-to-end through the *routing* entrypoint (not the ACP builder+ directly): an ACP user hits the ``isinstance(..., ACPAgentSettings)``+ branch in ``_build_start_conversation_request_for_user``, which must+ forward git_provider/selected_branch/remote_workspace into+ ``_build_acp_start_conversation_request`` for this to populate.+ """+ from openhands.sdk.settings import ACPAgentSettings++ self.mock_user.agent_settings = ACPAgentSettings(+ acp_server='claude-code',+ llm=LLM(model='claude-sonnet-4-5', api_key=SecretStr('k')),+ )+ self.mock_user_context.get_user_info.return_value = self.mock_user+ self.mock_user_context.get_secrets = AsyncMock(return_value={})+ self.mock_user_context.get_provider_tokens = AsyncMock(return_value=None)++ remote_workspace = Mock(spec=AsyncRemoteWorkspace)+ remote_workspace.execute_command = AsyncMock(+ return_value=SimpleNamespace(exit_code=0, stdout='def456sha\n')+ )++ result = await self.service._build_start_conversation_request_for_user(+ sandbox=self.mock_sandbox,+ conversation_id=uuid4(),+ initial_message=None,+ system_message_suffix=None,+ git_provider=ProviderType.GITHUB,+ working_dir='/test/dir',+ remote_workspace=remote_workspace,+ selected_repository='test/repo',+ selected_branch='feature-x',+ )++ assert result.agent.agent_kind == 'acp'+ assert result.observability_metadata == {+ 'repo': 'test/repo',+ 'branch': 'feature-x',+ 'git_provider': 'github',+ 'commit': 'def456sha',+ }+@patch('openhands.app_server.app_conversation.live_status_app_conversation_service.get_default_tools',return_value=[],@@ -3618,7 +3799,18 @@ class TestBuildAcpStartConversationRequestSecrets:)return user- def _call_build(self, service, user, tmp_path, *, secrets=None):+ def _call_build(+ self,+ service,+ user,+ tmp_path,+ *,+ secrets=None,+ git_provider=None,+ selected_repository=None,+ selected_branch=None,+ remote_workspace=None,+ ):"""Wire user_context and call _build_acp_start_conversation_request."""service.user_context.get_user_info = AsyncMock(return_value=user)service.user_context.get_user_email = AsyncMock(return_value=None)@@ -3630,6 +3822,10 @@ class TestBuildAcpStartConversationRequestSecrets:conversation_id=uuid4(),initial_message=None,working_dir=str(tmp_path),+ git_provider=git_provider,+ selected_repository=selected_repository,+ selected_branch=selected_branch,+ remote_workspace=remote_workspace,plugins=None,)@@ -3809,3 +4005,60 @@ class TestBuildAcpStartConversationRequestSecrets:) or {}assert agent_ctx_secrets.get('GH_TOKEN') == 'explicit-token'assert request.secrets.get('GH_TOKEN') is panel_secret++ @pytest.mark.asyncio+ async def test_observability_metadata_populated(self, service, tmp_path):+ """Repo / branch / provider land on the request's observability_metadata+ for ACP conversations too, matching the OpenHands-agent path."""+ user = self._make_acp_user()++ request = await self._call_build(+ service,+ user,+ tmp_path,+ git_provider=ProviderType.GITHUB,+ selected_repository='test/repo',+ selected_branch='feature-x',+ )++ assert request.observability_metadata == {+ 'repo': 'test/repo',+ 'branch': 'feature-x',+ 'git_provider': 'github',+ }++ @pytest.mark.asyncio+ async def test_observability_metadata_includes_commit(self, service, tmp_path):+ """The post-clone HEAD sha is resolved from the workspace and added,+ mirroring the OpenHands-agent path's commit resolution."""+ user = self._make_acp_user()+ remote_workspace = Mock(spec=AsyncRemoteWorkspace)+ remote_workspace.execute_command = AsyncMock(+ return_value=SimpleNamespace(exit_code=0, stdout='abc123sha\n')+ )++ request = await self._call_build(+ service,+ user,+ tmp_path,+ git_provider=ProviderType.GITHUB,+ selected_repository='test/repo',+ selected_branch='feature-x',+ remote_workspace=remote_workspace,+ )++ assert request.observability_metadata == {+ 'repo': 'test/repo',+ 'branch': 'feature-x',+ 'git_provider': 'github',+ 'commit': 'abc123sha',+ }++ @pytest.mark.asyncio+ async def test_no_repo_omits_observability_metadata(self, service, tmp_path):+ """A repo-less ACP conversation adds no repo metadata to the trace."""+ user = self._make_acp_user()++ request = await self._call_build(service, user, tmp_path)++ assert request.observability_metadata == {}