feat: DTOSS-9179 - Transform function completion, and test/logging refactoring (#23)

Author: ianfnelson

src/ServiceLayer.Common/Data/Migrations/20250527094020_ValidationErrors.Designer.cs

@@ -0,0 +1,28 @@
+using Microsoft.EntityFrameworkCore.Migrations;
+
+#nullable disable
+
+namespace ServiceLayer.Mesh.Migrations
+{
+    /// <inheritdoc />
+    public partial class ValidationErrors : Migration
+    {
+        /// <inheritdoc />
+        protected override void Up(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.AddColumn<string>(
+                name: "ValidationErrors",
+                table: "MeshFiles",
+                type: "nvarchar(max)",
+                nullable: true);
+        }
+
+        /// <inheritdoc />
+        protected override void Down(MigrationBuilder migrationBuilder)
+        {
+            migrationBuilder.DropColumn(
+                name: "ValidationErrors",
+                table: "MeshFiles");
+        }
+    }
+}

src/ServiceLayer.Common/Data/Migrations/20250527094020_ValidationErrors.cs

@@ -53,6 +53,9 @@ protected override void BuildModel(ModelBuilder modelBuilder)
                         .HasMaxLength(20)
                         .HasColumnType("nvarchar(20)");
 
+                    b.Property<string>("ValidationErrors")
+                        .HasColumnType("nvarchar(max)");
+
                     b.HasKey("FileId");
 
                     b.ToTable("MeshFiles");

src/ServiceLayer.Common/Data/Migrations/ServiceLayerDbContextModelSnapshot.cs

@@ -16,4 +16,6 @@ public class MeshFile
     public string? BlobPath { get; set; }
     public DateTime FirstSeenUtc { get; set; }
     public DateTime LastUpdatedUtc { get; set; }
+    // ReSharper disable once EntityFramework.ModelValidation.UnlimitedStringLength
+    public string? ValidationErrors { get; set; }
 }

src/ServiceLayer.Common/Data/Models/MeshFile.cs

@@ -4,7 +4,6 @@ namespace ServiceLayer.Mesh.Configuration;
 
 public class AppConfiguration :
     IFileDiscoveryFunctionConfiguration,
-    IFileExtractFunctionConfiguration,
     IFileExtractQueueClientConfiguration,
     IFileTransformQueueClientConfiguration,
     IFileTransformFunctionConfiguration,

src/ServiceLayer.Mesh/Configuration/AppConfiguration.cs

@@ -0,0 +1,11 @@
+using NHS.MESH.Client.Models;
+
+namespace ServiceLayer.Mesh.Extensions;
+
+public static class ApiErrorResponseExtensions
+{
+    public static string ToFormattedString(this APIErrorResponse? error)
+    {
+        return error == null ? "Unknown error" : $"ErrorEvent: {error.ErrorEvent ?? "N/A"}, ErrorCode: {error.ErrorCode ?? "N/A"}, ErrorDescription: {error.ErrorDescription}";
+    }
+}

src/ServiceLayer.Mesh/Configuration/IFileExtractFunctionConfiguration.cs

@@ -0,0 +1,10 @@
+using ServiceLayer.Data.Models;
+
+namespace ServiceLayer.Mesh;
+
+public abstract class FileTransformerBase : IFileTransformer
+{
+    protected abstract MeshFileType HandlesFileType { get; }
+    public virtual bool CanHandle(MeshFileType fileType) => fileType == HandlesFileType;
+    public abstract Task<IList<ValidationError>> TransformFileAsync(Stream stream, MeshFile metaData);
+}

src/ServiceLayer.Mesh/Extensions/ApiErrorResponseExtensions.cs

@@ -3,31 +3,23 @@
 
 namespace ServiceLayer.Mesh.FileTypes.NbssAppointmentEvents;
 
-// TODO - NBSS appointment file specific implementation of IFileTransformer. To orchestrate parsing, validation and staging of data (delegated to separate classes)
-public class FileTransformer : IFileTransformer
+public class FileTransformer(
+    IFileParser fileParser,
+    IValidationRunner validationRunner,
+    IStagingPersister stagingPersister)
+    : FileTransformerBase
 {
-    private readonly IFileParser _fileParser;
-    private readonly IValidationRunner _validationRunner;
-    private readonly IStagingPersister _stagingPersister;
+    protected override MeshFileType HandlesFileType => MeshFileType.NbssAppointmentEvents;
 
-    public FileTransformer(IFileParser fileParser, IValidationRunner validationRunner, IStagingPersister stagingPersister)
-    {
-        _fileParser = fileParser;
-        _validationRunner = validationRunner;
-        _stagingPersister = stagingPersister;
-    }
-
-    public MeshFileType HandlesFileType => MeshFileType.NbssAppointmentEvents;
-
-    public async Task<IList<ValidationError>> TransformFileAsync(Stream stream, MeshFile metaData)
+    public override async Task<IList<ValidationError>> TransformFileAsync(Stream stream, MeshFile metaData)
     {
         // TODO - wrap this parsing in a try-catch and return a List<ValidationError> in case of any unforeseen parsing issues (file is totally unlike anything we expect)
-        var parsed = _fileParser.Parse(stream);
+        var parsed = fileParser.Parse(stream);
 
-        var validationErrors = _validationRunner.Validate(parsed);
+        var validationErrors = validationRunner.Validate(parsed);
         if (!validationErrors.Any())
         {
-            await _stagingPersister.WriteStagedData(parsed, metaData);
+            await stagingPersister.WriteStagedData(parsed, metaData);
         }
 
         return validationErrors;

src/ServiceLayer.Mesh/FileTransformerBase.cs

@@ -0,0 +1,33 @@
+using Microsoft.Extensions.DependencyInjection;
+using ServiceLayer.Mesh.FileTypes.NbssAppointmentEvents.Validation;
+
+namespace ServiceLayer.Mesh.FileTypes.NbssAppointmentEvents;
+
+public static class ServiceCollectionExtensions
+{
+    public static IServiceCollection ConfigureNbssAppointmentEvents(this IServiceCollection services)
+    {
+        services.AddTransient<IFileTransformer, FileTransformer>();
+        services.AddTransient<IFileParser, FileParser>();
+        services.AddTransient<IStagingPersister, StagingPersister>();
+        services.AddSingleton<IValidationRunner, ValidationRunner>();
+        services.RegisterValidators();
+
+        return services;
+    }
+
+    private static IServiceCollection RegisterValidators(this IServiceCollection services)
+    {
+        foreach (var recordValidator in ValidatorRegistry.GetAllRecordValidators())
+        {
+            services.AddSingleton<IRecordValidator>(_ => recordValidator);
+        }
+
+        foreach (var fileValidator in ValidatorRegistry.GetAllFileValidators())
+        {
+            services.AddSingleton<IFileValidator>(_ => fileValidator);
+        }
+
+        return services;
+    }
+}