Use FluentValidation for Add alert journey (#2624)

gunndabad · web-flow · commit c74e28156cba · 2025-11-25T17:31:57.000Z
We're moving to using FluentValidation across the board so we can have a
consistent approach for SupportUi validation and the API. This adds FV
to the first journey in the Support UI - add alert.
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.Core/DataStore/Postgres/Models/Alert.cs b/TeachingRecordSystem/src/TeachingRecordSystem.Core/DataStore/Postgres/Models/Alert.cs
@@ -1,4 +1,5 @@
 using EntityFrameworkCore.Projectables;
+using FluentValidation;
 using TeachingRecordSystem.Core.Events.Legacy;
 
 namespace TeachingRecordSystem.Core.DataStore.Postgres.Models;
@@ -10,6 +11,8 @@ public class Alert
     public const string PersonIdIndexName = "ix_alerts_person_id";
     public const string PersonForeignKeyName = "fk_alerts_person";
 
+    public const int DetailsMaxLength = 4000;
+
     public required Guid AlertId { get; init; }
     public AlertType? AlertType { get; }
     public required Guid AlertTypeId { get; init; }
@@ -137,3 +140,41 @@ public void Update(
         };
     }
 }
+
+public static class AlertValidationExtensions
+{
+    public static IRuleBuilderOptions<T, string?> AlertDetails<T>(
+        this IRuleBuilder<T, string?> ruleBuilder,
+        Func<int, string> maxLengthMessage)
+    {
+        return ruleBuilder
+            .MaximumLength(Alert.DetailsMaxLength).WithMessage(maxLengthMessage(Alert.DetailsMaxLength));
+    }
+
+    public static IRuleBuilderOptions<T, string?> AlertLink<T>(
+        this IRuleBuilder<T, string?> ruleBuilder,
+        string invalidUrlMessage)
+    {
+        return ruleBuilder
+            .Must(link => TrsUriHelper.TryCreateWebsiteUri(link, out _)).WithMessage(invalidUrlMessage);
+    }
+
+    public static IRuleBuilderOptions<T, DateOnly?> AlertStartDate<T>(
+        this IRuleBuilder<T, DateOnly?> ruleBuilder,
+        DateOnly today,
+        string requiredMessage,
+        string dateInFutureMessage)
+    {
+        return ruleBuilder
+            .NotNull().WithMessage(requiredMessage)
+            .LessThanOrEqualTo(today).WithMessage(dateInFutureMessage);
+    }
+
+    public static IRuleBuilderOptions<T, Guid?> AlertType<T>(
+        this IRuleBuilder<T, Guid?> ruleBuilder,
+        string requiredMessage)
+    {
+        return ruleBuilder
+            .NotNull().WithMessage(requiredMessage);
+    }
+}
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/Details.cshtml.cs b/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/Details.cshtml.cs
@@ -1,14 +1,20 @@
-using System.ComponentModel.DataAnnotations;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.AspNetCore.Mvc.RazorPages;
+using TeachingRecordSystem.Core.DataStore.Postgres.Models;
 using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 
 namespace TeachingRecordSystem.SupportUi.Pages.Alerts.AddAlert;
 
 [Journey(JourneyNames.AddAlert), RequireJourneyInstance]
 public class DetailsModel(SupportUiLinkGenerator linkGenerator, EvidenceUploadManager evidenceUploadManager) : PageModel
 {
+    private readonly InlineValidator<DetailsModel> _validator = new()
+    {
+        v => v.RuleFor(m => m.Details).AlertDetails(
+            maxLengthMessage: maxLength => $"Details must be {maxLength} characters or less")
+    };
+
     public JourneyInstance<AddAlertState>? JourneyInstance { get; set; }
 
     [FromQuery]
@@ -22,7 +28,6 @@ public class DetailsModel(SupportUiLinkGenerator linkGenerator, EvidenceUploadMa
     public string? AlertTypeName { get; set; }
 
     [BindProperty]
-    [MaxLength(UiDefaults.DetailMaxCharacterCount, ErrorMessage = $"Details {UiDefaults.DetailMaxCharacterCountErrorMessage}")]
     public string? Details { get; set; }
 
     public void OnGet()
@@ -32,10 +37,7 @@ public void OnGet()
 
     public async Task<IActionResult> OnPostAsync()
     {
-        if (!ModelState.IsValid)
-        {
-            return this.PageWithErrors();
-        }
+        await _validator.ValidateAndThrowAsync(this);
 
         await JourneyInstance!.UpdateStateAsync(state =>
         {
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/Link.cshtml.cs b/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/Link.cshtml.cs
@@ -1,14 +1,20 @@
-using System.ComponentModel.DataAnnotations;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.AspNetCore.Mvc.RazorPages;
+using TeachingRecordSystem.Core.DataStore.Postgres.Models;
 using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 
 namespace TeachingRecordSystem.SupportUi.Pages.Alerts.AddAlert;
 
 [Journey(JourneyNames.AddAlert), RequireJourneyInstance]
 public class LinkModel(SupportUiLinkGenerator linkGenerator, EvidenceUploadManager evidenceUploadManager) : PageModel
 {
+    private readonly InlineValidator<LinkModel> _validator = new()
+    {
+        v => v.RuleFor(m => m.AddLink).NotNull().WithMessage("Select yes if you want to add a link to a panel outcome"),
+        v => v.RuleFor(m => m.Link).AlertLink("Enter a valid URL").When(m => m.AddLink == true)
+    };
+
     public JourneyInstance<AddAlertState>? JourneyInstance { get; set; }
 
     [FromQuery]
@@ -20,7 +26,6 @@ public class LinkModel(SupportUiLinkGenerator linkGenerator, EvidenceUploadManag
     public string? PersonName { get; set; }
 
     [BindProperty]
-    [Required(ErrorMessage = "Select yes if you want to add a link to a panel outcome")]
     public bool? AddLink { get; set; }
 
     [BindProperty]
@@ -34,15 +39,7 @@ public void OnGet()
 
     public async Task<IActionResult> OnPostAsync()
     {
-        if (AddLink == true && !TrsUriHelper.TryCreateWebsiteUri(Link, out _))
-        {
-            ModelState.AddModelError(nameof(Link), "Enter a valid URL");
-        }
-
-        if (!ModelState.IsValid)
-        {
-            return this.PageWithErrors();
-        }
+        await _validator.ValidateAndThrowAsync(this);
 
         await JourneyInstance!.UpdateStateAsync(state =>
         {
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/Reason.cshtml.cs b/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/Reason.cshtml.cs
@@ -1,4 +1,3 @@
-using System.ComponentModel.DataAnnotations;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.AspNetCore.Mvc.RazorPages;
@@ -9,6 +8,21 @@ namespace TeachingRecordSystem.SupportUi.Pages.Alerts.AddAlert;
 [Journey(JourneyNames.AddAlert), RequireJourneyInstance]
 public class ReasonModel(SupportUiLinkGenerator linkGenerator, EvidenceUploadManager evidenceUploadManager) : PageModel
 {
+    private readonly InlineValidator<ReasonModel> _validator = new()
+    {
+        v => v.RuleFor(m => m.AddReason)
+            .NotNull().WithMessage("Select a reason"),
+        v => v.RuleFor(m => m.HasAdditionalReasonDetail)
+            .NotNull().WithMessage("Select yes if you want to add more information"),
+        v => v.RuleFor(m => m.AddReasonDetail)
+            .NotNull().WithMessage("Enter additional detail")
+            .MaximumLength(4000).WithMessage("Additional detail must be 4000 characters or less")
+            .When(m => m.HasAdditionalReasonDetail == true),
+        v => v.RuleFor(m => m.Evidence.UploadEvidence)
+            .NotNull().WithMessage("Select yes if you want to upload evidence"),
+        v => v.RuleFor(m => m.Evidence).Evidence()
+    };
+
     public JourneyInstance<AddAlertState>? JourneyInstance { get; set; }
 
     [FromQuery]
@@ -20,15 +34,12 @@ public class ReasonModel(SupportUiLinkGenerator linkGenerator, EvidenceUploadMan
     public string? PersonName { get; set; }
 
     [BindProperty]
-    [Required(ErrorMessage = "Select a reason")]
     public AddAlertReasonOption? AddReason { get; set; }
 
     [BindProperty]
-    [Required(ErrorMessage = "Select yes if you want to add more information")]
     public bool? HasAdditionalReasonDetail { get; set; }
 
     [BindProperty]
-    [MaxLength(UiDefaults.DetailMaxCharacterCount, ErrorMessage = $"Additional detail {UiDefaults.DetailMaxCharacterCountErrorMessage}")]
     public string? AddReasonDetail { get; set; }
 
     [BindProperty]
@@ -57,17 +68,9 @@ public void OnGet()
 
     public async Task<IActionResult> OnPostAsync()
     {
-        if (HasAdditionalReasonDetail == true && AddReasonDetail is null)
-        {
-            ModelState.AddModelError(nameof(AddReasonDetail), "Enter additional detail");
-        }
+        await _validator.ValidateAndThrowAsync(this);
 
-        await evidenceUploadManager.ValidateAndUploadAsync<ReasonModel>(m => m.Evidence, ViewData);
-
-        if (!ModelState.IsValid)
-        {
-            return this.PageWithErrors();
-        }
+        await evidenceUploadManager.UploadAsync(Evidence);
 
         await JourneyInstance!.UpdateStateAsync(state =>
         {
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/StartDate.cshtml.cs b/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/StartDate.cshtml.cs
@@ -1,14 +1,22 @@
-using System.ComponentModel.DataAnnotations;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.AspNetCore.Mvc.RazorPages;
+using TeachingRecordSystem.Core.DataStore.Postgres.Models;
 using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 
 namespace TeachingRecordSystem.SupportUi.Pages.Alerts.AddAlert;
 
 [Journey(JourneyNames.AddAlert), RequireJourneyInstance]
 public class StartDateModel(SupportUiLinkGenerator linkGenerator, EvidenceUploadManager evidenceUploadManager, IClock clock) : PageModel
 {
+    private readonly InlineValidator<StartDateModel> _validator = new()
+    {
+        v => v.RuleFor(m => m.StartDate).AlertStartDate(
+            clock.Today,
+            requiredMessage: "Enter a start date",
+            dateInFutureMessage: "Start date cannot be in the future")
+    };
+
     public JourneyInstance<AddAlertState>? JourneyInstance { get; set; }
 
     [FromQuery]
@@ -20,7 +28,6 @@ public class StartDateModel(SupportUiLinkGenerator linkGenerator, EvidenceUpload
     public string? PersonName { get; set; }
 
     [BindProperty]
-    [Required(ErrorMessage = "Enter a start date")]
     public DateOnly? StartDate { get; set; }
 
     public void OnGet()
@@ -30,15 +37,7 @@ public void OnGet()
 
     public async Task<IActionResult> OnPostAsync()
     {
-        if (StartDate > clock.Today)
-        {
-            ModelState.AddModelError(nameof(StartDate), "Start date cannot be in the future");
-        }
-
-        if (!ModelState.IsValid)
-        {
-            return this.PageWithErrors();
-        }
+        await _validator.ValidateAndThrowAsync(this);
 
         await JourneyInstance!.UpdateStateAsync(state =>
         {
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/Type.cshtml.cs b/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Alerts/AddAlert/Type.cshtml.cs
@@ -1,8 +1,8 @@
-using System.ComponentModel.DataAnnotations;
 using Microsoft.AspNetCore.Authorization;
 using Microsoft.AspNetCore.Mvc;
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.AspNetCore.Mvc.RazorPages;
+using TeachingRecordSystem.Core.DataStore.Postgres.Models;
 using TeachingRecordSystem.SupportUi.Infrastructure.Security;
 using TeachingRecordSystem.SupportUi.Infrastructure.Security.Requirements;
 using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
@@ -16,6 +16,11 @@ public class TypeModel(
     EvidenceUploadManager evidenceUploadManager,
     IAuthorizationService authorizationService) : PageModel
 {
+    private readonly InlineValidator<TypeModel> _validator = new()
+    {
+        v => v.RuleFor(m => m.AlertTypeId).AlertType(requiredMessage: "Select an alert type")
+    };
+
     public JourneyInstance<AddAlertState>? JourneyInstance { get; set; }
 
     [FromQuery]
@@ -27,7 +32,6 @@ public class TypeModel(
     public string? PersonName { get; set; }
 
     [BindProperty]
-    [Required(ErrorMessage = "Select an alert type")]
     public Guid? AlertTypeId { get; set; }
 
     public AlertCategoryInfo[]? Categories { get; set; }
@@ -41,10 +45,7 @@ public void OnGet()
 
     public async Task<IActionResult> OnPostAsync()
     {
-        if (!ModelState.IsValid)
-        {
-            return this.PageWithErrors();
-        }
+        await _validator.ValidateAndThrowAsync(this);
 
         var selectedType = AlertTypes!.Single(t => t.AlertTypeId == AlertTypeId);
 
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Shared/Evidence/EvidenceUploadManager.cs b/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Shared/Evidence/EvidenceUploadManager.cs
@@ -6,37 +6,41 @@ namespace TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 
 public class EvidenceUploadManager(IFileService fileService, IModelExpressionProvider modelExpressionProvider)
 {
-    public async Task ValidateAndUploadAsync<TModel>(Expression<Func<TModel, EvidenceUploadModel>> evidenceExpression, ViewDataDictionary viewData)
+    public async Task UploadAsync(EvidenceUploadModel evidence)
     {
-        var expressionBuilder = new ModelExpressionBuilder<TModel, EvidenceUploadModel>(modelExpressionProvider, evidenceExpression, viewData);
-        var evidence = expressionBuilder.Model;
-
-        if (evidence.UploadEvidence == true && evidence.EvidenceFile is null && evidence.UploadedEvidenceFile is null)
-        {
-            var expression = expressionBuilder.GetModelExpressionFor(e => e.EvidenceFile);
-            viewData.ModelState.AddModelError(expression.Name, "Select a file");
-        }
-
         // Delete any previously uploaded file if they're uploading a new one,
         // or choosing not to upload evidence (check for UploadEvidence != true because if
         // UploadEvidence somehow got set to null we still want to delete the file)
         if (evidence.UploadedEvidenceFile is UploadedEvidenceFile file && (evidence.EvidenceFile is not null || evidence.UploadEvidence != true))
         {
-            await fileService!.DeleteFileAsync(file.FileId);
+            await fileService.DeleteFileAsync(file.FileId);
             evidence.UploadedEvidenceFile = null;
         }
 
         // Upload the file and set the display fields even if the rest of the form is invalid
         // otherwise the user will have to re-upload every time they re-submit
-        if (evidence.UploadEvidence == true && evidence.EvidenceFile is IFormFile uploadedFile)
+        if (evidence is { UploadEvidence: true, EvidenceFile: IFormFile uploadedFile })
         {
-            using var stream = evidence.EvidenceFile.OpenReadStream();
-            var fileId = await fileService!.UploadFileAsync(stream, evidence.EvidenceFile.ContentType);
+            await using var stream = evidence.EvidenceFile.OpenReadStream();
+            var fileId = await fileService.UploadFileAsync(stream, evidence.EvidenceFile.ContentType);
             evidence.UploadedEvidenceFile = new(fileId, uploadedFile.FileName, uploadedFile.Length);
-            evidence.EvidenceFile = null;
         }
     }
 
+    public async Task ValidateAndUploadAsync<TModel>(Expression<Func<TModel, EvidenceUploadModel>> evidenceExpression, ViewDataDictionary viewData)
+    {
+        var expressionBuilder = new ModelExpressionBuilder<TModel, EvidenceUploadModel>(modelExpressionProvider, evidenceExpression, viewData);
+        var evidence = expressionBuilder.Model;
+
+        if (evidence.UploadEvidence == true && evidence.EvidenceFile is null && evidence.UploadedEvidenceFile is null)
+        {
+            var expression = expressionBuilder.GetModelExpressionFor(e => e.EvidenceFile);
+            viewData.ModelState.AddModelError(expression.Name, "Select a file");
+        }
+
+        await UploadAsync(evidence);
+    }
+
     public async Task DeleteUploadedFileAsync(UploadedEvidenceFile? evidenceFile)
     {
         if (evidenceFile is UploadedEvidenceFile file)
@@ -51,8 +55,8 @@ public class ModelExpressionBuilder<TContainer, TModel>(
     Expression<Func<TContainer, TModel>> modelExpressionFromContainer,
     ViewDataDictionary viewData)
 {
-    private ViewDataDictionary<TContainer> _typedViewData = new(viewData);
-    private Func<TContainer, TModel> _getModel = modelExpressionFromContainer.Compile();
+    private readonly ViewDataDictionary<TContainer> _typedViewData = new(viewData);
+    private readonly Func<TContainer, TModel> _getModel = modelExpressionFromContainer.Compile();
 
     public TModel Model => _getModel(_typedViewData.Model);
 
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Shared/Evidence/EvidenceUploadModel.cs b/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Shared/Evidence/EvidenceUploadModel.cs
diff --git a/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/ValidationExtensions.cs b/TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/ValidationExtensions.cs
