Support storing state in filesystem for local deploys (#11877)

* Support storing state in file system for local deployments

* Move IDeploymentStateManager initialization to DistributedApplicationBuilder

Co-authored-by: captainsafia <[email protected]>

* Implement PR feedback: config ordering, save all params, remove clearCache check, add logging

Co-authored-by: davidfowl <[email protected]>

* Clean up build errors

* Fix setting of execution mode

* Fix order for cached deployment test

* Update src/Aspire.Hosting/Publishing/Internal/FileDeploymentStateManager.cs

Co-authored-by: Copilot <[email protected]>

* Remove Console.WriteLine from FileDeploymentStateManager, use logger only

Co-authored-by: captainsafia <[email protected]>

* Address PR feedback: rename userSecrets to deploymentState, fix parameter names, remove pragma, change visibility

Co-authored-by: captainsafia <[email protected]>

* Save deployment state after initializing provisioning context, persist AllowResourceGroupCreation, ensure it's true in publish mode

Co-authored-by: captainsafia <[email protected]>

* Add back ClearCache check to LoadDeploymentState to skip loading when cache should be cleared

Co-authored-by: captainsafia <[email protected]>

* Add File.Exists check before emitting deployment state step and only emit save steps when ClearCache is false

Co-authored-by: captainsafia <[email protected]>

* Fix parameter saving to handle newly added parameters without throwing exceptions

Co-authored-by: davidfowl <[email protected]>

* Simplify SaveParametersToDeploymentStateAsync to use GetValueAsync and remove inner exception handling

Co-authored-by: davidfowl <[email protected]>

* Remove step reporting from deployment state saves, just save the state directly

Co-authored-by: davidfowl <[email protected]>

---------

Co-authored-by: Safia Abdalla <[email protected]>
Co-authored-by: copilot-swe-agent[bot] <[email protected]>
Co-authored-by: captainsafia <[email protected]>
Co-authored-by: davidfowl <[email protected]>
Co-authored-by: Safia Abdalla <[email protected]>
Co-authored-by: Copilot <[email protected]>

Author: 4 people

src/Aspire.Cli/Commands/DeployCommand.cs

@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.CommandLine;
 using Aspire.Cli.Configuration;
 using Aspire.Cli.DotNet;
 using Aspire.Cli.Interaction;
@@ -13,16 +14,23 @@ namespace Aspire.Cli.Commands;
 
 internal sealed class DeployCommand : PublishCommandBase
 {
+    private readonly Option<bool> _clearCacheOption;
+
     public DeployCommand(IDotNetCliRunner runner, IInteractionService interactionService, IProjectLocator projectLocator, AspireCliTelemetry telemetry, IDotNetSdkInstaller sdkInstaller, IFeatures features, ICliUpdateNotifier updateNotifier, CliExecutionContext executionContext)
         : base("deploy", DeployCommandStrings.Description, runner, interactionService, projectLocator, telemetry, sdkInstaller, features, updateNotifier, executionContext)
     {
+        _clearCacheOption = new Option<bool>("--clear-cache")
+        {
+            Description = "Clear the deployment cache associated with the current environment and do not save deployment state"
+        };
+        Options.Add(_clearCacheOption);
     }
 
     protected override string OperationCompletedPrefix => DeployCommandStrings.OperationCompletedPrefix;
     protected override string OperationFailedPrefix => DeployCommandStrings.OperationFailedPrefix;
     protected override string GetOutputPathDescription() => DeployCommandStrings.OutputPathArgumentDescription;
 
-    protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens)
+    protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens, ParseResult parseResult)
     {
         var baseArgs = new List<string> { "--operation", "publish", "--publisher", "default" };
 
@@ -32,6 +40,13 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
         }
 
         baseArgs.AddRange(["--deploy", "true"]);
