TD-2865: Improve error messages when bulk upload Excel file doesn't contain correct worksheet

Author: sarathlal-sarangadharan

DigitalLearningSolutions.Web/Controllers/TrackingSystem/Delegates/BulkUploadController.cs

@@ -14,6 +14,8 @@
     using Microsoft.FeatureManagement.Mvc;
     using Microsoft.Extensions.Configuration;
     using ConfigurationExtensions = DigitalLearningSolutions.Data.Extensions.ConfigurationExtensions;
+    using ClosedXML.Excel;
+
     [FeatureGate(FeatureFlags.RefactoredTrackingSystem)]
     [Authorize(Policy = CustomPolicies.UserCentreAdmin)]
     [SetDlsSubApplication(nameof(DlsSubApplication.TrackingSystem))]
@@ -78,6 +80,12 @@ public IActionResult StartUpload()
         public IActionResult StartUpload(UploadDelegatesViewModel model)
         {
             int MaxBulkUploadRows = GetMaxBulkUploadRowsLimit();
+            var workbook = new XLWorkbook(model.DelegatesFile.OpenReadStream());
+            if (!workbook.Worksheets.Contains(DelegateDownloadFileService.DelegatesSheetName))
+            {
+                ModelState.AddModelError("MaxBulkUploadRows", CommonValidationErrorMessages.InvalidExcelValidationMessage);
+                return View("StartUpload", model);
+            }
             int ExcelRowsCount = delegateUploadFileService.GetBulkUploadExcelRowCount(model.DelegatesFile);
             if (ExcelRowsCount > MaxBulkUploadRows)
             {

DigitalLearningSolutions.Web/Helpers/CommonValidationErrorMessages.cs

@@ -35,5 +35,6 @@ public static class CommonValidationErrorMessages
             "A user with this email address is already registered";
         public const string CentreNameAlreadyExist = "The centre name you have entered already exists, please enter a different centre name";
         public const string MaxBulkUploadRowsLimit = "File must contain no more than {0} rows";
+        public const string InvalidExcelValidationMessage = "The uploaded file must contain a \"DelegatesBulkUpload\" worksheet. Use the \"Download delegates\" button to generate a template.";
     }
 }