Unify AgentResponse events with WorkflowOutputEvent (#2938)

- Change AgentResponseEvent and AgentResponseUpdateEvent to inherit from
  WorkflowOutputEvent instead of ExecutorEvent
- Update AIAgentHostExecutor and HandoffAgentExecutor to use YieldOutputAsync()
  instead of AddEventAsync() for agent outputs
- Add special-casing in InProcessRunnerContext.YieldOutputAsync() to create
  specific event types for AgentResponse and AgentResponseUpdate, bypassing
  OutputFilter for backwards compatibility
- Update TestRunContext and TestWorkflowContext with same special-casing
- Add regression tests in AgentEventsTests

Author: lokitoth

dotnet/src/Microsoft.Agents.AI.Workflows/AgentResponseEvent.cs

@@ -7,14 +7,14 @@ namespace Microsoft.Agents.AI.Workflows;
 /// <summary>
 /// Represents an event triggered when an agent produces a response.
 /// </summary>
-public class AgentResponseEvent : ExecutorEvent
+public class AgentResponseEvent : WorkflowOutputEvent
 {
     /// <summary>
     /// Initializes a new instance of the <see cref="AgentResponseEvent"/> class.
     /// </summary>
     /// <param name="executorId">The identifier of the executor that generated this event.</param>
     /// <param name="response">The agent response.</param>
-    public AgentResponseEvent(string executorId, AgentResponse response) : base(executorId, data: response)
+    public AgentResponseEvent(string executorId, AgentResponse response) : base(response, executorId)
     {
         this.Response = Throw.IfNull(response);
     }

dotnet/src/Microsoft.Agents.AI.Workflows/AgentResponseUpdateEvent.cs

@@ -8,14 +8,14 @@ namespace Microsoft.Agents.AI.Workflows;
 /// <summary>
 /// Represents an event triggered when an agent run produces an update.
 /// </summary>
-public class AgentResponseUpdateEvent : ExecutorEvent
+public class AgentResponseUpdateEvent : WorkflowOutputEvent
 {
     /// <summary>
     /// Initializes a new instance of the <see cref="AgentResponseUpdateEvent"/> class.
     /// </summary>
     /// <param name="executorId">The identifier of the executor that generated this event.</param>
     /// <param name="update">The agent run response update.</param>
-    public AgentResponseUpdateEvent(string executorId, AgentResponseUpdate update) : base(executorId, data: update)
+    public AgentResponseUpdateEvent(string executorId, AgentResponseUpdate update) : base(update, executorId)
     {
         this.Update = Throw.IfNull(update);
     }

dotnet/src/Microsoft.Agents.AI.Workflows/InProc/InProcessRunnerContext.cs

@@ -233,6 +233,20 @@ private async ValueTask YieldOutputAsync(string sourceId, object output, Cancell
         this.CheckEnded();
         Throw.IfNull(output);
 
+        // Special-case AgentResponse and AgentResponseUpdate to create their specific event types
+        // and bypass the output filter (for backwards compatibility - these events were previously
+        // emitted directly via AddEventAsync without filtering)
+        if (output is AgentResponseUpdate update)
+        {
+            await this.AddEventAsync(new AgentResponseUpdateEvent(sourceId, update), cancellationToken).ConfigureAwait(false);
+            return;
+        }
+        else if (output is AgentResponse response)
+        {
+            await this.AddEventAsync(new AgentResponseEvent(sourceId, response), cancellationToken).ConfigureAwait(false);
+            return;
+        }
+
         Executor sourceExecutor = await this.EnsureExecutorAsync(sourceId, tracer: null, cancellationToken).ConfigureAwait(false);
         if (!sourceExecutor.CanOutput(output.GetType()))
         {

dotnet/src/Microsoft.Agents.AI.Workflows/Specialized/AIAgentHostExecutor.cs

@@ -180,7 +180,7 @@ await this.EnsureSessionAsync(context, cancellationToken).ConfigureAwait(false),
             List<AgentResponseUpdate> updates = [];
             await foreach (AgentResponseUpdate update in agentStream.ConfigureAwait(false))
             {
-                await context.AddEventAsync(new AgentResponseUpdateEvent(this.Id, update), cancellationToken).ConfigureAwait(false);
+                await context.YieldOutputAsync(update, cancellationToken).ConfigureAwait(false);
                 ExtractUnservicedRequests(update.Contents);
                 updates.Add(update);
             }
@@ -200,7 +200,7 @@ await this.EnsureSessionAsync(context, cancellationToken).ConfigureAwait(false),
 
         if (this._options.EmitAgentResponseEvents == true)
         {
-            await context.AddEventAsync(new AgentResponseEvent(this.Id, response), cancellationToken).ConfigureAwait(false);
+            await context.YieldOutputAsync(response, cancellationToken).ConfigureAwait(false);
         }
 
         if (userInputRequests.Count > 0 || functionCalls.Count > 0)

dotnet/src/Microsoft.Agents.AI.Workflows/Specialized/HandoffAgentExecutor.cs

@@ -109,7 +109,7 @@ async Task AddUpdateAsync(AgentResponseUpdate update, CancellationToken cancella
                 updates.Add(update);
                 if (handoffState.TurnToken.EmitEvents is true)
                 {
-                    await context.AddEventAsync(new AgentResponseUpdateEvent(this.Id, update), cancellationToken).ConfigureAwait(false);
+                    await context.YieldOutputAsync(update, cancellationToken).ConfigureAwait(false);
                 }
             }
         });

dotnet/src/Microsoft.Agents.AI.Workflows/WorkflowOutputEvent.cs

@@ -2,15 +2,23 @@
 
 using System;
 using System.Diagnostics.CodeAnalysis;
+using System.Text.Json.Serialization;
 
 namespace Microsoft.Agents.AI.Workflows;
 
 /// <summary>
 /// Event triggered when a workflow executor yields output.
 /// </summary>
-public sealed class WorkflowOutputEvent : WorkflowEvent
+[JsonDerivedType(typeof(AgentResponseEvent))]
+[JsonDerivedType(typeof(AgentResponseUpdateEvent))]
+public class WorkflowOutputEvent : WorkflowEvent
 {
-    internal WorkflowOutputEvent(object data, string executorId) : base(data)
+    /// <summary>
+    /// Initializes a new instance of the <see cref="WorkflowOutputEvent"/> class.
+    /// </summary>
+    /// <param name="data">The output data.</param>
+    /// <param name="executorId">The identifier of the executor that yielded this output.</param>
+    public WorkflowOutputEvent(object data, string executorId) : base(data)
     {
         this.ExecutorId = executorId;
     }

dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/AgentEventsTests.cs

@@ -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);
+    }
+}

dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/TestRunContext.cs

@@ -50,7 +50,20 @@ public ValueTask AddEventAsync(WorkflowEvent workflowEvent, CancellationToken ca
             => runnerContext.AddEventAsync(workflowEvent, cancellationToken);
 
         public ValueTask YieldOutputAsync(object output, CancellationToken cancellationToken = default)
-            => this.AddEventAsync(new WorkflowOutputEvent(output, executorId), cancellationToken);
+        {
+            // Special-case AgentResponse and AgentResponseUpdate to create their specific event types
+            // (consistent with InProcessRunnerContext.YieldOutputAsync)
+            if (output is AgentResponseUpdate update)
+            {
+                return this.AddEventAsync(new AgentResponseUpdateEvent(executorId, update), cancellationToken);
+            }
+            else if (output is AgentResponse response)
+            {
+                return this.AddEventAsync(new AgentResponseEvent(executorId, response), cancellationToken);
+            }
+
+            return this.AddEventAsync(new WorkflowOutputEvent(output, executorId), cancellationToken);
+        }
 
         public ValueTask RequestHaltAsync()
             => this.AddEventAsync(new RequestHaltEvent());

dotnet/tests/Microsoft.Agents.AI.Workflows.UnitTests/TestWorkflowContext.cs

@@ -41,6 +41,18 @@ public ValueTask AddEventAsync(WorkflowEvent workflowEvent, CancellationToken ca
     public ValueTask YieldOutputAsync(object output, CancellationToken cancellationToken = default)
     {
         this.YieldedOutputs.Enqueue(output);
+
+        // Special-case AgentResponse and AgentResponseUpdate to create their specific event types
+        // (consistent with InProcessRunnerContext.YieldOutputAsync)
+        if (output is AgentResponseUpdate update)
+        {
+            return this.AddEventAsync(new AgentResponseUpdateEvent(this._executorId, update), cancellationToken);
+        }
+        else if (output is AgentResponse response)
+        {
+            return this.AddEventAsync(new AgentResponseEvent(this._executorId, response), cancellationToken);
+        }
+
         return this.AddEventAsync(new WorkflowOutputEvent(output, this._executorId), cancellationToken);
     }