Add Azure Blob Storage Gen2 (ADLS HNS) support to BlobFileStore

.github/workflows/main_ci.yml

@@ -33,7 +33,14 @@ jobs:
       # See pr_ci.yml for the reason why we disable NuGet audit warnings.
       run: |
         dotnet build -c Release /p:TreatWarningsAsErrors=true /p:RunAnalyzers=true /p:NuGetAudit=false
+    - name: Start Azurite
+      if: matrix.os == 'ubuntu-24.04'
+      run: |
+        docker run -d --name azurite -p 10000:10000 -p 10004:10004 ghcr.io/skrypt/azurite-adls-gen2:latest azurite --blobHost 0.0.0.0 --dfsHost 0.0.0.0 --queueHost 0.0.0.0 --tableHost 0.0.0.0 --skipApiVersionCheck
     - name: Unit Tests
+      env:
+        AZURITE_CONNECTION_STRING: ${{ matrix.os == 'ubuntu-24.04' && 'DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;' || '' }}
+        AZURITE_DFS_ENDPOINT: ${{ matrix.os == 'ubuntu-24.04' && 'http://127.0.0.1:10004/devstoreaccount1' || '' }}
       run: |
         dotnet test --project ./test/OrchardCore.Tests/OrchardCore.Tests.csproj -c Release --no-build
     - name: Functional Tests

.github/workflows/pr_ci.yml

@@ -30,7 +30,14 @@ jobs:
       # warnings and other better approaches don't work, see https://github.com/OrchardCMS/OrchardCore/pull/16317.
       run: |
         dotnet build -c Release /p:TreatWarningsAsErrors=true /p:RunAnalyzers=true /p:NuGetAudit=false
+    - name: Start Azurite
+      if: matrix.os == 'ubuntu-24.04'
+      run: |
+        docker run -d --name azurite -p 10000:10000 -p 10004:10004 ghcr.io/skrypt/azurite-adls-gen2:latest azurite --blobHost 0.0.0.0 --dfsHost 0.0.0.0 --queueHost 0.0.0.0 --tableHost 0.0.0.0 --skipApiVersionCheck
     - name: Unit Tests
+      env:
+        AZURITE_CONNECTION_STRING: ${{ matrix.os == 'ubuntu-24.04' && 'DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;' || '' }}
+        AZURITE_DFS_ENDPOINT: ${{ matrix.os == 'ubuntu-24.04' && 'http://127.0.0.1:10004/devstoreaccount1' || '' }}
       run: |
         dotnet test --project ./test/OrchardCore.Tests/OrchardCore.Tests.csproj -c Release --no-build
     - name: Functional Tests

Directory.Packages.props

@@ -14,6 +14,7 @@
     <PackageVersion Include="Azure.Identity" Version="1.19.0" />
     <PackageVersion Include="Azure.Search.Documents" Version="11.7.0" />
     <PackageVersion Include="Azure.Storage.Blobs" Version="12.27.0" />
+    <PackageVersion Include="Azure.Storage.Files.DataLake" Version="12.19.1" />
     <PackageVersion Include="BenchmarkDotNet" Version="0.15.8" />
     <PackageVersion Include="Castle.Core" Version="5.2.1" />
     <PackageVersion Include="DocumentFormat.OpenXml" Version="3.5.1" />

src/OrchardCore.Modules/OrchardCore.Media.Azure/Services/MediaBlobStorageOptionsConfiguration.cs

@@ -27,5 +27,6 @@ protected override void FurtherConfigure(MediaBlobStorageOptions rawOptions, Med
     {
         options.RemoveContainer = rawOptions.RemoveContainer;
         options.RemoveFilesFromBasePath = rawOptions.RemoveFilesFromBasePath;
+        options.UseHierarchicalNamespace = rawOptions.UseHierarchicalNamespace;
     }
 }

src/OrchardCore.Modules/OrchardCore.Media.Azure/Startup.cs

@@ -97,7 +97,9 @@ public override void ConfigureServices(IServiceCollection services)
                 var mediaCreatingEventHandlers = serviceProvider.GetServices<IMediaCreatingEventHandler>();
                 var logger = serviceProvider.GetRequiredService<ILogger<DefaultMediaFileStore>>();
 
-                var fileStore = new BlobFileStore(blobStorageOptions, clock, contentTypeProvider);
+                var blobLogger = serviceProvider.GetRequiredService<ILogger<BlobFileStore>>();
+                var fileStore = new BlobFileStore(blobStorageOptions, clock, contentTypeProvider, blobLogger);
+                fileStore.EnsureCapabilitiesAsync().GetAwaiter().GetResult();
                 var mediaUrlBase = "/" + fileStore.Combine(shellSettings.RequestUrlPrefix, mediaOptions.AssetsRequestPath);
 
                 var originalPathBase = serviceProvider.GetRequiredService<IHttpContextAccessor>().HttpContext

