2 Commits

• .NET: Bump MEAI to 10.5.1 and add Foundry per-call x-client header support (#5652)

  * Bump MEAI to 10.5.1 and add per-call x-client header support
  
  Replaces the brittle UserAgentResponsesClient subclass with a clean
  per-call x-client-* header pipeline built on the new Microsoft.Extensions.AI
  10.5.1 OpenAIRequestPolicies hook.
  
  Public surface (Microsoft.Agents.AI.Foundry, [Experimental(MAAI001)]):
  * chatOptions.WithClientHeader(name, value) and .WithClientHeaders(IEnumerable)
    validate the x-client- prefix (case-insensitive), apply all-or-nothing on
    bulk, and throw InvalidOperationException on foreign-typed slot collision
  * myAgent.AsBuilder().UseClientHeaders().Build() opts a customer-built agent
    into the pipeline; idempotent via agent.GetService<ClientHeadersAgent>()
  * Foundry-built agents (FoundryAgent.Create*) pre-wire automatically
  
  Internals:
  * ClientHeadersAgent decorator snapshots the dict at scope-push time so
    concurrent runs sharing a ChatOptions reference do not leak headers
  * ClientHeadersScope is an AsyncLocal<IReadOnlyDictionary<string,string>?>
    with LIFO push/dispose semantics
  * ClientHeadersPolicy singleton stamps headers via Headers.Set so per-call
    values overwrite any same-name header from earlier policies and so
    duplicate registration is value-stable
  * OpenAIRequestPoliciesReflection dedups against MEAI's private _entries
    field and falls back to AddPolicy on any reflection failure; a CI test
    asserts the field shape on every MEAI bump
  
  Hosting cleanup:
  * Deleted UserAgentResponsesClient and its dummy throwing pipeline
  * HostedAgentUserAgentPolicy is now registered via OpenAIRequestPolicies
    in FoundryHostingExtensions.TryApplyUserAgent
  
  Tests:
  * 19 new unit tests in ClientHeadersExtensionsTests.cs covering validation,
    AsyncLocal isolation, snapshot semantics, end-to-end wire stamping, and
    shared-chat-client dedup
  * Updated OpenTelemetryAgentTests for MEAI 10.5.1 changes to web_search
    serialization and the reduced tool definition payload when sensitive
    data capture is disabled
  
  Microsoft.Extensions.Compliance.Abstractions stays at 10.5.0 because no
  10.5.1 release exists on nuget.org.
  
  * Address PR review: pre-wire AsAIAgent path and dedup TryApplyUserAgent
  
  * FoundryAgent: extract WireClientHeaders helper and call it from the
    internal (AIProjectClient, ChatClientAgent) constructor used by
    AzureAIProjectChatClientExtensions.AsAIAgent so those Foundry-built
    agents also pre-wire the x-client header pipeline.
  * Foundry.Hosting TryApplyUserAgent: dedup HostedAgentUserAgentPolicy
    registration per OpenAIRequestPolicies instance via
    ConditionalWeakTable so per-request resolution does not grow the
    policy list unboundedly on singleton agents.
  
  * Add tests covering AsAIAgent pre-wire and TryApplyUserAgent dedup
  
  Backs the PR review fixes from a4c8f91 with regression tests:
  * ClientHeadersExtensionsTests: AsAIAgent_FoundryAgent_HasPreWiredClientHeadersAgent
    asserts the FoundryAgent built via AzureAIProjectChatClientExtensions.AsAIAgent
    contains a ClientHeadersAgent in its delegating chain (catches future
    regressions of the bypass).
  * ClientHeadersExtensionsTests: FoundryAgent_PublicConstructor_HasPreWiredClientHeadersAgent
    covers the public constructor path the same way.
  * ClientHeadersExtensionsTests: UseClientHeaders_RepeatedRegistrations_OnSameChatClient_OnlyRegistersOnce
    invokes UseClientHeaders 25 times on a shared chat client and asserts via
    reflection that OpenAIRequestPolicies._entries length is exactly 1.
  * HostedTryApplyUserAgentDedupTests: two tests asserting
    FoundryHostingExtensions.TryApplyUserAgent stays at one entry per
    OpenAIRequestPolicies instance after 50 calls on the same agent and across
    distinct agents on different chat clients.
  
  * Move tests next to their SUT
  
  Removes the dedicated HostedTryApplyUserAgentDedupTests.cs test class.
  Tests are co-located with the SUT they exercise:
  
  * FoundryAgentTests.cs gains the Constructor_PreWiresClientHeadersAgent
    and Constructor_FromAsAIAgentExtension_PreWiresClientHeadersAgent
    cases, since FoundryAgent is the SUT for the pre-wire behavior.
  * HostedOutboundUserAgentTests.cs gains the two TryApplyUserAgent dedup
    cases, since FoundryHostingExtensions.TryApplyUserAgent is the SUT
    it already covers.
  * ClientHeadersExtensionsTests.cs keeps only the
    UseClientHeaders_RepeatedRegistrations_OnSameChatClient_OnlyRegistersOnce
    case, which exercises the public ClientHeadersExtensions surface.
  
  * Remove redundant WithCancellation on inner streaming call
  
  ct is already passed to InnerAgent.RunStreamingAsync, so
  .WithCancellation(ct) on the resulting IAsyncEnumerable is a no-op.
  Caught by Sergey on PR review.
  
  * Address PR review: surface downstream MEAI experimental ID
  
  * Add AIOpenAIRequestPolicies = MEAIExperiments alias to
    DiagnosticIds.Experiments (matches the existing AIResponseContinuations,
    AIMcpServers, AIFunctionApprovals pattern).
  * Mark public ClientHeadersExtensions with [Experimental(AIOpenAIRequestPolicies)]
    instead of AgentsAIExperiments. Consumers now see the MEAI001 warning,
    surfacing the dependency on MEAI's experimental OpenAIRequestPolicies hook.
  * Mark internal OpenAIRequestPoliciesReflection with the same alias to
    suppress warnings at the source rather than via project-wide NoWarn.
  * Remove MEAI001 from Foundry csproj NoWarn (kept on Foundry.Hosting where
    pre-PR usages remain).
  * Clarify ClientHeadersScope XML doc: AsyncLocal flows values forward but
    does NOT auto-restore on method return; explicit using/Dispose is what
    gives stack-style LIFO semantics.

  Roger Barreto · 2026-05-06 14:43:08 +00:00
  b12109b7e4
• .NET: Add dedicated Foundry.Hosting UnitTest project (#5592)

  * Foundry.Hosting.UnitTests: extract project from Foundry.UnitTests
  
  Move all Hosting/* tests, three toolbox TestData JSONs, and the FakeAuthenticationTokenProvider/HttpHandlerAssert/TestDataUtil helpers (trimmed to toolbox getters) into a new Microsoft.Agents.AI.Foundry.Hosting.UnitTests project. Add it to the slnx and grant the new assembly InternalsVisibleTo from Microsoft.Agents.AI.Foundry and Microsoft.Agents.AI.Foundry.Hosting.
  
  * Foundry.Hosting.UnitTests: align namespaces to assembly name
  
  Rename namespaces from Microsoft.Agents.AI.Foundry.UnitTests(.Hosting) to Microsoft.Agents.AI.Foundry.Hosting.UnitTests across all moved tests, the duplicated helpers, and the trimmed TestDataUtil. Also fixes the prior namespace inconsistency in FoundryToolboxTests.
  
  * Foundry.Hosting.UnitTests: split WorkflowIntegrationTests by SUT
  
  Replace the WorkflowIntegrationTests file (an IT-named file inside a UT project) with two SUT-focused files plus a shared test-doubles file:
  
  - AgentFrameworkResponseHandlerWorkflowTests.cs - the 5 handler-driven tests that exercise AgentFrameworkResponseHandler with a real workflow agent.
  - OutputConverterWorkflowTests.cs - the 5 OutputConverter tests driven by hand-crafted update sequences mirroring real workflow patterns.
  - WorkflowTestAgents.cs - StreamingTextAgent and ThrowingStreamingAgent extracted as internal types used by both files.
  
  * Foundry.UnitTests: trim Hosting-related conditionals and dead testdata
  
  Now that Hosting tests live in their own project:
  - drop the Compile Remove guard for the Hosting subfolder,
  - drop the .NETCoreApp-only PackageReferences (Azure.AI.AgentServer.Responses, Microsoft.AspNetCore.TestHost, OpenTelemetry, OpenTelemetry.Exporter.InMemory),
  - drop the conditional ProjectReference to Microsoft.Agents.AI.Foundry.Hosting,
  - delete the three Toolbox JSON files and the matching Toolbox getters in TestDataUtil.
  
  * Foundry.Hosting.UnitTests: drop redundant 'using Microsoft.Agents.AI.Foundry.Hosting'
  
  The new project namespace is Microsoft.Agents.AI.Foundry.Hosting.UnitTests, which already brings the parent Microsoft.Agents.AI.Foundry.Hosting namespace into scope. The explicit using statement is therefore redundant (IDE0005). Caught by 'dotnet format --verify-no-changes' running on Linux against the .NET 10 SDK.
  
  * Foundry.Hosting: drop InternalsVisibleTo to Foundry.UnitTests
  
  The non-hosting Foundry.UnitTests project no longer holds any Hosting tests after the split, so it doesn't need access to internal types in Microsoft.Agents.AI.Foundry.Hosting. Only Microsoft.Agents.AI.Foundry.Hosting.UnitTests needs it.
  
  * Foundry.Hosting: rename DelegatingResponsesClient to UserAgentResponsesClient
  
  Address westey-m's review feedback on PR #5453: `Delegating*` is conventionally reserved for inheritable base classes (mirroring `DelegatingHandler`) where consumers override one or two members. This polyfill is sealed and only injects the User-Agent supplement, so the new name reflects its actual purpose.
  
  Renamed via `git mv` to preserve history:
  * `src/Microsoft.Agents.AI.Foundry.Hosting/DelegatingResponsesClient.cs` to `UserAgentResponsesClient.cs`
  * `tests/Microsoft.Agents.AI.Foundry.Hosting.UnitTests/DelegatingResponsesClientTests.cs` to `UserAgentResponsesClientTests.cs`
  
  Class, constructor, and all references updated across:
  * `src/.../UserAgentResponsesClient.cs` (class + constructor + internal log message)
  * `src/.../ServiceCollectionExtensions.cs` (cref + type check + instantiation)
  * `src/.../HostedAgentUserAgentPolicy.cs` (cref)
  * `tests/Foundry.UnitTests/RequestOptionsExtensionsTests.cs` (comment)
  * `tests/Foundry.Hosting.UnitTests/UserAgentResponsesClientTests.cs` (class + cref + instantiations)

  Roger Barreto · 2026-04-30 21:09:25 +00:00
  fb97e93a01