Refactor AspireStore APIs (#7626)

Reacting to https://github.com/dotnet/aspire/pull/7374/files#r1950365868

- Simplified IAspireStore by moving one method to extensions
- Retrieve IAspireStore from DI
- Refactoring stream code to write to the file while also computing the hash at the same time

---------

Co-authored-by: Eric Erhardt <[email protected]>

Author: sebastienros

src/Aspire.Hosting.Azure.EventHubs/AzureEventHubsExtensions.cs

@@ -317,7 +317,7 @@ public static IResourceBuilder<AzureEventHubsResource> RunAsEmulator(this IResou
                     jsonObject.WriteTo(writer);
                 }
 
-                var aspireStore = builder.ApplicationBuilder.CreateStore();
+                var aspireStore = @event.Services.GetRequiredService<IAspireStore>();
 
                 // Deterministic file path for the configuration file based on its content
                 var configJsonPath = aspireStore.GetFileNameWithContent($"{builder.Resource.Name}-Config.json", tempConfigFile);

src/Aspire.Hosting.Azure.ServiceBus/AzureServiceBusExtensions.cs

@@ -418,7 +418,7 @@ public static IResourceBuilder<AzureServiceBusResource> RunAsEmulator(this IReso
                     jsonObject.WriteTo(writer);
                 }
 
-                var aspireStore = builder.ApplicationBuilder.CreateStore();
+                var aspireStore = @event.Services.GetRequiredService<IAspireStore>();
 
                 // Deterministic file path for the configuration file based on its content
                 var configJsonPath = aspireStore.GetFileNameWithContent($"{builder.Resource.Name}-Config.json", tempConfigFile);

src/Aspire.Hosting/ApplicationModel/AspireStore.cs

@@ -1,12 +1,15 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Security.Cryptography;
+using System.IO.Hashing;
+using Aspire.Hosting.Utils;
 
 namespace Aspire.Hosting.ApplicationModel;
 
 internal sealed class AspireStore : IAspireStore
 {
+    internal const string AspireStorePathKeyName = "Aspire:Store:Path";
+
     private readonly string _basePath;
 
     /// <summary>
@@ -29,56 +32,38 @@ public AspireStore(string basePath)
 
     public string BasePath => _basePath;
 
-    public string GetFileNameWithContent(string filenameTemplate, string sourceFilename)
+    public string GetFileNameWithContent(string filenameTemplate, Stream contentStream)
     {
         ArgumentException.ThrowIfNullOrWhiteSpace(filenameTemplate);
-        ArgumentException.ThrowIfNullOrWhiteSpace(sourceFilename);
-
-        if (!File.Exists(sourceFilename))
-        {
-            throw new FileNotFoundException("The source file does not exist.", sourceFilename);
-        }
+        ArgumentNullException.ThrowIfNull(contentStream);
 
         EnsureDirectory();
 
         // Strip any folder information from the filename.
         filenameTemplate = Path.GetFileName(filenameTemplate);
 
-        var hashStream = File.OpenRead(sourceFilename);
+        // Create a temporary file to write the content to.
+        var tempFileName = Path.GetTempFileName();
 
-        // Compute the hash of the content.
-        var hash = SHA256.HashData(hashStream);
+        // Fast, non-cryptographic hash.
+        var hash = new XxHash3();
 
-        hashStream.Dispose();
+        // Write the content to the temporary file while also building a hash.
+        using (var fileStream = File.OpenWrite(tempFileName))
+        {
+            using var digestStream = new HashDigestStream(fileStream, hash);
+            contentStream.CopyTo(digestStream);
+        }
 
         var name = Path.GetFileNameWithoutExtension(filenameTemplate);
         var ext = Path.GetExtension(filenameTemplate);
-        var finalFilePath = Path.Combine(_basePath, $"{name}.{Convert.ToHexString(hash)[..12].ToLowerInvariant()}{ext}");
+        var finalFilePath = Path.Combine(_basePath, $"{name}.{Convert.ToHexString(hash.GetCurrentHash())[..12].ToLowerInvariant()}{ext}");
 
         if (!File.Exists(finalFilePath))
         {
-            File.Copy(sourceFilename, finalFilePath, overwrite: true);
+            File.Copy(tempFileName, finalFilePath, overwrite: true);
         }
 
-        return finalFilePath;
-    }
-
-    public string GetFileNameWithContent(string filenameTemplate, Stream contentStream)
-    {
-        ArgumentException.ThrowIfNullOrWhiteSpace(filenameTemplate);
-        ArgumentNullException.ThrowIfNull(contentStream);
-
-        // Create a temporary file to write the content to.
-        var tempFileName = Path.GetTempFileName();
-
-        // Write the content to the temporary file.
-        using (var fileStream = File.OpenWrite(tempFileName))
-        {
-            contentStream.CopyTo(fileStream);
-        }
-
-        var finalFilePath = GetFileNameWithContent(filenameTemplate, tempFileName);
-
         try
         {
             File.Delete(tempFileName);

src/Aspire.Hosting/ApplicationModel/AspireStoreExtensions.cs

@@ -1,49 +1,34 @@
 // Licensed to the .NET Foundation under one or more agreements.
 // The .NET Foundation licenses this file to you under the MIT license.
 
-using System.Reflection;
-
 namespace Aspire.Hosting.ApplicationModel;
 
 /// <summary>
 /// Provides extension methods for <see cref="IDistributedApplicationBuilder"/> to create an <see cref="IAspireStore"/> instance.
 /// </summary>
 public static class AspireStoreExtensions
 {
-    internal const string AspireStorePathKeyName = "Aspire:Store:Path";
-
     /// <summary>
-    /// Creates a new App Host store using the provided <paramref name="builder"/>.
+    /// Gets a deterministic file path that is a copy of the <paramref name="sourceFilename"/>.
+    /// The resulting file name will depend on the content of the file.
     /// </summary>
-    /// <param name="builder">The <see cref="IDistributedApplicationBuilder"/>.</param>
-    /// <returns>The <see cref="IAspireStore"/>.</returns>
-    public static IAspireStore CreateStore(this IDistributedApplicationBuilder builder)
+    /// <param name="aspireStore">The <see cref="IAspireStore"/> instance.</param>
+    /// <param name="filenameTemplate">A file name to base the result on.</param>
+    /// <param name="sourceFilename">An existing file.</param>
+    /// <returns>A deterministic file path with the same content as <paramref name="sourceFilename"/>.</returns>
+    /// <exception cref="FileNotFoundException">Thrown when the source file does not exist.</exception>
+    public static string GetFileNameWithContent(this IAspireStore aspireStore, string filenameTemplate, string sourceFilename)
     {
-        ArgumentNullException.ThrowIfNull(builder);
-
-        var aspireDir = builder.Configuration[AspireStorePathKeyName];
+        ArgumentException.ThrowIfNullOrWhiteSpace(filenameTemplate);
+        ArgumentException.ThrowIfNullOrWhiteSpace(sourceFilename);
 
-        if (string.IsNullOrWhiteSpace(aspireDir))
+        if (!File.Exists(sourceFilename))
         {
-            var assemblyMetadata = builder.AppHostAssembly?.GetCustomAttributes<AssemblyMetadataAttribute>();
-            aspireDir = GetMetadataValue(assemblyMetadata, "AppHostProjectBaseIntermediateOutputPath");
-
-            if (string.IsNullOrWhiteSpace(aspireDir))
-            {
-                throw new InvalidOperationException($"Could not determine an appropriate location for local storage. Set the {AspireStorePathKeyName} setting to a folder where the App Host content should be stored.");
-            }
+            throw new FileNotFoundException("The source file does not exist.", sourceFilename);
         }
 
-        return new AspireStore(Path.Combine(aspireDir, ".aspire"));
-    }
-
-    /// <summary>
-    /// Gets the metadata value for the specified key from the assembly metadata.
-    /// </summary>
-    /// <param name="assemblyMetadata">The assembly metadata.</param>
-    /// <param name="key">The key to look for.</param>
-    /// <returns>The metadata value if found; otherwise, null.</returns>
-    private static string? GetMetadataValue(IEnumerable<AssemblyMetadataAttribute>? assemblyMetadata, string key) =>
-        assemblyMetadata?.FirstOrDefault(a => string.Equals(a.Key, key, StringComparison.OrdinalIgnoreCase))?.Value;
+        using var sourceStream = File.OpenRead(sourceFilename);
 
+        return aspireStore.GetFileNameWithContent(filenameTemplate, sourceStream);
+    }
 }

src/Aspire.Hosting/ApplicationModel/IAspireStore.cs

@@ -29,14 +29,4 @@ public interface IAspireStore
     /// <param name="contentStream">A stream containing the content.</param>
     /// <returns>A deterministic file path with the same content as the provided stream.</returns>
     string GetFileNameWithContent(string filenameTemplate, Stream contentStream);
-
-    /// <summary>
-    /// Gets a deterministic file path that is a copy of the <paramref name="sourceFilename"/>.
-    /// The resulting file name will depend on the content of the file.
-    /// </summary>
-    /// <param name="filenameTemplate">A file name to base the result on.</param>
-    /// <param name="sourceFilename">An existing file.</param>
-    /// <returns>A deterministic file path with the same content as <paramref name="sourceFilename"/>.</returns>
-    /// <exception cref="FileNotFoundException">Thrown when the source file does not exist.</exception>
-    string GetFileNameWithContent(string filenameTemplate, string sourceFilename);
 }

src/Aspire.Hosting/Aspire.Hosting.csproj

@@ -50,6 +50,7 @@
     <PackageReference Include="Polly.Core" />
     <PackageReference Include="JsonPatch.Net" />
     <PackageReference Include="AspNetCore.HealthChecks.Uris" />
+    <PackageReference Include="System.IO.Hashing" />
   </ItemGroup>
 
   <ItemGroup>

src/Aspire.Hosting/DistributedApplicationBuilder.cs

@@ -156,13 +156,17 @@ public DistributedApplicationBuilder(DistributedApplicationOptions options)
         var appHostName = options.ProjectName ?? _innerBuilder.Environment.ApplicationName;
         AppHostPath = Path.Join(AppHostDirectory, appHostName);
 
+        var assemblyMetadata = AppHostAssembly?.GetCustomAttributes<AssemblyMetadataAttribute>();
+        var aspireDir = GetMetadataValue(assemblyMetadata, "AppHostProjectBaseIntermediateOutputPath");
+
         // Set configuration
         ConfigurePublishingOptions(options);
         _innerBuilder.Configuration.AddInMemoryCollection(new Dictionary<string, string?>
         {
             // Make the app host directory available to the application via configuration
             ["AppHost:Directory"] = AppHostDirectory,
             ["AppHost:Path"] = AppHostPath,
+            [AspireStore.AspireStorePathKeyName] = aspireDir
         });
 
         _executionContextOptions = _innerBuilder.Configuration["Publishing:Publisher"] switch
@@ -208,6 +212,18 @@ public DistributedApplicationBuilder(DistributedApplicationOptions options)
             // from a failure in that case.
             o.DefaultWaitBehavior = options.DisableDashboard ? WaitBehavior.StopOnResourceUnavailable : WaitBehavior.WaitOnResourceUnavailable;
         });
