Merge pull request #2141 from TechnologyEnhancedLearning/Develop/Features/TD-2492-Restrict-the-number-of-rows-that-can-be-uploaded-for-bulk-update-in-Excel_

TD-2492 restrict the number of rows that can be uploaded for bulk update in excel

Author: kevwhitt-hee

DigitalLearningSolutions.Data/Extensions/ConfigurationExtensions.cs

@@ -37,6 +37,7 @@ public static class ConfigurationExtensions
         private const string LearningHubReportAPIClientId = "LearningHubReportAPIConfig:ClientId";
         private const string LearningHubReportAPIClientIdentityKey = "LearningHubReportAPIConfig:ClientIdentityKey";
         private const string ExportQueryRowLimitKey = "FeatureManagement:ExportQueryRowLimit";
+        private const string MaxBulkUploadRowsLimitKey = "FeatureManagement:MaxBulkUploadRows";
         public static string GetAppRootPath(this IConfiguration config)
         {
             return config[AppRootPathName];
@@ -152,6 +153,9 @@ public static int GetExportQueryRowLimit(this IConfiguration config)
         {
             return int.Parse(config[ExportQueryRowLimitKey]);
         }
-
+        public static int GetMaxBulkUploadRowsLimit(this IConfiguration config)
+        {
+            return int.Parse(config[MaxBulkUploadRowsLimitKey]);
+        }
     }
 }

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

@@ -12,7 +12,8 @@
     using Microsoft.AspNetCore.Authorization;
     using Microsoft.AspNetCore.Mvc;
     using Microsoft.FeatureManagement.Mvc;
-
+    using Microsoft.Extensions.Configuration;
+    using ConfigurationExtensions = DigitalLearningSolutions.Data.Extensions.ConfigurationExtensions;
     [FeatureGate(FeatureFlags.RefactoredTrackingSystem)]
     [Authorize(Policy = CustomPolicies.UserCentreAdmin)]
     [SetDlsSubApplication(nameof(DlsSubApplication.TrackingSystem))]
@@ -23,23 +24,30 @@ public class BulkUploadController : Controller
         private readonly IDelegateDownloadFileService delegateDownloadFileService;
         private readonly IDelegateUploadFileService delegateUploadFileService;
         private readonly IClockUtility clockUtility;
-
+        private readonly IConfiguration configuration;
         public BulkUploadController(
             IDelegateDownloadFileService delegateDownloadFileService,
             IDelegateUploadFileService delegateUploadFileService,
-            IClockUtility clockUtility
+            IClockUtility clockUtility, IConfiguration configuration
         )
         {
             this.delegateDownloadFileService = delegateDownloadFileService;
             this.delegateUploadFileService = delegateUploadFileService;
             this.clockUtility = clockUtility;
+            this.configuration = configuration;
         }
 
         public IActionResult Index()
         {
+            int MaxBulkUploadRows = GetMaxBulkUploadRowsLimit();
+            TempData["MaxBulkUploadRows"] = MaxBulkUploadRows;
             return View();
         }
+        private int GetMaxBulkUploadRowsLimit()
+        {
+            return ConfigurationExtensions.GetMaxBulkUploadRowsLimit(configuration);
 
+        }
         [Route("DownloadDelegates")]
         public IActionResult DownloadDelegates()
         {
@@ -61,13 +69,20 @@ public IActionResult StartUpload()
         {
             TempData.Clear();
             var model = new UploadDelegatesViewModel(clockUtility.UtcToday);
+            model.MaxBulkUploadRows = GetMaxBulkUploadRowsLimit();
             return View("StartUpload", model);
         }
 
         [Route("StartUpload")]
         [HttpPost]
         public IActionResult StartUpload(UploadDelegatesViewModel model)
         {
+            int MaxBulkUploadRows = GetMaxBulkUploadRowsLimit();
+            int ExcelRowsCount = delegateUploadFileService.GetBulkUploadExcelRowCount(model.DelegatesFile);
+            if (ExcelRowsCount > MaxBulkUploadRows)
+            {
+                ModelState.AddModelError("MaxBulkUploadRows", string.Format(CommonValidationErrorMessages.MaxBulkUploadRowsLimit, MaxBulkUploadRows));
+            }
             if (!ModelState.IsValid)
             {
                 return View("StartUpload", model);

DigitalLearningSolutions.Web/Helpers/CommonValidationErrorMessages.cs

@@ -34,5 +34,6 @@ public static class CommonValidationErrorMessages
         public const string PrimaryEmailInUseDuringDelegateRegistration =
             "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";
     }
 }

DigitalLearningSolutions.Web/Services/DelegateUploadFileService.cs

@@ -20,6 +20,7 @@ namespace DigitalLearningSolutions.Web.Services
 {
     public interface IDelegateUploadFileService
     {
+        public int GetBulkUploadExcelRowCount(IFormFile delegatesFile);
         public BulkUploadResult ProcessDelegatesFile(IFormFile file, int centreId, DateTime welcomeEmailDate);
     }
 
@@ -310,5 +311,9 @@ private static bool ValidateHeaders(IXLTable table)
             var actualHeaders = table.Fields.Select(x => x.Name).OrderBy(x => x);
             return actualHeaders.SequenceEqual(expectedHeaders);
         }
+        public int GetBulkUploadExcelRowCount(IFormFile delegatesFile)
+        {
+            return OpenDelegatesTable(delegatesFile).AsNativeDataTable().Rows.Count;
+        }
     }
 }

