feat: wire-up dummy gp code changes

.github/workflows/ci-ui-tests.yaml

@@ -43,6 +43,8 @@ jobs:
           EXCEPTIONS_API_URL: ${{ vars.EXCEPTIONS_API_URL }}
           COHORT_MANAGER_RBAC_CODE: ${{ vars.COHORT_MANAGER_RBAC_CODE }}
           NEXTAUTH_SECRET: ${{ secrets.NEXTAUTH_SECRET }}
+          COHORT_MANAGER_REMOVE_DUMMY_GP_CODE_RBAC_CODE : ${{ vars.COHORT_MANAGER_REMOVE_DUMMY_GP_CODE_RBAC_CODE }}
+          REMOVE_DUMMY_GP_CODE_API_URL: ${{ vars.REMOVE_DUMMY_GP_CODE_API_URL }}
         run: npm run test:e2e
 
       - name: Upload test results

application/CohortManager/src/Functions/AuditServices/AuditWriter/AuditWriter.cs

@@ -1,24 +1,36 @@
 namespace NHS.CohortManager.AuditServices;
 
 using System.Text.Json;
+using Common;
 using DataServices.Database;
 using Microsoft.Azure.Functions.Worker;
 using Microsoft.Extensions.Logging;
+using Microsoft.Extensions.Options;
 using Model;
 
 public class AuditWriter
 {
+    private const string AuditBlobContainer = "participant-audit";
+
     private static readonly JsonSerializerOptions JsonOptions = new()
     {
         PropertyNameCaseInsensitive = true
     };
 
     private readonly DataServicesContext _dbContext;
+    private readonly IBlobStorageHelper _blobStorageHelper;
+    private readonly AuditConfig _config;
     private readonly ILogger<AuditWriter> _logger;
 
-    public AuditWriter(DataServicesContext dbContext, ILogger<AuditWriter> logger)
+    public AuditWriter(
+        DataServicesContext dbContext,
+        IBlobStorageHelper blobStorageHelper,
+        IOptions<AuditConfig> config,
+        ILogger<AuditWriter> logger)
     {
         _dbContext = dbContext;
+        _blobStorageHelper = blobStorageHelper;
+        _config = config.Value;
         _logger = logger;
     }
 
@@ -43,6 +55,8 @@
             return;
         }
 
+        var rawDataRef = await WriteSnapshotToBlobAsync(audit);
+
         var auditLog = new ParticipantAuditLog
         {
             CorrelationId = audit.CorrelationId,
@@ -53,7 +67,7 @@
             RecordSourceDesc = audit.RecordSourceDesc,
             CreatedBy = audit.CreatedBy,
             ScreeningId = audit.ScreeningId,
-            RawDataRef = audit.RawDataRef
+            RawDataRef = rawDataRef
         };
 
         try
@@ -80,4 +94,44 @@
                 audit.CorrelationId);
         }
     }
+
+    private async Task<string?> WriteSnapshotToBlobAsync(ParticipantAuditMessage message)
+    {
+        if (message.RequestSnapshot is null)
+        {
+            return null;
+        }
+
+        var blobPath = $"{message.CreatedDatetime:dd-MM-yyyy}/{message.CorrelationId}.json";
+        var payload = JsonSerializer.SerializeToUtf8Bytes(message.RequestSnapshot, JsonOptions);
+        var blobFile = new BlobFile(payload, blobPath);
+
+        try
+        {
+            var uri = await _blobStorageHelper.UploadFileToBlobStorageAndGetUri(
+                _config.AzureWebJobsStorage,
+                AuditBlobContainer,
+                blobFile,
+                overwrite: true);
+
+            if (uri is null)
+            {
+                _logger.LogError(
+                    "Blob write returned null URI for CorrelationId {CorrelationId}.",
+                    message.CorrelationId);
+                throw new InvalidOperationException(
+                    $"Blob write returned null URI for CorrelationId {message.CorrelationId}.");
+            }
+
+            return uri;
+        }
+        catch (Exception ex)
+        {
+            _logger.LogError(
+                ex,
+                "Failed to write audit snapshot to blob for CorrelationId {CorrelationId}.",
+                message.CorrelationId);
+            throw;
+        }
+    }
 }