+        _innerBuilder.Services.AddSingleton<IAspireStore, AspireStore>(sp =>
+        {
+            var configuration = sp.GetRequiredService<IConfiguration>();
+            var aspireDir = configuration[AspireStore.AspireStorePathKeyName];
+
+            if (string.IsNullOrWhiteSpace(aspireDir))
+            {
+                throw new InvalidOperationException($"Could not determine an appropriate location for local storage. Set the {AspireStore.AspireStorePathKeyName} setting to a folder where the App Host content should be stored.");
+            }
+
+            return new AspireStore(Path.Combine(aspireDir, ".aspire"));
+        });
 
         ConfigureHealthChecks();
 
@@ -506,4 +522,14 @@ private static DiagnosticListener LogAppBuilt(DistributedApplication app)
 
         return diagnosticListener;
     }
+
+    /// <summary>
+    /// Gets the metadata value for the specified key from the assembly metadata.
+    /// </summary>
+    /// <param name="assemblyMetadata">The assembly metadata.</param>
+    /// <param name="key">The key to look for.</param>
+    /// <returns>The metadata value if found; otherwise, null.</returns>
+    private static string? GetMetadataValue(IEnumerable<AssemblyMetadataAttribute>? assemblyMetadata, string key) =>
+        assemblyMetadata?.FirstOrDefault(a => string.Equals(a.Key, key, StringComparison.OrdinalIgnoreCase))?.Value;
+
 }

