chore: addressing comments on pr

Author: SamRobinson75684

application/CohortManager/src/Functions/DemographicServices/RetrievePDSDemographic/PdsProcessor.cs

@@ -32,6 +32,12 @@ public PdsProcessor(
         _config = retrievePDSDemographicConfig.Value;
     }
 
+    /// <summary>
+    /// processes pds error responses. Sends a record to distribute participant via service bus
+    /// </summary>
+    /// <param name="pdsResponse"></param>
+    /// <param name="nhsNumber"></param>
+    /// <returns></returns>
     public async Task ProcessPdsNotFoundResponse(HttpResponseMessage pdsResponse, string nhsNumber)
     {
         var errorResponse = await pdsResponse!.Content.ReadFromJsonAsync<PdsErrorResponse>();
@@ -54,11 +60,15 @@ public async Task ProcessPdsNotFoundResponse(HttpResponseMessage pdsResponse, st
         _logger.LogError("the PDS function has returned a 404 error. function now stopping processing");
     }
 
-
+    /// <summary>
+    /// sends a participant record to the distribute service bus topic 
+    /// </summary>
+    /// <param name="participant"></param>
+    /// <returns></returns>
     public async Task ProcessRecord(Participant participant)
     {
         var updateRecord = new ConcurrentQueue<BasicParticipantCsvRecord>();
-        participant.RecordType = participant.RecordType = Actions.Removed;
+        participant.RecordType = Actions.Removed;
 
         var basicParticipantCsvRecord = new BasicParticipantCsvRecord
         {
@@ -73,7 +83,11 @@ public async Task ProcessRecord(Participant participant)
         await _addBatchToQueue.ProcessBatch(updateRecord, _config.ParticipantManagementTopic);
     }
 
-
+    /// <summary>
+    /// adds or updates a demographic record depending on if an record already exists in the database
+    /// </summary>
+    /// <param name="participantDemographic"></param>
+    /// <returns></returns>
     public async Task<bool> UpsertDemographicRecordFromPDS(ParticipantDemographic participantDemographic)
     {
         ParticipantDemographic oldParticipantDemographic = await _participantDemographicClient.GetSingleByFilter(i => i.NhsNumber == participantDemographic.NhsNumber);

tests/PdsProcessorTests/PdsProcessorTests.cs

@@ -1,13 +1,8 @@
 namespace NHS.CohortManager.Tests.PdsProcessorTests;
 
-using System.Collections.Concurrent;
-using System.Data.Services.Client;
-using System.Runtime.CompilerServices;
 using System.Text.Json;
 using Common;
 using DataServices.Client;
-using Hl7.Fhir.ElementModel.Types;
-using Hl7.Fhir.Model;
 using Microsoft.Extensions.Logging;
 using Microsoft.Extensions.Options;
 using Model;
@@ -52,7 +47,7 @@ public PdsProcessorTests()
     }
 
     [TestMethod]
-    public async System.Threading.Tasks.Task ProcessPdsNotFoundResponse_ProcessesResponse_SendsForDistribution()
+    public async Task ProcessPdsNotFoundResponse_ProcessesResponse_SendsForDistribution()
     {
         var errorResponse = new PdsErrorResponse()
         {
@@ -96,7 +91,7 @@ public async System.Threading.Tasks.Task ProcessPdsNotFoundResponse_ProcessesRes
     }
 
     [TestMethod]
-    public async System.Threading.Tasks.Task ProcessPdsNotFoundResponse_ProcessesResponse_Logs404Happened()
+    public async Task ProcessPdsNotFoundResponse_WithNonInvalidatedResource_LogsError()
     {
         var errorResponse = new PdsErrorResponse()
         {
@@ -141,7 +136,7 @@ public async System.Threading.Tasks.Task ProcessPdsNotFoundResponse_ProcessesRes
 
 
     [TestMethod]
-    public async System.Threading.Tasks.Task UpsertDemographicRecordFromPDS_Updatesrecord_true()
+    public async Task UpsertDemographicRecordFromPDS_WithExistingRecord_ReturnsTrue()
     {
         _dataServiceClient.Setup(x => x.GetSingleByFilter(It.IsAny<System.Linq.Expressions.Expression<Func<ParticipantDemographic, bool>>>())).ReturnsAsync(new ParticipantDemographic()
         {
@@ -169,7 +164,7 @@ public async System.Threading.Tasks.Task UpsertDemographicRecordFromPDS_Updatesr
 
 
     [TestMethod]
-    public async System.Threading.Tasks.Task UpsertDemographicRecordFromPDS_AddsNewrecord_true()
+    public async Task UpsertDemographicRecordFromPDS_WithNewRecord_ReturnsTrue()
     {
         var res = await _pdsProcessor.UpsertDemographicRecordFromPDS(new ParticipantDemographic());
 
@@ -199,7 +194,7 @@ public async System.Threading.Tasks.Task UpsertDemographicRecordFromPDS_AddsNewr
     }
 
     [TestMethod]
-    public async System.Threading.Tasks.Task UpsertDemographicRecordFromPDS_FailsToAddNewRecord_False()
+    public async Task UpsertDemographicRecordFromPDS_FailsToAddNewRecord_ReturnsFalse()
     {
         _dataServiceClient.Setup(x => x.Add(It.IsAny<ParticipantDemographic>())).ReturnsAsync(false);
         var res = await _pdsProcessor.UpsertDemographicRecordFromPDS(new ParticipantDemographic());
@@ -229,7 +224,7 @@ public async System.Threading.Tasks.Task UpsertDemographicRecordFromPDS_FailsToA
     }
 
     [TestMethod]
-    public async System.Threading.Tasks.Task UpsertDemographicRecordFromPDS_UpdateRecordFails_False()
+    public async Task UpsertDemographicRecordFromPDS_UpdateRecordFails_ReturnsFalse()
     {
         _dataServiceClient.Setup(x => x.GetSingleByFilter(It.IsAny<System.Linq.Expressions.Expression<Func<ParticipantDemographic, bool>>>())).ReturnsAsync(new ParticipantDemographic()
         {