feat: Azure ServiceBus Client Auth and Keyed Services (#1221)

MWClayson-NHS · web-flow · commit b380b7772a91 · 2025-07-01T12:09:06.000Z
* refactor azure servicebus client

* sonar qube and xml comment

* changed lifetime of keyed Storage client
diff --git a/application/CohortManager/src/Functions/CohortDistributionServices/DistributeParticipant/DistributeParticipant.csproj b/application/CohortManager/src/Functions/CohortDistributionServices/DistributeParticipant/DistributeParticipant.csproj
@@ -15,7 +15,7 @@
     <PackageReference Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" Version="2.0.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.3.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http.AspNetCore" Version="2.0.2" />
-    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.ServiceBus" Version="5.22.2" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.ServiceBus" Version="5.23.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="2.0.4" />
     <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="9.0.2" />
      <PackageReference Include="Grpc.Net.Client" Version="2.70.0" />
diff --git a/application/CohortManager/src/Functions/ParticipantManagementServices/ManageParticipant/ManageParticipant.csproj b/application/CohortManager/src/Functions/ParticipantManagementServices/ManageParticipant/ManageParticipant.csproj
@@ -16,7 +16,7 @@
     <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="2.0.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http" Version="3.3.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.Http.AspNetCore" Version="2.0.2" />
-    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.ServiceBus" Version="5.22.2" />
+    <PackageReference Include="Microsoft.Azure.Functions.Worker.Extensions.ServiceBus" Version="5.23.0" />
     <PackageReference Include="Microsoft.Azure.Functions.Worker.Sdk" Version="2.0.4" />
     <PackageReference Include="Microsoft.Extensions.Diagnostics.HealthChecks" Version="9.0.2" />
   </ItemGroup>
diff --git a/application/CohortManager/src/Functions/Shared/Common/AzureServiceBusClient.cs b/application/CohortManager/src/Functions/Shared/Common/AzureServiceBusClient.cs
@@ -3,23 +3,19 @@ namespace Common;
 using System.Collections.Concurrent;
 using System.Text.Json;
 using Azure.Messaging.ServiceBus;
+using Microsoft.Extensions.Azure;
 using Microsoft.Extensions.Logging;
 
 public class AzureServiceBusClient : IQueueClient
 {
-    private readonly ServiceBusClient _serviceBusClient;
+    private readonly IAzureClientFactory<ServiceBusSender> _senderFactory;
     private readonly ILogger<AzureServiceBusClient> _logger;
-
     private readonly ConcurrentDictionary<string, ServiceBusSender> _senders = new();
 
-    public AzureServiceBusClient(string connectionString)
+    public AzureServiceBusClient(ILogger<AzureServiceBusClient> logger, IAzureClientFactory<ServiceBusSender> senderFactory)
     {
-        _serviceBusClient = new ServiceBusClient(connectionString);
-        var factory = LoggerFactory.Create(builder =>
-        {
-            builder.AddConsole();
-        });
-        _logger = factory.CreateLogger<AzureServiceBusClient>();
+        _logger = logger;
+        _senderFactory = senderFactory;
     }
 
 
@@ -33,7 +29,7 @@ public AzureServiceBusClient(string connectionString)
     /// <returns></returns>
     public async Task<bool> AddAsync<T>(T message, string queueTopicName)
     {
-        var sender = _senders.GetOrAdd(queueTopicName, _serviceBusClient.CreateSender);
+        var sender = _senders.GetOrAdd(queueTopicName, _senderFactory.CreateClient(queueTopicName));
 
         try
         {
@@ -51,4 +47,4 @@ public async Task<bool> AddAsync<T>(T message, string queueTopicName)
             return false;
         }
     }
-}
+}
diff --git a/application/CohortManager/src/Functions/Shared/Common/Common.csproj b/application/CohortManager/src/Functions/Shared/Common/Common.csproj
@@ -9,7 +9,7 @@
 
     <ItemGroup>
         <PackageReference Include="Azure.Extensions.AspNetCore.Configuration.Secrets" Version="1.4.0" />
