mirror of
https://github.com/microsoft/agent-framework.git
synced 2026-06-16 21:04:09 +08:00
Adjusted
This commit is contained in:
@@ -69,13 +69,11 @@ public sealed class ChatReducerCompactionStrategy : CompactionStrategy
|
||||
return false;
|
||||
}
|
||||
|
||||
// Rebuild the index from the reduced messages
|
||||
CompactionMessageIndex rebuilt = CompactionMessageIndex.Create(reducedMessages, index.Tokenizer);
|
||||
index.Groups.Clear();
|
||||
foreach (CompactionMessageGroup group in rebuilt.Groups)
|
||||
{
|
||||
index.Groups.Add(group);
|
||||
}
|
||||
// Rebuild the index from the reduced messages.
|
||||
// Use Update() rather than directly manipulating Groups so that
|
||||
// cached metrics (IncludedGroupCount, token counts, etc.) are
|
||||
// properly invalidated.
|
||||
index.Update(reducedMessages);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
@@ -40,9 +40,15 @@ public sealed class CompactionMessageGroup
|
||||
/// </remarks>
|
||||
public static readonly string SummaryPropertyKey = "_is_summary";
|
||||
|
||||
private readonly Action _exclusionChangedCallback;
|
||||
|
||||
/// <summary>
|
||||
/// Initializes a new instance of the <see cref="CompactionMessageGroup"/> class.
|
||||
/// </summary>
|
||||
/// <param name="exclusionChangedCallback">
|
||||
/// A callback invoked when <see cref="IsExcluded"/> changes value.
|
||||
/// Used internally by <see cref="CompactionMessageIndex"/> to invalidate cached aggregates.
|
||||
/// </param>
|
||||
/// <param name="kind">The kind of message group.</param>
|
||||
/// <param name="messages">The messages in this group. The list is captured as a read-only snapshot.</param>
|
||||
/// <param name="byteCount">The total UTF-8 byte count of the text content in the messages.</param>
|
||||
@@ -51,8 +57,15 @@ public sealed class CompactionMessageGroup
|
||||
/// The user turn this group belongs to, or <see langword="null"/> for <see cref="CompactionGroupKind.System"/>.
|
||||
/// </param>
|
||||
[JsonConstructor]
|
||||
internal CompactionMessageGroup(CompactionGroupKind kind, IReadOnlyList<ChatMessage> messages, int byteCount, int tokenCount, int? turnIndex = null)
|
||||
internal CompactionMessageGroup(
|
||||
Action exclusionChangedCallback,
|
||||
CompactionGroupKind kind,
|
||||
IReadOnlyList<ChatMessage> messages,
|
||||
int byteCount,
|
||||
int tokenCount,
|
||||
int? turnIndex = null)
|
||||
{
|
||||
this._exclusionChangedCallback = exclusionChangedCallback;
|
||||
this.Kind = kind;
|
||||
this.Messages = messages;
|
||||
this.MessageCount = messages.Count;
|
||||
@@ -101,14 +114,6 @@ public sealed class CompactionMessageGroup
|
||||
/// </remarks>
|
||||
public int? TurnIndex { get; }
|
||||
|
||||
private bool _isExcluded;
|
||||
|
||||
/// <summary>
|
||||
/// An optional callback invoked when <see cref="IsExcluded"/> changes value.
|
||||
/// Used internally by <see cref="CompactionMessageIndex"/> to invalidate cached aggregates.
|
||||
/// </summary>
|
||||
internal Action? ExclusionChanged;
|
||||
|
||||
/// <summary>
|
||||
/// Gets or sets a value indicating whether this group is excluded from the projected message list.
|
||||
/// </summary>
|
||||
@@ -118,13 +123,13 @@ public sealed class CompactionMessageGroup
|
||||
/// </remarks>
|
||||
public bool IsExcluded
|
||||
{
|
||||
get => _isExcluded;
|
||||
get;
|
||||
set
|
||||
{
|
||||
if (_isExcluded != value)
|
||||
if (field != value)
|
||||
{
|
||||
_isExcluded = value;
|
||||
ExclusionChanged?.Invoke();
|
||||
field = value;
|
||||
this._exclusionChangedCallback.Invoke();
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
@@ -61,12 +61,6 @@ public sealed class CompactionMessageIndex
|
||||
this.Groups = Throw.IfNull(groups, nameof(groups));
|
||||
this.Tokenizer = tokenizer;
|
||||
|
||||
// Register all pre-existing groups so that IsExcluded changes invalidate the cache.
|
||||
for (int i = 0; i < groups.Count; i++)
|
||||
{
|
||||
this.RegisterGroup(groups[i]);
|
||||
}
|
||||
|
||||
// Restore turn counter and last processed message from the groups
|
||||
for (int index = groups.Count - 1; index >= 0; --index)
|
||||
{
|
||||
@@ -205,13 +199,13 @@ public sealed class CompactionMessageIndex
|
||||
if (message.Role == ChatRole.System)
|
||||
{
|
||||
// System messages are not part of any turn
|
||||
this.AddAndRegisterGroup(CreateGroup(CompactionGroupKind.System, [message], this.Tokenizer, turnIndex: null));
|
||||
this.AddGroup(CompactionGroupKind.System, [message], turnIndex: null);
|
||||
index++;
|
||||
}
|
||||
else if (message.Role == ChatRole.User)
|
||||
{
|
||||
this._currentTurn++;
|
||||
this.AddAndRegisterGroup(CreateGroup(CompactionGroupKind.User, [message], this.Tokenizer, this._currentTurn));
|
||||
this.AddGroup(CompactionGroupKind.User, [message], this._currentTurn);
|
||||
index++;
|
||||
}
|
||||
else if (message.Role == ChatRole.Assistant && HasToolCalls(message))
|
||||
@@ -228,11 +222,11 @@ public sealed class CompactionMessageIndex
|
||||
index++;
|
||||
}
|
||||
|
||||
this.AddAndRegisterGroup(CreateGroup(CompactionGroupKind.ToolCall, groupMessages, this.Tokenizer, this._currentTurn));
|
||||
this.AddGroup(CompactionGroupKind.ToolCall, groupMessages, this._currentTurn);
|
||||
}
|
||||
else if (message.Role == ChatRole.Assistant && IsSummaryMessage(message))
|
||||
{
|
||||
this.AddAndRegisterGroup(CreateGroup(CompactionGroupKind.Summary, [message], this.Tokenizer, this._currentTurn));
|
||||
this.AddGroup(CompactionGroupKind.Summary, [message], this._currentTurn);
|
||||
index++;
|
||||
}
|
||||
else if (message.Role == ChatRole.Assistant && HasOnlyReasoning(message))
|
||||
@@ -268,17 +262,17 @@ public sealed class CompactionMessageIndex
|
||||
index++;
|
||||
}
|
||||
|
||||
this.AddAndRegisterGroup(CreateGroup(CompactionGroupKind.ToolCall, groupMessages, this.Tokenizer, this._currentTurn));
|
||||
this.AddGroup(CompactionGroupKind.ToolCall, groupMessages, this._currentTurn);
|
||||
}
|
||||
else
|
||||
{
|
||||
this.AddAndRegisterGroup(CreateGroup(CompactionGroupKind.AssistantText, [message], this.Tokenizer, this._currentTurn));
|
||||
this.AddGroup(CompactionGroupKind.AssistantText, [message], this._currentTurn);
|
||||
index++;
|
||||
}
|
||||
}
|
||||
else
|
||||
{
|
||||
this.AddAndRegisterGroup(CreateGroup(CompactionGroupKind.AssistantText, [message], this.Tokenizer, this._currentTurn));
|
||||
this.AddGroup(CompactionGroupKind.AssistantText, [message], this._currentTurn);
|
||||
index++;
|
||||
}
|
||||
}
|
||||
@@ -302,9 +296,8 @@ public sealed class CompactionMessageIndex
|
||||
/// <returns>The newly created <see cref="CompactionMessageGroup"/>.</returns>
|
||||
public CompactionMessageGroup InsertGroup(int index, CompactionGroupKind kind, IReadOnlyList<ChatMessage> messages, int? turnIndex = null)
|
||||
{
|
||||
CompactionMessageGroup group = CreateGroup(kind, messages, this.Tokenizer, turnIndex);
|
||||
CompactionMessageGroup group = this.CreateGroup(kind, messages, this.Tokenizer, turnIndex); // %%% DERIVE TURNINDEX
|
||||
this.Groups.Insert(index, group);
|
||||
this.RegisterGroup(group);
|
||||
this.InvalidateCache();
|
||||
return group;
|
||||
}
|
||||
@@ -319,9 +312,8 @@ public sealed class CompactionMessageIndex
|
||||
/// <returns>The newly created <see cref="CompactionMessageGroup"/>.</returns>
|
||||
public CompactionMessageGroup AddGroup(CompactionGroupKind kind, IReadOnlyList<ChatMessage> messages, int? turnIndex = null)
|
||||
{
|
||||
CompactionMessageGroup group = CreateGroup(kind, messages, this.Tokenizer, turnIndex);
|
||||
CompactionMessageGroup group = this.CreateGroup(kind, messages, this.Tokenizer, turnIndex); // %%% DERIVE TURNINDEX
|
||||
this.Groups.Add(group);
|
||||
this.RegisterGroup(group);
|
||||
this.InvalidateCache();
|
||||
return group;
|
||||
}
|
||||
@@ -347,57 +339,57 @@ public sealed class CompactionMessageIndex
|
||||
/// <summary>
|
||||
/// Gets the total number of messages across all groups, including excluded ones.
|
||||
/// </summary>
|
||||
public int TotalMessageCount => _cachedTotalMessageCount ??= this.Groups.Sum(group => group.MessageCount);
|
||||
public int TotalMessageCount => this._cachedTotalMessageCount ??= this.Groups.Sum(group => group.MessageCount);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total UTF-8 byte count across all groups, including excluded ones.
|
||||
/// </summary>
|
||||
public int TotalByteCount => _cachedTotalByteCount ??= this.Groups.Sum(group => group.ByteCount);
|
||||
public int TotalByteCount => this._cachedTotalByteCount ??= this.Groups.Sum(group => group.ByteCount);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total token count across all groups, including excluded ones.
|
||||
/// </summary>
|
||||
public int TotalTokenCount => _cachedTotalTokenCount ??= this.Groups.Sum(group => group.TokenCount);
|
||||
public int TotalTokenCount => this._cachedTotalTokenCount ??= this.Groups.Sum(group => group.TokenCount);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total number of groups that are not excluded.
|
||||
/// </summary>
|
||||
public int IncludedGroupCount => _cachedIncludedGroupCount ??= this.Groups.Count(group => !group.IsExcluded);
|
||||
public int IncludedGroupCount => this._cachedIncludedGroupCount ??= this.Groups.Count(group => !group.IsExcluded);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total number of messages across all included (non-excluded) groups.
|
||||
/// </summary>
|
||||
public int IncludedMessageCount => _cachedIncludedMessageCount ??= this.Groups.Where(group => !group.IsExcluded).Sum(group => group.MessageCount);
|
||||
public int IncludedMessageCount => this._cachedIncludedMessageCount ??= this.Groups.Where(group => !group.IsExcluded).Sum(group => group.MessageCount);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total UTF-8 byte count across all included (non-excluded) groups.
|
||||
/// </summary>
|
||||
public int IncludedByteCount => _cachedIncludedByteCount ??= this.Groups.Where(group => !group.IsExcluded).Sum(group => group.ByteCount);
|
||||
public int IncludedByteCount => this._cachedIncludedByteCount ??= this.Groups.Where(group => !group.IsExcluded).Sum(group => group.ByteCount);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total token count across all included (non-excluded) groups.
|
||||
/// </summary>
|
||||
public int IncludedTokenCount => _cachedIncludedTokenCount ??= this.Groups.Where(group => !group.IsExcluded).Sum(group => group.TokenCount);
|
||||
public int IncludedTokenCount => this._cachedIncludedTokenCount ??= this.Groups.Where(group => !group.IsExcluded).Sum(group => group.TokenCount);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total number of user turns across all groups (including those with excluded groups).
|
||||
/// </summary>
|
||||
public int TotalTurnCount => _cachedTotalTurnCount ??= this.Groups.Select(group => group.TurnIndex).Distinct().Count(turnIndex => turnIndex is not null && turnIndex > 0);
|
||||
public int TotalTurnCount => this._cachedTotalTurnCount ??= this.Groups.Select(group => group.TurnIndex).Distinct().Count(turnIndex => turnIndex is not null && turnIndex > 0);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the number of user turns that have at least one non-excluded group.
|
||||
/// </summary>
|
||||
public int IncludedTurnCount => _cachedIncludedTurnCount ??= this.Groups.Where(group => !group.IsExcluded && group.TurnIndex is not null && group.TurnIndex > 0).Select(group => group.TurnIndex).Distinct().Count();
|
||||
public int IncludedTurnCount => this._cachedIncludedTurnCount ??= this.Groups.Where(group => !group.IsExcluded && group.TurnIndex is not null && group.TurnIndex > 0).Select(group => group.TurnIndex).Distinct().Count();
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total number of groups across all included (non-excluded) groups that are not <see cref="CompactionGroupKind.System"/>.
|
||||
/// </summary>
|
||||
public int IncludedNonSystemGroupCount => _cachedIncludedNonSystemGroupCount ??= this.Groups.Count(group => !group.IsExcluded && group.Kind != CompactionGroupKind.System);
|
||||
public int IncludedNonSystemGroupCount => this._cachedIncludedNonSystemGroupCount ??= this.Groups.Count(group => !group.IsExcluded && group.Kind != CompactionGroupKind.System);
|
||||
|
||||
/// <summary>
|
||||
/// Gets the total number of original messages (that are not summaries).
|
||||
/// </summary>
|
||||
public int RawMessageCount => _cachedRawMessageCount ??= this.Groups.Where(group => group.Kind != CompactionGroupKind.Summary).Sum(group => group.MessageCount);
|
||||
public int RawMessageCount => this._cachedRawMessageCount ??= this.Groups.Where(group => group.Kind != CompactionGroupKind.Summary).Sum(group => group.MessageCount);
|
||||
|
||||
/// <summary>
|
||||
/// Returns all groups that belong to the specified user turn.
|
||||
@@ -408,33 +400,17 @@ public sealed class CompactionMessageIndex
|
||||
|
||||
private void InvalidateCache()
|
||||
{
|
||||
_cachedTotalMessageCount = null;
|
||||
_cachedTotalByteCount = null;
|
||||
_cachedTotalTokenCount = null;
|
||||
_cachedIncludedGroupCount = null;
|
||||
_cachedIncludedMessageCount = null;
|
||||
_cachedIncludedByteCount = null;
|
||||
_cachedIncludedTokenCount = null;
|
||||
_cachedTotalTurnCount = null;
|
||||
_cachedIncludedTurnCount = null;
|
||||
_cachedIncludedNonSystemGroupCount = null;
|
||||
_cachedRawMessageCount = null;
|
||||
}
|
||||
|
||||
private void RegisterGroup(CompactionMessageGroup group)
|
||||
{
|
||||
// Each group is owned by exactly one index, so assignment rather than
|
||||
// += is intentional — no need to chain callbacks.
|
||||
group.ExclusionChanged = this.InvalidateCache;
|
||||
}
|
||||
|
||||
// Adds the group to the list and registers it for cache invalidation.
|
||||
// Callers that add many groups in a loop (e.g. AppendFromMessages) call
|
||||
// InvalidateCache() once at the end rather than per-group for efficiency.
|
||||
private void AddAndRegisterGroup(CompactionMessageGroup group)
|
||||
{
|
||||
this.Groups.Add(group);
|
||||
this.RegisterGroup(group);
|
||||
this._cachedTotalMessageCount = null;
|
||||
this._cachedTotalByteCount = null;
|
||||
this._cachedTotalTokenCount = null;
|
||||
this._cachedIncludedGroupCount = null;
|
||||
this._cachedIncludedMessageCount = null;
|
||||
this._cachedIncludedByteCount = null;
|
||||
this._cachedIncludedTokenCount = null;
|
||||
this._cachedTotalTurnCount = null;
|
||||
this._cachedIncludedTurnCount = null;
|
||||
this._cachedIncludedNonSystemGroupCount = null;
|
||||
this._cachedRawMessageCount = null;
|
||||
}
|
||||
|
||||
/// <summary>
|
||||
@@ -555,14 +531,14 @@ public sealed class CompactionMessageIndex
|
||||
private static int GetStringByteCount(string? value) =>
|
||||
value is { Length: > 0 } ? Encoding.UTF8.GetByteCount(value) : 0;
|
||||
|
||||
private static CompactionMessageGroup CreateGroup(CompactionGroupKind kind, IReadOnlyList<ChatMessage> messages, Tokenizer? tokenizer, int? turnIndex)
|
||||
private CompactionMessageGroup CreateGroup(CompactionGroupKind kind, IReadOnlyList<ChatMessage> messages, Tokenizer? tokenizer, int? turnIndex)
|
||||
{
|
||||
int byteCount = ComputeByteCount(messages);
|
||||
int tokenCount = tokenizer is not null
|
||||
? ComputeTokenCount(messages, tokenizer)
|
||||
: byteCount / 4;
|
||||
|
||||
return new CompactionMessageGroup(kind, messages, byteCount, tokenCount, turnIndex);
|
||||
return new CompactionMessageGroup(this.InvalidateCache, kind, messages, byteCount, tokenCount, turnIndex);
|
||||
}
|
||||
|
||||
private static bool HasToolCalls(ChatMessage message)
|
||||
|
||||
+7
-25
@@ -263,7 +263,7 @@ public class CompactionMessageIndexTests
|
||||
public void MessageGroupStoresPassedCounts()
|
||||
{
|
||||
// Arrange & Act
|
||||
CompactionMessageGroup group = new(CompactionGroupKind.User, [new ChatMessage(ChatRole.User, "Hello")], byteCount: 5, tokenCount: 2);
|
||||
CompactionMessageGroup group = new(InvalidateCallback, CompactionGroupKind.User, [new ChatMessage(ChatRole.User, "Hello")], byteCount: 5, tokenCount: 2);
|
||||
|
||||
// Assert
|
||||
Assert.Equal(1, group.MessageCount);
|
||||
@@ -276,7 +276,7 @@ public class CompactionMessageIndexTests
|
||||
{
|
||||
// Arrange
|
||||
IReadOnlyList<ChatMessage> messages = [new ChatMessage(ChatRole.User, "Hello")];
|
||||
CompactionMessageGroup group = new(CompactionGroupKind.User, messages, byteCount: 5, tokenCount: 1);
|
||||
CompactionMessageGroup group = new(InvalidateCallback, CompactionGroupKind.User, messages, byteCount: 5, tokenCount: 1);
|
||||
|
||||
// Assert — Messages is IReadOnlyList, not IList
|
||||
Assert.IsType<IReadOnlyList<ChatMessage>>(group.Messages, exactMatch: false);
|
||||
@@ -752,9 +752,9 @@ public class CompactionMessageIndexTests
|
||||
public void ConstructorWithGroupsRestoresTurnIndex()
|
||||
{
|
||||
// Arrange — pre-existing groups with turn indices
|
||||
CompactionMessageGroup group1 = new(CompactionGroupKind.User, [new ChatMessage(ChatRole.User, "Q1")], 2, 1, turnIndex: 1);
|
||||
CompactionMessageGroup group2 = new(CompactionGroupKind.AssistantText, [new ChatMessage(ChatRole.Assistant, "A1")], 2, 1, turnIndex: 1);
|
||||
CompactionMessageGroup group3 = new(CompactionGroupKind.User, [new ChatMessage(ChatRole.User, "Q2")], 2, 1, turnIndex: 2);
|
||||
CompactionMessageGroup group1 = new(InvalidateCallback, CompactionGroupKind.User, [new ChatMessage(ChatRole.User, "Q1")], 2, 1, turnIndex: 1);
|
||||
CompactionMessageGroup group2 = new(InvalidateCallback, CompactionGroupKind.AssistantText, [new ChatMessage(ChatRole.Assistant, "A1")], 2, 1, turnIndex: 1);
|
||||
CompactionMessageGroup group3 = new(InvalidateCallback, CompactionGroupKind.User, [new ChatMessage(ChatRole.User, "Q2")], 2, 1, turnIndex: 2);
|
||||
List<CompactionMessageGroup> groups = [group1, group2, group3];
|
||||
|
||||
// Act — constructor should restore _currentTurn from the last group's TurnIndex
|
||||
@@ -789,7 +789,7 @@ public class CompactionMessageIndexTests
|
||||
public void ConstructorWithGroupsWithoutTurnIndexSkipsRestore()
|
||||
{
|
||||
// Arrange — groups without turn indices (system messages)
|
||||
CompactionMessageGroup systemGroup = new(CompactionGroupKind.System, [new ChatMessage(ChatRole.System, "Be helpful")], 10, 3, turnIndex: null);
|
||||
CompactionMessageGroup systemGroup = new(InvalidateCallback, CompactionGroupKind.System, [new ChatMessage(ChatRole.System, "Be helpful")], 10, 3, turnIndex: null);
|
||||
List<CompactionMessageGroup> groups = [systemGroup];
|
||||
|
||||
// Act — constructor won't find a TurnIndex to restore
|
||||
@@ -1648,23 +1648,5 @@ public class CompactionMessageIndexTests
|
||||
Assert.Equal(2, index.TotalTokenCount);
|
||||
}
|
||||
|
||||
[Fact]
|
||||
public void ConstructorWithPreExistingGroupsRegistersThemForCacheInvalidation()
|
||||
{
|
||||
// Arrange — build groups externally, pass them into constructor
|
||||
CompactionMessageGroup group1 = new(CompactionGroupKind.User, [new ChatMessage(ChatRole.User, "Q1")], 2, 1, turnIndex: 1);
|
||||
CompactionMessageGroup group2 = new(CompactionGroupKind.AssistantText, [new ChatMessage(ChatRole.Assistant, "A1")], 2, 1, turnIndex: 1);
|
||||
List<CompactionMessageGroup> groups = [group1, group2];
|
||||
|
||||
CompactionMessageIndex index = new(groups);
|
||||
|
||||
// Prime the cache
|
||||
Assert.Equal(2, index.IncludedGroupCount);
|
||||
|
||||
// Act — exclude a pre-existing group (ExclusionChanged should fire and invalidate)
|
||||
group1.IsExcluded = true;
|
||||
|
||||
// Assert — cache reflects the change
|
||||
Assert.Equal(1, index.IncludedGroupCount);
|
||||
}
|
||||
private static void InvalidateCallback() { }
|
||||
}
|
||||
|
||||
@@ -356,7 +356,7 @@ public sealed class CompactionProviderTests
|
||||
Assert.Empty(state.MessageGroups);
|
||||
|
||||
// Act
|
||||
state.MessageGroups = [new CompactionMessageGroup(CompactionGroupKind.User, [], 0, 0, 0)];
|
||||
state.MessageGroups = [new CompactionMessageGroup(() => { }, CompactionGroupKind.User, [], 0, 0, 0)];
|
||||
|
||||
// Assert
|
||||
Assert.Single(state.MessageGroups);
|
||||
|
||||
@@ -17,7 +17,7 @@ public class MessageMergerTests
|
||||
[Fact]
|
||||
public void Test_MessageMerger_AssemblesMessage()
|
||||
{
|
||||
DateTimeOffset creationTime = DateTimeOffset.UtcNow;
|
||||
DateTimeOffset creationTime = DateTimeOffset.UtcNow.Subtract(TimeSpan.FromSeconds(1));
|
||||
string responseId = Guid.NewGuid().ToString("N");
|
||||
string messageId = Guid.NewGuid().ToString("N");
|
||||
|
||||
|
||||
Reference in New Issue
Block a user