diff --git a/python/packages/devui/agent_framework_devui/_utils.py b/python/packages/devui/agent_framework_devui/_utils.py index 2165a9592c7..3c9778de08c 100644 --- a/python/packages/devui/agent_framework_devui/_utils.py +++ b/python/packages/devui/agent_framework_devui/_utils.py @@ -100,13 +100,22 @@ def extract_agent_metadata(entity_object: Any) -> dict[str, Any]: if hasattr(entity_object, "client"): metadata["chat_client_type"] = entity_object.client.__class__.__name__ - # Try to get context providers - if ( - hasattr(entity_object, "context_provider") - and entity_object.context_provider - and hasattr(entity_object.context_provider, "__class__") - ): - metadata["context_provider"] = [entity_object.context_provider.__class__.__name__] # type: ignore + # Try to get context providers. + # ``Agent`` exposes a ``context_providers`` list; the singular + # ``context_provider`` attribute only exists on older/custom agent + # objects, so fall back to it when the list is absent. + context_provider_names: list[str] = [] + providers = getattr(entity_object, "context_providers", None) + if isinstance(providers, (list, tuple)): + for provider in cast("list[Any]", providers): + if provider is not None: + context_provider_names.append(type(provider).__name__) + if not context_provider_names: + single_provider = getattr(entity_object, "context_provider", None) + if single_provider is not None: + context_provider_names = [type(single_provider).__name__] + if context_provider_names: + metadata["context_provider"] = context_provider_names # type: ignore # Try to get middleware if hasattr(entity_object, "middleware") and entity_object.middleware: diff --git a/python/packages/devui/tests/devui/test_agent_metadata.py b/python/packages/devui/tests/devui/test_agent_metadata.py new file mode 100644 index 00000000000..5b8d6ba390e --- /dev/null +++ b/python/packages/devui/tests/devui/test_agent_metadata.py @@ -0,0 +1,75 @@ +# Copyright (c) Microsoft. All rights reserved. + +"""Tests for agent metadata extraction used by DevUI discovery.""" + +from unittest.mock import Mock + +from agent_framework import Agent, ContextProvider, InMemoryHistoryProvider + +from agent_framework_devui._utils import extract_agent_metadata + + +class _ZebraProvider(ContextProvider): + """Provider whose class name sorts after the other one used in the order test.""" + + +class _AardvarkProvider(ContextProvider): + """Provider whose class name sorts before the other one used in the order test.""" + + +def test_extract_agent_metadata_reports_configured_context_providers() -> None: + """A configured context provider must show up in the agent metadata.""" + agent = Agent( + client=Mock(model=None), + context_providers=[InMemoryHistoryProvider()], + ) + + metadata = extract_agent_metadata(agent) + + assert metadata["context_provider"] == ["InMemoryHistoryProvider"] + + +def test_extract_agent_metadata_preserves_provider_order() -> None: + """Multiple providers are listed in their configured order.""" + agent = Agent( + client=Mock(model=None), + context_providers=[ + _ZebraProvider(source_id="zebra"), + _AardvarkProvider(source_id="aardvark"), + ], + ) + + metadata = extract_agent_metadata(agent) + + assert metadata["context_provider"] == ["_ZebraProvider", "_AardvarkProvider"] + + +def test_extract_agent_metadata_without_context_providers() -> None: + """An agent without providers reports no context provider.""" + agent = Agent(client=Mock(model=None)) + + metadata = extract_agent_metadata(agent) + + assert metadata["context_provider"] is None + + +def test_extract_agent_metadata_falls_back_to_single_context_provider() -> None: + """Older agent objects exposing a single ``context_provider`` still work.""" + + class LegacyAgent: + context_provider = InMemoryHistoryProvider() + + metadata = extract_agent_metadata(LegacyAgent()) + + assert metadata["context_provider"] == ["InMemoryHistoryProvider"] + + +def test_extract_agent_metadata_ignores_non_iterable_context_providers() -> None: + """A truthy but non-iterable ``context_providers`` value must not break discovery.""" + + class OddAgent: + context_providers = Mock() + + metadata = extract_agent_metadata(OddAgent()) + + assert metadata["context_provider"] is None