Update Azure Data Protection (#18089)

Author: MikeAlhayek

Directory.Packages.props

@@ -10,7 +10,7 @@
     <PackageVersion Include="Azure.Communication.Email" Version="1.0.1" />
     <PackageVersion Include="Azure.Communication.Sms" Version="1.0.1" />
     <PackageVersion Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.4.0" />
-    <PackageVersion Include="Azure.Extensions.AspNetCore.DataProtection.Blobs" Version="1.5.0" />
+    <PackageVersion Include="Azure.Extensions.AspNetCore.DataProtection.Blobs" Version="1.5.1" />
     <PackageVersion Include="Azure.Identity" Version="1.14.0" />
     <PackageVersion Include="Azure.Search.Documents" Version="11.6.1" />
     <PackageVersion Include="Azure.Storage.Blobs" Version="12.24.1" />

src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobModularTenantEvents.cs

@@ -1,6 +1,5 @@
 using Azure.Storage.Blobs;
 using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Options;
 using OrchardCore.Environment.Shell.Removing;
 using OrchardCore.Modules;
 
@@ -15,10 +14,10 @@ internal sealed class BlobModularTenantEvents : ModularTenantEvents
     private readonly ILogger _logger;
 
     public BlobModularTenantEvents(
-        IOptions<BlobOptions> blobOptions,
+        BlobOptions blobOptions,
         ILogger<BlobModularTenantEvents> logger)
     {
-        _blobOptions = blobOptions.Value;
+        _blobOptions = blobOptions;
         _logger = logger;
     }
 

src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobOptions.cs

@@ -1,6 +1,8 @@
+using Microsoft.Extensions.Options;
+
 namespace OrchardCore.DataProtection.Azure;
 
-public class BlobOptions
+public class BlobOptions : IAsyncOptions
 {
     public string ConnectionString { get; set; }
 

src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobOptionsConfiguration.cs renamed to src/OrchardCore.Modules/OrchardCore.DataProtection.Azure/BlobOptionsSetup.cs

@@ -9,7 +9,7 @@
 
 namespace OrchardCore.DataProtection.Azure;
 
-internal sealed class BlobOptionsConfiguration : IConfigureOptions<BlobOptions>
+public sealed class BlobOptionsSetup : IAsyncConfigureOptions<BlobOptions>
 {
     private readonly FluidParser _fluidParser = new();
 
@@ -18,28 +18,28 @@ internal sealed class BlobOptionsConfiguration : IConfigureOptions<BlobOptions>
     private readonly ShellSettings _shellSettings;
     private readonly ILogger _logger;
 
-    public BlobOptionsConfiguration(
+    public BlobOptionsSetup(
         IShellConfiguration configuration,
         IOptions<ShellOptions> shellOptions,
         ShellSettings shellSettings,
-        ILogger<BlobOptionsConfiguration> logger)
+        ILogger<BlobOptionsSetup> logger)
     {
         _configuration = configuration;
         _shellOptions = shellOptions.Value;
         _shellSettings = shellSettings;
         _logger = logger;
     }
 
-    public void Configure(BlobOptions options)
+    public async ValueTask ConfigureAsync(BlobOptions options)
     {
         _logger.LogDebug("Configuring BlobOptions in BlobOptionsSetup");
 
         _configuration.Bind("OrchardCore_DataProtection_Azure", options);
-        ConfigureContainerName(options);
-        ConfigureBlobName(options);
+        await ConfigureContainerNameAsync(options);
+        await ConfigureBlobNameAsync(options);
     }
 
-    private void ConfigureContainerName(BlobOptions options)
+    private async ValueTask ConfigureContainerNameAsync(BlobOptions options)
     {
         _logger.LogDebug("Configuring BlobOptions.ContainerName in BlobOptionsSetup");
 
@@ -54,7 +54,7 @@ private void ConfigureContainerName(BlobOptions options)
             var template = _fluidParser.Parse(options.ContainerName);
 
             // Container name must be lowercase.
-            var containerName = template.Render(templateContext, NullEncoder.Default).ToLowerInvariant();
+            var containerName = (await template.RenderAsync(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 void ConfigureContainerName(BlobOptions options)
             {
                 _logger.LogDebug("Testing data protection container {ContainerName} existence", options.ContainerName);
                 var blobContainer = new BlobContainerClient(options.ConnectionString, options.ContainerName);
-                var response = blobContainer.CreateIfNotExistsAsync(PublicAccessType.None).GetAwaiter().GetResult();
+                var response = await blobContainer.CreateIfNotExistsAsync(PublicAccessType.None);
                 _logger.LogDebug("Data protection container {ContainerName} created.", options.ContainerName);
             }
             catch (Exception e)
@@ -85,7 +85,7 @@ private void ConfigureContainerName(BlobOptions options)
         }
     }
 
-    private void ConfigureBlobName(BlobOptions options)
+    private async ValueTask ConfigureBlobNameAsync(BlobOptions options)
     {
         _logger.LogDebug("Configuring BlobOptions.BlobName in BlobOptionsSetup");
 
@@ -111,7 +111,7 @@ private void ConfigureBlobName(BlobOptions options)
 
             var template = _fluidParser.Parse(options.BlobName);
 
-            var blobName = template.Render(templateContext, NullEncoder.Default);
+            var blobName = await template.RenderAsync(templateContext, NullEncoder.Default);
             options.BlobName = blobName.Replace("\r", string.Empty).Replace("\n", string.Empty);
 
             if (_logger.IsEnabled(LogLevel.Debug))

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

@@ -3,7 +3,6 @@
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
-using Microsoft.Extensions.Options;
 using OrchardCore.Environment.Shell.Configuration;
 using OrchardCore.Modules;
 
@@ -35,10 +34,11 @@ public override void ConfigureServices(IServiceCollection services)
             }
 
             services
+                .Configure<BlobOptions, BlobOptionsSetup>()
                 .AddDataProtection()
                 .PersistKeysToAzureBlobStorage(sp =>
                 {
-                    var options = sp.GetRequiredService<IOptions<BlobOptions>>().Value;
+                    var options = sp.GetRequiredService<BlobOptions>();
 
                     var logger = sp.GetRequiredService<ILogger<Startup>>();
 
@@ -53,8 +53,6 @@ public override void ConfigureServices(IServiceCollection services)
                         options.BlobName);
                 });
 
-            services.AddSingleton<IConfigureOptions<BlobOptions>, BlobOptionsConfiguration>();
-
             services.AddScoped<IModularTenantEvents, BlobModularTenantEvents>();
         }
         else

src/OrchardCore/OrchardCore.Abstractions/Shell/Builders/Extensions/IAsyncConfigureOptions.cs

@@ -3,7 +3,8 @@ namespace Microsoft.Extensions.Options;
 /// <summary>
 /// Used to configure asynchronously a type of options just after a tenant container is created.
 /// </summary>
-public interface IAsyncConfigureOptions<TOptions> where TOptions : class, IAsyncOptions
+public interface IAsyncConfigureOptions<TOptions>
+    where TOptions : class, IAsyncOptions
 {
     /// <summary>
     /// Configures asynchronously an options instance.