mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
3bbc81554b
* Improve the handling of intermediate outputs for workflows and orchestrations
* Address PR review feedback on intermediate output forwarding
- Switch workflow.as_agent() forwarding to an explicit allowlist of {output,
intermediate, data, request_info} so orchestration-internal events
(group_chat, handoff_sent, magentic_orchestrator) stay inside the workflow
instead of leaking into agent responses via str(data) coercion.
- Stop raising on intermediate AgentResponseUpdate in non-streaming run();
surface the partial as a Message with text_reasoning content. The defensive
raise still applies to terminal output events, where Update payloads would
corrupt message ordering.
- Extend the DevUI workflow-event mapper so intermediate yields wrapping
plain strings, Messages, and list[Message] render as visible output items
instead of generic completed-trace events.
- Add orchestration coverage for GroupChat, Handoff, and Magentic builders
(default vs intermediate_outputs=True; structural where end-to-end is heavy).
* Lift output-designation policy into a value type
Replace the ``Workflow._output_executors`` list and the
``RunnerContext.should_label_as_intermediate`` Protocol method with a single
immutable ``OutputDesignation`` value type owned by ``Workflow``. Thread the
designation as a parameter through the existing call chain (Runner ->
EdgeRunner -> Executor -> WorkflowContext) so ``yield_output`` consults the
threaded snapshot directly rather than calling back into the runner context.
Removes the ``InProcRunnerContext._workflow`` back-reference and the
``WorkflowBuilder.build()`` assignment that wired it up. Adds the public
predicate ``Workflow.is_terminal_executor(executor_id)`` for external
observers; ``OutputDesignation`` itself stays package-internal.
Key decisions
- ``OutputDesignation.designated`` is ``frozenset[str] | None`` -- ``None``
preserves legacy "every yield is type='output'" behavior, any frozenset
(including empty) opts into strict mode. The ``DeprecationWarning`` for
legacy mode at build time is unchanged.
- ``output_designation`` is an optional parameter on ``Runner``,
``EdgeRunner.send_message``, ``EdgeRunner._execute_on_target``,
``Executor.execute``, ``Executor._create_context_for_handler``, and
``WorkflowContext.__init__``. Each defaults to legacy ``OutputDesignation()``
so direct callers (Azure Functions ``CapturingRunnerContext``,
``test_runner`` recording fixtures) keep working without ceremony.
- The workflow-level filter in ``_run_core`` reads ``self._output_designation``
live, preserving today's semantics where mutating the designation after
build still affects subsequent runs (used by two existing tests).
- ``Workflow.to_dict()`` continues to emit ``"output_executors":
list[str] | None`` (sorted from the frozenset). Checkpoint format unchanged.
Files changed
- _workflow.py: add ``OutputDesignation`` dataclass; replace
``_output_executors`` with ``_output_designation``; add
``is_terminal_executor``; delete ``_should_yield_output_event``.
- _runner_context.py: drop ``should_label_as_intermediate`` Protocol method
and ``InProcRunnerContext`` impl; drop ``_workflow`` back-reference.
- _workflow_builder.py: remove ``context._workflow = workflow`` assignment.
- _runner.py, _edge_runner.py, _executor.py, _workflow_context.py: thread
``output_designation`` parameter through the call chain.
- tests/workflow/test_output_designation.py (new): three-state coverage of
the value type plus the public predicate delegation.
- tests/workflow/test_workflow_builder.py, test_validation.py,
test_workflow.py, test_runner.py and
orchestrations/tests/test_orchestration_intermediate_vs_terminal.py:
switch probes from ``_output_executors`` set checks to
``get_output_executors`` / ``is_terminal_executor``; update two
post-build mutation tests to set ``_output_designation`` instead.
Verification
- core/tests/workflow/, orchestrations/tests/, azurefunctions/tests/:
1119 passed, 42 skipped, 2 xfailed.
- ``uv run poe lint``: clean.
- ``uv run poe typing``: only the pre-existing
``_AGENT_FORWARDED_EVENT_TYPES`` pyright warning from 394bcd607 remains.
Notes for next iteration
- The builder's own ``_output_executors`` attribute (``list[Executor |
SupportsAgentRun]``) is intentionally untouched; the issue scoped the
rename to the workflow attribute.
- Adjacent review candidates (twin ``WorkflowAgent`` translators,
``_AGENT_FORWARDED_EVENT_TYPES`` kind classifier,
``_event_origin_context`` ContextVar removal, ``WorkflowEvent`` ADT
split, legacy-mode removal) remain out of scope.
* Add explicit workflow output designation
Key decisions
- Extend the internal OutputDesignation value type from terminal-only membership to output/intermediate/hidden classification. Legacy mode remains outputs=None, so workflows built without output_executors or intermediate_executors still label every yield_output as type='output'.
- WorkflowBuilder now accepts intermediate_executors. Providing either designation enters explicit mode; output executors emit output, intermediate executors emit intermediate, and unlisted yield_output payloads are hidden from caller-facing events while remaining in executor_completed data.
- Empty explicit designation, duplicate entries, overlaps, unknown executors, and designated executors without workflow output annotations fail build validation. Existing orchestration builders pass intermediate-capable participants through intermediate_executors to preserve current intermediate_outputs behavior until participant-oriented designation lands.
Files changed
- packages/core/agent_framework/_workflows/_workflow.py, _workflow_builder.py, _workflow_context.py, _validation.py, _events.py
- packages/core/tests/workflow/test_output_designation.py, test_output_executors_contract.py, test_strict_mode_event_labeling.py, test_validation.py, test_workflow.py, test_workflow_agent_intermediate.py
- packages/orchestrations/agent_framework_orchestrations/_sequential.py, _concurrent.py, _group_chat.py, _magentic.py
- packages/core/AGENTS.md
Verification
- uv run pytest packages/core/tests/workflow packages/orchestrations/tests packages/devui/tests/devui/test_mapper.py -q
- uv run pytest packages/azurefunctions/tests -q
- uv run poe lint
- uv run poe typing fails only on pre-existing packages/core/agent_framework/_workflows/_agent.py _AGENT_FORWARDED_EVENT_TYPES private-use pyright error.
Notes for next iteration
- issues/03-core-workflow-explicit-designation.md was moved to issues/done but issues/ remains untracked and intentionally excluded from this commit.
- Slice 4 should tighten workflow.as_agent() mapping for hidden emissions and streaming-only update payloads; Slice 5 should replace orchestration intermediate_outputs with participant-oriented designation.
* Tighten workflow-as-agent output mapping
Key decisions
- Treat AgentResponseUpdate as a streaming-only payload across the workflow.as_agent() adapter, so non-streaming agent runs now reject both terminal output and intermediate workflow events carrying updates.
- Keep streaming classification behavior explicit: terminal update payloads remain normal text content, while intermediate update payloads are rewritten to text_reasoning content.
- Add explicit-mode coverage proving hidden yield_output emissions do not appear in non-streaming AgentResponse messages or streaming AgentResponseUpdate chunks.
Files changed
- packages/core/agent_framework/_workflows/_agent.py
- packages/core/tests/workflow/test_workflow_agent_intermediate.py
Verification
- uv run pytest packages/core/tests/workflow/test_workflow_agent_intermediate.py -q
- uv run pytest packages/core/tests/workflow/test_workflow_agent.py packages/core/tests/workflow/test_workflow_agent_intermediate.py -q
- uv run pytest packages/core/tests/workflow packages/orchestrations/tests packages/devui/tests/devui/test_mapper.py -q
- uv run poe lint
- uv run poe typing fails only on the pre-existing packages/core/agent_framework/_workflows/_agent.py _AGENT_FORWARDED_EVENT_TYPES private-use pyright error.
Blockers or notes for next iteration
- issues/04-workflow-as-agent-output-mapping.md was moved to issues/done/ but issues/ remains untracked and intentionally excluded from this commit.
- Slice 5 should replace orchestration intermediate_outputs with participant-oriented designation.
* Add orchestration participant output designation
Key decisions
- Replace orchestration intermediate_outputs with participant-oriented output_participants and intermediate_participants across Sequential, Concurrent, GroupChat, Magentic, and Handoff builders.
- Keep synthetic final executors terminal by default for Concurrent, GroupChat, and Magentic; keep Sequential's final participant terminal by default; keep Handoff participants terminal by default.
- Centralize participant designation validation for empty explicit designation, duplicates, overlaps, and unknown participants, then map validated participants to workflow output/intermediate executors.
Files changed
- packages/orchestrations/agent_framework_orchestrations/_participant_designation.py
- packages/orchestrations/agent_framework_orchestrations/_sequential.py
- packages/orchestrations/agent_framework_orchestrations/_concurrent.py
- packages/orchestrations/agent_framework_orchestrations/_group_chat.py
- packages/orchestrations/agent_framework_orchestrations/_magentic.py
- packages/orchestrations/agent_framework_orchestrations/_handoff.py
- packages/orchestrations/tests/test_orchestration_intermediate_vs_terminal.py
- packages/orchestrations/tests/test_magentic.py
Blockers or notes for next iteration
- issues/05-orchestration-participant-designation.md was moved to issues/done/ but issues/ remains untracked and intentionally excluded from this commit.
- Slice 7 should migrate samples and docs away from intermediate_outputs to the new participant designation API.
- uv run poe typing still fails only on the pre-existing packages/core/agent_framework/_workflows/_agent.py _AGENT_FORWARDED_EVENT_TYPES private-use pyright error.
* Migrate samples to explicit output designation
Key decisions
- Replace sample usage of the removed orchestration intermediate_outputs boolean with participant-oriented intermediate_participants designation.
- Update raw workflow guidance to show output_executors together with intermediate_executors, and document that unlisted yields are hidden in explicit designation mode.
- Keep orchestration final outputs terminal while streaming designated participant responses as intermediate progress, including workflow.as_agent() samples where intermediates map to text_reasoning content.
- Refresh workflow and orchestration README guidance plus the changelog reference so public docs no longer point users at intermediate_outputs.
Files changed
- CHANGELOG.md
- packages/orchestrations/README.md
- samples/README.md
- samples/03-workflows/README.md
- samples/03-workflows/control-flow/intermediate_vs_terminal_outputs.py
- samples/03-workflows/orchestrations/README.md
- samples/03-workflows/orchestrations/group_chat_agent_manager.py
- samples/03-workflows/orchestrations/group_chat_philosophical_debate.py
- samples/03-workflows/orchestrations/group_chat_simple_selector.py
- samples/03-workflows/orchestrations/magentic.py
- samples/03-workflows/orchestrations/magentic_human_plan_review.py
- samples/03-workflows/orchestrations/sequential_chain_only_agent_responses.py
- samples/03-workflows/agents/group_chat_workflow_as_agent.py
- samples/03-workflows/agents/magentic_workflow_as_agent.py
- samples/03-workflows/agents/sequential_workflow_as_agent.py
- samples/semantic-kernel-migration/orchestrations/group_chat.py
- samples/semantic-kernel-migration/orchestrations/magentic.py
Blockers or notes for next iteration
- issues/07-samples-and-docs-explicit-output-designation.md was moved to issues/done/ but issues/ remains untracked and intentionally excluded from this commit.
- issues/06-devui-intermediate-event-rendering.md remains present and appears already satisfied by existing DevUI mapper/tests from the prior implementation slice.
- PRD-explicit-workflow-output-designation.md remains untracked and intentionally excluded from this commit.
* Render DevUI intermediate workflow outputs
Key decisions
- Preserve workflow output designation metadata on visible DevUI output messages and text deltas so intermediate/data emissions remain distinguishable from terminal output.
- Render intermediate workflow message items in the execution timeline using executor metadata, while excluding them from the final workflow result aggregation.
- Keep terminal output message rendering unchanged and retain legacy data events on the intermediate compatibility path.
Files changed
- packages/devui/agent_framework_devui/_mapper.py
- packages/devui/frontend/src/components/features/workflow/execution-timeline.tsx
- packages/devui/frontend/src/components/features/workflow/workflow-view.tsx
- packages/devui/frontend/src/types/openai.ts
- packages/devui/tests/devui/test_mapper.py
Blockers or notes for next iteration
- issues/06-devui-intermediate-event-rendering.md was moved to issues/done/ but issues/ remains untracked and intentionally excluded from this commit.
- PRD-explicit-workflow-output-designation.md remains untracked and intentionally excluded from this commit.
- uv run poe typing still fails only on the pre-existing packages/core/agent_framework/_workflows/_agent.py _AGENT_FORWARDED_EVENT_TYPES private-use pyright error.
* Fix mypy
* Clarify orchestration participant output config
* Rename participant output kwargs for clarity
output_participants -> final_output_from, intermediate_participants ->
intermediate_output_from. The old names read like categories of
participant; the new names make it clear the kwarg designates which
participants' outputs surface as final vs. intermediate events.
* Rename core workflow output kwargs with deprecation shim
Adds final_output_from / intermediate_output_from as canonical kwargs on
Workflow and WorkflowBuilder. Old output_executors / intermediate_executors
kwargs continue to work but emit DeprecationWarning via a shared coalesce
helper that also rejects supplying both. Wire-format keys in to_dict()
stay as output_executors / intermediate_executors so checkpoint
compatibility is preserved.
Internal call sites in orchestrations and samples updated to the new
names so users following sample code learn the canonical vocabulary;
legacy callers still work with a one-shot warning.
* Suppress pyright reportPrivateUsage on cross-module sentinel import
* Update docstrings
* Propagate sub-workflow intermediate outputs, fix handoff/sequential intermediate-only designation, and shore up tests, sample, and docstrings around the intermediate output contract.
* Add canonical workflow output_from selection
Key decisions:\n- Make output_from the canonical workflow-output allow-list and keep output_executors/final_output_from as deprecated compatibility aliases.\n- Treat empty output_from/intermediate_output_from lists as explicit selections and keep validation responsible for empty, duplicate, overlap, and unknown selections.\n- Remove the branch-only public intermediate_executors WorkflowBuilder kwarg while preserving legacy wire keys in to_dict().\n\nFiles changed:\n- packages/core/agent_framework/_workflows/_workflow.py\n- packages/core/agent_framework/_workflows/_workflow_builder.py\n- packages/core/agent_framework/_workflows/_workflow_context.py\n- packages/core/agent_framework/_workflows/_agent.py\n- packages/core/agent_framework/_workflows/_agent_executor.py\n- packages/core/tests/workflow/* output-selection coverage updates\n- packages/core/AGENTS.md\n- issues/done/001-canonical-list-based-output-selection.md\n\nBlockers/notes:\n- Orchestration builders still pass final_output_from internally; follow-up issue 004 should migrate them to output_from.\n- Legacy omitted-selection behavior and explicit all/all_other literals are left for issues 002 and 003.
* Add explicit all workflow output selection
Key decisions:
- Treat output_from='all' as an explicit workflow-output selection sentinel and expand it at build time to executors with declared workflow output types.
- Keep omitted output selections in legacy all-output mode with a deprecation warning that names output_from and intermediate_output_from and points to output_from='all'.
- Reject intermediate_output_from='all' at construction because the all-output literal is output-only for this issue.
Files changed:
- packages/core/agent_framework/_workflows/_workflow_builder.py
- packages/core/tests/workflow/test_output_executors_contract.py
- issues/done/002-explicit-all-output-and-legacy-migration.md
Blockers/notes:
- all_other intermediate-output selection remains for issue 003.
- Workflow-as-agent/orchestration parity remains for issue 004.
* Add all-other intermediate output selection
Key decisions:
- Treat intermediate_output_from='all_other' as an explicit intermediate-output selection sentinel and expand it at build time after the workflow graph is complete.
- Expand all_other to output-capable executors not selected by output_from; omitted or empty output_from selects no workflow outputs, while output_from='all' leaves an empty intermediate selection.
- Keep output_from='all_other' invalid so all_other remains intermediate-output-only and runtime classification still receives concrete executor-id sets.
Files changed:
- packages/core/agent_framework/_workflows/_workflow_builder.py
- packages/core/tests/workflow/test_output_executors_contract.py
- issues/done/003-all-other-intermediate-output-selection.md
Blockers/notes:
- Workflow-as-agent and orchestration parity remains for issue 004.
- Full documentation updates remain for issue 005.
* Add orchestration output selection parity
Key decisions:
- Expose output_from on sequential, concurrent, group chat, handoff, and magentic builders while keeping final_output_from as a deprecated compatibility alias.
- Resolve orchestration participant selections through the same explicit rules as workflows: output_from='all', intermediate_output_from='all_other', hidden unselected participant payloads, and overlap/duplicate/unknown/invalid-literal validation.
- Continue preserving documented orchestration defaults by always designating each pattern's terminal internal executor where applicable.
Files changed:
- packages/orchestrations/agent_framework_orchestrations/_participant_output_config.py
- packages/orchestrations/agent_framework_orchestrations/_sequential.py
- packages/orchestrations/agent_framework_orchestrations/_concurrent.py
- packages/orchestrations/agent_framework_orchestrations/_group_chat.py
- packages/orchestrations/agent_framework_orchestrations/_handoff.py
- packages/orchestrations/agent_framework_orchestrations/_magentic.py
- packages/orchestrations/agent_framework_orchestrations/_orchestration_request_info.py
- packages/orchestrations/tests/test_orchestration_intermediate_vs_terminal.py
- issues/done/004-workflow-as-agent-and-orchestration-parity.md
Blockers/notes:
- Full documentation and sample migration wording remains for issue 005.
- Existing tests that intentionally use final_output_from now emit the new deprecation warning.
* Document workflow output selection contract
Key decisions:
- Use Workflow Output and Intermediate Output as the developer-facing terms for selected caller-facing emissions.
- Document output_from and intermediate_output_from as the canonical API, with output_from as an allow-list and unselected payloads hidden unless explicitly selected as intermediate.
- Add scenario and invalid-selection tables for workflow and orchestration docs, including legacy omission warnings, output_from='all', intermediate_output_from='all_other', list selections, invalid literals, overlap, duplicates, unknown selections, and empty explicit selections.
- Migrate samples away from final_output_from and output_executors except where compatibility aliases are explicitly documented.
Files changed:
- packages/core/AGENTS.md
- packages/orchestrations/README.md
- packages/orchestrations/agent_framework_orchestrations/_handoff.py
- packages/orchestrations/agent_framework_orchestrations/_sequential.py
- samples/03-workflows/README.md
- samples/03-workflows/control-flow/intermediate_vs_terminal_outputs.py
- samples/03-workflows/human-in-the-loop/agents_with_approval_requests.py
- samples/03-workflows/orchestrations/README.md
- samples/04-hosting/foundry-hosted-agents/responses/05_workflows/main.py
- scripts/sample_validation/create_dynamic_workflow_executor.py
- issues/done/005-document-output-selection-contract.md
Blockers/notes:
- Direct full Ruff on scripts/sample_validation/create_dynamic_workflow_executor.py still reports pre-existing docstring/print/line-length issues outside this docs migration; syntax-focused checks for changed files pass.
- No remaining AFK issue files are present under issues/.
* Latest updates
* Typing fixes
* Cleanup
937 lines
40 KiB
Python
937 lines
40 KiB
Python
# Copyright (c) Microsoft. All rights reserved.
|
|
|
|
"""Tests for message mapping functionality.
|
|
|
|
This module tests the MessageMapper which converts Agent Framework events
|
|
to OpenAI-compatible streaming events. Tests use REAL classes from
|
|
agent_framework, not mocks, to ensure proper serialization.
|
|
"""
|
|
|
|
from typing import Any
|
|
|
|
import pytest
|
|
|
|
# Import Agent Framework types
|
|
from agent_framework._types import (
|
|
AgentResponseUpdate,
|
|
Content,
|
|
)
|
|
|
|
# Import real workflow event classes - NOT mocks!
|
|
from agent_framework._workflows._events import (
|
|
WorkflowEvent,
|
|
WorkflowRunState,
|
|
)
|
|
|
|
# Import factory functions from conftest for parameterized test data creation
|
|
from conftest import (
|
|
create_agent_run_response,
|
|
create_executor_completed_event,
|
|
create_executor_failed_event,
|
|
create_executor_invoked_event,
|
|
)
|
|
|
|
from agent_framework_devui._mapper import MessageMapper
|
|
from agent_framework_devui.models._openai_custom import (
|
|
AgentCompletedEvent,
|
|
AgentFailedEvent,
|
|
AgentFrameworkRequest,
|
|
AgentStartedEvent,
|
|
)
|
|
|
|
# Note: mapper and test_request fixtures are provided by conftest.py
|
|
|
|
|
|
# =============================================================================
|
|
# Test Helpers
|
|
# =============================================================================
|
|
|
|
|
|
def create_test_content(content_type: str, **kwargs: Any) -> Any:
|
|
"""Create test content objects."""
|
|
if content_type == "text":
|
|
return Content.from_text(text=kwargs.get("text", "Hello, world!"))
|
|
if content_type == "function_call":
|
|
return Content.from_function_call(
|
|
call_id=kwargs.get("call_id", "test_call_id"),
|
|
name=kwargs.get("name", "test_func"),
|
|
arguments=kwargs.get("arguments", {"param": "value"}),
|
|
)
|
|
if content_type == "error":
|
|
return Content.from_error(
|
|
message=kwargs.get("message", "Test error"), error_code=kwargs.get("code", "test_error")
|
|
)
|
|
raise ValueError(f"Unknown content type: {content_type}")
|
|
|
|
|
|
def create_test_agent_update(contents: list[Any]) -> AgentResponseUpdate:
|
|
"""Create test AgentResponseUpdate."""
|
|
return AgentResponseUpdate(contents=contents, role="assistant", message_id="test_msg", response_id="test_resp")
|
|
|
|
|
|
# =============================================================================
|
|
# Basic Content Mapping Tests
|
|
# =============================================================================
|
|
|
|
|
|
async def test_critical_isinstance_bug_detection(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""CRITICAL: Test that would have caught the isinstance vs hasattr bug."""
|
|
content = create_test_content("text", text="Bug detection test")
|
|
update = create_test_agent_update([content])
|
|
|
|
# Key assertions that would have caught the bug
|
|
assert hasattr(update, "contents") # Real attribute
|
|
assert not hasattr(update, "response") # Fake attribute should not exist
|
|
|
|
# Test isinstance works with real types
|
|
assert isinstance(update, AgentResponseUpdate)
|
|
|
|
# Test mapper conversion - should NOT produce "Unknown event"
|
|
events = await mapper.convert_event(update, test_request)
|
|
|
|
assert len(events) > 0
|
|
assert all(hasattr(event, "type") for event in events)
|
|
assert all(event.type != "unknown" for event in events)
|
|
|
|
|
|
async def test_text_content_mapping(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test TextContent mapping with proper OpenAI event hierarchy."""
|
|
content = create_test_content("text", text="Hello, clean test!")
|
|
update = create_test_agent_update([content])
|
|
|
|
events = await mapper.convert_event(update, test_request)
|
|
|
|
# With proper OpenAI hierarchy, we expect 3 events:
|
|
# 1. response.output_item.added (message)
|
|
# 2. response.content_part.added (text part)
|
|
# 3. response.output_text.delta (actual text)
|
|
assert len(events) == 3
|
|
|
|
# Check message output item
|
|
assert events[0].type == "response.output_item.added"
|
|
assert events[0].item.type == "message"
|
|
assert events[0].item.role == "assistant"
|
|
|
|
# Check content part
|
|
assert events[1].type == "response.content_part.added"
|
|
assert events[1].part.type == "output_text"
|
|
|
|
# Check text delta
|
|
assert events[2].type == "response.output_text.delta"
|
|
assert events[2].delta == "Hello, clean test!"
|
|
|
|
|
|
async def test_function_call_mapping(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test FunctionCallContent mapping."""
|
|
content = create_test_content("function_call", name="test_func", arguments={"location": "TestCity"})
|
|
update = create_test_agent_update([content])
|
|
|
|
events = await mapper.convert_event(update, test_request)
|
|
|
|
# Should generate: response.output_item.added + response.function_call_arguments.delta
|
|
assert len(events) >= 2
|
|
assert events[0].type == "response.output_item.added"
|
|
assert events[1].type == "response.function_call_arguments.delta"
|
|
|
|
# Check JSON is in delta event
|
|
delta_events = [e for e in events if e.type == "response.function_call_arguments.delta"]
|
|
full_json = "".join(event.delta for event in delta_events)
|
|
assert "TestCity" in full_json
|
|
|
|
|
|
async def test_function_result_content_with_string_result(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""Test FunctionResultContent with plain string result (regular tools)."""
|
|
content = Content.from_function_result(
|
|
call_id="test_call_123",
|
|
result="Hello, World!",
|
|
)
|
|
update = create_test_agent_update([content])
|
|
|
|
events = await mapper.convert_event(update, test_request)
|
|
|
|
assert len(events) >= 1
|
|
result_events = [e for e in events if e.type == "response.function_result.complete"]
|
|
assert len(result_events) == 1
|
|
assert result_events[0].output == "Hello, World!"
|
|
assert result_events[0].call_id == "test_call_123"
|
|
assert result_events[0].status == "completed"
|
|
|
|
|
|
async def test_function_result_content_with_nested_content_objects(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""Test FunctionResultContent with nested Content objects (MCP tools case)."""
|
|
content = Content.from_function_result(
|
|
call_id="mcp_call_456",
|
|
result=[Content.from_text(text="Hello from MCP!")],
|
|
)
|
|
update = create_test_agent_update([content])
|
|
|
|
events = await mapper.convert_event(update, test_request)
|
|
|
|
assert len(events) >= 1
|
|
result_events = [e for e in events if e.type == "response.function_result.complete"]
|
|
assert len(result_events) == 1
|
|
assert "Hello from MCP!" in result_events[0].output
|
|
assert result_events[0].call_id == "mcp_call_456"
|
|
|
|
|
|
async def test_error_content_mapping(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test ErrorContent mapping."""
|
|
content = create_test_content("error", message="Test error", code="test_code")
|
|
update = create_test_agent_update([content])
|
|
|
|
events = await mapper.convert_event(update, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "error"
|
|
assert events[0].message == "Test error"
|
|
assert events[0].code == "test_code"
|
|
|
|
|
|
async def test_mixed_content_types(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test multiple content types together."""
|
|
contents = [
|
|
create_test_content("text", text="Starting..."),
|
|
create_test_content("function_call", name="process", arguments={"data": "test"}),
|
|
create_test_content("text", text="Done!"),
|
|
]
|
|
update = create_test_agent_update(contents)
|
|
|
|
events = await mapper.convert_event(update, test_request)
|
|
|
|
assert len(events) >= 3
|
|
event_types = {event.type for event in events}
|
|
assert "response.output_text.delta" in event_types
|
|
assert "response.function_call_arguments.delta" in event_types
|
|
|
|
|
|
# =============================================================================
|
|
# Agent Lifecycle Event Tests
|
|
# =============================================================================
|
|
|
|
|
|
async def test_agent_lifecycle_events(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test that agent lifecycle events are properly converted to OpenAI format."""
|
|
# Test AgentStartedEvent
|
|
start_event = AgentStartedEvent()
|
|
events = await mapper.convert_event(start_event, test_request)
|
|
|
|
assert len(events) == 2 # response.created and response.in_progress
|
|
assert events[0].type == "response.created"
|
|
assert events[1].type == "response.in_progress"
|
|
assert events[0].response.model == "devui"
|
|
assert events[0].response.status == "in_progress"
|
|
|
|
# Test AgentCompletedEvent
|
|
complete_event = AgentCompletedEvent()
|
|
events = await mapper.convert_event(complete_event, test_request)
|
|
# AgentCompletedEvent no longer emits response.completed to avoid duplicates
|
|
assert len(events) == 0
|
|
|
|
# Test AgentFailedEvent
|
|
error = Exception("Test error")
|
|
failed_event = AgentFailedEvent(error=error)
|
|
events = await mapper.convert_event(failed_event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.failed"
|
|
assert events[0].response.status == "failed"
|
|
assert events[0].response.error.message == "Test error"
|
|
|
|
|
|
async def test_agent_run_response_mapping(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test that mapper handles complete AgentResponse (non-streaming)."""
|
|
response = create_agent_run_response("Complete response from run()")
|
|
|
|
events = await mapper.convert_event(response, test_request)
|
|
|
|
assert len(events) > 0
|
|
text_events = [e for e in events if e.type == "response.output_text.delta"]
|
|
assert len(text_events) > 0
|
|
assert text_events[0].delta == "Complete response from run()"
|
|
|
|
|
|
# =============================================================================
|
|
# Workflow Executor Event Tests (using REAL classes, not mocks!)
|
|
# =============================================================================
|
|
|
|
|
|
async def test_executor_invoked_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test WorkflowEvent(type='executor_invoked') using the REAL class from agent_framework."""
|
|
# Use real class, not mock!
|
|
event = create_executor_invoked_event(executor_id="exec_123")
|
|
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.added"
|
|
# Access as dict since item might be ExecutorActionItem
|
|
item = events[0].item if isinstance(events[0].item, dict) else events[0].item.model_dump()
|
|
assert item["type"] == "executor_action"
|
|
assert item["executor_id"] == "exec_123"
|
|
assert item["status"] == "in_progress"
|
|
|
|
|
|
async def test_executor_completed_event_simple_data(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test WorkflowEvent(type='executor_completed') with simple dict data."""
|
|
# Create event with simple data
|
|
event = WorkflowEvent.executor_completed(executor_id="exec_123", data={"simple": "result"})
|
|
|
|
# First need to invoke the executor to set up context
|
|
invoke_event = create_executor_invoked_event(executor_id="exec_123")
|
|
await mapper.convert_event(invoke_event, test_request)
|
|
|
|
# Now complete it
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.done"
|
|
item = events[0].item if isinstance(events[0].item, dict) else events[0].item.model_dump()
|
|
assert item["type"] == "executor_action"
|
|
assert item["executor_id"] == "exec_123"
|
|
assert item["status"] == "completed"
|
|
# Result should be serialized
|
|
assert item["result"] == {"simple": "result"}
|
|
|
|
|
|
async def test_executor_completed_event_with_agent_response(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""Test WorkflowEvent(type='executor_completed') with nested AgentExecutorResponse.
|
|
|
|
This is a REGRESSION TEST for the serialization bug where
|
|
WorkflowEvent.data contained AgentExecutorResponse with nested
|
|
AgentResponse and Message objects (SerializationMixin) that
|
|
Pydantic couldn't serialize.
|
|
"""
|
|
# Create event with realistic nested data - the exact structure that caused the bug
|
|
event = create_executor_completed_event(executor_id="exec_agent", with_agent_response=True)
|
|
|
|
# Verify the data has the problematic structure
|
|
assert hasattr(event.data, "agent_response")
|
|
assert hasattr(event.data, "full_conversation")
|
|
|
|
# First invoke the executor
|
|
invoke_event = create_executor_invoked_event(executor_id="exec_agent")
|
|
await mapper.convert_event(invoke_event, test_request)
|
|
|
|
# Now complete - this should NOT raise serialization errors
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.done"
|
|
|
|
# Get the item (might be Pydantic model or dict)
|
|
item = events[0].item if isinstance(events[0].item, dict) else events[0].item.model_dump()
|
|
assert item["type"] == "executor_action"
|
|
assert item["executor_id"] == "exec_agent"
|
|
assert item["status"] == "completed"
|
|
|
|
# The result should be serialized (converted to dict)
|
|
result = item["result"]
|
|
assert result is not None
|
|
# Should be a dict or list, not the original object
|
|
assert isinstance(result, (dict, list))
|
|
|
|
|
|
async def test_executor_completed_event_serialization_to_json(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""REGRESSION TEST: Verify the full JSON serialization works.
|
|
|
|
This tests the exact failure mode from the bug: calling model_dump_json()
|
|
on the event containing nested SerializationMixin objects.
|
|
"""
|
|
# Create the problematic event
|
|
event = create_executor_completed_event(executor_id="exec_json_test", with_agent_response=True)
|
|
|
|
# Invoke first
|
|
invoke_event = create_executor_invoked_event(executor_id="exec_json_test")
|
|
await mapper.convert_event(invoke_event, test_request)
|
|
|
|
# Complete
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
done_event = events[0]
|
|
|
|
# This is the critical test - model_dump_json() should NOT raise
|
|
# "Unable to serialize unknown type: <class 'agent_framework._types.AgentResponse'>"
|
|
try:
|
|
json_str = done_event.model_dump_json()
|
|
assert json_str is not None
|
|
assert len(json_str) > 0
|
|
# Verify it's valid JSON by checking it contains expected fields
|
|
assert "executor_action" in json_str
|
|
assert "exec_json_test" in json_str
|
|
assert "completed" in json_str
|
|
except Exception as e:
|
|
pytest.fail(f"model_dump_json() raised an exception: {e}")
|
|
|
|
|
|
async def test_executor_failed_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test WorkflowEvent(type='executor_failed') using the REAL class."""
|
|
# First invoke the executor
|
|
invoke_event = create_executor_invoked_event(executor_id="exec_fail")
|
|
await mapper.convert_event(invoke_event, test_request)
|
|
|
|
# Now fail it
|
|
event = create_executor_failed_event(executor_id="exec_fail", error_message="Executor failed")
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.done"
|
|
item = events[0].item if isinstance(events[0].item, dict) else events[0].item.model_dump()
|
|
assert item["type"] == "executor_action"
|
|
assert item["executor_id"] == "exec_fail"
|
|
assert item["status"] == "failed"
|
|
assert "Executor failed" in str(item["error"])
|
|
|
|
|
|
async def test_executor_events_carry_created_at_timestamp(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""REGRESSION TEST: Executor mapped events must include a created_at timestamp.
|
|
|
|
Without created_at, the frontend synthesizes timestamps using
|
|
Math.max(baseTimestamp, lastTimestamp + 1) with second precision, forcing
|
|
a minimum 1-second gap between sequential events regardless of their actual
|
|
elapsed time. This makes instant workflows appear to take multiple seconds
|
|
in the DevUI timeline.
|
|
"""
|
|
invoke_event = create_executor_invoked_event(executor_id="exec_ts")
|
|
complete_event = create_executor_completed_event(executor_id="exec_ts")
|
|
fail_event = create_executor_failed_event(executor_id="exec_ts_fail")
|
|
|
|
invoked_results = await mapper.convert_event(invoke_event, test_request)
|
|
completed_results = await mapper.convert_event(complete_event, test_request)
|
|
|
|
# Set up a separate context for the failed path
|
|
mapper2 = MessageMapper()
|
|
await mapper2.convert_event(create_executor_invoked_event(executor_id="exec_ts_fail"), test_request)
|
|
failed_results = await mapper2.convert_event(fail_event, test_request)
|
|
|
|
for label, results in [
|
|
("executor_invoked", invoked_results),
|
|
("executor_completed", completed_results),
|
|
("executor_failed", failed_results),
|
|
]:
|
|
assert results, f"mapper.convert_event should return events for {label}"
|
|
for event in results:
|
|
assert getattr(event, "created_at", None) is not None, (
|
|
f"{label} mapped event {type(event).__name__} is missing 'created_at'. "
|
|
"The frontend relies on this field for accurate workflow timeline timings."
|
|
)
|
|
assert event.created_at > 0, (
|
|
f"{label} mapped event {type(event).__name__} has a non-positive "
|
|
f"created_at value ({event.created_at!r}); expected a valid Unix timestamp."
|
|
)
|
|
|
|
|
|
def test_custom_output_item_event_models_have_created_at_field() -> None:
|
|
"""MODEL TEST: CustomResponseOutputItemAddedEvent and Done must declare created_at.
|
|
|
|
This guards against accidentally removing the field from the model definition.
|
|
A missing field causes a downstream ValidationError instead of a clear test failure.
|
|
"""
|
|
from agent_framework_devui.models._openai_custom import (
|
|
CustomResponseOutputItemAddedEvent,
|
|
CustomResponseOutputItemDoneEvent,
|
|
)
|
|
|
|
assert "created_at" in CustomResponseOutputItemAddedEvent.model_fields, (
|
|
"CustomResponseOutputItemAddedEvent is missing 'created_at' in model_fields. "
|
|
"The frontend uses this field for accurate workflow timeline timings."
|
|
)
|
|
assert "created_at" in CustomResponseOutputItemDoneEvent.model_fields, (
|
|
"CustomResponseOutputItemDoneEvent is missing 'created_at' in model_fields. "
|
|
"The frontend uses this field for accurate workflow timeline timings."
|
|
)
|
|
|
|
|
|
async def test_executor_completed_maps_to_output_item_done_event(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""Test executor_completed events are mapped to CustomResponseOutputItemDoneEvent.
|
|
|
|
Ensures executor_completed does not fall through to the legacy
|
|
ResponseWorkflowEventComplete path, which lacks a top-level created_at field.
|
|
"""
|
|
from agent_framework_devui.models._openai_custom import ResponseWorkflowEventComplete
|
|
|
|
invoke_event = create_executor_invoked_event(executor_id="exec_output_item")
|
|
await mapper.convert_event(invoke_event, test_request)
|
|
|
|
complete_event = create_executor_completed_event(executor_id="exec_output_item")
|
|
results = await mapper.convert_event(complete_event, test_request)
|
|
|
|
assert results, "mapper.convert_event should return events for executor_completed"
|
|
|
|
workflow_events = [r for r in results if isinstance(r, ResponseWorkflowEventComplete)]
|
|
assert not workflow_events, (
|
|
"executor_completed should map to CustomResponseOutputItemDoneEvent, not ResponseWorkflowEventComplete."
|
|
)
|
|
|
|
output_item_done = [r for r in results if r.type == "response.output_item.done"]
|
|
assert output_item_done, f"Expected at least one response.output_item.done event; got: {[r.type for r in results]}"
|
|
|
|
|
|
# =============================================================================
|
|
# Workflow Lifecycle Event Tests
|
|
# =============================================================================
|
|
|
|
|
|
async def test_workflow_started_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test WorkflowEvent(type='started') using the REAL class."""
|
|
|
|
event = WorkflowEvent.started()
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# WorkflowEvent(type='started') should emit response.created and response.in_progress
|
|
assert len(events) == 2
|
|
assert events[0].type == "response.created"
|
|
assert events[1].type == "response.in_progress"
|
|
|
|
|
|
async def test_workflow_status_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test WorkflowEvent(type='status') using the REAL class."""
|
|
|
|
event = WorkflowEvent.status(state=WorkflowRunState.IN_PROGRESS)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# Should emit some status-related event
|
|
assert len(events) >= 0 # May emit events or may be filtered
|
|
|
|
|
|
# =============================================================================
|
|
# Magentic Event Tests - Testing WorkflowEvent[AgentResponseUpdate] with additional_properties
|
|
# =============================================================================
|
|
|
|
|
|
async def test_magentic_executor_event_with_agent_delta_metadata(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""Test that WorkflowEvent[AgentResponseUpdate] with magentic_event_type='agent_delta' is handled correctly.
|
|
|
|
This tests the ACTUAL event format Magentic emits - not a fake MagenticAgentDeltaEvent class.
|
|
Magentic emits type='intermediate' WorkflowEvent instances with additional_properties
|
|
containing magentic_event_type.
|
|
"""
|
|
from agent_framework._types import AgentResponseUpdate
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
# Create the REAL event format that Magentic emits
|
|
update = AgentResponseUpdate(
|
|
contents=[Content.from_text(text="Hello from agent")],
|
|
role="assistant",
|
|
author_name="Writer",
|
|
additional_properties={
|
|
"magentic_event_type": "agent_delta",
|
|
"agent_id": "writer_agent",
|
|
},
|
|
)
|
|
event = WorkflowEvent("intermediate", executor_id="magentic_executor", data=update)
|
|
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# Should be treated as a regular WorkflowEvent[AgentResponseUpdate] with text content
|
|
# The mapper should emit text delta events
|
|
assert len(events) >= 1
|
|
text_events = [e for e in events if getattr(e, "type", "") == "response.output_text.delta"]
|
|
assert len(text_events) >= 1
|
|
assert text_events[0].delta == "Hello from agent"
|
|
|
|
|
|
async def test_magentic_orchestrator_message_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test that WorkflowEvent[AgentResponseUpdate] with magentic_event_type='orchestrator_message' is handled.
|
|
|
|
Magentic emits orchestrator planning/instruction messages using type='intermediate'
|
|
WorkflowEvent instances with additional_properties containing magentic_event_type='orchestrator_message'.
|
|
"""
|
|
from agent_framework._types import AgentResponseUpdate
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
# Create orchestrator message event (REAL format from Magentic)
|
|
update = AgentResponseUpdate(
|
|
contents=[Content.from_text(text="Planning: First, the writer will create content...")],
|
|
role="assistant",
|
|
author_name="Orchestrator",
|
|
additional_properties={
|
|
"magentic_event_type": "orchestrator_message",
|
|
"orchestrator_message_kind": "task_ledger",
|
|
"orchestrator_id": "magentic_orchestrator",
|
|
},
|
|
)
|
|
event = WorkflowEvent("intermediate", executor_id="magentic_orchestrator", data=update)
|
|
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# Currently, mapper treats this as regular WorkflowEvent[AgentResponseUpdate] (no special handling)
|
|
# This test documents the current behavior
|
|
assert len(events) >= 1
|
|
text_events = [e for e in events if getattr(e, "type", "") == "response.output_text.delta"]
|
|
assert len(text_events) >= 1
|
|
assert "Planning:" in text_events[0].delta
|
|
|
|
|
|
async def test_magentic_events_use_same_event_class_as_other_workflows(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""Verify Magentic uses the same WorkflowEvent class as other workflows.
|
|
|
|
This test documents that Magentic does NOT define separate event classes like
|
|
MagenticAgentDeltaEvent - it reuses WorkflowEvent with metadata in
|
|
additional_properties. Any mapper code checking for 'MagenticAgentDeltaEvent'
|
|
class names is dead code.
|
|
"""
|
|
from agent_framework._types import AgentResponseUpdate
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
# Create events the way different workflows do it
|
|
# 1. Regular workflow (no additional_properties)
|
|
regular_update = AgentResponseUpdate(
|
|
contents=[Content.from_text(text="Regular workflow response")],
|
|
role="assistant",
|
|
)
|
|
regular_event = WorkflowEvent("intermediate", executor_id="regular_executor", data=regular_update)
|
|
|
|
# 2. Magentic workflow (with additional_properties)
|
|
magentic_update = AgentResponseUpdate(
|
|
contents=[Content.from_text(text="Magentic workflow response")],
|
|
role="assistant",
|
|
additional_properties={"magentic_event_type": "agent_delta"},
|
|
)
|
|
magentic_event = WorkflowEvent("intermediate", executor_id="magentic_executor", data=magentic_update)
|
|
|
|
# Both should be the SAME class
|
|
assert type(regular_event) is type(magentic_event)
|
|
assert isinstance(regular_event, WorkflowEvent)
|
|
assert isinstance(magentic_event, WorkflowEvent)
|
|
|
|
# Both should be handled by the same isinstance check in mapper
|
|
regular_events = await mapper.convert_event(regular_event, test_request)
|
|
magentic_events = await mapper.convert_event(magentic_event, test_request)
|
|
|
|
# Both produce text delta events
|
|
regular_text = [e for e in regular_events if getattr(e, "type", "") == "response.output_text.delta"]
|
|
magentic_text = [e for e in magentic_events if getattr(e, "type", "") == "response.output_text.delta"]
|
|
|
|
assert len(regular_text) >= 1
|
|
assert len(magentic_text) >= 1
|
|
|
|
|
|
# =============================================================================
|
|
# Unknown Content Fallback Tests
|
|
# =============================================================================
|
|
|
|
|
|
async def test_unknown_content_fallback(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test graceful handling of unknown content types."""
|
|
|
|
class MockUnknownContent:
|
|
def __init__(self):
|
|
self.__class__.__name__ = "WeirdUnknownContent"
|
|
|
|
context = mapper._get_or_create_context(test_request)
|
|
unknown_content = MockUnknownContent()
|
|
|
|
event = await mapper._create_unknown_content_event(unknown_content, context)
|
|
|
|
assert event.type == "response.output_text.delta"
|
|
assert "Unknown content type" in event.delta
|
|
assert "WeirdUnknownContent" in event.delta
|
|
|
|
|
|
# =============================================================================
|
|
# output event (type='output') Tests
|
|
# =============================================================================
|
|
|
|
|
|
async def test_workflow_output_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test output event (type='output') is converted to output_item.added."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
event = WorkflowEvent("output", executor_id="final_executor", data="Final workflow output")
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# output event (type='output') should emit output_item.added
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.added"
|
|
# Check item contains the output text
|
|
item = events[0].item
|
|
assert item.type == "message"
|
|
assert item.metadata["workflow_event_type"] == "output"
|
|
assert item.metadata["workflow_output_kind"] == "terminal"
|
|
assert item.metadata["executor_id"] == "final_executor"
|
|
assert any("Final workflow output" in str(c) for c in item.content)
|
|
|
|
|
|
async def test_workflow_output_event_with_list_data(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test output event (type='output') with list data (common for sequential/concurrent workflows)."""
|
|
from agent_framework import Message
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
# Sequential/Concurrent workflows often output list[Message]
|
|
messages = [
|
|
Message(role="user", contents=[Content.from_text(text="Hello")]),
|
|
Message(role="assistant", contents=[Content.from_text(text="World")]),
|
|
]
|
|
event = WorkflowEvent("output", executor_id="complete", data=messages)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.added"
|
|
|
|
|
|
async def test_workflow_intermediate_event_with_agent_response_update_dispatched(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""A WorkflowEvent with type='intermediate' wrapping an AgentResponseUpdate is mapped
|
|
just like type='output' / type='data' — to OpenAI text-delta events."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
update = AgentResponseUpdate(
|
|
contents=[Content.from_text(text="intermediate progress")],
|
|
role="assistant",
|
|
author_name="non-designated-agent",
|
|
)
|
|
event = WorkflowEvent("intermediate", executor_id="non_designated", data=update)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) >= 1
|
|
added_events = [e for e in events if getattr(e, "type", "") == "response.output_item.added"]
|
|
assert added_events
|
|
item = added_events[0].item
|
|
assert item.metadata["workflow_event_type"] == "intermediate"
|
|
assert item.metadata["workflow_output_kind"] == "intermediate"
|
|
assert item.metadata["executor_id"] == "non_designated"
|
|
text_events = [e for e in events if getattr(e, "type", "") == "response.output_text.delta"]
|
|
assert len(text_events) >= 1
|
|
assert text_events[0].metadata["workflow_event_type"] == "intermediate"
|
|
assert text_events[0].metadata["workflow_output_kind"] == "intermediate"
|
|
assert text_events[0].metadata["executor_id"] == "non_designated"
|
|
assert text_events[0].delta == "intermediate progress"
|
|
|
|
|
|
async def test_workflow_intermediate_event_with_string_payload_renders_visible_text(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""A WorkflowEvent with type='intermediate' wrapping a plain string surfaces as a
|
|
visible output item — not a generic completed-trace event. Without this, executors
|
|
that ``await ctx.yield_output("plan: …")`` from non-designated nodes are silently
|
|
dropped in DevUI."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
event = WorkflowEvent("intermediate", executor_id="planner", data="plan: starting work")
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.added"
|
|
item = events[0].item
|
|
assert item.type == "message"
|
|
assert item.metadata["workflow_event_type"] == "intermediate"
|
|
assert item.metadata["workflow_output_kind"] == "intermediate"
|
|
assert item.metadata["executor_id"] == "planner"
|
|
assert any("plan: starting work" in str(c) for c in item.content)
|
|
|
|
|
|
async def test_workflow_intermediate_event_with_message_payload_renders_visible_text(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""type='intermediate' wrapping a Message surfaces visibly — same path as type='output'."""
|
|
from agent_framework import Message
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
msg = Message(role="assistant", contents=[Content.from_text(text="research note")])
|
|
event = WorkflowEvent("intermediate", executor_id="researcher", data=msg)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.added"
|
|
item = events[0].item
|
|
assert item.metadata["workflow_event_type"] == "intermediate"
|
|
assert item.metadata["workflow_output_kind"] == "intermediate"
|
|
assert item.metadata["executor_id"] == "researcher"
|
|
assert any("research note" in str(c) for c in item.content)
|
|
|
|
|
|
async def test_workflow_data_event_keeps_intermediate_compatibility_metadata(
|
|
mapper: MessageMapper, test_request: AgentFrameworkRequest
|
|
) -> None:
|
|
"""Deprecated type='data' workflow events remain visible and explicitly intermediate."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
with pytest.warns(DeprecationWarning):
|
|
event = WorkflowEvent.emit(executor_id="legacy", data="legacy progress")
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.output_item.added"
|
|
item = events[0].item
|
|
assert item.metadata["workflow_event_type"] == "data"
|
|
assert item.metadata["workflow_output_kind"] == "intermediate"
|
|
assert item.metadata["executor_id"] == "legacy"
|
|
assert any("legacy progress" in str(c) for c in item.content)
|
|
|
|
|
|
# =============================================================================
|
|
# failed event (type='failed') Tests
|
|
# =============================================================================
|
|
|
|
|
|
async def test_workflow_failed_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test failed event (type='failed') is converted to response.failed."""
|
|
from agent_framework._workflows._events import WorkflowErrorDetails, WorkflowEvent
|
|
|
|
details = WorkflowErrorDetails(
|
|
error_type="TestError",
|
|
message="Workflow failed due to test error",
|
|
executor_id="failing_executor",
|
|
)
|
|
event = WorkflowEvent.failed(details=details)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# failed event (type='failed') should emit response.failed
|
|
assert len(events) >= 1
|
|
# Find the failed event
|
|
failed_events = [e for e in events if getattr(e, "type", "") == "response.failed"]
|
|
assert len(failed_events) == 1, f"Expected response.failed, got types: {[getattr(e, 'type', '') for e in events]}"
|
|
# Check response contains error info
|
|
response = failed_events[0].response
|
|
assert response.status == "failed"
|
|
assert response.error is not None
|
|
# Verify error message is correctly extracted from details.message (not "Unknown error")
|
|
assert "Workflow failed due to test error" in response.error.message
|
|
assert "Unknown error" not in response.error.message
|
|
|
|
|
|
async def test_workflow_failed_event_with_extra(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test failed event (type='failed') includes extra context when available."""
|
|
from agent_framework._workflows._events import WorkflowErrorDetails, WorkflowEvent
|
|
|
|
details = WorkflowErrorDetails(
|
|
error_type="ValidationError",
|
|
message="Input validation failed",
|
|
executor_id="validation_executor",
|
|
extra={"field": "email", "reason": "invalid format"},
|
|
)
|
|
event = WorkflowEvent.failed(details=details)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.failed"
|
|
response = events[0].response
|
|
# Verify both the message and extra context are included
|
|
assert "Input validation failed" in response.error.message
|
|
assert "extra:" in response.error.message
|
|
assert "email" in response.error.message
|
|
|
|
|
|
async def test_workflow_failed_event_with_traceback(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test failed event (type='failed') includes traceback when available."""
|
|
from agent_framework._workflows._events import WorkflowErrorDetails, WorkflowEvent
|
|
|
|
details = WorkflowErrorDetails(
|
|
error_type="ValueError",
|
|
message="Invalid input provided",
|
|
traceback="Traceback (most recent call last):\n File ...\nValueError: Invalid input",
|
|
executor_id="validation_executor",
|
|
)
|
|
event = WorkflowEvent.failed(details=details)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.failed"
|
|
|
|
|
|
# =============================================================================
|
|
# WorkflowWarningEvent and WorkflowErrorEvent Tests
|
|
# =============================================================================
|
|
|
|
|
|
async def test_workflow_warning_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test WorkflowEvent(type='warning') is converted to trace event."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
event = WorkflowEvent.warning("This is a warning message")
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# WorkflowEvent(type='warning') should emit a trace event
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.trace.completed"
|
|
assert events[0].data["event_type"] == "warning"
|
|
|
|
|
|
async def test_workflow_error_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test WorkflowEvent(type='error') is converted to trace event."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
event = WorkflowEvent.error(ValueError("Something went wrong"))
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# WorkflowEvent(type='error') should emit a trace event
|
|
assert len(events) == 1
|
|
assert events[0].type == "response.trace.completed"
|
|
assert events[0].data["event_type"] == "error"
|
|
|
|
|
|
# =============================================================================
|
|
# request_info event (type='request_info') Tests (Human-in-the-Loop)
|
|
# =============================================================================
|
|
|
|
|
|
async def test_request_info_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test request_info event (type='request_info') is converted to HIL request event."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
event = WorkflowEvent.request_info(
|
|
request_id="req_123",
|
|
source_executor_id="approval_executor",
|
|
request_data={"action": "approve", "details": "Please approve this action"},
|
|
response_type=str,
|
|
)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# request_info event (type='request_info') should emit response.request_info.requested
|
|
assert len(events) >= 1
|
|
# Check that request info is captured
|
|
has_hil_event = any(getattr(e, "type", "") == "response.request_info.requested" for e in events)
|
|
assert has_hil_event, f"Expected response.request_info.requested, got: {[getattr(e, 'type', '') for e in events]}"
|
|
|
|
# Verify the event contains the expected data
|
|
hil_event = [e for e in events if getattr(e, "type", "") == "response.request_info.requested"][0]
|
|
assert hil_event.request_id == "req_123"
|
|
assert hil_event.source_executor_id == "approval_executor"
|
|
|
|
|
|
# =============================================================================
|
|
# SuperStep Event Tests
|
|
# =============================================================================
|
|
|
|
|
|
async def test_superstep_started_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test superstep_started event (type='superstep_started') is handled gracefully."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
event = WorkflowEvent.superstep_started(iteration=1)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# superstep_started event (type='superstep_started') may not emit events (internal workflow signal)
|
|
# Just ensure it doesn't crash
|
|
assert isinstance(events, list)
|
|
|
|
|
|
async def test_superstep_completed_event(mapper: MessageMapper, test_request: AgentFrameworkRequest) -> None:
|
|
"""Test superstep_completed event (type='superstep_completed') is handled gracefully."""
|
|
from agent_framework._workflows._events import WorkflowEvent
|
|
|
|
event = WorkflowEvent.superstep_completed(iteration=1)
|
|
events = await mapper.convert_event(event, test_request)
|
|
|
|
# superstep_completed event (type='superstep_completed') may not emit events (internal workflow signal)
|
|
# Just ensure it doesn't crash
|
|
assert isinstance(events, list)
|