Fix CommandLineArgsCallbackContext ExecutionContext in AzureResourcePreparer and prevent WithVSCodeDebugSupport execution in publish mode #11783

Copilot · 2025-10-01T19:25:04Z

Fix: WithVSCodeDebugSupport ServiceProvider Access Issue During Manifest Generation

Fixes a regression in Aspire 9.5.0 where using AddPythonApp with AddAzureContainerAppEnvironment causes manifest generation (azd infra gen) to fail with "IServiceProvider is not available" error.

Root Cause

When AzureResourcePreparer.GetAzureReferences() evaluates command line argument callbacks to discover Azure resource references, it was creating CommandLineArgsCallbackContext without setting the ExecutionContext property. This caused the context to default to Run mode instead of inheriting the actual execution context (Publish mode during manifest generation).

The WithVSCodeDebugSupport callback (introduced in 9.5.0 for Python apps) checks ctx.ExecutionContext.IsRunMode before accessing ctx.ExecutionContext.ServiceProvider. With the incorrect default context, this check failed, causing the callback to attempt accessing ServiceProvider during manifest generation where it's not available.

Changes Made

Set ExecutionContext in AzureResourcePreparer - Set the ExecutionContext property when creating CommandLineArgsCallbackContext in AzureResourcePreparer.GetAzureReferences() to match the pattern already used for EnvironmentCallbackContext
Only execute WithVSCodeDebugSupport in run mode - Modified WithVSCodeDebugSupport to return early when not in run mode, preventing both the WithArgs callback registration and the SupportsDebuggingAnnotation from being added during publish mode
Added tests - Added tests to verify:
- WithVSCodeDebugSupport correctly adds the annotation in run mode
- WithVSCodeDebugSupport does not add the annotation in publish mode
- CommandLineArgsCallbackContext has the correct ExecutionContext set during publish operations

Impact

Python apps (and other resources using WithVSCodeDebugSupport) now work correctly with Azure Container Apps during manifest generation
Command line argument callbacks receive the correct execution context, allowing them to make proper IsRunMode vs IsPublishMode decisions
Defense-in-depth: WithVSCodeDebugSupport callbacks and debugging annotations are only registered when appropriate for the execution mode
Minimal changes with no breaking changes or behavioral modifications for existing functionality

Testing

Added regression test CommandLineArgsCallbackContextHasCorrectExecutionContextDuringPublish that verifies callbacks receive the correct execution context during publish operations
Added test WithVSCodeDebugSupportAddsAnnotationInRunMode to verify the SupportsDebuggingAnnotation is correctly added in run mode
Added test WithVSCodeDebugSupportDoesNotAddAnnotationInPublishMode to verify the annotation is not added in publish mode

Fixes #11781

Original prompt

This section details on the original issue you should resolve

<issue_title>WithVSCodeDebugSupport in Python 9.5.0 causes IServiceProvider error with AddAzureContainerAppEnvironment during manifest generation (azd infra gen)</issue_title>
<issue_description>## Description

When using AddAzureContainerAppEnvironment together with AddPythonApp in Aspire 9.5.0, running azd infra gen (manifest generation) fails with an IServiceProvider is not available error. This is a regression in 9.5.0 - the same code works correctly in 9.4.2.

Environment

.NET Aspire version: 9.5.0
.NET SDK version: 9.0
OS: macOS (also reproduces on Windows/Linux)
Tool: Azure Developer CLI (azd)

Steps to Reproduce

Create an AppHost project with Aspire 9.5.0

Add the following packages:

<PackageReference Include="Aspire.Hosting.AppHost" Version="9.5.0" />
<PackageReference Include="Aspire.Hosting.Python" Version="9.5.0" />
<PackageReference Include="Aspire.Hosting.Azure.AppContainers" Version="9.5.0" />

Configure AppHost.cs with both Azure Container App Environment and Python app:

var builder = DistributedApplication.CreateBuilder(args);