+
+        var clearCache = parseResult.GetValue(_clearCacheOption);
+        if (clearCache)
+        {
+            baseArgs.AddRange(["--clear-cache", "true"]);
+        }
+
         baseArgs.AddRange(unmatchedTokens);
 
         return [.. baseArgs];

src/Aspire.Cli/Commands/PublishCommand.cs

@@ -1,6 +1,7 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
+using System.CommandLine;
 using Aspire.Cli.Configuration;
 using Aspire.Cli.DotNet;
 using Aspire.Cli.Interaction;
@@ -44,7 +45,7 @@ public PublishCommand(IDotNetCliRunner runner, IInteractionService interactionSe
     protected override string OperationFailedPrefix => PublishCommandStrings.OperationFailedPrefix;
     protected override string GetOutputPathDescription() => PublishCommandStrings.OutputPathArgumentDescription;
 
-    protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens)
+    protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens, ParseResult parseResult)
     {
         var baseArgs = new List<string> { "--operation", "publish", "--publisher", "default" };
 

src/Aspire.Cli/Commands/PublishCommandBase.cs

@@ -75,7 +75,7 @@ protected PublishCommandBase(string name, string description, IDotNetCliRunner r
     }
 
     protected abstract string GetOutputPathDescription();
-    protected abstract string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens);
+    protected abstract string[] GetRunArguments(string? fullyQualifiedOutputPath, string[] unmatchedTokens, ParseResult parseResult);
     protected abstract string GetCanceledMessage();
     protected abstract string GetProgressMessage();
 
