Some refactoring (#1767)

Author: MiraGeowerkstatt

src/api/BoreholeGeometry/AzIncFormat.cs

@@ -14,14 +14,14 @@ internal sealed class AzIncFormat : IBoreholeGeometryFormat
 
     public string Name => "Azimuth Inclination";
 
-    private Lazy<string> expectedCsvHeader = new(Helper.GetCSVHeader<Geometry>);
+    private Lazy<string> expectedCsvHeader = new(CsvConfigHelper.GetCsvHeader<Geometry>);
 
     public string CsvHeader => expectedCsvHeader.Value;
 
     public IList<BoreholeGeometryElement> ReadCsv(IFormFile file, int boreholeId)
     {
         using var reader = new StreamReader(file.OpenReadStream());
-        using var csv = new CsvReader(reader, Helper.CsvConfig);
+        using var csv = new CsvReader(reader, CsvConfigHelper.CsvConfig);
 
         var data = csv.GetRecords<Geometry>().ToList();
 

src/api/BoreholeGeometry/CsvConfigHelper.cs

@@ -0,0 +1,38 @@
+using BDMS.Models;
+using CsvHelper;
+using CsvHelper.Configuration;
+using Humanizer;
+using NetTopologySuite.Mathematics;
+using NetTopologySuite.Utilities;
+using System.Globalization;
+
+namespace BDMS.BoreholeGeometry;
+
+public static class CsvConfigHelper
+{
+    internal static readonly CsvConfiguration CsvConfig = new(new CultureInfo("de-CH"))
+    {
+        Delimiter = ";",
+        IgnoreReferences = true,
+        PrepareHeaderForMatch = args => args.Header.Humanize(LetterCasing.Title),
+        MissingFieldFound = null,
+    };
+
+    /// <summary>
+    /// Get the CSV header <see cref="CsvHelper"/> for a class of type <typeparamref name="T"/>.
+    /// Uses the map generated by <see cref="CsvHelper.CsvContext.AutoMap{T}()"/>.
+    /// If a property has multiple possible column names only the first is considered.
+    /// </summary>
+    /// <typeparam name="T">The class to get the header for.</typeparam>
+    internal static string GetCsvHeader<T>()
+    {
+        var context = new CsvContext(CsvConfig);
+        var map = context.AutoMap<T>();
+        return string.Join("; ", map.MemberMaps
+            .Select(m =>
+            {
+                var name = m.Data.Names.FirstOrDefault(m.Data.Member.Name);
+                return m.Data.IsOptional ? $"[{name}]" : name;
+            }));
+    }
+}

src/api/BoreholeGeometry/PitchRollFormat.cs

@@ -14,14 +14,14 @@ internal sealed class PitchRollFormat : IBoreholeGeometryFormat
 
     public string Name => "Pitch Roll";
 
-    private Lazy<string> expectedCsvHeader = new(Helper.GetCSVHeader<Geometry>);
+    private Lazy<string> expectedCsvHeader = new(CsvConfigHelper.GetCsvHeader<Geometry>);
 
     public string CsvHeader => expectedCsvHeader.Value;
 
     public IList<BoreholeGeometryElement> ReadCsv(IFormFile file, int boreholeId)
     {
         using var reader = new StreamReader(file.OpenReadStream());
-        using var csv = new CsvReader(reader, Helper.CsvConfig);
+        using var csv = new CsvReader(reader, CsvConfigHelper.CsvConfig);
 
         var data = csv.GetRecords<Geometry>().ToList();
 

src/api/BoreholeGeometry/XYZFormat.cs

@@ -13,14 +13,14 @@ internal sealed class XYZFormat : IBoreholeGeometryFormat
 
     public string Name => "X Y Z";
 
-    private Lazy<string> expectedCsvHeader = new(Helper.GetCSVHeader<Geometry>);
+    private Lazy<string> expectedCsvHeader = new(CsvConfigHelper.GetCsvHeader<Geometry>);
 
     public string CsvHeader => expectedCsvHeader.Value;
 
     public IList<BoreholeGeometryElement> ReadCsv(IFormFile file, int boreholeId)
     {
         using var reader = new StreamReader(file.OpenReadStream());
-        using var csv = new CsvReader(reader, Helper.CsvConfig);
+        using var csv = new CsvReader(reader, CsvConfigHelper.CsvConfig);
 
         var data = csv.GetRecords<Geometry>();
         return ToBoreholeGeometry(data, boreholeId);

src/api/BoreholeGeometry/Helper.cs renamed to src/api/BoreholeGeometryExtensions.cs

@@ -1,42 +1,41 @@
 using BDMS.Models;
-using CsvHelper;
-using CsvHelper.Configuration;
-using Humanizer;
 using NetTopologySuite.Mathematics;
 using NetTopologySuite.Utilities;
-using System.Globalization;
 
-namespace BDMS.BoreholeGeometry;
+namespace BDMS;
 
-public static class Helper
+public static class BoreholeGeometryExtensions
 {
-    internal static readonly CsvConfiguration CsvConfig = new(new CultureInfo("de-CH"))
-    {
-        Delimiter = ";",
-        IgnoreReferences = true,
-        PrepareHeaderForMatch = args => args.Header.Humanize(LetterCasing.Title),
-        MissingFieldFound = null,
-    };
-
     /// <summary>
-    /// Get the CSV header <see cref="CsvHelper"/> expects to read a class <typeparamref name="T"/>.
-    /// Uses the map generated by <see cref="CsvHelper.CsvContext.AutoMap{T}()"/>.
-    /// If a property has multiple possible column names only the first is considered.
+    /// Get the TVD of <paramref name="depthMD"/> according to the <paramref name="geometry"/> if the geometry exists.
     /// </summary>
-    /// <typeparam name="T">The class to get the header for.</typeparam>
-    internal static string GetCSVHeader<T>()
+    /// <param name="geometry">The list of <see cref="BoreholeGeometryElement"/> representing the borehole's path geometry.</param>
+    /// <param name="depthMD">The measured depth (MD) at which to calculate the TVD.</param>
+    /// <returns>The TVD at <paramref name="depthMD"/> if the geometry exists; otherwise <see langword="null"/>.</returns>
+    internal static double? GetTVDIfGeometryExists(this List<BoreholeGeometryElement> geometry, double? depthMD)
     {
-        var context = new CsvContext(CsvConfig);
-        var map = context.AutoMap<T>();
-        return string.Join("; ", map.MemberMaps
-            .Select(m =>
+        if (geometry == null || geometry.Count < 2)
+        {
+            if (depthMD != null && depthMD >= 0)
             {
-                var name = m.Data.Names.FirstOrDefault(m.Data.Member.Name);
-                return m.Data.IsOptional ? $"[{name}]" : name;
-            }));
-    }
+                // Return the depthMD unchanged as if the borehole is perfectly vertical and infinitely long.
+                return depthMD;
+            }
+        }
+        else if (depthMD != null)
+        {
+            try
+            {
+                return geometry.GetDepthTVD(depthMD.Value);
+            }
+            catch (ArgumentOutOfRangeException)
+            {
+                // Exception is ignored so that the method returns null in case the input was invalid.
+            }
+        }
 
-    private static readonly IComparer<BoreholeGeometryElement> geometryMDComparer = Comparer<BoreholeGeometryElement>.Create((a, b) => a.MD.CompareTo(b.MD));
+        return null;
+    }
 
     /// <summary>
     /// Get the TVD of <paramref name="depthMD"/> according to the <paramref name="geometry"/>.
@@ -130,6 +129,8 @@ private static double InterpolateDepthTVD(List<BoreholeGeometryElement> geometry
         }
     }
 
+    private static readonly IComparer<BoreholeGeometryElement> geometryMDComparer = Comparer<BoreholeGeometryElement>.Create((a, b) => a.MD.CompareTo(b.MD));
+
     internal static Vector3D ToVector3D(this BoreholeGeometryElement element)
         => new Vector3D(element.X, element.Y, element.Z);
 

src/api/Controllers/BoreholeGeometryController.cs

@@ -118,28 +118,13 @@ public async Task<IActionResult> GetDepthTVD([FromQuery] int boreholeId, [FromQu
     {
         var geometry = await GetBoreholeGeometry(boreholeId).ConfigureAwait(false);
 
-        if (geometry.Count < 2)
+        var tvd = geometry.GetTVDIfGeometryExists(depthMD);
+        if (tvd == null)
         {
-            if (depthMD >= 0)
-            {
-                // Return the depthMD unchanged as if the borehole is perfectly vertical and infinitely long.
-                return Ok(depthMD);
-            }
-        }
-        else
-        {
-            try
-            {
-                return Ok(geometry.GetDepthTVD(depthMD));
-            }
-            catch (ArgumentOutOfRangeException)
-            {
-             // Exception is ignored so that the action returns an empty response in case the input was invalid.
-            }
+            logger?.LogInformation($"Invalid input, could not calculate true vertical depth from measured depth of {depthMD}");
         }
 
-        logger?.LogInformation($"Invalid input, could not calculate true vertical depth from measured depth of {depthMD}");
-        return Ok();
+        return Ok(tvd);
     }
 
     private async Task<List<BoreholeGeometryElement>> GetBoreholeGeometry(int boreholeId)

src/api/Controllers/UploadController.cs renamed to src/api/Controllers/ImportController.cs

@@ -14,7 +14,7 @@ namespace BDMS.Controllers;
 
 [ApiController]
 [Route("api/v{version:apiVersion}/[controller]")]
-public class UploadController : ControllerBase
+public class ImportController : ControllerBase
 {
     private const int MaxFileSize = 210_000_000; // 1024 x 1024 x 200 = 209715200 bytes
     private readonly BdmsContext context;
@@ -35,7 +35,7 @@ public class UploadController : ControllerBase
 
     private static readonly JsonSerializerOptions jsonImportOptions = new() { PropertyNameCaseInsensitive = true };
 
-    public UploadController(BdmsContext context, ILogger<UploadController> logger, LocationService locationService, CoordinateService coordinateService, BoreholeFileCloudService boreholeFileCloudService)
+    public ImportController(BdmsContext context, ILogger<ImportController> logger, LocationService locationService, CoordinateService coordinateService, BoreholeFileCloudService boreholeFileCloudService)
     {
         this.context = context;
         this.logger = logger;

src/client/cypress/e2e/helpers/testHelpers.js

@@ -109,6 +109,8 @@ export const interceptApiCalls = () => {
   cy.intercept("dataextraction/api/V1/extract_data").as("extract-data");
 
   cy.intercept("https://api3.geo.admin.ch/rest/services/height*").as("height");
+
+  cy.intercept("/api/v2/import*").as("borehole-upload");
 };
 
 /**

src/client/cypress/e2e/mainPage/import.cy.js

@@ -42,9 +42,6 @@ describe("Test for importing boreholes.", () => {
       });
     });
 
-    // Intercept upload request
-    cy.intercept("/api/v2/upload?workgroupId=1").as("borehole-upload");
-
     // Import boreholes and attachments
     cy.get('[data-cy="import-button"]').click();
     cy.wait("@borehole-upload");
@@ -75,9 +72,6 @@ describe("Test for importing boreholes.", () => {
           });
         });
       });
-
-    cy.intercept("/api/v2/upload?workgroupId=1").as("borehole-upload");
-
     cy.get('[data-cy="import-button"]').click();
 
     cy.wait("@borehole-upload");

src/client/cypress/fixtures/import/boreholes-missing-fields-and-duplicates.csv

@@ -1,4 +1,4 @@
-alternate_name;original_name;location_x;location_y
+name;original_name;location_x;location_y
 BH-1001;Wellington 1;
 BH-1002;Wellington 2;
 BH-1003;Wellington 3;2189456;1334567