src/Aspire.Hosting/Utils/HashDigestStream.cs

@@ -0,0 +1,53 @@
+// Licensed to the .NET Foundation under one or more agreements.
+// The .NET Foundation licenses this file to you under the MIT license.
+
+using System.IO.Hashing;
+
+namespace Aspire.Hosting.Utils;
+
+/// <summary>
+/// A stream capable of computing the hash digest of raw data while also copying it.
+/// </summary>
+internal sealed class HashDigestStream : Stream
+{
+    private readonly Stream _writeStream;
+    private readonly NonCryptographicHashAlgorithm _hashAlgorithm;
+
+    public HashDigestStream(Stream writeStream, NonCryptographicHashAlgorithm hashAlgorithm)
+    {
+        _writeStream = writeStream;
+        _hashAlgorithm = hashAlgorithm;
+    }
+
+    public override bool CanWrite => true;
+
+    public override void Write(byte[] buffer, int offset, int count)
+    {
+        _hashAlgorithm.Append(buffer.AsSpan(offset, count));
+        _writeStream.Write(buffer, offset, count);
+    }
+
+    public override void Flush()
+    {
+        _writeStream.Flush();
+    }
+
+    // This should not be used by Stream.CopyTo(Stream)
+    public override void Write(ReadOnlySpan<byte> buffer)
+        => throw new NotImplementedException();
+
+    // This class is never used with async writes, but if it ever is, implement these overrides
+    public override Task WriteAsync(byte[] buffer, int offset, int count, CancellationToken cancellationToken)
+        => throw new NotImplementedException();
+    public override ValueTask WriteAsync(ReadOnlyMemory<byte> buffer, CancellationToken cancellationToken)
+        => throw new NotImplementedException();
+
+    public override bool CanRead => false;
+    public override bool CanSeek => false;
+    public override long Length => throw new NotImplementedException();
+    public override long Position { get => throw new NotImplementedException(); set => throw new NotImplementedException(); }
+
+    public override int Read(byte[] buffer, int offset, int count) => throw new NotImplementedException();
+    public override long Seek(long offset, SeekOrigin origin) => throw new NotImplementedException();
+    public override void SetLength(long value) => throw new NotImplementedException();
+}