application/CohortManager/src/Functions/AuditServices/AuditWriter/Program.cs

@@ -13,6 +13,7 @@
     .AddServiceBusClient(auditConfig.ServiceBusConnectionString)
     .ConfigureServices(services =>
     {
+        services.AddTransient<IBlobStorageHelper, BlobStorageHelper>();
         services.AddDatabaseHealthCheck("AuditWriter");
     })
     .AddTelemetry()

application/CohortManager/src/Functions/CaasIntegration/receiveCaasFile/Program.cs

@@ -37,13 +37,12 @@
         services.AddTransient<IBlobStorageHelper, BlobStorageHelper>();
         services.AddTransient<ICopyFailedBatchToBlob, CopyFailedBatchToBlob>();
         services.AddScoped<IValidateDates, ValidateDates>();
-        services.AddTransient<IAuditLogClient, AuditLogClient>();
         // Register health checks
         services.AddBlobStorageHealthCheck("receiveCaasFile");
     })
     .AddTelemetry()
     .AddHttpClient()
-    .AddServiceBusClient(config.ServiceBusConnectionString_client_internal)
+    .AddAuditLogging(config.ServiceBusConnectionString_client_internal)
     .AddExceptionHandler()
     .AddDatabaseConnection()
     .Build();

application/CohortManager/src/Functions/ParticipantManagementServices/ManageServiceNowParticipant/ManageServiceNowParticipantFunction.cs

@@ -23,21 +23,19 @@ public class ManageServiceNowParticipantFunction
     private readonly IExceptionHandler _exceptionHandler;
     private readonly IDataServiceClient<ParticipantManagement> _participantManagementClient;
     private readonly IQueueClient _queueClient;
-    private readonly IAuditLogClient _auditLogClient;
 
     private static readonly Regex NonLetterRegex = new(@"[^\p{Lu}\p{Ll}\p{Lt}]", RegexOptions.Compiled, TimeSpan.FromSeconds(1));
 
     public ManageServiceNowParticipantFunction(ILogger<ManageServiceNowParticipantFunction> logger, IOptions<ManageServiceNowParticipantConfig> config,
         IHttpClientFunction httpClientFunction, IExceptionHandler handleException, IDataServiceClient<ParticipantManagement> participantManagementClient,
-        IQueueClient queueClient, IAuditLogClient auditLogClient)
+        IQueueClient queueClient)
     {
         _logger = logger;
         _config = config.Value;
         _httpClientFunction = httpClientFunction;
         _exceptionHandler = handleException;
         _participantManagementClient = participantManagementClient;
         _queueClient = queueClient;
-        _auditLogClient = auditLogClient;
     }
 
     /// <summary>
@@ -86,15 +84,6 @@ public async Task Run([ServiceBusTrigger(topicName: "%ServiceNowParticipantManag
                 await HandleException(new Exception($"Failed to send participant from ServiceNow to topic: {_config.CohortDistributionTopic}"), serviceNowParticipant, ServiceNowMessageType.AddRequestInProgress);
             }
 
-            await _auditLogClient.AddAsync(new ParticipantAuditMessage
-            {
-                NhsNumber = serviceNowParticipant.NhsNumber.ToString(),
-                Source = AuditSource.ManualAdd,
-                RecordSourceDesc = $"ServiceNow case: {serviceNowParticipant.ServiceNowCaseNumber}",
-                CreatedBy = nameof(ManageServiceNowParticipantFunction),
-                ScreeningId = (int)serviceNowParticipant.ScreeningId,
-                RequestSnapshot = serviceNowParticipant,
-            });
         }
         catch (Exception ex)
         {

application/CohortManager/src/Functions/ParticipantManagementServices/ManageServiceNowParticipant/Program.cs

@@ -8,8 +8,7 @@
 
 var host = new HostBuilder()
     .AddConfiguration(out ManageServiceNowParticipantConfig config)
-    .AddConfiguration<AuditClientConfig>()
-        .AddDataServicesHandler()
+    .AddDataServicesHandler()
         .AddDataService<ParticipantManagement>(config.ParticipantManagementURL)
         .Build()
     .ConfigureFunctionsWorkerDefaults()
@@ -18,11 +17,10 @@
         // Register health checks
         services.AddBasicHealthCheck("ManageServiceNowParticipant");
         services.AddTransient<IBlobStorageHelper, BlobStorageHelper>();
-        services.AddTransient<IAuditLogClient, AuditLogClient>();
     })
