Skip to content

Python: Correlate AG-UI confirm_changes snapshots by call id - #7411

Merged
Eduard van Valkenburg (eavanvalkenburg) merged 3 commits into
microsoft:mainfrom
eavanvalkenburg:python-agui-confirm-changes-snapshot
Jul 30, 2026
Merged

Python: Correlate AG-UI confirm_changes snapshots by call id#7411
Eduard van Valkenburg (eavanvalkenburg) merged 3 commits into
microsoft:mainfrom
eavanvalkenburg:python-agui-confirm-changes-snapshot

Conversation

@eavanvalkenburg

@eavanvalkenburg Eduard van Valkenburg (eavanvalkenburg) commented Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Member

Motivation & Context

AG-UI confirm_changes uses a synthetic confirmation call id. Snapshot cleanup can therefore miss the original
tool result or combine unrelated results when several calls are present.

Description & Review Guide

  • What are the major changes?
    • Resolve the synthetic confirmation to its original function_call_id.
    • Replace the approval payload with only the matching result.
    • Require a real result before recording an accepted confirmation; clean rejection explicitly.
    • Treat malformed or non-list confirmation metadata as inert.
  • What is the impact of these changes?
    • Completed approval-gated changes remain completed in replayed snapshots.
    • Unrelated tool results cannot leak into the confirmation message.
    • Blocked or invalid accepted approvals cannot be recorded as successful side effects.
    • Malformed snapshot metadata does not trigger guessed correlation.
  • What do you want reviewers to focus on?
    • Exact original-call correlation when multiple results exist.
    • Fallback behavior and malformed metadata handling.

Related Issue

Fixes #6828

Contribution Checklist

  • The code builds clean without any errors or warnings
  • All unit tests pass, and I have added new tests where possible
  • The PR follows the Contribution Guidelines
  • This PR is linked to an issue and there is no other open PR for this issue (see Related Issue above).
  • This is not a breaking change. If it is a breaking change, add the breaking change label (or add "[BREAKING]" to the title prefix, before or after any language prefix) — a workflow keeps the label and title prefix in sync automatically.

Copilot AI review requested due to automatic review settings July 29, 2026 20:11
@agent-framework-automation agent-framework-automation Bot added documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python labels Jul 29, 2026
@eavanvalkenburg
Eduard van Valkenburg (eavanvalkenburg) marked this pull request as ready for review July 29, 2026 20:12
Copilot AI reviewed Jul 29, 2026
View reviewed changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR fixes AG-UI confirm_changes snapshot cleanup so the synthetic confirmation tool call is correlated back to the original function_call_id, preventing unrelated tool results from being substituted/concatenated when multiple tool results exist. It also adds deterministic fallbacks for accepted/declined/missing-result cases and ensures malformed confirmation metadata is treated as inert.

Changes:

  • Add _confirm_changes_target_call_id to resolve a confirm_changes tool result’s synthetic call id back to its original call id (via explicit payload or parsed tool-call arguments).
  • Update _clean_resolved_approvals_from_snapshot to replace only the matching original tool result (or apply deterministic fallbacks), rather than potentially combining unrelated results.
  • Add focused unit tests and update AG-UI documentation/spec coverage to lock in the expected behavior.

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated no comments.

File Description
python/packages/ag-ui/agent_framework_ag_ui/_agent_run.py Implements original-call correlation for confirm_changes snapshot cleanup and deterministic fallbacks.
python/packages/ag-ui/tests/ag_ui/test_confirm_changes_snapshot.py Adds regressions for multi-result correlation, explicit payload correlation, rejection/missing-result fallbacks, and malformed metadata handling.
python/packages/ag-ui/AGENTS.md Documents the confirm_changes snapshot cleanup invariant (must not concatenate unrelated results).
docs/specs/004-python-function-calling-loop.md Updates the spec’s invariant/test mapping to include the new confirm_changes snapshot coverage.

@github-actions

github-actions Bot commented Jul 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Python Test Coverage

Python Test Coverage Report •
FileStmtsMissCoverMissing
packages/ag-ui/agent_framework_ag_ui
   _agent_run.py114711889%184–191, 238–239, 246, 355, 359, 361, 378, 405–406, 519, 533, 537, 541, 544, 549, 554, 563, 566, 573–579, 612, 624, 635, 638, 673, 727–731, 796, 811, 814, 816, 842, 868–870, 928, 930, 932, 935–939, 953, 961–966, 975–976, 1025–1028, 1039, 1047, 1079, 1094, 1108, 1120, 1150, 1154, 1157, 1159, 1199–1201, 1265, 1271–1272, 1277, 1281–1282, 1480, 1488, 1518, 1522, 1567, 1626, 1656–1657, 1779, 1925, 1985, 2002, 2022–2023, 2030, 2138, 2166, 2174, 2176, 2179, 2185, 2240, 2243, 2253–2254, 2261, 2307
TOTAL45889447690% 

Python Unit Test Overview

Tests Skipped Failures Errors Time
9472 34 💤 0 ❌ 0 🔥 2m 28s ⏱️

github-actions[bot]
github-actions Bot reviewed Jul 30, 2026
View reviewed changes

@github-actions github-actions Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Automated Code Review

Reviewers: 5 | Confidence: 62% | Result: All clear

Reviewed: Correctness, Security Reliability, Test Coverage, Failure Modes, Design Approach

Automated review by eavanvalkenburg's agents

@eavanvalkenburg
Python: Correlate AG-UI confirm_changes snapshots by call id
9f2d6ac 
Co-authored-by: Copilot <[email protected]>

Copilot-Session: 1ee1d250-d1e2-4c6f-8c36-aae0d94fe7a1
@eavanvalkenburg
Chore: retrigger PR checks
767c6fb 
Co-authored-by: Copilot <[email protected]>
Copilot-Session: 1ee1d250-d1e2-4c6f-8c36-aae0d94fe7a1
@eavanvalkenburg
Python: Require real results for accepted confirmations
8699a49 
Keep accepted confirm_changes snapshot payloads inert unless approval resolution produced a matching function result, while retaining explicit rejection cleanup.

Co-authored-by: Copilot <[email protected]>
Copilot-Session: 1ee1d250-d1e2-4c6f-8c36-aae0d94fe7a1
Merged via the queue into microsoft:main with commit e344f45 Jul 30, 2026
38 checks passed

This branch was previously deployed

1 inactive deployment
github-app-auth — 8699a49a Deployed Jul 30, 2026 by eavanvalkenburg via add_label #19924
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@github-actions github-actions[bot] github-actions[bot] left review comments
Copilot code review Copilot
Copilot review effort
Applies to this pull request for everyone.Learn more about Copilot code review.
Copilot left review comments
@moonbox3 Evan Mattson (moonbox3) moonbox3 approved these changes
+1 more reviewer
@TaoChenOSU Tao Chen (TaoChenOSU) TaoChenOSU approved these changes
Reviewers whose approvals may not affect merge requirements

Assignees

No one assigned

Labels

documentation Usage: [Issues, PRs], Target: documentation in the code base and learn docs python Usage: [Issues, PRs], Target: Python

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Python: [Bug]: AG-UI confirm_changes approval-gated tool reverts to "in progress" after completing

4 participants

@eavanvalkenburg @TaoChenOSU @moonbox3