tests/Aspire.Hosting.Tests/AspireStoreTests.cs

@@ -2,6 +2,7 @@
 // The .NET Foundation licenses this file to you under the MIT license.
 
 using Aspire.Hosting.Utils;
+using Microsoft.Extensions.DependencyInjection;
 using Xunit;
 
 namespace Aspire.Hosting.Tests;
@@ -31,8 +32,9 @@ public void BasePath_ShouldBeAbsolute()
     public void BasePath_ShouldUseConfiguration()
     {
         var builder = TestDistributedApplicationBuilder.Create();
-        builder.Configuration[AspireStoreExtensions.AspireStorePathKeyName] = Path.GetTempPath();
-        var store = builder.CreateStore();
+        builder.Configuration[AspireStore.AspireStorePathKeyName] = Path.GetTempPath();
+        var app = builder.Build();
+        var store = app.Services.GetRequiredService<IAspireStore>();
 
         var path = store.BasePath;
 
@@ -54,8 +56,9 @@ public void BasePath_ShouldBePrefixed_WhenUsingConfiguration()
     public void GetOrCreateFileWithContent_ShouldCreateFile_WithStreamContent()
     {
         var builder = TestDistributedApplicationBuilder.Create();
-        builder.Configuration[AspireStoreExtensions.AspireStorePathKeyName] = Path.GetTempPath();
-        var store = builder.CreateStore();
+        builder.Configuration[AspireStore.AspireStorePathKeyName] = Path.GetTempPath();
+        var app = builder.Build();
+        var store = app.Services.GetRequiredService<IAspireStore>();
 
         var filename = "testfile2.txt";
         var content = new MemoryStream(System.Text.Encoding.UTF8.GetBytes("Test content"));
@@ -127,8 +130,8 @@ public void AspireStoreConstructor_ShouldThrow_IfNotAbsolutePath(string? basePat
     private static IAspireStore CreateStore()
     {
         var builder = TestDistributedApplicationBuilder.Create();
-        builder.Configuration[AspireStoreExtensions.AspireStorePathKeyName] = Path.GetTempPath();
-        var store = builder.CreateStore();
-        return store;
+        builder.Configuration[AspireStore.AspireStorePathKeyName] = Path.GetTempPath();
+        var app = builder.Build();
+        return app.Services.GetRequiredService<IAspireStore>();
     }
 }