+    .AddServiceBusClient(config.ServiceBusConnectionString_client_internal)
     .AddTelemetry()
     .AddExceptionHandler()
-    .AddServiceBusClient(config.ServiceBusConnectionString_client_internal)
     .AddHttpClient()
     .Build();
 

application/CohortManager/src/Functions/ParticipantManagementServices/RemoveDummyGPCode/Program.cs

@@ -6,12 +6,13 @@
 
 var host = new HostBuilder()
     .AddConfiguration(out RemoveDummyGpCodeConfig config)
-    .ConfigureFunctionsWorkerDefaults()
+    .AddAuthentication()
     .ConfigureServices(services =>
     {
         services.AddSingleton<ICreateResponse, CreateResponse>();
         services.AddBasicHealthCheck("RemoveDummyGPCode");
     })
+    .AddAuditLogging(config.ServiceBusConnectionString_client_internal)
     .AddTelemetry()
     .AddHttpClient()
     .AddServiceBusClient(config.ServiceBusConnectionString_client_internal)

application/CohortManager/src/Functions/ParticipantManagementServices/RemoveDummyGPCode/ReceiveRemoveDummyGPCodeFunction.cs

@@ -4,6 +4,7 @@ namespace NHS.CohortManager.ParticipantManagementServices;
 using System.Globalization;
 using System.Net;
 using System.Net.Http.Json;
+using System.Runtime.CompilerServices;
 using System.Text;
 using System.Text.Json;
 using System.Text.RegularExpressions;
@@ -14,6 +15,7 @@ namespace NHS.CohortManager.ParticipantManagementServices;
 using Microsoft.Extensions.Options;
 using Model;
 using Model.Constants;
+using Model.Enums;
 using NHS.CohortManager.ParticipantManagementServices.Models;
 
 public class ReceiveRemoveDummyGpCodeFunction
@@ -23,6 +25,8 @@ public class ReceiveRemoveDummyGpCodeFunction
     private readonly IHttpClientFunction _httpClientFunction;
     private readonly IQueueClient _queueClient;
     private readonly RemoveDummyGpCodeConfig _config;
+    private readonly IAuditLogClient _auditLogClient;
+    private readonly IFunctionContextAuthResolver _authResolver;
 
     private static readonly Regex NonLetterRegex = new(@"[^\p{Lu}\p{Ll}\p{Lt}]", RegexOptions.Compiled, TimeSpan.FromSeconds(1));
 
@@ -31,19 +35,24 @@ public ReceiveRemoveDummyGpCodeFunction(
         ICreateResponse createResponse,
         IHttpClientFunction httpClientFunction,
         IQueueClient queueClient,
-        IOptions<RemoveDummyGpCodeConfig> config)
+        IOptions<RemoveDummyGpCodeConfig> config,
+        IAuditLogClient auditLogClient,
+        IFunctionContextAuthResolver authResolver)
     {
         _logger = logger;
         _createResponse = createResponse;
         _httpClientFunction = httpClientFunction;
         _queueClient = queueClient;
         _config = config.Value;
+        _auditLogClient = auditLogClient;
+        _authResolver = authResolver;
     }
 
     /// <summary>
     /// Validates and enqueues a dummy GP code removal request to the ServiceNow participant management topic.
     /// </summary>
     [Function("ReceiveRemoveDummyGPCodeFunction")]
