fix: Resolve SonarQube warnings (#36)

ianfnelson · web-flow · commit 84f71aafdfee · 2025-05-30T11:05:22.000Z
diff --git a/src/ServiceLayer.Mesh/FileTypes/NbssAppointmentEvents/Validation/IRecordValidator.cs b/src/ServiceLayer.Mesh/FileTypes/NbssAppointmentEvents/Validation/IRecordValidator.cs
@@ -2,7 +2,6 @@
 
 namespace ServiceLayer.Mesh.FileTypes.NbssAppointmentEvents.Validation;
 
-// TODO - create a whole bunch of implementations of this to perform the validation against NBSS Appointment events records
 public interface IRecordValidator
 {
     IEnumerable<ValidationError> Validate(FileDataRecord fileDataRecord);
diff --git a/src/ServiceLayer.Mesh/Functions/FileRetryFunction.cs b/src/ServiceLayer.Mesh/Functions/FileRetryFunction.cs
@@ -34,14 +34,14 @@ private async Task RetryStaleExtractions(DateTime staleDateTimeUtc)
                 && f.LastUpdatedUtc <= staleDateTimeUtc)
             .ToListAsync();
 
-        logger.LogInformation($"FileRetryFunction: {staleFiles.Count} stale files found for extraction retry");
+        logger.LogInformation("FileRetryFunction: {StaleFilesCount} stale files found for extraction retry", staleFiles.Count);
 
         foreach (var file in staleFiles)
         {
             await fileExtractQueueClient.EnqueueFileExtractAsync(file);
             file.LastUpdatedUtc = DateTime.UtcNow;
             await serviceLayerDbContext.SaveChangesAsync();
-            logger.LogInformation($"FileRetryFunction: File {file.FileId} enqueued to Extract queue");
+            logger.LogInformation("FileRetryFunction: File {FileFileId} enqueued to Extract queue", file.FileId);
         }
     }
 
@@ -53,14 +53,14 @@ private async Task RetryStaleTransformations(DateTime staleDateTimeUtc)
                 && f.LastUpdatedUtc <= staleDateTimeUtc)
             .ToListAsync();
 
-        logger.LogInformation($"FileRetryFunction: {staleFiles.Count} stale files found for transforming retry");
+        logger.LogInformation("FileRetryFunction: {StaleFilesCount} stale files found for transforming retry", staleFiles.Count);
 
         foreach (var file in staleFiles)
         {
             await fileTransformQueueClient.EnqueueFileTransformAsync(file);
             file.LastUpdatedUtc = DateTime.UtcNow;
             await serviceLayerDbContext.SaveChangesAsync();
-            logger.LogInformation($"FileRetryFunction: File {file.FileId} enqueued to Transform queue");
+            logger.LogInformation("FileRetryFunction: File {FileFileId} enqueued to Transform queue", file.FileId);
         }
     }
 }
diff --git a/src/ServiceLayer.Mesh/Messaging/FileExtractQueueClient.cs b/src/ServiceLayer.Mesh/Messaging/FileExtractQueueClient.cs
@@ -1,15 +1,13 @@
 using Azure.Storage.Queues;
-using Microsoft.Extensions.Logging;
 using ServiceLayer.Data.Models;
 using ServiceLayer.Mesh.Configuration;
 
 namespace ServiceLayer.Mesh.Messaging;
 
 public class FileExtractQueueClient(
-    ILogger<FileExtractQueueClient> logger,
     IFileExtractQueueClientConfiguration configuration,
     QueueServiceClient queueServiceClient)
