Fix Azure DataProtection (OrchardCMS#18067)

MikeAlhayek · web-flow · commit 4b059f06e979 · 2025-06-19T16:21:28.000-07:00
diff --git a/src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobModularTenantEvents.cs b/src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobModularTenantEvents.cs
@@ -1,5 +1,6 @@
 using Azure.Storage.Blobs;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using OrchardCore.Environment.Shell.Removing;
 using OrchardCore.Modules;
 
@@ -14,10 +15,10 @@ internal sealed class BlobModularTenantEvents : ModularTenantEvents
     private readonly ILogger _logger;
 
     public BlobModularTenantEvents(
-        BlobOptions blobOptions,
+        IOptions<BlobOptions> blobOptions,
         ILogger<BlobModularTenantEvents> logger)
     {
-        _blobOptions = blobOptions;
+        _blobOptions = blobOptions.Value;
         _logger = logger;
     }
 
diff --git a/src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobOptions.cs b/src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobOptions.cs
@@ -1,8 +1,6 @@
-using Microsoft.Extensions.Options;
-
 namespace OrchardCore.DataProtection.Azure;
 
-public class BlobOptions : IAsyncOptions
+public class BlobOptions
 {
     public string ConnectionString { get; set; }
 
diff --git a/src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobOptionsConfiguration.cs b/src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobOptionsConfiguration.cs
@@ -9,7 +9,7 @@
 
 namespace OrchardCore.DataProtection.Azure;
 
-public class BlobOptionsSetup : IAsyncConfigureOptions<BlobOptions>
+internal sealed class BlobOptionsConfiguration : IConfigureOptions<BlobOptions>
 {
     private readonly FluidParser _fluidParser = new();
 
@@ -18,28 +18,28 @@ public class BlobOptionsSetup : IAsyncConfigureOptions<BlobOptions>
     private readonly ShellSettings _shellSettings;
     private readonly ILogger _logger;
 
-    public BlobOptionsSetup(
+    public BlobOptionsConfiguration(
         IShellConfiguration configuration,
         IOptions<ShellOptions> shellOptions,
         ShellSettings shellSettings,
-        ILogger<BlobOptionsSetup> logger)
+        ILogger<BlobOptionsConfiguration> logger)
     {
         _configuration = configuration;
         _shellOptions = shellOptions.Value;
         _shellSettings = shellSettings;
         _logger = logger;
     }
 
-    public async ValueTask ConfigureAsync(BlobOptions options)
+    public void Configure(BlobOptions options)
     {
         _logger.LogDebug("Configuring BlobOptions in BlobOptionsSetup");
 
         _configuration.Bind("OrchardCore_DataProtection_Azure", options);
-        await ConfigureContainerNameAsync(options);
-        await ConfigureBlobNameAsync(options);
+        ConfigureContainerName(options);
+        ConfigureBlobName(options);
     }
 
-    private async ValueTask ConfigureContainerNameAsync(BlobOptions options)
+    private void ConfigureContainerName(BlobOptions options)
     {
         _logger.LogDebug("Configuring BlobOptions.ContainerName in BlobOptionsSetup");
 
@@ -54,7 +54,7 @@ private async ValueTask ConfigureContainerNameAsync(BlobOptions options)
             var template = _fluidParser.Parse(options.ContainerName);
 
             // Container name must be lowercase.
-            var containerName = (await template.RenderAsync(templateContext, NullEncoder.Default)).ToLower();
+            var containerName = template.Render(templateContext, NullEncoder.Default).ToLowerInvariant();
             options.ContainerName = containerName.Replace("\r", string.Empty).Replace("\n", string.Empty);
 
             if (_logger.IsEnabled(LogLevel.Debug))
@@ -74,7 +74,7 @@ private async ValueTask ConfigureContainerNameAsync(BlobOptions options)
             {
                 _logger.LogDebug("Testing data protection container {ContainerName} existence", options.ContainerName);
                 var blobContainer = new BlobContainerClient(options.ConnectionString, options.ContainerName);
-                var response = await blobContainer.CreateIfNotExistsAsync(PublicAccessType.None);
+                var response = blobContainer.CreateIfNotExistsAsync(PublicAccessType.None).GetAwaiter().GetResult();
                 _logger.LogDebug("Data protection container {ContainerName} created.", options.ContainerName);
             }
             catch (Exception e)
@@ -85,7 +85,7 @@ private async ValueTask ConfigureContainerNameAsync(BlobOptions options)
         }
     }
 
-    private async ValueTask ConfigureBlobNameAsync(BlobOptions options)
+    private void ConfigureBlobName(BlobOptions options)
     {
         _logger.LogDebug("Configuring BlobOptions.BlobName in BlobOptionsSetup");
 
@@ -111,7 +111,7 @@ private async ValueTask ConfigureBlobNameAsync(BlobOptions options)
 
             var template = _fluidParser.Parse(options.BlobName);
 
-            var blobName = await template.RenderAsync(templateContext, NullEncoder.Default);
+            var blobName = template.Render(templateContext, NullEncoder.Default);
             options.BlobName = blobName.Replace("\r", string.Empty).Replace("\n", string.Empty);
 
             if (_logger.IsEnabled(LogLevel.Debug))
diff --git a/src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/Startup.cs b/src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/Startup.cs
@@ -3,6 +3,7 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using OrchardCore.Environment.Shell.Configuration;
 using OrchardCore.Modules;
 
@@ -28,23 +29,37 @@ public override void ConfigureServices(IServiceCollection services)
 
         if (!string.IsNullOrWhiteSpace(connectionString))
         {
+            if (_logger.IsEnabled(LogLevel.Debug))
+            {
+                _logger.LogDebug("OrchardCore_DataProtection_Azure:ConnectionString was found. Adding 'OrchardCore.DataProtection.Azure' feature services.");
+            }
+
             services
-                .Configure<BlobOptions, BlobOptionsSetup>()
                 .AddDataProtection()
                 .PersistKeysToAzureBlobStorage(sp =>
                 {
-                    var options = sp.GetRequiredService<BlobOptions>();
+                    var options = sp.GetRequiredService<IOptions<BlobOptions>>().Value;
+
+                    var logger = sp.GetRequiredService<ILogger<Startup>>();
+
+                    if (logger.IsEnabled(LogLevel.Debug))
+                    {
+                        logger.LogDebug("Creating BlobClient instance using '{ContainerName}' as container name and '{BlobName}' as blob name.", options.ContainerName, options.BlobName);
+                    }
+
                     return new BlobClient(
                         options.ConnectionString,
                         options.ContainerName,
                         options.BlobName);
                 });
 
+            services.AddSingleton<IConfigureOptions<BlobOptions>, BlobOptionsConfiguration>();
+
             services.AddScoped<IModularTenantEvents, BlobModularTenantEvents>();
         }
         else
         {
-            _logger.LogCritical("No connection string was supplied for OrchardCore.DataProtection.Azure. Ensure that an application setting containing a valid Azure Storage connection string is available at `Modules:OrchardCore.DataProtection.Azure:ConnectionString`.");
+            _logger.LogCritical("No connection string was supplied for OrchardCore.DataProtection.Azure. Ensure that an application setting containing a valid Azure Storage connection string is available at `OrchardCore:OrchardCore_DataProtection_Azure:ConnectionString`.");
         }
     }
 }
diff --git a/src/OrchardCore/OrchardCore.Abstractions/Shell/Builders/Extensions/ServiceCollectionExtensions.cs b/src/OrchardCore/OrchardCore.Abstractions/Shell/Builders/Extensions/ServiceCollectionExtensions.cs
@@ -1,3 +1,4 @@
+using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using OrchardCore.Environment.Shell.Builders;
 
@@ -23,10 +24,11 @@ public static IServiceCollection Configure<TOptions>(
             services.AddSingleton(new TOptions());
         }
 
-        services.Initialize(async sp =>
+        services.Initialize(sp =>
         {
             var options = sp.GetRequiredService<TOptions>();
-            await configureAsync(sp, options);
+
+            return configureAsync(sp, options);
         });
 
         return services;
@@ -36,21 +38,38 @@ public static IServiceCollection Configure<TOptions>(
     /// Registers an <see cref="IAsyncConfigureOptions{TOptions}"/> used to configure
     /// asynchronously a type of options just after a tenant container is created.
     /// </summary>
-    public static IServiceCollection Configure<TOptions, TConfigure>(this IServiceCollection services)
-        where TOptions : class, IAsyncOptions, new() where TConfigure : IAsyncConfigureOptions<TOptions>
+    public static IServiceCollection Configure<TOptions, TConfigure>(this IServiceCollection services, ILogger logger = null)
+        where TOptions : class, IAsyncOptions, new()
+        where TConfigure : IAsyncConfigureOptions<TOptions>
     {
         if (!services.Any(d => d.ServiceType == typeof(TOptions)))
         {
+            if (logger is not null && logger.IsEnabled(LogLevel.Debug))
+            {
+                logger.LogDebug("Adding IAsyncOptions type '{OptionsType}' instance to the service collection.", typeof(TOptions).FullName);
+            }
+
             services.AddSingleton(new TOptions());
         }
 
         if (!services.Any(d => d.ServiceType == typeof(TConfigure)))
         {
+            if (logger is not null && logger.IsEnabled(LogLevel.Debug))
+            {
+                logger.LogDebug("Adding IAsyncConfigureOptions type '{ConfigureType}' instance to the service collection.", typeof(TConfigure).FullName);
+            }
+
             services.AddTransient(typeof(TConfigure));
             services.Initialize(sp =>
             {
                 var options = sp.GetRequiredService<TOptions>();
                 var setup = sp.GetRequiredService<TConfigure>();
+                var logger = sp.GetRequiredService<ILogger<TConfigure>>();
+
+                if (logger.IsEnabled(LogLevel.Debug))
+                {
+                    logger.LogDebug("Invoking the ConfigureAsync method on '{ConfigureType}' to configure the '{OptionsType}'", typeof(TConfigure).FullName, typeof(TOptions).FullName);
+                }
 
                 return setup.ConfigureAsync(options);
             });
diff --git a/src/OrchardCore/OrchardCore/Shell/Builders/ShellContainerFactory.cs b/src/OrchardCore/OrchardCore/Shell/Builders/ShellContainerFactory.cs
@@ -2,6 +2,7 @@
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.DependencyInjection.Extensions;
 using Microsoft.Extensions.Hosting;
+using Microsoft.Extensions.Logging;
 using OrchardCore.Environment.Extensions;
 using OrchardCore.Environment.Extensions.Features;
 using OrchardCore.Environment.Shell.Builders.Models;
@@ -17,21 +18,29 @@ public class ShellContainerFactory : IShellContainerFactory
     private readonly IExtensionManager _extensionManager;
     private readonly IServiceProvider _serviceProvider;
     private readonly IServiceCollection _applicationServices;
+    private readonly ILogger _logger;
 
     public ShellContainerFactory(
         IHostEnvironment hostingEnvironment,
         IExtensionManager extensionManager,
         IServiceProvider serviceProvider,
-        IServiceCollection applicationServices)
+        IServiceCollection applicationServices,
+        ILogger<ShellContainerFactory> logger)
     {
         _hostingEnvironment = hostingEnvironment;
         _extensionManager = extensionManager;
         _applicationServices = applicationServices;
+        _logger = logger;
         _serviceProvider = serviceProvider;
     }
 
     public async Task<IServiceProvider> CreateContainerAsync(ShellSettings settings, ShellBlueprint blueprint)
     {
+        if (_logger.IsEnabled(LogLevel.Debug))
+        {
+            _logger.LogDebug("Creating service provider container for tenant '{TenantName}'", settings.Name);
+        }
+
         var tenantServiceCollection = _serviceProvider.CreateChildContainer(_applicationServices);
 
         tenantServiceCollection.AddSingleton(settings);
@@ -46,7 +55,6 @@ public async Task<IServiceProvider> CreateContainerAsync(ShellSettings settings,
         tenantServiceCollection.AddSingleton(blueprint);
 
         // Execute IStartup registrations
-
         foreach (var dependency in blueprint.Dependencies.Where(t => typeof(IStartup).IsAssignableFrom(t.Key)))
         {
             tenantServiceCollection.TryAddEnumerable(ServiceDescriptor.Singleton(typeof(IStartup), dependency.Key));
@@ -132,6 +140,11 @@ public async Task<IServiceProvider> CreateContainerAsync(ShellSettings settings,
         var typeFeatureProvider = shellServiceProvider.GetRequiredService<ITypeFeatureProvider>();
         PopulateTypeFeatureProvider(typeFeatureProvider, featureAwareServiceCollection);
 
+        if (_logger.IsEnabled(LogLevel.Debug))
+        {
+            _logger.LogDebug("Done Creating service provider container for tenant '{TenantName}'", settings.Name);
+        }
+
         return shellServiceProvider;
     }
 
diff --git a/src/OrchardCore/OrchardCore/Shell/Builders/ShellContextFactory.cs b/src/OrchardCore/OrchardCore/Shell/Builders/ShellContextFactory.cs
@@ -79,19 +79,36 @@ public async Task<ShellContext> CreateDescribedContextAsync(ShellSettings settin
             var blueprint = await _compositionStrategy.ComposeAsync(settings, shellDescriptor);
             var provider = await _shellContainerFactory.CreateContainerAsync(settings, blueprint);
 
-            var options = provider.GetService<IOptions<ShellContainerOptions>>().Value;
+            var options = provider.GetRequiredService<IOptions<ShellContainerOptions>>().Value;
+
+            if (_logger.IsEnabled(LogLevel.Debug))
+            {
+                _logger.LogDebug("Invoking shell container initializers described context for tenant '{TenantName}'. There are a total of '{TotalInitializers}' initializers to invoke", settings.Name, options.Initializers.Count);
+            }
+
             foreach (var initializeAsync in options.Initializers)
             {
                 await initializeAsync(provider);
             }
 
+            if (_logger.IsEnabled(LogLevel.Debug))
+            {
+                _logger.LogDebug("Done creating described context for tenant '{TenantName}'", settings.Name);
+            }
+
             return new ShellContext
             {
                 Settings = settings,
                 Blueprint = blueprint,
                 ServiceProvider = provider,
             };
         }
+        catch (Exception ex)
+        {
+            _logger.LogError(ex, "Error occurred while creating described context for tenant '{TenantName}'", settings.Name);
+
+            throw;
+        }
         finally
         {
             Interlocked.Decrement(ref settings._shellCreating);
diff --git a/test/OrchardCore.Tests/Shell/ShellContainerFactoryTests.cs b/test/OrchardCore.Tests/Shell/ShellContainerFactoryTests.cs
@@ -33,11 +33,14 @@ public ShellContainerFactoryTests()
         applicationServices.AddSingleton<IHostSingletonAndScopedOfTheSameType, HostSingletonOfTheSameTypeAsScoped>();
         applicationServices.AddScoped<IHostSingletonAndScopedOfTheSameType, HostScopedOfTheSameTypeAsSingleton>();
 
+        var loggerMock = new Mock<ILogger<ShellContainerFactory>>();
+
         _shellContainerFactory = new ShellContainerFactory(
             new StubHostingEnvironment(),
             new StubExtensionManager(),
             _applicationServiceProvider = applicationServices.BuildServiceProvider(),
-            applicationServices
+            applicationServices,
+            loggerMock.Object
         );
     }
 

Original file line number	Diff line number	Diff line change
`@@ -1,8 +1,6 @@`
`1`		`-using Microsoft.Extensions.Options;`
`2`		`-`
`3`	`1`	`namespace OrchardCore.DataProtection.Azure;`
`4`	`2`
`5`		`-public class BlobOptions : IAsyncOptions`
	`3`	`+public class BlobOptions`
`6`	`4`	`{`
`7`	`5`	`public string ConnectionString { get; set; }`
`8`	`6`