-        <PackageReference Include="Azure.Identity" Version="1.13.0" />
+        <PackageReference Include="Azure.Identity" Version="1.14.1" />
         <PackageReference Include="Azure.Messaging.ServiceBus" Version="7.20.1" />
         <PackageReference Include="Azure.Security.KeyVault.Secrets" Version="4.6.0" />
         <PackageReference Include="Azure.Storage.Blobs" Version="12.20.0" />
@@ -20,6 +20,7 @@
         <PackageReference Include="Microsoft.AspNetCore.WebUtilities" Version="8.0.7" />
         <PackageReference Include="Microsoft.Azure.Functions.Worker" Version="2.0.0" />
         <PackageReference Include="Microsoft.Azure.Functions.Worker.ApplicationInsights" Version="2.0.0" />
+        <PackageReference Include="Microsoft.Extensions.Azure" Version="1.12.0" />
         <PackageReference Include="Microsoft.Extensions.Options.DataAnnotations" Version="9.0.6" />
         <PackageReference Include="RulesEngine" Version="5.0.3" />
         <PackageReference Include="Polly" Version="8.5.0" />
diff --git a/application/CohortManager/src/Functions/Shared/Common/Extensions/AzureQueueExtension.cs b/application/CohortManager/src/Functions/Shared/Common/Extensions/AzureQueueExtension.cs
@@ -1,5 +1,8 @@
 namespace Common;
 
+using Azure.Identity;
+using Hl7.FhirPath.Expressions;
+using Microsoft.Extensions.Azure;
 using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Hosting;
 
@@ -11,20 +14,29 @@ public static class AzureQueueExtension
     /// </summary>
     public static IHostBuilder AddAzureQueues(this IHostBuilder hostBuilder, bool UseNewFunctions, string serviceBusConnectionString)
     {
-        return hostBuilder.ConfigureServices(_ =>
-        {
+
+
+        hostBuilder.ConfigureServices(_ =>
+            {
             if (UseNewFunctions)
             {
-                _.AddSingleton<IQueueClient>(_ => new AzureServiceBusClient(serviceBusConnectionString));
+                _.AddAzureClients(builder =>
+                {
+                    builder.AddServiceBusClient(serviceBusConnectionString);
+                    builder.UseCredential(new DefaultAzureCredential());
+
+                });
+                _.AddSingleton<IQueueClient, AzureStorageQueueClient>();
             }
             else
             {
                 _.AddTransient<IQueueClient, AzureStorageQueueClient>();
                 _.AddTransient<IQueueClientFactory, QueueClientFactory>();
             }
         });
-    }
 
+        return hostBuilder;
+    }
     /// <summary>
     /// Overload that creates storage queue clients for instances where only storage queues
     /// will be used and we do not need control what is injected via config
@@ -37,4 +49,36 @@ public static IHostBuilder AddAzureQueues(this IHostBuilder hostBuilder)
             _.AddTransient<IQueueClientFactory, QueueClientFactory>();
         });
     }
-}
+     /// <summary>
+    /// Extension method for adding azure queue clients, if UseNewFunctions is set to true, it will inject a service bus queue client,
+    /// otherwise, it will inject a azure storage queue client
+    /// This will implement the queue client as a keyed service allowing it to be used in parallel with other queue types
+    /// </summary>
+    public static IHostBuilder AddKeyedAzureQueues(this IHostBuilder hostBuilder, bool UseNewFunctions, string serviceBusConnectionString, string keyName)
+    {
+
+
+        hostBuilder.ConfigureServices(_ =>
+            {
+                if (UseNewFunctions)
+                {
+                    _.AddAzureClients(builder =>
+                    {
+                        builder.AddServiceBusClient(serviceBusConnectionString);
+                        builder.UseCredential(new DefaultAzureCredential());
+
+                    });
+                    _.AddKeyedSingleton<IQueueClient, AzureStorageQueueClient>(keyName);
+                }
+                else
+                {
+                    _.AddKeyedTransient<IQueueClient, AzureStorageQueueClient>(keyName);
+                    _.AddTransient<IQueueClientFactory, QueueClientFactory>();
+                }
+            });
+
+        return hostBuilder;
+    }
+
+
+}
diff --git a/application/CohortManager/src/Functions/Shared/Common/Extensions/ExceptionHandlerServiceExtension.cs b/application/CohortManager/src/Functions/Shared/Common/Extensions/ExceptionHandlerServiceExtension.cs
@@ -21,11 +21,11 @@ public static IHostBuilder AddExceptionHandler(this IHostBuilder hostBuilder)
     public static IHostBuilder AddExceptionHandlerWithServiceBus(this IHostBuilder hostBuilder)
     {
         hostBuilder.AddConfiguration<ServiceBusValidationConfig>(out ServiceBusValidationConfig config);
+        hostBuilder.AddKeyedAzureQueues(true, config.serviceBusConnectionString, "Exception");
         return hostBuilder.ConfigureServices(_ =>
         {
             _.AddSingleton<IExceptionHandler, ExceptionHandler>();
             _.AddTransient<IExceptionSender, SendExceptionToServiceBus>();
-            _.AddTransient<IQueueClient>(_ => new AzureServiceBusClient(config.serviceBusConnectionString));
         });
     }
 
