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

.github/workflows/integration_tests.yml

@@ -65,3 +65,25 @@ jobs:
         S3_EMULATOR_URL: http://127.0.0.1:9090
       run: |
         dotnet test --project ./test/OrchardCore.Tests.Integration/OrchardCore.Tests.Integration.csproj -c Release --no-build
+  test_azure_blob:
+    name: Integration Tests - Azure Blob Storage (Azurite)
+    if: github.event_name == 'workflow_dispatch' ||
+        github.event_name == 'push' ||
+        github.event.review.state == 'APPROVED' ||
+        github.event.review.state == 'CHANGES_REQUESTED'
+    runs-on: ubuntu-24.04
+    steps:
+    - uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+    - uses: ./.github/actions/setup-dotnet
+    - name: Build
+      run: |
+        dotnet build -c Release ./test/OrchardCore.Tests.Integration/OrchardCore.Tests.Integration.csproj /p:NuGetAudit=false
+    - name: Start Azurite
+      run: |
+        docker run -d --name azurite -p 10000:10000 ghcr.io/skrypt/azurite-adls-gen2:latest azurite --blobHost 0.0.0.0 --skipApiVersionCheck --enableHierarchicalNamespace=true
+    - name: Azure Blob Integration Tests
+      env:
+        AZURITE_CONNECTION_STRING: "DefaultEndpointsProtocol=http;AccountName=devstoreaccount1;AccountKey=Eby8vdM02xNOcqFlqUwJPLlmEtlCDXJ1OUzFT50uSRZ6IFsuFq2UVErCz4I6tq/K1SZFPTOtr/KBHBeksoGMGw==;BlobEndpoint=http://127.0.0.1:10000/devstoreaccount1;"
+      run: |
+        dotnet test --project ./test/OrchardCore.Tests.Integration/OrchardCore.Tests.Integration.csproj -c Release --no-build
+

Directory.Packages.props

@@ -15,6 +15,7 @@
     <PackageVersion Include="Azure.Identity" Version="1.21.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/MediaBlobContainerTenantEvents.cs

@@ -6,6 +6,7 @@
 using Microsoft.Extensions.Options;
 using OrchardCore.Environment.Shell;
 using OrchardCore.Environment.Shell.Removing;
+using OrchardCore.FileStorage.AzureBlob;
 using OrchardCore.Modules;
 
 namespace OrchardCore.Media.Azure.Services;
@@ -14,25 +15,30 @@ public sealed class MediaBlobContainerTenantEvents : ModularTenantEvents
 {
     private readonly MediaBlobStorageOptions _options;
     private readonly ShellSettings _shellSettings;
+    private readonly BlobFileStore _blobFileStore;
     private readonly ILogger _logger;
 
     internal readonly IStringLocalizer S;
 
     public MediaBlobContainerTenantEvents(
         IOptions<MediaBlobStorageOptions> options,
         ShellSettings shellSettings,
+        BlobFileStore blobFileStore,
         IStringLocalizer<MediaBlobContainerTenantEvents> localizer,
         ILogger<MediaBlobContainerTenantEvents> logger
         )
     {
         _options = options.Value;
         _shellSettings = shellSettings;
+        _blobFileStore = blobFileStore;
         S = localizer;
         _logger = logger;
     }
 
     public override async Task ActivatingAsync()
     {
+        await _blobFileStore.EnsureCapabilitiesAsync();
+
         // Only create container if options are valid.
         if (_shellSettings.IsUninitialized() || !_options.IsConfigured() || !_options.CreateContainer)
         {

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

@@ -84,20 +84,27 @@ public override void ConfigureServices(IServiceCollection services)
             services.AddSingleton<IMediaFileStoreCache>(serviceProvider =>
                 serviceProvider.GetRequiredService<IMediaFileStoreCacheFileProvider>());
 
+            // Register the blob file store as a singleton so it can be injected for async initialization.
+            services.AddSingleton(serviceProvider =>
+            {
+                var blobStorageOptions = serviceProvider.GetRequiredService<IOptions<MediaBlobStorageOptions>>().Value;
+                var clock = serviceProvider.GetRequiredService<IClock>();
+                var contentTypeProvider = serviceProvider.GetRequiredService<IContentTypeProvider>();
+                var blobLogger = serviceProvider.GetRequiredService<ILogger<BlobFileStore>>();
+
+                return new BlobFileStore(blobStorageOptions, clock, contentTypeProvider, blobLogger);
+            });
+
             // Replace the default media file store with a blob file store.
             services.Replace(ServiceDescriptor.Singleton<IMediaFileStore>(serviceProvider =>
             {
-                var blobStorageOptions = serviceProvider.GetRequiredService<IOptions<MediaBlobStorageOptions>>().Value;
-                var shellOptions = serviceProvider.GetRequiredService<IOptions<ShellOptions>>();
+                var fileStore = serviceProvider.GetRequiredService<BlobFileStore>();
                 var shellSettings = serviceProvider.GetRequiredService<ShellSettings>();
                 var mediaOptions = serviceProvider.GetRequiredService<IOptions<MediaOptions>>().Value;
-                var clock = serviceProvider.GetRequiredService<IClock>();
-                var contentTypeProvider = serviceProvider.GetRequiredService<IContentTypeProvider>();
                 var mediaEventHandlers = serviceProvider.GetServices<IMediaEventHandler>();
                 var mediaCreatingEventHandlers = serviceProvider.GetServices<IMediaCreatingEventHandler>();
                 var logger = serviceProvider.GetRequiredService<ILogger<DefaultMediaFileStore>>();
 
-                var fileStore = new BlobFileStore(blobStorageOptions, clock, contentTypeProvider);
                 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>
@@ -109,7 +149,7 @@ public interface IFileStore
     Task<string> CreateFileFromStreamAsync(string path, Stream inputStream, bool overwrite = false);
 
     /// <summary>
-    /// Calculates the free space available in this file store. 
+    /// Calculates the free space available in this file store.
     /// </summary>
     /// <returns>The usable space in bytes, or <see langword="null"/> if the space is unlimited.</returns>
     Task<long?> GetPermittedStorageAsync() => Task.FromResult<long?>(null);