Register IPipelineOutputService in DI for pipeline output directory management (#12563)

* Initial plan

* Set default OutputPath and add IntermediateOutputPath at PipelineContext level

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

* Refactor output path handling to use IPipelineOutputService

- Create IPipelineOutputService interface with GetOutputDirectory() and GetTempDirectory() methods
- Implement PipelineOutputService with better naming than IntermediateOutputPath
- Expose service via PipelineContext.OutputService and PipelineStepContext.OutputService
- Keep backward compatible OutputPath property for existing consumers
- Remove direct IntermediateOutputPath property per feedback

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

* Add resource-specific directory support to IPipelineOutputService

- Add GetOutputDirectory(IResource) overload for resource-specific output directories
- Add GetTempDirectory(IResource) overload for resource-specific temp directories
- Implementation creates subdirectories using resource.Name under base directories
- Enables per-resource isolation of output and temp artifacts

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

* Remove OutputPath property from PipelineContext and PipelineStepContext

- Remove OutputPath convenience property per @davidfowl feedback
- Consumers now explicitly call OutputService.GetOutputDirectory()
- Update AzureEnvironmentResource to use OutputService.GetOutputDirectory()
- Update PublishingContextUtils to use OutputService.GetOutputDirectory()
- Update test helper to use OutputService.GetOutputDirectory()
- Keep OutputService property for explicit access to output management

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

* Remove OutputService from PipelineContext and resolve from DI

- Register IPipelineOutputService in DI container with PipelineOptions
- Remove OutputService property from PipelineContext and PipelineStepContext
- Remove outputPath parameter from PipelineContext constructor
- Update all consumers to resolve IPipelineOutputService from Services
  - AzureEnvironmentResource
  - PublishingContextUtils
  - JsonDocumentManifestPublisher test helper
- Remove IOptions<PipelineOptions> dependency from PipelineExecutor
- Steps now explicitly resolve IPipelineOutputService when needed

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

* Update PipelineOutputService to inject dependencies and use resource-specific overload

- PipelineOutputService now injects IOptions<PipelineOptions> and IConfiguration directly in constructor
- Simplified DI registration to use standard AddSingleton without factory lambda
- PublishingContextUtils uses GetOutputDirectory(environment) for resource-specific paths
- Removes manual path combination logic in favor of service method

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

* Update src/Shared/PublishingContextUtils.cs

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

* Add XML documentation and update diagnostic ID to ASPIREPIPELINES004

- Update Experimental attribute from ASPIREPIPELINES001 to ASPIREPIPELINES004
- Add XML documentation for GetOutputDirectory() default behavior
- Add XML documentation for private fields in PipelineOutputService
- Document purpose of AppHost:PathSha256 usage in CreateTempDirectory
- Suppress ASPIREPIPELINES004 diagnostic in all consuming files

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

---------

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

Author: 4 people

src/Aspire.Cli/Commands/PublishCommand.cs

@@ -49,11 +49,10 @@ protected override string[] GetRunArguments(string? fullyQualifiedOutputPath, st
     {
         var baseArgs = new List<string> { "--operation", "publish", "--step", "publish" };
 
-        var targetPath = fullyQualifiedOutputPath is not null
-            ? fullyQualifiedOutputPath
-            : Path.Combine(Environment.CurrentDirectory, "aspire-output");
-
-        baseArgs.AddRange(["--output-path", targetPath]);
+        if (fullyQualifiedOutputPath is not null)
+        {
+            baseArgs.AddRange(["--output-path", fullyQualifiedOutputPath]);
+        }
 
         // Add --log-level and --envionment flags if specified
         var logLevel = parseResult.GetValue(_logLevelOption);

src/Aspire.Hosting.Azure/AzureEnvironmentResource.cs

@@ -4,6 +4,7 @@
 #pragma warning disable ASPIREAZURE001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 #pragma warning disable ASPIREPIPELINES003 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 #pragma warning disable ASPIREINTERACTION001 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
+#pragma warning disable ASPIREPIPELINES004 // Type is for evaluation purposes only and is subject to change or removal in future updates. Suppress this diagnostic to proceed.
 
 using System.Diagnostics.CodeAnalysis;
 using Aspire.Hosting.ApplicationModel;
@@ -121,8 +122,9 @@ public AzureEnvironmentResource(string name, ParameterResource location, Paramet
     private Task PublishAsync(PipelineStepContext context)
     {
         var azureProvisioningOptions = context.Services.GetRequiredService<IOptions<AzureProvisioningOptions>>();
+        var outputService = context.Services.GetRequiredService<IPipelineOutputService>();
         var publishingContext = new AzurePublishingContext(
-            context.OutputPath ?? throw new InvalidOperationException("OutputPath is required for Azure publishing."),
+            outputService.GetOutputDirectory(),
             azureProvisioningOptions.Value,
             context.Services,
             context.Logger,

src/Aspire.Hosting.Docker/DockerComposePublishingContext.cs

@@ -37,7 +37,7 @@ internal sealed class DockerComposePublishingContext(
         UnixFileMode.OtherRead | UnixFileMode.OtherWrite;
 
     public readonly IResourceContainerImageBuilder ImageBuilder = imageBuilder;
-    public readonly string OutputPath = outputPath ?? throw new InvalidOperationException("OutputPath is required for Docker Compose publishing.");
+    public readonly string OutputPath = outputPath;
 
     internal async Task WriteModelAsync(DistributedApplicationModel model, DockerComposeEnvironmentResource environment)
     {

src/Aspire.Hosting.Kubernetes/KubernetesPublishingContext.cs

@@ -20,7 +20,7 @@ internal sealed class KubernetesPublishingContext(
     ILogger logger,
     CancellationToken cancellationToken = default)
 {
-    public readonly string OutputPath = outputPath ?? throw new InvalidOperationException("OutputPath is required for Kubernetes publishing.");
+    public readonly string OutputPath = outputPath;
 
     private readonly Dictionary<string, Dictionary<string, object>> _helmValues = new()
     {

src/Aspire.Hosting/DistributedApplicationBuilder.cs

@@ -4,6 +4,7 @@
 #pragma warning disable ASPIREPIPELINES003
 #pragma warning disable ASPIREPIPELINES001
 #pragma warning disable ASPIREPIPELINES002
+#pragma warning disable ASPIREPIPELINES004
 
 using System.Diagnostics;
 using System.Reflection;
@@ -462,6 +463,7 @@ public DistributedApplicationBuilder(DistributedApplicationOptions options)
         _innerBuilder.Services.AddSingleton<IResourceContainerImageBuilder, ResourceContainerImageBuilder>();
         _innerBuilder.Services.AddSingleton<PipelineActivityReporter>();
         _innerBuilder.Services.AddSingleton<IPipelineActivityReporter, PipelineActivityReporter>(sp => sp.GetRequiredService<PipelineActivityReporter>());
+        _innerBuilder.Services.AddSingleton<IPipelineOutputService, PipelineOutputService>();
         _innerBuilder.Services.AddSingleton(Pipeline);
 
         // Configure pipeline logging options

src/Aspire.Hosting/Pipelines/IPipelineOutputService.cs

@@ -0,0 +1,41 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics.CodeAnalysis;
+using Aspire.Hosting.ApplicationModel;
+
+namespace Aspire.Hosting.Pipelines;
+
+/// <summary>
+/// Service for managing pipeline output directories.
+/// </summary>
+[Experimental("ASPIREPIPELINES004", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
+public interface IPipelineOutputService
+{
+    /// <summary>
+    /// Gets the output directory for deployment artifacts.
+    /// If no output path is configured, defaults to <c>{CurrentDirectory}/aspire-output</c>.
+    /// </summary>
+    /// <returns>The path to the output directory for deployment artifacts.</returns>
+    string GetOutputDirectory();
+
+    /// <summary>
+    /// Gets the output directory for a specific resource's deployment artifacts.
+    /// </summary>
+    /// <param name="resource">The resource to get the output directory for.</param>
+    /// <returns>The path to the output directory for the resource's deployment artifacts.</returns>
+    string GetOutputDirectory(IResource resource);
+
+    /// <summary>
+    /// Gets a temporary directory for build artifacts.
+    /// </summary>
+    /// <returns>The path to a temporary directory for build artifacts.</returns>
+    string GetTempDirectory();
+
+    /// <summary>
+    /// Gets a temporary directory for a specific resource's build artifacts.
+    /// </summary>
+    /// <param name="resource">The resource to get the temporary directory for.</param>
+    /// <returns>The path to a temporary directory for the resource's build artifacts.</returns>
+    string GetTempDirectory(IResource resource);
+}

src/Aspire.Hosting/Pipelines/PipelineContext.cs

@@ -15,15 +15,13 @@ namespace Aspire.Hosting.Pipelines;
 /// <param name="serviceProvider">The service provider for dependency resolution.</param>
 /// <param name="logger">The logger for pipeline operations.</param>
 /// <param name="cancellationToken">The cancellation token for the pipeline operation.</param>
-/// <param name="outputPath">The output path for deployment artifacts.</param>
 [Experimental("ASPIREPIPELINES001", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
 public sealed class PipelineContext(
     DistributedApplicationModel model,
     DistributedApplicationExecutionContext executionContext,
     IServiceProvider serviceProvider,
     ILogger logger,
-    CancellationToken cancellationToken,
-    string? outputPath)
+    CancellationToken cancellationToken)
 {
     /// <summary>
     /// Gets the distributed application model to be deployed.
@@ -49,9 +47,4 @@ public sealed class PipelineContext(
     /// Gets the cancellation token for the pipeline operation.
     /// </summary>
     public CancellationToken CancellationToken { get; set; } = cancellationToken;
-
-    /// <summary>
-    /// Gets the output path for deployment artifacts.
-    /// </summary>
-    public string? OutputPath { get; } = outputPath;
 }

src/Aspire.Hosting/Pipelines/PipelineOutputService.cs

@@ -0,0 +1,81 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.Diagnostics.CodeAnalysis;
+using Aspire.Hosting.ApplicationModel;
+using Microsoft.Extensions.Configuration;
+using Microsoft.Extensions.Options;
+
+namespace Aspire.Hosting.Pipelines;
+
+/// <summary>
+/// Default implementation of <see cref="IPipelineOutputService"/>.
+/// </summary>
+[Experimental("ASPIREPIPELINES004", UrlFormat = "https://aka.ms/aspire/diagnostics/{0}")]
+internal sealed class PipelineOutputService : IPipelineOutputService
+{
+    /// <summary>
+    /// Stores the resolved output directory path, or <c>null</c> if not specified.
+    /// </summary>
+    private readonly string? _outputPath;
+    
+    /// <summary>
+    /// Lazily creates and stores the path to the temporary directory for pipeline output.
+    /// </summary>
+    private readonly Lazy<string> _tempDirectory;
+
+    public PipelineOutputService(IOptions<PipelineOptions> options, IConfiguration configuration)
+    {
+        _outputPath = options.Value.OutputPath is not null ? Path.GetFullPath(options.Value.OutputPath) : null;
+        _tempDirectory = new Lazy<string>(() => CreateTempDirectory(configuration));
+    }
+
+    /// <inheritdoc/>
+    public string GetOutputDirectory()
+    {
+        return _outputPath ?? Path.Combine(Environment.CurrentDirectory, "aspire-output");
+    }
+
+    /// <inheritdoc/>
+    public string GetOutputDirectory(IResource resource)
+    {
+        ArgumentNullException.ThrowIfNull(resource);
+
+        var baseOutputDir = GetOutputDirectory();
+        return Path.Combine(baseOutputDir, resource.Name);
+    }
+
+    /// <inheritdoc/>
+    public string GetTempDirectory()
+    {
+        return _tempDirectory.Value;
+    }
+
+    /// <inheritdoc/>
+    public string GetTempDirectory(IResource resource)
+    {
+        ArgumentNullException.ThrowIfNull(resource);
+
+        var baseTempDir = GetTempDirectory();
+        return Path.Combine(baseTempDir, resource.Name);
+    }
+
+    /// <summary>
+    /// Creates a temporary directory for pipeline build artifacts.
+    /// Uses AppHost:PathSha256 from configuration to create an isolated temp directory per app host,
+    /// enabling multiple app hosts to run concurrently without conflicts.
+    /// If AppHost:PathSha256 is not available, falls back to a generic "aspire" temp directory.
+    /// </summary>
+    private static string CreateTempDirectory(IConfiguration configuration)
+    {
+        var appHostSha = configuration["AppHost:PathSha256"];
+
+        if (!string.IsNullOrEmpty(appHostSha))
+        {
+            return Directory.CreateTempSubdirectory($"aspire-{appHostSha}").FullName;
+        }
+
+        // Fallback if AppHost:PathSha256 is not available
+        return Directory.CreateTempSubdirectory("aspire").FullName;
+    }
+}

src/Aspire.Hosting/Pipelines/PipelineStepContext.cs

@@ -54,9 +54,4 @@ public sealed class PipelineStepContext
     /// Gets the cancellation token for the pipeline operation.
     /// </summary>
     public CancellationToken CancellationToken => PipelineContext.CancellationToken;
-
-    /// <summary>
-    /// Gets the output path for deployment artifacts.
-    /// </summary>
-    public string? OutputPath => PipelineContext.OutputPath;
 }

src/Aspire.Hosting/Publishing/PipelineExecutor.cs

@@ -12,7 +12,6 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Options;
 
 namespace Aspire.Hosting.Publishing;
 
@@ -25,7 +24,6 @@ internal sealed class PipelineExecutor(
     IPipelineActivityReporter activityReporter,
     IDistributedApplicationEventing eventing,
     BackchannelService backchannelService,
-    IOptions<PipelineOptions> options,
     IPipelineActivityReporter pipelineActivityReporter) : BackgroundService
 {
     protected override async Task ExecuteAsync(CancellationToken stoppingToken)
@@ -99,8 +97,7 @@ await eventing.PublishAsync<AfterPublishEvent>(
 
     public async Task ExecutePipelineAsync(DistributedApplicationModel model, CancellationToken cancellationToken)
     {
-        var pipelineContext = new PipelineContext(model, executionContext, serviceProvider, logger, cancellationToken, options.Value.OutputPath is not null ?
-            Path.GetFullPath(options.Value.OutputPath) : null);
+        var pipelineContext = new PipelineContext(model, executionContext, serviceProvider, logger, cancellationToken);
 
         var pipeline = serviceProvider.GetRequiredService<IDistributedApplicationPipeline>();
         await pipeline.ExecuteAsync(pipelineContext).ConfigureAwait(false);