@@ -173,7 +173,7 @@ protected override async Task<int> ExecuteAsync(ParseResult parseResult, Cancell
                 effectiveAppHostFile,
                 false,
                 true,
-                GetRunArguments(fullyQualifiedOutputPath, unmatchedTokens),
+                GetRunArguments(fullyQualifiedOutputPath, unmatchedTokens, parseResult),
                 env,
                 backchannelCompletionSource,
                 operationRunOptions,

src/Aspire.Hosting.Azure/AzureDeployingContext.cs

@@ -23,7 +23,7 @@ namespace Aspire.Hosting.Azure;
 
 internal sealed class AzureDeployingContext(
     IProvisioningContextProvider provisioningContextProvider,
-    IUserSecretsManager userSecretsManager,
+    IDeploymentStateManager deploymentStateManager,
     IBicepProvisioner bicepProvisioner,
     IPublishingActivityReporter activityReporter,
     IResourceContainerImageBuilder containerImageBuilder,
@@ -40,9 +40,16 @@ public async Task DeployModelAsync(DistributedApplicationModel model, Cancellati
             return;
         }
 
-        var userSecrets = await userSecretsManager.LoadUserSecretsAsync(cancellationToken).ConfigureAwait(false);
+        var userSecrets = await deploymentStateManager.LoadStateAsync(cancellationToken).ConfigureAwait(false);
         var provisioningContext = await provisioningContextProvider.CreateProvisioningContextAsync(userSecrets, cancellationToken).ConfigureAwait(false);
 
+        // Save deployment state after initializing provisioning context (only if ClearCache is false)
+        var clearCache = configuration.GetValue<bool>("Publishing:ClearCache");
+        if (!clearCache)
+        {
+            await deploymentStateManager.SaveStateAsync(provisioningContext.DeploymentState, cancellationToken).ConfigureAwait(false);
+        }
+
         // Step 1: Provision Azure Bicep resources from the distributed application model
         var bicepResources = model.Resources.OfType<AzureBicepResource>()
             .Where(r => !r.IsExcludedFromPublish())
@@ -65,6 +72,12 @@ public async Task DeployModelAsync(DistributedApplicationModel model, Cancellati
             return;
         }
 
+        // Step 4: Save deployment state after successful deployment (only if ClearCache is false)
+        if (!clearCache)
+        {
+            await deploymentStateManager.SaveStateAsync(provisioningContext.DeploymentState, cancellationToken).ConfigureAwait(false);
+        }
+
         // Display dashboard URL after successful deployment
         var dashboardUrl = TryGetDashboardUrl(model);
         if (!string.IsNullOrEmpty(dashboardUrl))
@@ -104,7 +117,16 @@ private async Task<bool> TryValidateAzureCliLoginAsync(CancellationToken cancell
 
     private async Task<bool> TryProvisionAzureBicepResources(List<AzureBicepResource> bicepResources, ProvisioningContext provisioningContext, CancellationToken cancellationToken)
     {
-        var deployingStep = await activityReporter.CreateStepAsync("Deploying Azure resources", cancellationToken).ConfigureAwait(false);
+        bicepResources = bicepResources
+            .Where(r => r.ProvisioningTaskCompletionSource == null || !r.ProvisioningTaskCompletionSource.Task.IsCompleted)
+            .ToList();
+
+        if (bicepResources.Count == 0)
+        {
+            return true;
+        }
+
+        var deployingStep = await activityReporter.CreateStepAsync($"Deploying {bicepResources.Count} Azure resource(s)", cancellationToken).ConfigureAwait(false);
         await using (deployingStep.ConfigureAwait(false))
         {
             try
@@ -125,11 +147,17 @@ private async Task<bool> TryProvisionAzureBicepResources(List<AzureBicepResource
                                 {
                                     bicepResource.ProvisioningTaskCompletionSource = new(TaskCreationOptions.RunContinuationsAsynchronously);
 
-                                    await bicepProvisioner.GetOrCreateResourceAsync(bicepResource, provisioningContext, cancellationToken).ConfigureAwait(false);
-
-                                    bicepResource.ProvisioningTaskCompletionSource?.TrySetResult();
-
-                                    await resourceTask.CompleteAsync($"Successfully provisioned {bicepResource.Name}", CompletionState.Completed, cancellationToken).ConfigureAwait(false);
+                                    if (await bicepProvisioner.ConfigureResourceAsync(configuration, bicepResource, cancellationToken).ConfigureAwait(false))
+                                    {
+                                        bicepResource.ProvisioningTaskCompletionSource?.TrySetResult();
+                                        await resourceTask.CompleteAsync($"Using existing deployment for {bicepResource.Name}", CompletionState.Completed, cancellationToken).ConfigureAwait(false);
+                                    }
+                                    else
+                                    {
+                                        await bicepProvisioner.GetOrCreateResourceAsync(bicepResource, provisioningContext, cancellationToken).ConfigureAwait(false);
+                                        bicepResource.ProvisioningTaskCompletionSource?.TrySetResult();
+                                        await resourceTask.CompleteAsync($"Successfully provisioned {bicepResource.Name}", CompletionState.Completed, cancellationToken).ConfigureAwait(false);
+                                    }
                                 }
                                 catch (Exception ex)
                                 {

src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs

@@ -73,7 +73,7 @@ private Task PublishAsync(PublishingContext context)
     private Task DeployAsync(DeployingContext context)
     {
         var provisioningContextProvider = context.Services.GetRequiredService<IProvisioningContextProvider>();
-        var userSecretsManager = context.Services.GetRequiredService<IUserSecretsManager>();
+        var userSecretsManager = context.Services.GetRequiredService<IDeploymentStateManager>();
         var bicepProvisioner = context.Services.GetRequiredService<IBicepProvisioner>();
         var activityPublisher = context.Services.GetRequiredService<IPublishingActivityReporter>();
         var containerImageBuilder = context.Services.GetRequiredService<IResourceContainerImageBuilder>();

src/Aspire.Hosting.Azure/Provisioning/AzureProvisionerExtensions.cs

@@ -44,8 +44,8 @@ public static IDistributedApplicationBuilder AddAzureProvisioning(this IDistribu
         builder.Services.TryAddSingleton<IArmClientProvider, DefaultArmClientProvider>();
         builder.Services.TryAddSingleton<ISecretClientProvider, DefaultSecretClientProvider>();
         builder.Services.TryAddSingleton<IBicepCompiler, BicepCliCompiler>();
-        builder.Services.TryAddSingleton<IUserSecretsManager, DefaultUserSecretsManager>();
         builder.Services.TryAddSingleton<IUserPrincipalProvider, DefaultUserPrincipalProvider>();
+
         if (builder.ExecutionContext.IsPublishMode)
         {
             builder.Services.AddSingleton<IProvisioningContextProvider, PublishModeProvisioningContextProvider>();

src/Aspire.Hosting.Azure/Provisioning/Internal/BaseProvisioningContextProvider.cs

@@ -72,7 +72,7 @@ protected static bool IsValidResourceGroupName(string? name)
         return !name.Contains("..");
     }
 
-    public virtual async Task<ProvisioningContext> CreateProvisioningContextAsync(JsonObject userSecrets, CancellationToken cancellationToken = default)
+    public virtual async Task<ProvisioningContext> CreateProvisioningContextAsync(JsonObject deploymentState, CancellationToken cancellationToken = default)
     {
         var subscriptionId = _options.SubscriptionId ?? throw new MissingConfigurationException("An Azure subscription id is required. Set the Azure:SubscriptionId configuration value.");
 
@@ -103,19 +103,26 @@ public virtual async Task<ProvisioningContext> CreateProvisioningContextAsync(Js
         if (string.IsNullOrEmpty(_options.ResourceGroup))
         {
             // Generate an resource group name since none was provided
-            // Create a unique resource group name and save it in user secrets
+            // Create a unique resource group name and save it in deployment state
             resourceGroupName = GetDefaultResourceGroupName();
 
             createIfAbsent = true;
 
-            userSecrets.Prop("Azure")["ResourceGroup"] = resourceGroupName;
+            deploymentState.Prop("Azure")["ResourceGroup"] = resourceGroupName;
         }
         else
         {
             resourceGroupName = _options.ResourceGroup;
             createIfAbsent = _options.AllowResourceGroupCreation ?? false;
         }
 
+        // In publish mode, always allow resource group creation
+        if (_distributedApplicationExecutionContext.IsPublishMode)
+        {
+            createIfAbsent = true;
+            _options.AllowResourceGroupCreation = true;
+        }
+
         var resourceGroups = subscriptionResource.GetResourceGroups();
 
         IResourceGroupResource? resourceGroup;
@@ -149,6 +156,16 @@ public virtual async Task<ProvisioningContext> CreateProvisioningContextAsync(Js
 
         var principal = await _userPrincipalProvider.GetUserPrincipalAsync(cancellationToken).ConfigureAwait(false);
 
+        // Persist the provisioning options to deployment state so they can be reused in the future
+        var azureSection = deploymentState.Prop("Azure");
+        azureSection["Location"] = _options.Location;
+        azureSection["SubscriptionId"] = _options.SubscriptionId;
+        azureSection["ResourceGroup"] = resourceGroupName;
+        if (_options.AllowResourceGroupCreation.HasValue)
+        {
+            azureSection["AllowResourceGroupCreation"] = _options.AllowResourceGroupCreation.Value;
+        }
+
         return new ProvisioningContext(
                     credential,
                     armClient,
@@ -157,7 +174,7 @@ public virtual async Task<ProvisioningContext> CreateProvisioningContextAsync(Js
                     tenantResource,
                     location,
                     principal,
-                    userSecrets,
+                    deploymentState,
                     _distributedApplicationExecutionContext);
     }
 

src/Aspire.Hosting.Azure/Provisioning/Internal/IProvisioningServices.cs

@@ -49,22 +49,6 @@ internal interface IBicepCompiler
     Task<string> CompileBicepToArmAsync(string bicepFilePath, CancellationToken cancellationToken = default);
 }
 
-/// <summary>
-/// Provides user secrets management functionality.
-/// </summary>
-internal interface IUserSecretsManager
-{
-    /// <summary>
-    /// Loads user secrets from the current application.
-    /// </summary>
-    Task<JsonObject> LoadUserSecretsAsync(CancellationToken cancellationToken = default);
-
-    /// <summary>
-    /// Saves user secrets to the current application.
-    /// </summary>
-    Task SaveUserSecretsAsync(JsonObject userSecrets, CancellationToken cancellationToken = default);
-}
-
 /// <summary>
 /// Provides provisioning context creation functionality.
 /// </summary>

src/Aspire.Hosting.Azure/Provisioning/Internal/RunModeProvisioningContextProvider.cs

@@ -61,7 +61,7 @@ protected override string GetDefaultResourceGroupName()
         return $"{prefix}-{normalizedApplicationName}-{suffix}";
     }
 
-    private void EnsureProvisioningOptions(JsonObject userSecrets)
+    private void EnsureProvisioningOptions()
     {
         if (!_interactionService.IsAvailable ||
             (!string.IsNullOrEmpty(_options.Location) && !string.IsNullOrEmpty(_options.SubscriptionId)))
@@ -77,7 +77,7 @@ private void EnsureProvisioningOptions(JsonObject userSecrets)
         {
             try
             {
-                await RetrieveAzureProvisioningOptions(userSecrets).ConfigureAwait(false);
+                await RetrieveAzureProvisioningOptions().ConfigureAwait(false);
 
                 _logger.LogDebug("Azure provisioning options have been handled successfully.");
             }
@@ -91,14 +91,14 @@ private void EnsureProvisioningOptions(JsonObject userSecrets)
 
     public override async Task<ProvisioningContext> CreateProvisioningContextAsync(JsonObject userSecrets, CancellationToken cancellationToken = default)
     {
-        EnsureProvisioningOptions(userSecrets);
+        EnsureProvisioningOptions();
 
         await _provisioningOptionsAvailable.Task.ConfigureAwait(false);
 
         return await base.CreateProvisioningContextAsync(userSecrets, cancellationToken).ConfigureAwait(false);
     }
 
-    private async Task RetrieveAzureProvisioningOptions(JsonObject userSecrets, CancellationToken cancellationToken = default)
+    private async Task RetrieveAzureProvisioningOptions(CancellationToken cancellationToken = default)
     {
         var locations = typeof(AzureLocation).GetProperties(BindingFlags.Public | BindingFlags.Static)
                             .Where(p => p.PropertyType == typeof(AzureLocation))
@@ -166,13 +166,6 @@ private async Task RetrieveAzureProvisioningOptions(JsonObject userSecrets, Canc
                     _options.ResourceGroup = result.Data[ResourceGroupName].Value;
                     _options.AllowResourceGroupCreation = true; // Allow the creation of the resource group if it does not exist.
 
-                    var azureSection = userSecrets.Prop("Azure");
-
-                    // Persist the parameter value to user secrets so they can be reused in the future
-                    azureSection["Location"] = _options.Location;
-                    azureSection["SubscriptionId"] = _options.SubscriptionId;
-                    azureSection["ResourceGroup"] = _options.ResourceGroup;
-
                     _provisioningOptionsAvailable.SetResult();
                 }
             }

src/Aspire.Hosting.Azure/Provisioning/JsonExtensions.cs

@@ -9,14 +9,27 @@ internal static class JsonExtensions
 {
     public static JsonNode Prop(this JsonNode obj, string key)
     {
-        var node = obj[key];
+        var jsonObj = obj.AsObject();
+
+        // Try to get the existing node
+        var node = jsonObj[key];
         if (node is not null)
         {
             return node;
         }
 
+        // Create a new node and try to add it
         node = new JsonObject();
-        obj.AsObject().Add(key, node);
+
+        if (!jsonObj.TryAdd(key, node))
+        {
+            node = jsonObj[key];
+            if (node is null)
+            {
+                throw new InvalidOperationException($"Failed to get or create property '{key}'");
+            }
+        }
+
         return node;
     }
 }