-
Notifications
You must be signed in to change notification settings - Fork 1.1k
.NET: BREAKING: Unify AgentResponse[Update] events as WorkflowOutputEvents
#3441
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
lokitoth
wants to merge
2
commits into
main
Choose a base branch
from
dev/dotnet_workflow/unify_agent_response_event_in_output
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
91 changes: 91 additions & 0 deletions
91
dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/AgentEventsTests.cs
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| // Copyright (c) Microsoft. All rights reserved. | ||
|
|
||
| using System.Collections.Generic; | ||
| using System.Threading.Tasks; | ||
| using Microsoft.Extensions.AI; | ||
|
|
||
| namespace Microsoft.Agents.AI.Workflows.UnitTests; | ||
|
|
||
| public class AgentEventsTests | ||
| { | ||
| /// <summary> | ||
| /// Regression test for https://github.com/microsoft/agent-framework/issues/2938 | ||
| /// Verifies that WorkflowOutputEvent is triggered for agent workflows built with | ||
| /// WorkflowBuilder directly (without using AgentWorkflowBuilder helpers). | ||
| /// </summary> | ||
| [Fact] | ||
| public async Task WorkflowBuilder_WithAgents_EmitsWorkflowOutputEventAsync() | ||
| { | ||
| // Arrange - Build workflow using WorkflowBuilder directly (not AgentWorkflowBuilder.BuildSequential) | ||
| AIAgent agent1 = new TestEchoAgent("agent1"); | ||
| AIAgent agent2 = new TestEchoAgent("agent2"); | ||
|
|
||
| Workflow workflow = new WorkflowBuilder(agent1) | ||
| .AddEdge(agent1, agent2) | ||
| .Build(); | ||
|
|
||
| // Act | ||
| await using StreamingRun run = await InProcessExecution.StreamAsync(workflow, new List<ChatMessage> { new(ChatRole.User, "Hello") }); | ||
| await run.TrySendMessageAsync(new TurnToken(emitEvents: true)); | ||
|
|
||
| List<WorkflowOutputEvent> outputEvents = new(); | ||
| List<AgentResponseUpdateEvent> updateEvents = new(); | ||
|
|
||
| await foreach (WorkflowEvent evt in run.WatchStreamAsync()) | ||
| { | ||
| if (evt is AgentResponseUpdateEvent updateEvt) | ||
| { | ||
| updateEvents.Add(updateEvt); | ||
| } | ||
|
|
||
| if (evt is WorkflowOutputEvent outputEvt) | ||
| { | ||
| outputEvents.Add(outputEvt); | ||
| } | ||
| } | ||
|
|
||
| // Assert - AgentResponseUpdateEvent should now be a WorkflowOutputEvent | ||
| Assert.NotEmpty(updateEvents); | ||
| Assert.NotEmpty(outputEvents); | ||
| // All update events should also be output events (since AgentResponseUpdateEvent now inherits from WorkflowOutputEvent) | ||
| Assert.All(updateEvents, updateEvt => Assert.Contains(updateEvt, outputEvents)); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Verifies that AgentResponseUpdateEvent inherits from WorkflowOutputEvent. | ||
| /// </summary> | ||
| [Fact] | ||
| public void AgentResponseUpdateEvent_IsWorkflowOutputEvent() | ||
| { | ||
| // Arrange | ||
| AgentResponseUpdate update = new(ChatRole.Assistant, "test"); | ||
|
|
||
| // Act | ||
| AgentResponseUpdateEvent evt = new("executor1", update); | ||
|
|
||
| // Assert | ||
| Assert.IsAssignableFrom<WorkflowOutputEvent>(evt); | ||
| Assert.Equal("executor1", evt.ExecutorId); | ||
| Assert.Same(update, evt.Update); | ||
| Assert.Same(update, evt.Data); | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Verifies that AgentResponseEvent inherits from WorkflowOutputEvent. | ||
| /// </summary> | ||
| [Fact] | ||
| public void AgentResponseEvent_IsWorkflowOutputEvent() | ||
| { | ||
| // Arrange | ||
| AgentResponse response = new(new List<ChatMessage> { new(ChatRole.Assistant, "test") }); | ||
|
|
||
| // Act | ||
| AgentResponseEvent evt = new("executor1", response); | ||
|
|
||
| // Assert | ||
| Assert.IsAssignableFrom<WorkflowOutputEvent>(evt); | ||
| Assert.Equal("executor1", evt.ExecutorId); | ||
| Assert.Same(response, evt.Response); | ||
| Assert.Same(response, evt.Data); | ||
| } | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Should this be sealed now or do we expect people to derive from AgentResponseUpdateEvent and AgentResponseEvent?