diff --git a/application/CohortManager/src/Functions/Shared/Common/SendExceptionToServicBus.cs b/application/CohortManager/src/Functions/Shared/Common/SendExceptionToServicBus.cs
@@ -2,6 +2,7 @@
 namespace Common.Interfaces;
 
 using Common;
+using Microsoft.Extensions.DependencyInjection;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Model;
@@ -14,7 +15,7 @@ public class SendExceptionToServiceBus : IExceptionSender
     private readonly ServiceBusValidationConfig _serviceBusValidationConfig;
 
 
-    public SendExceptionToServiceBus(IQueueClient serviceBusHandler, ILogger<SendExceptionToServiceBus> logger, IOptions<ServiceBusValidationConfig> serviceBusValidationConfig)
+    public SendExceptionToServiceBus([FromKeyedServices("Exception")] IQueueClient serviceBusHandler, ILogger<SendExceptionToServiceBus> logger, IOptions<ServiceBusValidationConfig> serviceBusValidationConfig)
     {
         _serviceBusHandler = serviceBusHandler;
         _logger = logger;
@@ -30,4 +31,4 @@ public async Task<bool> sendToCreateException(ValidationException validationExce
         }
         return await _serviceBusHandler.AddAsync<ValidationException>(validationException, serviceBusTopicName);
     }
-}
+}
diff --git a/application/CohortManager/src/Functions/Shared/DataServices.Migrations/DataServices.Migrations.csproj b/application/CohortManager/src/Functions/Shared/DataServices.Migrations/DataServices.Migrations.csproj
@@ -18,7 +18,7 @@
   </ItemGroup>
 
   <ItemGroup>
-    <PackageReference Include="Azure.Identity" Version="1.13.0" />
+    <PackageReference Include="Azure.Identity" Version="1.14.1" />
   </ItemGroup>
 
   <ItemGroup>

Original file line number	Diff line number	Diff line change
`@@ -3,23 +3,19 @@ namespace Common;`
`3`	`3`	`using System.Collections.Concurrent;`
`4`	`4`	`using System.Text.Json;`
`5`	`5`	`using Azure.Messaging.ServiceBus;`
	`6`	`+using Microsoft.Extensions.Azure;`
`6`	`7`	`using Microsoft.Extensions.Logging;`
`7`	`8`
`8`	`9`	`public class AzureServiceBusClient : IQueueClient`
`9`	`10`	`{`
`10`		`- private readonly ServiceBusClient _serviceBusClient;`
	`11`	`+ private readonly IAzureClientFactory<ServiceBusSender> _senderFactory;`
`11`	`12`	`private readonly ILogger<AzureServiceBusClient> _logger;`
`12`		`-`
`13`	`13`	`private readonly ConcurrentDictionary<string, ServiceBusSender> _senders = new();`
`14`	`14`
`15`		`- public AzureServiceBusClient(string connectionString)`
	`15`	`+ public AzureServiceBusClient(ILogger<AzureServiceBusClient> logger, IAzureClientFactory<ServiceBusSender> senderFactory)`
