mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
d2f79930d5
* Refactor group chat workflow to prevent message echoing and enhance checkpointing - Updated GroupChatWorkflowBuilder to disable forwarding incoming messages to prevent duplicates. - Enhanced RoundRobinGroupChatManager with checkpointing support to preserve state across executions. - Modified GroupChatHost to maintain a history of messages and track the current speaker for message broadcasting. - Implemented broadcasting logic to ensure participants receive messages from others while excluding their own responses. - Added comprehensive unit tests for group chat orchestration, including scenarios for tool approval and function calls. - Introduced a new ApprovalHarness for testing tool invocation and approval workflows. * fixup: format * Add JSON serialization support for GroupChatManagerState and RoundRobinGroupChatManagerState --------- Co-authored-by: Jacob Alber <jalber@lokitoth.com>
618 lines
28 KiB
C#
618 lines
28 KiB
C#
// Copyright (c) Microsoft. All rights reserved.
|
|
|
|
using System;
|
|
using System.Collections.Generic;
|
|
using System.Linq;
|
|
using System.Runtime.CompilerServices;
|
|
using System.Text;
|
|
using System.Text.Json;
|
|
using System.Text.RegularExpressions;
|
|
using System.Threading;
|
|
using System.Threading.Tasks;
|
|
using Microsoft.Agents.AI.Workflows.InProc;
|
|
using Microsoft.Extensions.AI;
|
|
|
|
#pragma warning disable SYSLIB1045 // Use GeneratedRegex
|
|
#pragma warning disable RCS1186 // Use Regex instance instead of static method
|
|
|
|
namespace Microsoft.Agents.AI.Workflows.UnitTests;
|
|
|
|
public class AgentWorkflowBuilderTests
|
|
{
|
|
[Fact]
|
|
public void BuildSequential_InvalidArguments_Throws()
|
|
{
|
|
Assert.Throws<ArgumentNullException>("agents", () => AgentWorkflowBuilder.BuildSequential(workflowName: null!, null!));
|
|
Assert.Throws<ArgumentException>("agents", () => AgentWorkflowBuilder.BuildSequential());
|
|
}
|
|
|
|
[Fact]
|
|
public void BuildConcurrent_InvalidArguments_Throws()
|
|
{
|
|
Assert.Throws<ArgumentNullException>("agents", () => AgentWorkflowBuilder.BuildConcurrent(null!));
|
|
}
|
|
|
|
[Fact]
|
|
public void BuildGroupChat_InvalidArguments_Throws()
|
|
{
|
|
Assert.Throws<ArgumentNullException>("managerFactory", () => AgentWorkflowBuilder.CreateGroupChatBuilderWith(null!));
|
|
|
|
var groupChat = AgentWorkflowBuilder.CreateGroupChatBuilderWith(_ => new RoundRobinGroupChatManager([new DoubleEchoAgent("a1")]));
|
|
Assert.NotNull(groupChat);
|
|
Assert.Throws<ArgumentNullException>("agents", () => groupChat.AddParticipants(null!));
|
|
Assert.Throws<ArgumentNullException>("agents", () => groupChat.AddParticipants([null!]));
|
|
Assert.Throws<ArgumentNullException>("agents", () => groupChat.AddParticipants(new DoubleEchoAgent("a1"), null!));
|
|
|
|
Assert.Throws<ArgumentNullException>("agents", () => new RoundRobinGroupChatManager(null!));
|
|
}
|
|
|
|
[Fact]
|
|
public void GroupChatManager_MaximumIterationCount_Invalid_Throws()
|
|
{
|
|
var manager = new RoundRobinGroupChatManager([new DoubleEchoAgent("a1")]);
|
|
|
|
const int DefaultMaxIterations = 40;
|
|
Assert.Equal(DefaultMaxIterations, manager.MaximumIterationCount);
|
|
Assert.Throws<ArgumentOutOfRangeException>("value", void () => manager.MaximumIterationCount = 0);
|
|
Assert.Throws<ArgumentOutOfRangeException>("value", void () => manager.MaximumIterationCount = -1);
|
|
Assert.Equal(DefaultMaxIterations, manager.MaximumIterationCount);
|
|
|
|
manager.MaximumIterationCount = 30;
|
|
Assert.Equal(30, manager.MaximumIterationCount);
|
|
|
|
manager.MaximumIterationCount = 1;
|
|
Assert.Equal(1, manager.MaximumIterationCount);
|
|
|
|
manager.MaximumIterationCount = int.MaxValue;
|
|
Assert.Equal(int.MaxValue, manager.MaximumIterationCount);
|
|
}
|
|
|
|
[Fact]
|
|
public void BuildGroupChat_WithNameAndDescription_SetsWorkflowNameAndDescription()
|
|
{
|
|
const string WorkflowName = "Test Group Chat";
|
|
const string WorkflowDescription = "A test group chat workflow";
|
|
|
|
var workflow = AgentWorkflowBuilder
|
|
.CreateGroupChatBuilderWith(agents => new RoundRobinGroupChatManager(agents) { MaximumIterationCount = 2 })
|
|
.AddParticipants(new DoubleEchoAgent("agent1"), new DoubleEchoAgent("agent2"))
|
|
.WithName(WorkflowName)
|
|
.WithDescription(WorkflowDescription)
|
|
.Build();
|
|
|
|
Assert.Equal(WorkflowName, workflow.Name);
|
|
Assert.Equal(WorkflowDescription, workflow.Description);
|
|
}
|
|
|
|
[Fact]
|
|
public void BuildGroupChat_WithNameOnly_SetsWorkflowName()
|
|
{
|
|
const string WorkflowName = "Named Group Chat";
|
|
|
|
var workflow = AgentWorkflowBuilder
|
|
.CreateGroupChatBuilderWith(agents => new RoundRobinGroupChatManager(agents) { MaximumIterationCount = 2 })
|
|
.AddParticipants(new DoubleEchoAgent("agent1"))
|
|
.WithName(WorkflowName)
|
|
.Build();
|
|
|
|
Assert.Equal(WorkflowName, workflow.Name);
|
|
Assert.Null(workflow.Description);
|
|
}
|
|
|
|
[Fact]
|
|
public void BuildGroupChat_WithoutNameOrDescription_DefaultsToNull()
|
|
{
|
|
var workflow = AgentWorkflowBuilder
|
|
.CreateGroupChatBuilderWith(agents => new RoundRobinGroupChatManager(agents) { MaximumIterationCount = 2 })
|
|
.AddParticipants(new DoubleEchoAgent("agent1"))
|
|
.Build();
|
|
|
|
Assert.Null(workflow.Name);
|
|
Assert.Null(workflow.Description);
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(1)]
|
|
[InlineData(2)]
|
|
[InlineData(3)]
|
|
[InlineData(4)]
|
|
[InlineData(5)]
|
|
public async Task BuildSequential_AgentsRunInOrderAsync(int numAgents)
|
|
{
|
|
var workflow = AgentWorkflowBuilder.BuildSequential(
|
|
from i in Enumerable.Range(1, numAgents)
|
|
select new DoubleEchoAgent($"agent{i}"));
|
|
|
|
for (int iter = 0; iter < 3; iter++)
|
|
{
|
|
const string UserInput = "abc";
|
|
(string updateText, List<ChatMessage>? result, _, _) = await RunWorkflowAsync(workflow, [new ChatMessage(ChatRole.User, UserInput)]);
|
|
|
|
Assert.NotNull(result);
|
|
Assert.Equal(numAgents + 1, result.Count);
|
|
|
|
Assert.Equal(ChatRole.User, result[0].Role);
|
|
Assert.Null(result[0].AuthorName);
|
|
Assert.Equal(UserInput, result[0].Text);
|
|
|
|
string[] texts = new string[numAgents + 1];
|
|
texts[0] = UserInput;
|
|
string expectedTotal = string.Empty;
|
|
for (int i = 1; i < numAgents + 1; i++)
|
|
{
|
|
string id = $"agent{((i - 1) % numAgents) + 1}";
|
|
texts[i] = $"{id}{Double(string.Concat(texts.Take(i)))}";
|
|
Assert.Equal(ChatRole.Assistant, result[i].Role);
|
|
Assert.Equal(id, result[i].AuthorName);
|
|
Assert.Equal(texts[i], result[i].Text);
|
|
expectedTotal += texts[i];
|
|
}
|
|
|
|
Assert.Equal(expectedTotal, updateText);
|
|
Assert.Equal(UserInput + expectedTotal, string.Concat(result));
|
|
|
|
static string Double(string s) => s + s;
|
|
}
|
|
}
|
|
|
|
private class DoubleEchoAgent(string name) : AIAgent
|
|
{
|
|
public override string Name => name;
|
|
|
|
protected override ValueTask<AgentSession> CreateSessionCoreAsync(CancellationToken cancellationToken = default)
|
|
=> new(new DoubleEchoAgentSession());
|
|
|
|
protected override ValueTask<AgentSession> DeserializeSessionCoreAsync(JsonElement serializedState, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
|
|
=> new(new DoubleEchoAgentSession());
|
|
|
|
protected override ValueTask<JsonElement> SerializeSessionCoreAsync(AgentSession session, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
|
|
=> default;
|
|
|
|
protected override Task<AgentResponse> RunCoreAsync(
|
|
IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default) =>
|
|
throw new NotImplementedException();
|
|
|
|
protected override async IAsyncEnumerable<AgentResponseUpdate> RunCoreStreamingAsync(
|
|
IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
|
|
{
|
|
await Task.Yield();
|
|
|
|
var contents = messages.SelectMany(m => m.Contents).ToList();
|
|
string id = Guid.NewGuid().ToString("N");
|
|
yield return new AgentResponseUpdate(ChatRole.Assistant, this.Name) { AuthorName = this.Name, MessageId = id };
|
|
yield return new AgentResponseUpdate(ChatRole.Assistant, contents) { AuthorName = this.Name, MessageId = id };
|
|
yield return new AgentResponseUpdate(ChatRole.Assistant, contents) { AuthorName = this.Name, MessageId = id };
|
|
}
|
|
}
|
|
|
|
private sealed class DoubleEchoAgentSession() : AgentSession();
|
|
|
|
[Fact]
|
|
public async Task BuildConcurrent_AgentsRunInParallelAsync()
|
|
{
|
|
StrongBox<TaskCompletionSource<bool>> barrier = new();
|
|
StrongBox<int> remaining = new();
|
|
|
|
var workflow = AgentWorkflowBuilder.BuildConcurrent(
|
|
[
|
|
new DoubleEchoAgentWithBarrier("agent1", barrier, remaining),
|
|
new DoubleEchoAgentWithBarrier("agent2", barrier, remaining),
|
|
]);
|
|
|
|
for (int iter = 0; iter < 3; iter++)
|
|
{
|
|
barrier.Value = new TaskCompletionSource<bool>(TaskCreationOptions.RunContinuationsAsynchronously);
|
|
remaining.Value = 2;
|
|
|
|
(string updateText, List<ChatMessage>? result, _, _) = await RunWorkflowAsync(workflow, [new ChatMessage(ChatRole.User, "abc")]);
|
|
Assert.NotEmpty(updateText);
|
|
Assert.NotNull(result);
|
|
|
|
// TODO: https://github.com/microsoft/agent-framework/issues/784
|
|
// These asserts are flaky until we guarantee message delivery order.
|
|
Assert.Single(Regex.Matches(updateText, "agent1"));
|
|
Assert.Single(Regex.Matches(updateText, "agent2"));
|
|
Assert.Equal(4, Regex.Matches(updateText, "abc").Count);
|
|
Assert.Equal(2, result.Count);
|
|
}
|
|
}
|
|
|
|
[Theory]
|
|
[InlineData(1)]
|
|
[InlineData(2)]
|
|
[InlineData(3)]
|
|
[InlineData(4)]
|
|
[InlineData(5)]
|
|
public async Task BuildGroupChat_AgentsRunInOrderAsync(int maxIterations)
|
|
{
|
|
const int NumAgents = 3;
|
|
var workflow = AgentWorkflowBuilder.CreateGroupChatBuilderWith(agents => new RoundRobinGroupChatManager(agents) { MaximumIterationCount = maxIterations })
|
|
.AddParticipants(new DoubleEchoAgent("agent1"), new DoubleEchoAgent("agent2"))
|
|
.AddParticipants(new DoubleEchoAgent("agent3"))
|
|
.Build();
|
|
|
|
for (int iter = 0; iter < 3; iter++)
|
|
{
|
|
const string UserInput = "abc";
|
|
(string updateText, List<ChatMessage>? result, _, _) = await RunWorkflowAsync(workflow, [new ChatMessage(ChatRole.User, UserInput)]);
|
|
|
|
Assert.NotNull(result);
|
|
Assert.Equal(maxIterations + 1, result.Count);
|
|
|
|
Assert.Equal(ChatRole.User, result[0].Role);
|
|
Assert.Null(result[0].AuthorName);
|
|
Assert.Equal(UserInput, result[0].Text);
|
|
|
|
// The group-chat host broadcasts each new message (initial user input + each speaker's
|
|
// response) to every participant except the speaker that produced it. The selected
|
|
// speaker therefore sees only what's been broadcast to it since its previous turn.
|
|
string[] agentIds = ["agent1", "agent2", "agent3"];
|
|
List<string>[] buffers = new List<string>[NumAgents];
|
|
for (int a = 0; a < NumAgents; a++)
|
|
{
|
|
buffers[a] = [UserInput];
|
|
}
|
|
|
|
string[] texts = new string[maxIterations + 1];
|
|
texts[0] = UserInput;
|
|
string expectedTotal = string.Empty;
|
|
for (int i = 1; i < maxIterations + 1; i++)
|
|
{
|
|
int speakerIdx = (i - 1) % NumAgents;
|
|
string id = agentIds[speakerIdx];
|
|
string concatReceived = string.Concat(buffers[speakerIdx]);
|
|
texts[i] = $"{id}{Double(concatReceived)}";
|
|
buffers[speakerIdx].Clear();
|
|
for (int a = 0; a < NumAgents; a++)
|
|
{
|
|
if (a == speakerIdx)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
buffers[a].Add(texts[i]);
|
|
}
|
|
|
|
Assert.Equal(ChatRole.Assistant, result[i].Role);
|
|
Assert.Equal(id, result[i].AuthorName);
|
|
Assert.Equal(texts[i], result[i].Text);
|
|
expectedTotal += texts[i];
|
|
}
|
|
|
|
Assert.Equal(expectedTotal, updateText);
|
|
Assert.Equal(UserInput + expectedTotal, string.Concat(result));
|
|
|
|
static string Double(string s) => s + s;
|
|
}
|
|
}
|
|
|
|
private sealed record WorkflowRunResult(string UpdateText, List<ChatMessage>? Result, CheckpointInfo? LastCheckpoint, List<RequestInfoEvent> PendingRequests);
|
|
|
|
private static async Task<WorkflowRunResult> RunWorkflowCheckpointedAsync(
|
|
Workflow workflow, List<ChatMessage> input, InProcessExecutionEnvironment environment, CheckpointInfo? fromCheckpoint = null)
|
|
{
|
|
await using StreamingRun run =
|
|
fromCheckpoint != null ? await environment.ResumeStreamingAsync(workflow, fromCheckpoint)
|
|
: await environment.OpenStreamingAsync(workflow);
|
|
|
|
await run.TrySendMessageAsync(input);
|
|
await run.TrySendMessageAsync(new TurnToken(emitEvents: true));
|
|
|
|
return await ProcessWorkflowRunAsync(run);
|
|
}
|
|
|
|
private static async Task<WorkflowRunResult> ProcessWorkflowRunAsync(StreamingRun run)
|
|
{
|
|
StringBuilder sb = new();
|
|
WorkflowOutputEvent? output = null;
|
|
CheckpointInfo? lastCheckpoint = null;
|
|
|
|
List<RequestInfoEvent> pendingRequests = [];
|
|
|
|
await foreach (WorkflowEvent evt in run.WatchStreamAsync(blockOnPendingRequest: false).ConfigureAwait(false))
|
|
{
|
|
switch (evt)
|
|
{
|
|
case AgentResponseUpdateEvent responseUpdate:
|
|
sb.Append(responseUpdate.Data);
|
|
break;
|
|
|
|
case RequestInfoEvent requestInfo:
|
|
pendingRequests.Add(requestInfo);
|
|
break;
|
|
|
|
case WorkflowOutputEvent e:
|
|
output = e;
|
|
break;
|
|
|
|
case WorkflowErrorEvent errorEvent:
|
|
Assert.Fail($"Workflow execution failed with error: {errorEvent.Exception}");
|
|
break;
|
|
|
|
case SuperStepCompletedEvent stepCompleted:
|
|
lastCheckpoint = stepCompleted.CompletionInfo?.Checkpoint;
|
|
break;
|
|
}
|
|
}
|
|
|
|
return new(sb.ToString(), output?.As<List<ChatMessage>>(), lastCheckpoint, pendingRequests);
|
|
}
|
|
|
|
private static Task<WorkflowRunResult> RunWorkflowAsync(
|
|
Workflow workflow, List<ChatMessage> input, ExecutionEnvironment executionEnvironment = ExecutionEnvironment.InProcess_Lockstep)
|
|
=> RunWorkflowCheckpointedAsync(workflow, input, executionEnvironment.ToWorkflowExecutionEnvironment());
|
|
|
|
private sealed class DoubleEchoAgentWithBarrier(string name, StrongBox<TaskCompletionSource<bool>> barrier, StrongBox<int> remaining) : DoubleEchoAgent(name)
|
|
{
|
|
protected override async IAsyncEnumerable<AgentResponseUpdate> RunCoreStreamingAsync(
|
|
IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
|
|
{
|
|
if (Interlocked.Decrement(ref remaining.Value) == 0)
|
|
{
|
|
barrier.Value!.SetResult(true);
|
|
}
|
|
|
|
await barrier.Value!.Task.ConfigureAwait(false);
|
|
|
|
await foreach (var update in base.RunCoreStreamingAsync(messages, session, options, cancellationToken))
|
|
{
|
|
await Task.Yield();
|
|
yield return update;
|
|
}
|
|
}
|
|
}
|
|
|
|
private sealed class RecordingAgent(string name) : AIAgent
|
|
{
|
|
public List<List<string>> Invocations { get; } = [];
|
|
|
|
public override string Name => name;
|
|
|
|
protected override ValueTask<AgentSession> CreateSessionCoreAsync(CancellationToken cancellationToken = default)
|
|
=> new(new RecordingAgentSession());
|
|
|
|
protected override ValueTask<AgentSession> DeserializeSessionCoreAsync(JsonElement serializedState, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
|
|
=> new(new RecordingAgentSession());
|
|
|
|
protected override ValueTask<JsonElement> SerializeSessionCoreAsync(AgentSession session, JsonSerializerOptions? jsonSerializerOptions = null, CancellationToken cancellationToken = default)
|
|
=> default;
|
|
|
|
protected override Task<AgentResponse> RunCoreAsync(
|
|
IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, CancellationToken cancellationToken = default) =>
|
|
throw new NotImplementedException();
|
|
|
|
protected override async IAsyncEnumerable<AgentResponseUpdate> RunCoreStreamingAsync(
|
|
IEnumerable<ChatMessage> messages, AgentSession? session = null, AgentRunOptions? options = null, [EnumeratorCancellation] CancellationToken cancellationToken = default)
|
|
{
|
|
await Task.Yield();
|
|
|
|
this.Invocations.Add(messages.Select(m => m.Text).ToList());
|
|
|
|
string id = Guid.NewGuid().ToString("N");
|
|
yield return new AgentResponseUpdate(ChatRole.Assistant, name) { AuthorName = name, MessageId = id };
|
|
}
|
|
}
|
|
|
|
private sealed class RecordingAgentSession() : AgentSession();
|
|
|
|
[Fact]
|
|
public async Task BuildGroupChat_BroadcastsDeltaAndTargetsTurnTokenToSpeakerOnlyAsync()
|
|
{
|
|
var agentA = new RecordingAgent("agentA");
|
|
var agentB = new RecordingAgent("agentB");
|
|
var agentC = new RecordingAgent("agentC");
|
|
|
|
var workflow = AgentWorkflowBuilder
|
|
.CreateGroupChatBuilderWith(agents => new RoundRobinGroupChatManager(agents) { MaximumIterationCount = 4 })
|
|
.AddParticipants(agentA, agentB, agentC)
|
|
.Build();
|
|
|
|
const string UserInput = "hello";
|
|
(_, List<ChatMessage>? result, _, _) = await RunWorkflowAsync(workflow, [new ChatMessage(ChatRole.User, UserInput)]);
|
|
|
|
Assert.NotNull(result);
|
|
Assert.Equal(5, result.Count); // initial user input + 4 agent turns
|
|
Assert.Collection(
|
|
result,
|
|
m => Assert.Equal(UserInput, m.Text),
|
|
m => Assert.Equal("agentA", m.Text),
|
|
m => Assert.Equal("agentB", m.Text),
|
|
m => Assert.Equal("agentC", m.Text),
|
|
m => Assert.Equal("agentA", m.Text));
|
|
|
|
// Each agent's TurnToken fires exactly when it is the selected speaker — invocation counts
|
|
// confirm only the chosen participant receives a TurnToken on each round.
|
|
Assert.Equal(2, agentA.Invocations.Count);
|
|
Assert.Single(agentB.Invocations);
|
|
Assert.Single(agentC.Invocations);
|
|
|
|
// Turn 1: agentA is the first speaker. Initial broadcast went to every participant, so
|
|
// agentA's only buffered message is the user input.
|
|
Assert.Equal([UserInput], agentA.Invocations[0]);
|
|
|
|
// Turn 2: agentB. It received the initial broadcast (user input) plus turn-1 broadcast of
|
|
// agentA's response (agentA itself is excluded as the last speaker).
|
|
Assert.Equal([UserInput, "agentA"], agentB.Invocations[0]);
|
|
|
|
// Turn 3: agentC. It also received every broadcast so far (it has never been excluded).
|
|
Assert.Equal([UserInput, "agentA", "agentB"], agentC.Invocations[0]);
|
|
|
|
// Turn 4: agentA again. It was excluded on turn 2's broadcast (its own response), but
|
|
// received turn-3 (agentB's response) and turn-4 (agentC's response) deltas.
|
|
Assert.Equal(["agentB", "agentC"], agentA.Invocations[1]);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task BuildGroupChat_UpdateHistoryAsync_FiltersBroadcastPayloadAsync()
|
|
{
|
|
var agentA = new RecordingAgent("agentA");
|
|
var agentB = new RecordingAgent("agentB");
|
|
|
|
var workflow = AgentWorkflowBuilder
|
|
.CreateGroupChatBuilderWith(agents => new PrefixingGroupChatManager(agents, "[broadcast] ") { MaximumIterationCount = 2 })
|
|
.AddParticipants(agentA, agentB)
|
|
.Build();
|
|
|
|
const string UserInput = "hello";
|
|
await RunWorkflowAsync(workflow, [new ChatMessage(ChatRole.User, UserInput)]);
|
|
|
|
// Turn 1: agentA's buffer contains only the initial broadcast, which UpdateHistoryAsync
|
|
// prefixed.
|
|
Assert.Equal(["[broadcast] hello"], agentA.Invocations[0]);
|
|
|
|
// Turn 2: agentB received both the initial broadcast and agentA's response — both passed
|
|
// through UpdateHistoryAsync before being broadcast.
|
|
Assert.Equal(["[broadcast] hello", "[broadcast] agentA"], agentB.Invocations[0]);
|
|
}
|
|
|
|
[Fact]
|
|
public async Task BuildGroupChat_CheckpointResumeMidConversation_PreservesIterationCursorAndBroadcastExclusionAsync()
|
|
{
|
|
const string UserInput = "hello";
|
|
const int MaxIterations = 6;
|
|
|
|
// --- Baseline: run the full conversation under checkpointing and capture every checkpoint
|
|
// plus the final transcript. The same workflow + agents are reused for the resume,
|
|
// because the runner enforces workflow-shape compatibility on ResumeStreamingAsync. ---
|
|
BaselineRunResult baseline = await RunGroupChatBaselineAsync(UserInput, MaxIterations);
|
|
|
|
// We need at least one mid-conversation checkpoint to resume from. The baseline produces a
|
|
// checkpoint per superstep, which for MaxIterations=6 yields many; we pick a checkpoint
|
|
// captured roughly midway so the resumed run still has work to do.
|
|
Assert.True(baseline.Checkpoints.Count >= 5,
|
|
$"expected at least 5 checkpoints in the baseline, got {baseline.Checkpoints.Count}");
|
|
|
|
int midIndex = baseline.Checkpoints.Count / 2;
|
|
CheckpointInfo midCheckpoint = baseline.Checkpoints[midIndex];
|
|
|
|
// Snapshot per-agent invocation counts before the resume so we can isolate the invocations
|
|
// produced after the checkpoint is restored.
|
|
int aPreCount = baseline.AgentA.Invocations.Count;
|
|
int bPreCount = baseline.AgentB.Invocations.Count;
|
|
int cPreCount = baseline.AgentC.Invocations.Count;
|
|
|
|
// --- Resume the same workflow from the mid-conversation checkpoint. ---
|
|
List<ChatMessage>? resumedResult = null;
|
|
await using (StreamingRun resumed = await baseline.Environment
|
|
.ResumeStreamingAsync(baseline.Workflow, midCheckpoint))
|
|
{
|
|
await foreach (WorkflowEvent evt in resumed.WatchStreamAsync(blockOnPendingRequest: false))
|
|
{
|
|
if (evt is WorkflowOutputEvent o)
|
|
{
|
|
resumedResult = o.As<List<ChatMessage>>();
|
|
}
|
|
else if (evt is WorkflowErrorEvent err)
|
|
{
|
|
Assert.Fail($"Resumed workflow failed: {err.Exception}");
|
|
}
|
|
}
|
|
}
|
|
|
|
// (1) Iteration-count continuity: the resumed run terminates with exactly the same number
|
|
// of turns the baseline produced — proves IterationCount was rehydrated and the manager
|
|
// honored MaximumIterationCount across the boundary.
|
|
Assert.NotNull(resumedResult);
|
|
Assert.Equal(baseline.Result.Count, resumedResult!.Count);
|
|
|
|
// (2) Next-speaker consistency: the full transcript (initial input + every speaker's turn,
|
|
// in order) matches the baseline — proves the round-robin cursor was restored.
|
|
List<string?> baselineTranscript = [.. baseline.Result.Select(m => m.Text)];
|
|
List<string?> resumedTranscript = [.. resumedResult.Select(m => m.Text)];
|
|
Assert.Equal(baselineTranscript, resumedTranscript);
|
|
|
|
// (3) Broadcast exclusion holds across resume: a RecordingAgent's response text is just its
|
|
// own Name. Examine only the invocations recorded after the resume. If the host failed
|
|
// to exclude the current speaker from its post-resume broadcasts, an agent's next
|
|
// invocation buffer would contain its own previously produced response. Asserting that
|
|
// no post-resume invocation input contains the invoking agent's own name proves the
|
|
// exclusion was preserved through checkpoint+restore.
|
|
AssertPostResumeBroadcastExclusion(baseline.AgentA, aPreCount);
|
|
AssertPostResumeBroadcastExclusion(baseline.AgentB, bPreCount);
|
|
AssertPostResumeBroadcastExclusion(baseline.AgentC, cPreCount);
|
|
|
|
// Sanity: at least one agent was actually invoked after the resume; otherwise the test
|
|
// would trivially pass even if the host stopped scheduling turns after restore.
|
|
int totalPost = baseline.AgentA.Invocations.Count - aPreCount
|
|
+ (baseline.AgentB.Invocations.Count - bPreCount)
|
|
+ (baseline.AgentC.Invocations.Count - cPreCount);
|
|
Assert.True(totalPost > 0, "at least one agent should be invoked after resuming from the mid-conversation checkpoint");
|
|
|
|
static void AssertPostResumeBroadcastExclusion(RecordingAgent agent, int preCount)
|
|
{
|
|
for (int i = preCount; i < agent.Invocations.Count; i++)
|
|
{
|
|
Assert.DoesNotContain(agent.Name, agent.Invocations[i]);
|
|
}
|
|
}
|
|
}
|
|
|
|
private sealed record BaselineRunResult(
|
|
Workflow Workflow,
|
|
InProcessExecutionEnvironment Environment,
|
|
RecordingAgent AgentA,
|
|
RecordingAgent AgentB,
|
|
RecordingAgent AgentC,
|
|
List<ChatMessage> Result,
|
|
List<CheckpointInfo> Checkpoints,
|
|
CheckpointManager CheckpointManager);
|
|
|
|
private static async Task<BaselineRunResult> RunGroupChatBaselineAsync(string userInput, int maxIterations)
|
|
{
|
|
var agentA = new RecordingAgent("agentA");
|
|
var agentB = new RecordingAgent("agentB");
|
|
var agentC = new RecordingAgent("agentC");
|
|
|
|
Workflow workflow = AgentWorkflowBuilder
|
|
.CreateGroupChatBuilderWith(agents => new RoundRobinGroupChatManager(agents) { MaximumIterationCount = maxIterations })
|
|
.AddParticipants(agentA, agentB, agentC)
|
|
.Build();
|
|
|
|
CheckpointManager checkpointMgr = CheckpointManager.CreateInMemory();
|
|
InProcessExecutionEnvironment env = ExecutionEnvironment.InProcess_Lockstep
|
|
.ToWorkflowExecutionEnvironment()
|
|
.WithCheckpointing(checkpointMgr);
|
|
|
|
List<CheckpointInfo> checkpoints = [];
|
|
List<ChatMessage>? finalResult = null;
|
|
|
|
await using (StreamingRun run = await env.OpenStreamingAsync(workflow))
|
|
{
|
|
await run.TrySendMessageAsync(new List<ChatMessage> { new(ChatRole.User, userInput) });
|
|
await run.TrySendMessageAsync(new TurnToken(emitEvents: true));
|
|
|
|
await foreach (WorkflowEvent evt in run.WatchStreamAsync(blockOnPendingRequest: false))
|
|
{
|
|
switch (evt)
|
|
{
|
|
case SuperStepCompletedEvent step when step.CompletionInfo?.Checkpoint is { } cp:
|
|
checkpoints.Add(cp);
|
|
break;
|
|
case WorkflowOutputEvent o:
|
|
finalResult = o.As<List<ChatMessage>>();
|
|
break;
|
|
case WorkflowErrorEvent err:
|
|
Assert.Fail($"Baseline workflow failed: {err.Exception}");
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
|
|
Assert.NotNull(finalResult);
|
|
return new BaselineRunResult(workflow, env, agentA, agentB, agentC, finalResult!, checkpoints, checkpointMgr);
|
|
}
|
|
|
|
private sealed class PrefixingGroupChatManager(IReadOnlyList<AIAgent> agents, string prefix) : RoundRobinGroupChatManager(agents)
|
|
{
|
|
protected internal override ValueTask<IEnumerable<ChatMessage>> UpdateHistoryAsync(
|
|
IReadOnlyList<ChatMessage> history,
|
|
CancellationToken cancellationToken = default)
|
|
{
|
|
IEnumerable<ChatMessage> prefixed =
|
|
history.Select(m => new ChatMessage(m.Role, $"{prefix}{m.Text}") { AuthorName = m.AuthorName });
|
|
|
|
return new(prefixed);
|
|
}
|
|
}
|
|
}
|