-    : QueueClientBase(logger, queueServiceClient), IFileExtractQueueClient
+    : QueueClientBase(queueServiceClient), IFileExtractQueueClient
 {
     public async Task EnqueueFileExtractAsync(MeshFile file)
     {
diff --git a/src/ServiceLayer.Mesh/Messaging/FileTransformQueueClient.cs b/src/ServiceLayer.Mesh/Messaging/FileTransformQueueClient.cs
@@ -1,15 +1,13 @@
 using Azure.Storage.Queues;
-using Microsoft.Extensions.Logging;
 using ServiceLayer.Data.Models;
 using ServiceLayer.Mesh.Configuration;
 
 namespace ServiceLayer.Mesh.Messaging;
 
 public class FileTransformQueueClient(
-    ILogger<FileTransformQueueClient> logger,
     IFileTransformQueueClientConfiguration configuration,
     QueueServiceClient queueServiceClient)
-    : QueueClientBase(logger, queueServiceClient), IFileTransformQueueClient
+    : QueueClientBase(queueServiceClient), IFileTransformQueueClient
 {
     public async Task EnqueueFileTransformAsync(MeshFile file)
     {
diff --git a/src/ServiceLayer.Mesh/Messaging/QueueClientBase.cs b/src/ServiceLayer.Mesh/Messaging/QueueClientBase.cs
@@ -1,10 +1,9 @@
 using System.Text.Json;
 using Azure.Storage.Queues;
-using Microsoft.Extensions.Logging;
 
 namespace ServiceLayer.Mesh.Messaging;
 
-public abstract class QueueClientBase(ILogger logger, QueueServiceClient queueServiceClient)
+public abstract class QueueClientBase(QueueServiceClient queueServiceClient)
 {
     private QueueClient? _queueClient;
     private QueueClient? _poisonQueueClient;
@@ -37,30 +36,13 @@ private QueueClient CreatePoisonClient()
 
     protected async Task SendJsonMessageAsync<T>(T message)
     {
-        try
-        {
-            var json = JsonSerializer.Serialize(message, QueueJsonOptions);
-            await Client.SendMessageAsync(json);
-        }
-        catch (Exception e)
-        {
-            // TODO - consider including file ID or correlation ID in error logs
-            logger.LogError(e, "Error sending message to queue {QueueName}", QueueName);
-            throw;
-        }
+        var json = JsonSerializer.Serialize(message, QueueJsonOptions);
+        await Client.SendMessageAsync(json);
     }
 
     protected async Task SendToPoisonQueueAsync<T>(T message)
     {
-        try
-        {
-            var json = JsonSerializer.Serialize(message, QueueJsonOptions);
-            await PoisonClient.SendMessageAsync(json);
-        }
-        catch (Exception e)
-        {
-            logger.LogError(e, "Error sending message to poison queue {PoisonQueueName}", $"{QueueName}-poison");
-            throw;
-        }
+        var json = JsonSerializer.Serialize(message, QueueJsonOptions);
+        await PoisonClient.SendMessageAsync(json);
     }
 }
diff --git a/src/ServiceLayer.Mesh/Program.cs b/src/ServiceLayer.Mesh/Program.cs
@@ -26,12 +26,6 @@
         services.AddNbssAppointmentEventServices();
     });
 
-
-// Application Insights isn't enabled by default. See https://aka.ms/AAt8mw4.
-// builder.Services
-//     .AddApplicationInsightsTelemetryWorkerService()
-//     .ConfigureFunctionsApplicationInsights();
-
 var app = host.Build();
 await app.RunAsync();
 return;
diff --git a/src/ServiceLayer.Mesh/Storage/IMeshFilesBlobStore.cs b/src/ServiceLayer.Mesh/Storage/IMeshFilesBlobStore.cs
@@ -4,9 +4,8 @@ namespace ServiceLayer.Mesh.Storage;
 
 public interface IMeshFilesBlobStore
 {
-    // TODO - return a Stream or a byte array?
     public Task<Stream> DownloadAsync(MeshFile file);
 
-    // Mesh client gives us a byte array, hence this not taking a stream.
+    // Mesh client gives us a byte array, hence this is not taking a stream.
     public Task<string> UploadAsync(MeshFile file, byte[] data);
 }
diff --git a/src/ServiceLayer.Mesh/Storage/MeshFilesBlobStore.cs b/src/ServiceLayer.Mesh/Storage/MeshFilesBlobStore.cs
@@ -5,7 +5,7 @@ namespace ServiceLayer.Mesh.Storage;
 
 public class MeshFilesBlobStore : IMeshFilesBlobStore
 {
-    private BlobContainerClient _blobContainerClient;
+    private readonly BlobContainerClient _blobContainerClient;
 
     public MeshFilesBlobStore(BlobContainerClient blobContainerClient)
     {
diff --git a/tests/ServiceLayer.Mesh.Tests/FileTypes/NbssAppointmentEvents/Validation/RegexValidatorTests.cs b/tests/ServiceLayer.Mesh.Tests/FileTypes/NbssAppointmentEvents/Validation/RegexValidatorTests.cs
@@ -4,12 +4,12 @@
 
 namespace ServiceLayer.Mesh.Tests.FileTypes.NbssAppointmentEvents.Validation;
 
-public class RegexValidatorTests
+public partial class RegexValidatorTests
 {
     private const string FieldName = "TestField";
     private const string MissingCode = "ERR001";
     private const string InvalidFormatCode = "ERR002";
-    private readonly Regex _pattern = new(@"^[A-Z]{2}\d{2}$", RegexOptions.Compiled);
+    private readonly Regex _pattern = TestRegex();
 
     [Fact]
     public void Validate_NullValue_ShouldReturnMissingError()
@@ -68,4 +68,7 @@ public void Validate_ValueMatchingPattern_ShouldReturnNoErrors(string validValue
 
         Assert.Empty(errors);
     }
+
+    [GeneratedRegex(@"^[A-Z]{2}\d{2}$", RegexOptions.Compiled)]
+    private static partial Regex TestRegex();
 }
diff --git a/tests/ServiceLayer.Mesh.Tests/Functions/FileDiscoveryFunctionTests.cs b/tests/ServiceLayer.Mesh.Tests/Functions/FileDiscoveryFunctionTests.cs
@@ -1,4 +1,5 @@
-﻿using Moq;
+﻿using Microsoft.Azure.Functions.Worker;
+using Moq;
 using NHS.MESH.Client.Contracts.Services;
 using NHS.MESH.Client.Models;
 using ServiceLayer.Data.Models;
@@ -44,7 +45,7 @@ public async Task Run_AddsNewMessageToDbAndQueue()
             });
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         var meshFile = AssertFileUpdated(testMessageId, MeshFileStatus.Discovered);
@@ -67,7 +68,7 @@ public async Task Run_DoesNotAddDuplicateMessageOrQueueIt()
             });
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         var count = DbContext.MeshFiles.Count(f => f.FileId == existingFile.FileId);
@@ -87,7 +88,7 @@ public async Task Run_NoMessagesInInbox_DoesNothing()
             });
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         Assert.Empty(DbContext.MeshFiles);
@@ -107,7 +108,7 @@ public async Task Run_MultipleMessagesInInbox_AllAreProcessed()
             });
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         foreach (var id in messageIds)
diff --git a/tests/ServiceLayer.Mesh.Tests/Functions/FileRetryFunctionTests.cs b/tests/ServiceLayer.Mesh.Tests/Functions/FileRetryFunctionTests.cs
@@ -1,3 +1,4 @@
+using Microsoft.Azure.Functions.Worker;
 using Moq;
 using ServiceLayer.Data.Models;
 using ServiceLayer.Mesh.Functions;
