Ensure user input contains no new lines (#204)

Author: akustn

api/Controllers/PlantDataController.cs

@@ -3,6 +3,7 @@
 using api.Database.Models;
 using api.Services;
 using api.Utilities;
+using Api.Utilities;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 
@@ -192,21 +193,22 @@ public async Task<ActionResult<BlobStorageLocation>> DownloadUriFromInspectionId
         [FromRoute] string inspectionId
     )
     {
+        inspectionId = Sanitize.SanitizeUserInput(inspectionId);
         try
         {
             var plantData = await plantDataService.ReadByInspectionId(inspectionId);
             if (plantData == null)
             {
                 logger.LogWarning(
-                    "No plant data found for InspectionId: {InspectionId}",
+                    "No plant data found for InspectionId: {inspectionId}",
                     inspectionId
                 );
                 return NotFound($"Could not find plant data with inspection id {inspectionId}");
             }
 
             var anonymizerWorkflowStatus = plantData.AnonymizerWorkflowStatus;
             logger.LogInformation(
-                "Anonymization workflow status for InspectionId: {InspectionId} is {Status}",
+                "Anonymization workflow status for InspectionId: {inspectionId} is {Status}",
                 inspectionId,
                 anonymizerWorkflowStatus
             );
@@ -216,7 +218,7 @@ [FromRoute] string inspectionId
                 case WorkflowStatus.ExitSuccess:
                     var plantDataJson = JsonSerializer.Serialize(plantData, _jsonSerializerOptions);
                     logger.LogInformation(
-                        "Full Plant Data for InspectionId: {InspectionId}: {PlantData}",
+                        "Full Plant Data for InspectionId: {inspectionId}: {PlantData}",
                         inspectionId,
                         plantDataJson
                     );

api/Controllers/WorkflowsController.cs

@@ -2,6 +2,7 @@
 using api.Database.Models;
 using api.MQTT;
 using api.Services;
+using Api.Utilities;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 
@@ -83,23 +84,22 @@ public async Task<ActionResult<PlantDataResponse>> AnonymizerDone(
         [FromBody] AnonymizerDoneNotification notification
     )
     {
+        var inspectionId = Sanitize.SanitizeUserInput(notification.InspectionId);
         // TODO: Update plantData with information that the Anonymizer is Done
         logger.LogInformation(
             "Completed anonymization of plantData with inspection id {id}",
-            notification.InspectionId
+            inspectionId
         );
 
-        var plantData = await plantDataService.ReadByInspectionId(notification.InspectionId);
+        var plantData = await plantDataService.ReadByInspectionId(inspectionId);
         if (plantData == null)
         {
-            return NotFound(
-                $"Could not find plantData with inspection id {notification.InspectionId}"
-            );
+            return NotFound($"Could not find plantData with inspection id {inspectionId}");
         }
 
         var message = new SaraVisualizationAvailableMessage
         {
-            InspectionId = notification.InspectionId,
+            InspectionId = inspectionId,
             StorageAccount = plantData.AnonymizedBlobStorageLocation.StorageAccount,
             BlobContainer = plantData.AnonymizedBlobStorageLocation.BlobContainer,
             BlobName = plantData.AnonymizedBlobStorageLocation.BlobName,
@@ -108,7 +108,7 @@ [FromBody] AnonymizerDoneNotification notification
         mqttMessageService.OnSaraVisualizationAvailable(message);
 
         var updatedPlantData = await plantDataService.UpdateAnonymizerWorkflowStatus(
-            notification.InspectionId,
+            inspectionId,
             WorkflowStatus.ExitSuccess
         );
 
@@ -127,24 +127,23 @@ public async Task<ActionResult<PlantDataResponse>> ConstantLevelOilerCompleted(
         [FromBody] ConstantLevelOilerDoneNotification notification
     )
     {
+        var inspectionId = Sanitize.SanitizeUserInput(notification.InspectionId);
         // TODO: Update plantData with information that the CLO is Done
         logger.LogInformation(
             "Completed Constant Level Oiler analysis for plantData with inspection id {id} and oil level {oilLevel}",
-            notification.InspectionId,
+            inspectionId,
             notification.OilLevel
         );
 
-        var plantData = await plantDataService.ReadByInspectionId(notification.InspectionId);
+        var plantData = await plantDataService.ReadByInspectionId(inspectionId);
         if (plantData == null)
         {
-            return NotFound(
-                $"Could not find plantData with inspection id {notification.InspectionId}"
-            );
+            return NotFound($"Could not find plantData with inspection id {inspectionId}");
         }
 
         var message = new SaraAnalysisResultMessage
         {
-            InspectionId = notification.InspectionId,
+            InspectionId = inspectionId,
             AnalysisType = Analysis.TypeToString(AnalysisType.ConstantLevelOiler),
             RegressionResult = notification.OilLevel,
             StorageAccount = plantData.VisualizedBlobStorageLocation.StorageAccount,
@@ -170,7 +169,7 @@ public ActionResult FencillaDone([FromBody] FencillaDoneNotification notificatio
         // TODO: Update plantData with information that Fencilla is Done
         logger.LogInformation(
             "Completed Fencilla analysis for plantData with inspection id {id} and break found is {IsBreak} with confidence {Confidence}",
-            notification.InspectionId,
+            Sanitize.SanitizeUserInput(notification.InspectionId),
             notification.IsBreak,
             notification.Confidence
         );

api/Utilities/SanitizedInput.cs

@@ -0,0 +1,10 @@
+namespace Api.Utilities
+{
+    public static class Sanitize
+    {
+        public static string SanitizeUserInput(string inputString)
+        {
+            return inputString.Replace("\n", "").Replace("\r", "");
+        }
+    }
+}