var containerAppEnvironment = builder.AddAzureContainerAppEnvironment("containerAppEnvironment");

var pythonapp = builder.AddPythonApp("instrumented-python-app", "../InstrumentedPythonProject", "app.py")
       .WithHttpEndpoint(env: "PORT")
       .WithExternalHttpEndpoints();

builder.Build().Run();

Run azd infra gen

Expected Behavior

Manifest generation should succeed and produce infrastructure files.

Actual Behavior

The command fails with the following error:

ERROR: generating apphost manifest: generating app host manifest: dotnet run --publisher manifest on project
'AspireWithPython.AppHost.csproj' failed: exit code: 134

Unhandled exception. System.AggregateException: One or more errors occurred.
(IServiceProvider is not available because execution context was not constructed with DistributedApplicationExecutionContextOptions.)
 ---> System.InvalidOperationException: IServiceProvider is not available because execution context was not
 constructed with DistributedApplicationExecutionContextOptions.
   at Aspire.Hosting.DistributedApplicationExecutionContext.get_ServiceProvider()
      in /_/src/Aspire.Hosting/DistributedApplicationExecutionContext.cs:line 67
   at Aspire.Hosting.ResourceBuilderExtensions.<>c__DisplayClass71_0`1.<WithVSCodeDebugSupport>b__0(CommandLineArgsCallbackContext ctx)
      in /_/src/Aspire.Hosting/ResourceBuilderExtensions.cs:line 2322
   at Aspire.Hosting.ResourceBuilderExtensions.<>c__DisplayClass14_0`1.<WithArgs>b__0(CommandLineArgsCallbackContext context)
      in /_/src/Aspire.Hosting/ResourceBuilderExtensions.cs:line 323
   at Aspire.Hosting.Azure.AzureResourcePreparer.GetAzureReferences(IResource resource, CancellationToken cancellationToken)
      in /_/src/Aspire.Hosting.Azure/AzureResourcePreparer.cs:line 387
   at Aspire.Hosting.Azure.AzureResourcePreparer.BuildRoleAssignmentAnnotations(DistributedApplicationModel appModel, List`1 azureResources, AzureProvisioningOptions options, CancellationToken cancellationToken)
      in /_/src/Aspire.Hosting.Azure/AzureResourcePreparer.cs:line 142
   at Aspire.Hosting.Azure.AzureResourcePreparer.BeforeStartAsync(DistributedApplicationModel appModel, CancellationToken cancellationToken)
      in /_/src/Aspire.Hosting.Azure/AzureResourcePreparer.cs:line 39
   at Aspire.Hosting.DistributedApplication.ExecuteBeforeStartHooksAsync(CancellationToken cancellationToken)
      in /_/src/Aspire.Hosting/DistributedApplication.cs:line 490
   at Aspire.Hosting.DistributedApplication.RunAsync(CancellationToken cancellationToken)
      in /_/src/Aspire.Hosting/DistributedApplication.cs:line 440

Root Cause Analysis

New Feature in 9.5.0: WithVSCodeDebugSupport was added to AddPythonApp in Aspire 9.5.0 to enable VS Code debugging support (see diff)
The Conflict: When AddAzureContainerAppEnvironment is present, the AzureResourcePreparer.BeforeStartAsync lifecycle hook runs during manifest generation and calls GetAzureReferences(), which evaluates all args callbacks to discover Azure resource references
The Bug: The WithVSCodeDebugSupport callback attempts to access ctx.ExecutionContext.ServiceProvider, but during manifest generation, the execution context wasn't constructed with DistributedApplicationExecutionContextOptions, causing the ServiceProvider property getter to throw an exception before the IsRunMode check can execute
Why 9.4.2 Works: The Python package in 9.4.2 does not include WithVSCodeDebugSupport, so this callback never exists

Impact

This regression affects any Aspire 9.5.0 project that:

Uses ...

Fixes #11781

💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

…reparer Set the ExecutionContext property when creating CommandLineArgsCallbackContext in AzureResourcePreparer.GetAzureReferences() to match how EnvironmentCallbackContext is created. This ensures callbacks receive the correct execution context (Publish vs Run mode), preventing WithVSCodeDebugSupport from incorrectly attempting to access ServiceProvider during manifest generation. Co-authored-by: davidfowl <[email protected]>

davidfowl · 2025-10-01T20:02:39Z

@copilot Also change WithVSCodeDebugSupport to only execute if builder.ApplicationBuilder.ExecutionContext.IsRunMode is true.

Add check at method level to only register WithArgs callback when builder.ApplicationBuilder.ExecutionContext.IsRunMode is true. This prevents the callback from being registered during publish mode, avoiding unnecessary callback evaluation during manifest generation. Co-authored-by: davidfowl <[email protected]>

Copilot · 2025-10-01T20:08:26Z

@copilot Also change WithVSCodeDebugSupport to only execute if builder.ApplicationBuilder.ExecutionContext.IsRunMode is true.

Done in 1348d79. Added check at method level to only register the WithArgs callback when builder.ApplicationBuilder.ExecutionContext.IsRunMode is true, preventing the callback from being registered during publish mode.

src/Aspire.Hosting/ResourceBuilderExtensions.cs

github-actions · 2025-10-01T20:21:39Z

🚀 Dogfood this PR with:

⚠️ WARNING: Do not do this without first carefully reviewing the code of this PR to satisfy yourself it is safe.

curl -fsSL https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.sh | bash -s -- 11783

Or

Run remotely in PowerShell:

iex "& { $(irm https://raw.githubusercontent.com/dotnet/aspire/main/eng/scripts/get-aspire-cli-pr.ps1) } 11783"

davidfowl · 2025-10-01T20:22:46Z

@copilot add a test for WithVSCodeDebugSupport not applying in publish mode (there should be no annotation)

Copilot

Pull Request Overview

This pull request fixes a regression in Aspire 9.5.0 where using AddPythonApp with AddAzureContainerAppEnvironment causes manifest generation to fail with an "IServiceProvider is not available" error. The issue stems from incorrect execution context handling in command line argument callbacks during publish mode.

Key changes:

Sets the correct ExecutionContext in AzureResourcePreparer.GetAzureReferences() when creating CommandLineArgsCallbackContext
Prevents WithVSCodeDebugSupport from registering callbacks during publish mode by checking execution context at the method level
Adds a regression test to verify command line argument callbacks receive the correct execution context

Reviewed Changes

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

File	Description
src/Aspire.Hosting.Azure/AzureResourcePreparer.cs	Sets ExecutionContext property when creating CommandLineArgsCallbackContext to match the actual execution mode
src/Aspire.Hosting/ResourceBuilderExtensions.cs	Moves execution context check to method level to prevent callback registration during publish mode
tests/Aspire.Hosting.Azure.Tests/AzureResourcePreparerTests.cs	Adds regression test verifying callbacks receive correct execution context during publish operations

Added tests to verify that WithVSCodeDebugSupport does not add the SupportsDebuggingAnnotation in publish mode, only in run mode. This ensures the debugging annotation is only added when appropriate. Co-authored-by: davidfowl <[email protected]>

Copilot · 2025-10-01T20:37:00Z

@copilot add a test for WithVSCodeDebugSupport not applying in publish mode (there should be no annotation)

Done in 72ae992. Added tests WithVSCodeDebugSupportAddsAnnotationInRunMode and WithVSCodeDebugSupportDoesNotAddAnnotationInPublishMode to verify the annotation is only added in run mode.

eerhardt · 2025-10-01T20:55:23Z

src/Aspire.Hosting/ResourceBuilderExtensions.cs

+        builder.WithAnnotation(new SupportsDebuggingAnnotation(projectPath, debugAdapterId, requiredExtensionId));
+
+        return builder;


Suggested change

builder.WithAnnotation(new SupportsDebuggingAnnotation(projectPath, debugAdapterId, requiredExtensionId));

return builder;

return builder.WithAnnotation(new SupportsDebuggingAnnotation(projectPath, debugAdapterId, requiredExtensionId));

(nit) this can be reverted.

Done in d421906. Reverted the formatting change.

eerhardt · 2025-10-01T20:56:43Z

tests/Aspire.Hosting.Azure.Tests/AzureResourcePreparerTests.cs

+                // This simulates WithVSCodeDebugSupport behavior - checking IsRunMode before accessing ServiceProvider
+                if (!context.ExecutionContext.IsRunMode)
+                {
+                    return;
+                }
+
+                // This should not be reached during publish mode, but if the ExecutionContext is not set correctly,
+                // it will default to Run mode and then try to access ServiceProvider which will throw
+                _ = context.ExecutionContext.ServiceProvider;


we don't need the IsRunMode check. That can be removed.

You can set the IServiceProvider to a variable outside of the callback on line 243, and then Assert that it is not null at the end of the test on line 267.

Done in d421906. Removed the IsRunMode check and updated the test to capture the ExecutionContext and assert it's not null and in Publish mode.

davidfowl · 2025-10-01T21:34:36Z

@copilot implement PR feedback.

- Reverted formatting change in ResourceBuilderExtensions.cs (return statement on one line) - Improved CommandLineArgsCallbackContextHasCorrectExecutionContextDuringPublish test to: - Remove unnecessary IsRunMode check in callback - Capture ExecutionContext to verify it's set correctly - Assert ExecutionContext is not null and in Publish mode Co-authored-by: davidfowl <[email protected]>

Copilot · 2025-10-01T21:41:11Z

@copilot implement PR feedback.

Implemented in d421906.

davidfowl · 2025-10-01T22:30:00Z

/backport to release/9.5

github-actions · 2025-10-01T22:30:10Z

Started backporting to release/9.5: https://github.com/dotnet/aspire/actions/runs/18177473850

…reparer and prevent WithVSCodeDebugSupport execution in publish mode (#11783) * Initial plan * Fix CommandLineArgsCallbackContext ExecutionContext in AzureResourcePreparer Set the ExecutionContext property when creating CommandLineArgsCallbackContext in AzureResourcePreparer.GetAzureReferences() to match how EnvironmentCallbackContext is created. This ensures callbacks receive the correct execution context (Publish vs Run mode), preventing WithVSCodeDebugSupport from incorrectly attempting to access ServiceProvider during manifest generation. Co-authored-by: davidfowl <[email protected]> * Only execute WithVSCodeDebugSupport in run mode Add check at method level to only register WithArgs callback when builder.ApplicationBuilder.ExecutionContext.IsRunMode is true. This prevents the callback from being registered during publish mode, avoiding unnecessary callback evaluation during manifest generation. Co-authored-by: davidfowl <[email protected]> * Update src/Aspire.Hosting/ResourceBuilderExtensions.cs * Add tests for WithVSCodeDebugSupport behavior in publish mode Added tests to verify that WithVSCodeDebugSupport does not add the SupportsDebuggingAnnotation in publish mode, only in run mode. This ensures the debugging annotation is only added when appropriate. Co-authored-by: davidfowl <[email protected]> * Address PR feedback: revert formatting and improve test - Reverted formatting change in ResourceBuilderExtensions.cs (return statement on one line) - Improved CommandLineArgsCallbackContextHasCorrectExecutionContextDuringPublish test to: - Remove unnecessary IsRunMode check in callback - Capture ExecutionContext to verify it's set correctly - Assert ExecutionContext is not null and in Publish mode Co-authored-by: davidfowl <[email protected]> --------- Co-authored-by: copilot-swe-agent[bot] <[email protected]> Co-authored-by: davidfowl <[email protected]> Co-authored-by: David Fowler <[email protected]>

Initial plan

8afc522

Copilot AI assigned Copilot and davidfowl Oct 1, 2025

Copilot started work on behalf of davidfowl October 1, 2025 19:25 View session

Copilot AI changed the title ~~[WIP] WithVSCodeDebugSupport in Python 9.5.0 causes IServiceProvider error with AddAzureContainerAppEnvironment during manifest generation (azd infra gen)~~ Fix CommandLineArgsCallbackContext ExecutionContext in AzureResourcePreparer Oct 1, 2025

Copilot AI requested a review from davidfowl October 1, 2025 19:52

Copilot finished work on behalf of davidfowl October 1, 2025 19:53

Copilot started work on behalf of davidfowl October 1, 2025 20:02 View session

Copilot AI changed the title ~~Fix CommandLineArgsCallbackContext ExecutionContext in AzureResourcePreparer~~ Fix CommandLineArgsCallbackContext ExecutionContext in AzureResourcePreparer and prevent WithVSCodeDebugSupport execution in publish mode Oct 1, 2025

Copilot finished work on behalf of davidfowl October 1, 2025 20:09

davidfowl reviewed Oct 1, 2025

View reviewed changes

src/Aspire.Hosting/ResourceBuilderExtensions.cs Outdated Show resolved Hide resolved

Update src/Aspire.Hosting/ResourceBuilderExtensions.cs

e744326

davidfowl marked this pull request as ready for review October 1, 2025 20:22

davidfowl requested review from captainsafia and eerhardt as code owners October 1, 2025 20:22

Copilot AI review requested due to automatic review settings October 1, 2025 20:22

Copilot started work on behalf of davidfowl October 1, 2025 20:22 View session

Copilot AI reviewed Oct 1, 2025

View reviewed changes

Copilot AI requested a review from mitchdenny as a code owner October 1, 2025 20:36

Copilot AI requested a review from davidfowl October 1, 2025 20:37

Copilot finished work on behalf of davidfowl October 1, 2025 20:37

eerhardt approved these changes Oct 1, 2025

View reviewed changes

Copilot started work on behalf of davidfowl October 1, 2025 21:34 View session

Copilot finished work on behalf of davidfowl October 1, 2025 21:42

davidfowl merged commit 9136c2f into main Oct 1, 2025
618 of 621 checks passed

dotnet-policy-service bot added this to the 13.0 milestone Oct 1, 2025

github-actions bot mentioned this pull request Oct 1, 2025

[release/9.5] Fix CommandLineArgsCallbackContext ExecutionContext in AzureResourcePreparer and prevent WithVSCodeDebugSupport execution in publish mode #11788

Merged

		builder.WithAnnotation(new SupportsDebuggingAnnotation(projectPath, debugAdapterId, requiredExtensionId));

		return builder;

Uh oh!

Fix CommandLineArgsCallbackContext ExecutionContext in AzureResourcePreparer and prevent WithVSCodeDebugSupport execution in publish mode #11783

Fix CommandLineArgsCallbackContext ExecutionContext in AzureResourcePreparer and prevent WithVSCodeDebugSupport execution in publish mode #11783

Uh oh!

Conversation

Copilot AI commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Fix: WithVSCodeDebugSupport ServiceProvider Access Issue During Manifest Generation

Root Cause

Changes Made

Impact

Testing

Environment

Steps to Reproduce

Expected Behavior

Actual Behavior

Root Cause Analysis

Impact

Uh oh!

davidfowl commented Oct 1, 2025

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

Uh oh!

github-actions bot commented Oct 1, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

davidfowl commented Oct 1, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

eerhardt Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

eerhardt Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Oct 1, 2025

Choose a reason for hiding this comment

Uh oh!

davidfowl commented Oct 1, 2025

Uh oh!

Copilot AI commented Oct 1, 2025

Uh oh!

Uh oh!

davidfowl commented Oct 1, 2025

Uh oh!

github-actions bot commented Oct 1, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Copilot AI commented Oct 1, 2025 •

edited

Loading

github-actions bot commented Oct 1, 2025 •

edited

Loading