+    [Authentication(Role.CohortManagerDummyGpRemoval)]
     public async Task<HttpResponseData> Run([HttpTrigger(AuthorizationLevel.Anonymous, "post", Route = "RemoveDummyGPCode")] HttpRequestData req)
     {
         try
@@ -55,6 +64,29 @@ public async Task<HttpResponseData> Run([HttpTrigger(AuthorizationLevel.Anonymou
                 return _createResponse.CreateHttpResponse(HttpStatusCode.BadRequest, req);
             }
 
+
+            var user = _authResolver.GetCis2User(req.FunctionContext);
+
+            if(user == null && _authResolver.IsAuthenticationRequired(req.FunctionContext))
+            {
+                _logger.LogError("User information could not be retrieved from the function context");
+                return _createResponse.CreateHttpResponse(HttpStatusCode.InternalServerError, req);
+            }
+
+
+            await _auditLogClient.AddAsync(new ParticipantAuditMessage
+            {
+                NhsNumber = requestBody.NhsNumber,
+                Source = AuditSource.DummyGpRemoval,
+                RecordSourceDesc = "Dummy GP Code Removal Form",
+                CreatedBy = user != null ? $"{user.GivenName} {user.FamilyName}" : "Unknown User",
+                ScreeningId = 1,
+                RequestSnapshot = requestBody
+
+            });
+
+
+
             var validationContext = new ValidationContext(requestBody);
             var validationResult = new List<ValidationResult>();
             var isRequestValid = Validator.TryValidateObject(requestBody, validationContext, validationResult, true);

application/CohortManager/src/Functions/ServiceNowIntegration/ServiceNowMessageHandler/Program.cs

@@ -22,6 +22,7 @@
         // Register health checks
         services.AddBasicHealthCheck("ServiceNowMessageHandler");
     })
+    .AddAuditLogging(config.ServiceBusConnectionString_client_internal)
     .AddTelemetry()
     .AddServiceBusClient(config.ServiceBusConnectionString_client_internal)
     .Build();

application/CohortManager/src/Functions/ServiceNowIntegration/ServiceNowMessageHandler/ReceiveServiceNowMessageFunction.cs

@@ -22,15 +22,17 @@ public class ReceiveServiceNowMessageFunction
     private readonly ServiceNowMessageHandlerConfig _config;
     private readonly IDataServiceClient<ServicenowCase> _serviceNowCaseClient;
     private readonly IServiceNowClient _serviceNowClient;
+    private readonly IAuditLogClient _auditLogClient;
 
     public ReceiveServiceNowMessageFunction(ILogger<ReceiveServiceNowMessageFunction> logger, ICreateResponse createResponse,
         IQueueClient queueClient, IOptions<ServiceNowMessageHandlerConfig> config, IDataServiceClient<ServicenowCase> serviceNowCaseClient,
-        IServiceNowClient serviceNowClient)
+        IServiceNowClient serviceNowClient, IAuditLogClient auditLogClient)
     {
         _logger = logger;
         _createResponse = createResponse;
         _queueClient = queueClient;
         _config = config.Value;
+        _auditLogClient = auditLogClient;
         _serviceNowCaseClient = serviceNowCaseClient;
         _serviceNowClient = serviceNowClient;
     }
@@ -59,6 +61,16 @@ public async Task<HttpResponseData> Run([HttpTrigger(AuthorizationLevel.Anonymou
                 return _createResponse.CreateHttpResponse(HttpStatusCode.BadRequest, req);
             }
 
+            await _auditLogClient.AddAsync(new ParticipantAuditMessage
+            {
+                NhsNumber = requestBody.VariableData.NhsNumber,
+                Source = AuditSource.ManualAdd,
+                RecordSourceDesc = $"ServiceNow case: {requestBody.ServiceNowCaseNumber}",
+                CreatedBy = nameof(ReceiveServiceNowMessageFunction),
+                ScreeningId = (int)ServiceProvider.BSS,
+                RequestSnapshot = requestBody
+            });
+
             var validationContext = new ValidationContext(requestBody.VariableData);
             var validationResult = new List<ValidationResult>();
             bool isVariableDataValid = Validator.TryValidateObject(requestBody.VariableData, validationContext, validationResult, true);