src/OrchardCore/OrchardCore.FileStorage.Abstractions/IFileStore.cs

@@ -41,6 +41,46 @@ public interface IFileStore
     /// </remarks>
     IAsyncEnumerable<IFileStoreEntry> GetDirectoryContentAsync(string path = null, bool includeSubDirectories = false);
 
+    /// <summary>
+    /// Enumerates only the files (not directories) in a given directory within the file store.
+    /// </summary>
+    /// <param name="path">The path of the directory to enumerate, or <c>null</c> to enumerate the root of the file store.</param>
+    /// <returns>The list of files in the given directory.</returns>
+    /// <remarks>
+    /// Default implementation filters <see cref="GetDirectoryContentAsync"/>. Implementations
+    /// may override this to avoid enumerating directories for better performance.
+    /// </remarks>
+    async IAsyncEnumerable<IFileStoreEntry> GetFilesAsync(string path = null)
+    {
+        await foreach (var entry in GetDirectoryContentAsync(path))
+        {
+            if (!entry.IsDirectory)
+            {
+                yield return entry;
+            }
+        }
+    }
+
+    /// <summary>
+    /// Enumerates only the subdirectories in a given directory within the file store.
+    /// </summary>
+    /// <param name="path">The path of the directory to enumerate, or <c>null</c> to enumerate the root of the file store.</param>
+    /// <returns>The list of subdirectories in the given directory.</returns>
+    /// <remarks>
+    /// Default implementation filters <see cref="GetDirectoryContentAsync"/>. Implementations
+    /// may override this to avoid enumerating files for better performance.
+    /// </remarks>
+    async IAsyncEnumerable<IFileStoreEntry> GetDirectoriesAsync(string path = null)
+    {
+        await foreach (var entry in GetDirectoryContentAsync(path))
+        {
+            if (entry.IsDirectory)
+            {
+                yield return entry;
+            }
+        }
+    }
+
     /// <summary>
     /// Creates a directory in the file store if it doesn't already exist.
     /// </summary>
@@ -113,6 +153,11 @@ public interface IFileStore
     /// </summary>
     /// <returns>The usable space in bytes, or <see langword="null"/> if the space is unlimited.</returns>
     Task<long?> GetPermittedStorageAsync() => Task.FromResult<long?>(null);
+
+    /// <summary>
+    /// Gets the capabilities supported by this file store.
+    /// </summary>
+    IFileStoreCapabilities Capabilities => FileStoreCapabilities.Default;
 }
 
 public static class IFileStoreExtensions

src/OrchardCore/OrchardCore.FileStorage.Abstractions/IFileStoreCapabilities.cs

@@ -0,0 +1,52 @@
+namespace OrchardCore.FileStorage;
+
+/// <summary>
+/// Describes the capabilities supported by a specific <see cref="IFileStore"/> implementation.
+/// </summary>
+public interface IFileStoreCapabilities
+{
+    /// <summary>
+    /// Gets a value indicating whether the store has a true hierarchical namespace
+    /// (i.e. directories are first-class objects, not simulated via path prefixes).
+    /// </summary>
+    bool HasHierarchicalNamespace { get; }
+
+    /// <summary>
+    /// Gets a value indicating whether the store supports atomic (server-side) move / rename
+    /// that does not require a copy-then-delete round-trip.
+    /// </summary>
+    bool SupportsAtomicMove { get; }
+
+    /// <summary>
+    /// Gets a human-readable name identifying the storage provider (e.g. "Local", "Azure Blob").
+    /// </summary>
+    string StorageProvider => "Unknown";
+}
+
+/// <summary>
+/// Provides a default <see cref="IFileStoreCapabilities"/> instance where all capabilities are <c>false</c>.
+/// </summary>
+public sealed class FileStoreCapabilities : IFileStoreCapabilities
+{
+    /// <summary>
+    /// A shared instance that returns <c>false</c> for every capability.
+    /// </summary>
+    public static readonly IFileStoreCapabilities Default = new FileStoreCapabilities();
+
+    public FileStoreCapabilities()
+    {
+    }
+
+    public FileStoreCapabilities(bool hasHierarchicalNamespace, bool supportsAtomicMove, string storageProvider = "Unknown")
+    {
+        HasHierarchicalNamespace = hasHierarchicalNamespace;
+        SupportsAtomicMove = supportsAtomicMove;
+        StorageProvider = storageProvider;
+    }
+
+    public bool HasHierarchicalNamespace { get; }
+
+    public bool SupportsAtomicMove { get; }
+
+    public string StorageProvider { get; } = "Unknown";
+}