Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -756,6 +756,7 @@ def _convert_workflow_event_to_agent_response_updates(
agent_id=data.agent_id,
response_id=data.response_id,
message_id=data.message_id,
merge_mode=data.merge_mode,
created_at=data.created_at,
# The attribute is typed wider than the constructor accepts (custom
# connectors may set any string); forward the value unchanged.
Expand Down
48 changes: 47 additions & 1 deletion python/packages/core/tests/workflow/test_workflow_agent.py
Original file line number Diff line number Diff line change
Expand Up @@ -887,7 +887,10 @@ async def yielding_executor(messages: list[Message], ctx: WorkflowContext[Never,
assert "first output" in texts
assert "second output" in texts

async def test_workflow_as_agent_stream_preserves_response_update_metadata(self) -> None:
@pytest.mark.parametrize("merge_mode", [None, "append", "replace"])
async def test_workflow_as_agent_stream_preserves_response_update_metadata(
self, merge_mode: Literal["append", "replace"] | None
) -> None:
"""Test that streaming forwards finish_reason, continuation_token, terminality, and additional properties.

This validates the fix for issue #7952: AgentResponseUpdate metadata should be
Expand All @@ -902,6 +905,7 @@ async def metadata_executor(messages: list[Message], ctx: WorkflowContext[Never,
agent_id="source-agent",
response_id="source-response",
message_id="source-message",
merge_mode=merge_mode,
finish_reason="stop",
continuation_token=cast(Any, {"token": "resume-token"}),
additional_properties={"provider_marker": "preserve-me"},
Expand All @@ -921,11 +925,53 @@ async def metadata_executor(messages: list[Message], ctx: WorkflowContext[Never,
update = metadata_updates[0]
assert update.text == "payload"
assert update.agent_id == "source-agent"
assert update.merge_mode == merge_mode
assert update.finish_reason == "stop"
assert update.continuation_token == {"token": "resume-token"}
assert _get_operation_state(update) == "in_progress"
assert update.additional_properties == {"provider_marker": "preserve-me"}

@pytest.mark.parametrize("with_uri", [False, True])
@pytest.mark.parametrize("result_source", ["stream", "history"])
async def test_workflow_as_agent_stream_replaces_logical_message_contents(
self, with_uri: bool, result_source: str
) -> None:
"""An authoritative update replaces old text and atomic content in output and history."""

@executor
async def snapshot_executor(messages: list[Message], ctx: WorkflowContext[Never, AgentResponseUpdate]) -> None:
draft = [Content.from_text("draft")]
final = [Content.from_text("final")]
if with_uri:
draft.append(Content.from_uri("https://example.com/draft.png", media_type="image/png"))
final.append(Content.from_uri("https://example.com/final.png", media_type="image/png"))
await ctx.yield_output(AgentResponseUpdate(contents=draft, role="assistant", message_id="message-1"))
await ctx.yield_output(
AgentResponseUpdate(contents=final, role="assistant", message_id="message-1", merge_mode="replace")
)

workflow = WorkflowBuilder(start_executor=snapshot_executor, output_from=[snapshot_executor]).build()
history = InMemoryHistoryProvider()
agent = workflow.as_agent(context_providers=[history])
session = AgentSession()

stream = agent.run("hello", stream=True, session=session)
updates = [update async for update in stream]
response = await stream.get_final_response()
if result_source == "history":
stored = await history.get_messages(session.session_id, state=session.state[history.source_id])
messages = [message for message in stored if message.role == "assistant"]
else:
messages = response.messages

assert len(messages) == 1
assert messages[0].message_id == "message-1"
assert messages[0].text == "final"
assert [content.uri for content in messages[0].contents if content.type == "uri"] == (
["https://example.com/final.png"] if with_uri else []
)
assert updates[-1].merge_mode == "replace"

async def test_workflow_as_agent_stream_preserves_response_metadata(self) -> None:
"""Test that streaming preserves metadata from an AgentResponse output."""

Expand Down
Loading