.NET: Preserve UTF-8 order in HeadTailBuffer#7128
Open
jstar0 wants to merge 1 commit into
Open
Conversation
Contributor
There was a problem hiding this comment.
Pull request overview
This PR fixes a UTF-8 boundary bug in the .NET HeadTailBuffer used for bounded stdout/stderr capture, ensuring multi-byte runes are never reordered or silently dropped at the head/tail boundary and that truncation reporting matches actual byte loss.
Changes:
- Seals the head buffer after the first rune that can’t fully fit, forcing all subsequent runes into the tail to preserve byte order.
- Defers tail eviction until the overall byte cap is exceeded (not merely the tail budget), preventing silent loss when input is exactly at cap.
- Adds unit tests covering exact-cap and minimal-overflow multi-byte UTF-8 regression scenarios.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated no comments.
| File | Description |
|---|---|
| dotnet/src/Microsoft.Agents.AI.Tools.Shell/HeadTailBuffer.cs | Updates head/tail append and eviction logic to preserve UTF-8 rune order and correct truncation behavior. |
| dotnet/tests/Microsoft.Agents.AI.Tools.Shell.UnitTests/HeadTailBufferTests.cs | Adds regression tests for exact-cap and overflow cases involving 4-byte UTF-8 runes. |
c507c47 to
710fe03
Compare
rogerbarreto
approved these changes
Jul 15, 2026
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Motivation & Context
HeadTailBuffercan silently drop and reorder multi-byte UTF-8 output when a complete rune no longer fits the remaining head bytes but later smaller runes still do. At the exact overall byte cap, the previous logic could evict a tail rune and still report that the output was not truncated. This affects the bounded stdout and stderr capture shared by the local and Docker shell executors.Description & Review Guide
Related Issue
Fixes #7112
Contribution Checklist
breaking changelabel (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.