@@ -38,7 +39,7 @@ public async Task Run_EnqueuesDiscoveredOrExtractingFilesOlderThan12Hours(MeshFi
         var file = SaveMeshFile(testStatus, 13);
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         _fileExtractQueueClientMock.Verify(q => q.EnqueueFileExtractAsync(It.Is<MeshFile>(f => f.FileId == file.FileId)), Times.Once);
@@ -56,7 +57,7 @@ public async Task Run_EnqueuesExtractedOrTransformingFilesOlderThan12Hours(MeshF
         var file = SaveMeshFile(testStatus, 13);
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         _fileTransformQueueClientMock.Verify(q => q.EnqueueFileTransformAsync(It.Is<MeshFile>(f => f.FileId == file.FileId)), Times.Once);
@@ -76,7 +77,7 @@ public async Task Run_SkipsFreshFiles(MeshFileStatus testStatus)
         var file = SaveMeshFile(testStatus);
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         _fileExtractQueueClientMock.Verify(q => q.EnqueueFileExtractAsync(It.IsAny<MeshFile>()), Times.Never);
@@ -95,7 +96,7 @@ public async Task Run_IgnoresFilesInOtherStatuses(MeshFileStatus ignoredStatus)
         SaveMeshFile(ignoredStatus, 20);
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         _fileTransformQueueClientMock.Verify(q => q.EnqueueFileTransformAsync(It.IsAny<MeshFile>()), Times.Never);
@@ -106,7 +107,7 @@ public async Task Run_IgnoresFilesInOtherStatuses(MeshFileStatus ignoredStatus)
     public async Task Run_IfNoFilesFoundDoNothing()
     {
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         _fileExtractQueueClientMock.Verify(q => q.EnqueueFileExtractAsync(It.IsAny<MeshFile>()), Times.Never);
@@ -122,7 +123,7 @@ public async Task Run_ProcessesMultipleEligibleFiles()
         var file3 = SaveMeshFile(MeshFileStatus.Transforming, 13);
 
         // Act
-        await _function.Run(null);
+        await _function.Run(new TimerInfo());
 
         // Assert
         _fileExtractQueueClientMock.Verify(q => q.EnqueueFileExtractAsync(It.Is<MeshFile>(f => f.FileId == file1.FileId)), Times.Once);

Original file line number	Diff line number	Diff line change
`@@ -2,7 +2,6 @@`
`2`	`2`
`3`	`3`	`namespace ServiceLayer.Mesh.FileTypes.NbssAppointmentEvents.Validation;`
`4`	`4`
`5`		`-// TODO - create a whole bunch of implementations of this to perform the validation against NBSS Appointment events records`
`6`	`5`	`public interface IRecordValidator`
`7`	`6`	`{`
`8`	`7`	`IEnumerable<ValidationError> Validate(FileDataRecord fileDataRecord);`
Original file line number	Diff line number	Diff line change
`@@ -34,14 +34,14 @@ private async Task RetryStaleExtractions(DateTime staleDateTimeUtc)`
`34`	`34`	`&& f.LastUpdatedUtc <= staleDateTimeUtc)`
`35`	`35`	`.ToListAsync();`
`36`	`36`
`37`		`- logger.LogInformation($"FileRetryFunction: {staleFiles.Count} stale files found for extraction retry");`
	`37`	`+ logger.LogInformation("FileRetryFunction: {StaleFilesCount} stale files found for extraction retry", staleFiles.Count);`
`38`	`38`
`39`	`39`	`foreach (var file in staleFiles)`
`40`	`40`	`{`
`41`	`41`	`await fileExtractQueueClient.EnqueueFileExtractAsync(file);`
`42`	`42`	`file.LastUpdatedUtc = DateTime.UtcNow;`
`43`	`43`	`await serviceLayerDbContext.SaveChangesAsync();`
`44`		`- logger.LogInformation($"FileRetryFunction: File {file.FileId} enqueued to Extract queue");`
	`44`	`+ logger.LogInformation("FileRetryFunction: File {FileFileId} enqueued to Extract queue", file.FileId);`
`45`	`45`	`}`
`46`	`46`	`}`
`47`	`47`
`@@ -53,14 +53,14 @@ private async Task RetryStaleTransformations(DateTime staleDateTimeUtc)`
`53`	`53`	`&& f.LastUpdatedUtc <= staleDateTimeUtc)`
`54`	`54`	`.ToListAsync();`
`55`	`55`
`56`		`- logger.LogInformation($"FileRetryFunction: {staleFiles.Count} stale files found for transforming retry");`
	`56`	`+ logger.LogInformation("FileRetryFunction: {StaleFilesCount} stale files found for transforming retry", staleFiles.Count);`
`57`	`57`
`58`	`58`	`foreach (var file in staleFiles)`
`59`	`59`	`{`
`60`	`60`	`await fileTransformQueueClient.EnqueueFileTransformAsync(file);`
`61`	`61`	`file.LastUpdatedUtc = DateTime.UtcNow;`
`62`	`62`	`await serviceLayerDbContext.SaveChangesAsync();`
`63`		`- logger.LogInformation($"FileRetryFunction: File {file.FileId} enqueued to Transform queue");`
	`63`	`+ logger.LogInformation("FileRetryFunction: File {FileFileId} enqueued to Transform queue", file.FileId);`
`64`	`64`	`}`
`65`	`65`	`}`
`66`	`66`	`}`
Original file line number	Diff line number	Diff line change
`@@ -4,9 +4,8 @@ namespace ServiceLayer.Mesh.Storage;`
`4`	`4`
`5`	`5`	`public interface IMeshFilesBlobStore`
`6`	`6`	`{`
`7`		`- // TODO - return a Stream or a byte array?`
`8`	`7`	`public Task<Stream> DownloadAsync(MeshFile file);`
`9`	`8`
`10`		`- // Mesh client gives us a byte array, hence this not taking a stream.`
	`9`	`+ // Mesh client gives us a byte array, hence this is not taking a stream.`
`11`	`10`	`public Task<string> UploadAsync(MeshFile file, byte[] data);`
`12`	`11`	`}`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@ namespace ServiceLayer.Mesh.Storage;`
`5`	`5`
`6`	`6`	`public class MeshFilesBlobStore : IMeshFilesBlobStore`
`7`	`7`	`{`
`8`		`- private BlobContainerClient _blobContainerClient;`
	`8`	`+ private readonly BlobContainerClient _blobContainerClient;`
`9`	`9`
`10`	`10`	`public MeshFilesBlobStore(BlobContainerClient blobContainerClient)`
`11`	`11`	`{`
Original file line number	Diff line number	Diff line change
`@@ -4,12 +4,12 @@`
`4`	`4`
`5`	`5`	`namespace ServiceLayer.Mesh.Tests.FileTypes.NbssAppointmentEvents.Validation;`
`6`	`6`
`7`		`-public class RegexValidatorTests`
	`7`	`+public partial class RegexValidatorTests`
`8`	`8`	`{`
`9`	`9`	`private const string FieldName = "TestField";`
`10`	`10`	`private const string MissingCode = "ERR001";`
`11`	`11`	`private const string InvalidFormatCode = "ERR002";`
`12`		`- private readonly Regex _pattern = new(@"^[A-Z]{2}\d{2}$", RegexOptions.Compiled);`
	`12`	`+ private readonly Regex _pattern = TestRegex();`
`13`	`13`
`14`	`14`	`[Fact]`
`15`	`15`	`public void Validate_NullValue_ShouldReturnMissingError()`
`@@ -68,4 +68,7 @@ public void Validate_ValueMatchingPattern_ShouldReturnNoErrors(string validValue`
`68`	`68`
`69`	`69`	`Assert.Empty(errors);`
`70`	`70`	`}`
	`71`	`+`
	`72`	`+ [GeneratedRegex(@"^[A-Z]{2}\d{2}$", RegexOptions.Compiled)]`
	`73`	`+ private static partial Regex TestRegex();`
`71`	`74`	`}`