DigitalLearningSolutions.Web/ViewModels/TrackingSystem/Delegates/UploadDelegatesViewModel.cs

@@ -21,7 +21,7 @@ public UploadDelegatesViewModel(DateTime welcomeEmailDate)
         [AllowedExtensions(new[] { ".xlsx" }, "Delegates update file must be in xlsx format")]
         [MaxFileSize(5 * 1024 * 1024, "Maximum allowed file size is 5MB")]
         public IFormFile? DelegatesFile { get; set; }
-
+        public int MaxBulkUploadRows { get; set; }
         public DateTime GetWelcomeEmailDate()
         {
             return new DateTime(Year!.Value, Month!.Value, Day!.Value);

DigitalLearningSolutions.Web/Views/TrackingSystem/Delegates/BulkUpload/Index.cshtml

@@ -28,7 +28,7 @@
       <p class="nhsuk-body-m">
         Once you have downloaded, amended and saved the Excel delegates sheet above, start the upload to process your changes.
       </p>
-
+      <p class="nhsuk-body-m">If your spreadsheet is large, you must split it so that each uploaded sheet contains no more than @TempData["MaxBulkUploadRows"] rows.</p>
       <a class="nhsuk-button nhsuk-u-margin-bottom-7" role="button" asp-controller="BulkUpload" asp-action="StartUpload">
         Start upload
       </a>

DigitalLearningSolutions.Web/Views/TrackingSystem/Delegates/BulkUpload/StartUpload.cshtml

@@ -29,7 +29,7 @@
                      css-class="@(errorHasOccurred ? " nhsuk-u-padding-left-5 nhsuk-u-margin-bottom-3" : "")"
                      hint-text-lines="@hintTextLines" />
 
-      <vc:file-input asp-for="@nameof(Model.DelegatesFile)" label="File with updated information" hint-text="" css-class="nhsuk-u-width-one-half" />
+            <vc:file-input asp-for="@nameof(Model.DelegatesFile)" label="File with updated information (max @(Model.MaxBulkUploadRows) rows)" hint-text="" css-class="nhsuk-u-width-one-half" />
 
       <button class="nhsuk-button" type="submit">Upload and process</button>
     </form>

DigitalLearningSolutions.Web/appSettings.UAT.json

@@ -20,7 +20,8 @@
     "PricingPage": false,
     "RefactoredFindYourCentrePage": true,
     "UserFeedbackBar": true,
-    "ExportQueryRowLimit": 250
+    "ExportQueryRowLimit": 250,
+    "MaxBulkUploadRows": 200
   },
   "LearningHubOpenAPIBaseUrl": "https://uks-learninghubnhsuk-openapi-test.azurewebsites.net"
 }

DigitalLearningSolutions.Web/appsettings.Development.json

@@ -20,7 +20,8 @@
     "PricingPage": true,
     "RefactoredFindYourCentrePage": true,
     "UserFeedbackBar": true,
-    "ExportQueryRowLimit": 250
+    "ExportQueryRowLimit": 250,
+    "MaxBulkUploadRows": 200
   },
   "LearningHubOpenAPIBaseUrl": "https://uks-learninghubnhsuk-openapi-test.azurewebsites.net",
   "LearningHubReportAPIConfig": {

DigitalLearningSolutions.Web/appsettings.Production.json

@@ -20,7 +20,8 @@
     "PricingPage": false,
     "RefactoredFindYourCentrePage": true,
     "UserFeedbackBar": true,
-    "ExportQueryRowLimit": 250
+    "ExportQueryRowLimit": 250,
+    "MaxBulkUploadRows": 200
   },
   "LearningHubOpenAPIBaseUrl": "https://learninghubnhsuk-openapi-prod.azurewebsites.net",
   "LearningHubReportAPIConfig": {