`16`	`16`	`{`
`17`		`- _serviceBusClient = new ServiceBusClient(connectionString);`
`18`		`- var factory = LoggerFactory.Create(builder =>`
`19`		`- {`
`20`		`- builder.AddConsole();`
`21`		`- });`
`22`		`- _logger = factory.CreateLogger<AzureServiceBusClient>();`
	`17`	`+ _logger = logger;`
	`18`	`+ _senderFactory = senderFactory;`
`23`	`19`	`}`
`24`	`20`
`25`	`21`
`@@ -33,7 +29,7 @@ public AzureServiceBusClient(string connectionString)`
`33`	`29`	`/// <returns></returns>`
`34`	`30`	`public async Task<bool> AddAsync<T>(T message, string queueTopicName)`
`35`	`31`	`{`
`36`		`- var sender = _senders.GetOrAdd(queueTopicName, _serviceBusClient.CreateSender);`
	`32`	`+ var sender = _senders.GetOrAdd(queueTopicName, _senderFactory.CreateClient(queueTopicName));`
`37`	`33`
`38`	`34`	`try`
`39`	`35`	`{`
`@@ -51,4 +47,4 @@ public async Task<bool> AddAsync<T>(T message, string queueTopicName)`
`51`	`47`	`return false;`
`52`	`48`	`}`
`53`	`49`	`}`
`54`		`-}`
	`50`	`+}`
Original file line number	Diff line number	Diff line change
`@@ -21,11 +21,11 @@ public static IHostBuilder AddExceptionHandler(this IHostBuilder hostBuilder)`
`21`	`21`	`public static IHostBuilder AddExceptionHandlerWithServiceBus(this IHostBuilder hostBuilder)`
`22`	`22`	`{`
`23`	`23`	`hostBuilder.AddConfiguration<ServiceBusValidationConfig>(out ServiceBusValidationConfig config);`
	`24`	`+ hostBuilder.AddKeyedAzureQueues(true, config.serviceBusConnectionString, "Exception");`
`24`	`25`	`return hostBuilder.ConfigureServices(_ =>`
`25`	`26`	`{`
`26`	`27`	`_.AddSingleton<IExceptionHandler, ExceptionHandler>();`
`27`	`28`	`_.AddTransient<IExceptionSender, SendExceptionToServiceBus>();`
`28`		`- _.AddTransient<IQueueClient>(_ => new AzureServiceBusClient(config.serviceBusConnectionString));`
`29`	`29`	`});`
`30`	`30`	`}`
`31`	`31`
Original file line number	Diff line number	Diff line change
`@@ -2,6 +2,7 @@`
`2`	`2`	`namespace Common.Interfaces;`
`3`	`3`
`4`	`4`	`using Common;`
	`5`	`+using Microsoft.Extensions.DependencyInjection;`
`5`	`6`	`using Microsoft.Extensions.Logging;`
`6`	`7`	`using Microsoft.Extensions.Options;`
`7`	`8`	`using Model;`
`@@ -14,7 +15,7 @@ public class SendExceptionToServiceBus : IExceptionSender`
`14`	`15`	`private readonly ServiceBusValidationConfig _serviceBusValidationConfig;`
`15`	`16`
`16`	`17`
`17`		`- public SendExceptionToServiceBus(IQueueClient serviceBusHandler, ILogger<SendExceptionToServiceBus> logger, IOptions<ServiceBusValidationConfig> serviceBusValidationConfig)`
	`18`	`+ public SendExceptionToServiceBus([FromKeyedServices("Exception")] IQueueClient serviceBusHandler, ILogger<SendExceptionToServiceBus> logger, IOptions<ServiceBusValidationConfig> serviceBusValidationConfig)`
`18`	`19`	`{`
`19`	`20`	`_serviceBusHandler = serviceBusHandler;`
`20`	`21`	`_logger = logger;`
`@@ -30,4 +31,4 @@ public async Task<bool> sendToCreateException(ValidationException validationExce`
`30`	`31`	`}`
`31`	`32`	`return await _serviceBusHandler.AddAsync<ValidationException>(validationException, serviceBusTopicName);`
`32`	`33`	`}`
`33`		`-}`
	`34`	`+}`