Add UploadEvidence/EvidenceFileLink view components (#2623)

Introduces `UploadEvidence` and `EvidenceFileLink` view components to
consolidate/unify upload evidence behaviour. Implemented initially in
Add Person/Edit Details journeys for review, and then will roll out to
other journeys once merged.

Extracts out:
* `EvidenceUploadModel` - the model fields involved in uploading an
evidence file
* `UploadedEvidenceFile` - a file that has already been uploaded and is
being displayed
* `EvidenceUploadManager` - contains the validation logic, uploads the
file and clears down already uploaded files

### Limitations
* `UploadEvidence` does not use `ModelExpression` to resolve model
fields to bind to, so the form keys are simply the base (i.e.
unprefixed) property names of `EvidenceUploadModel`, so the hosting
`PageModel` should not contain any field names that clash with the
following to avoid model binding issues:
  * `UploadEvidence`
  * `EvidenceFile` 
* `UploadedEvidenceFile` (including fields of `UploadedEvidenceFile`
i.e. `UploadedEvidenceFile.FileId`, `UploadedEvidenceFile.FileName`,
`UploadedEvidenceFile.FileSizeDescription`,
`UploadedEvidenceFile.PreviewUrl`)
* For the same reason, any `PageModel` cannot contain more than one
`EvidenceUploadModel` as the default model binder will not be able to
distinguish between them to model-bind to (will arbitrarily bind all
instances to the last mentioned values in the form collection)

I think these are reasonable limitations and unlikely to cause any
issues with the page structure as it currently stands.

### Checklist

-   [x] Attach to Trello card
-   [x] Rebased master
-   [x] Cleaned commit history
-   [x] Tested by running locally

Author: stusherwin

TeachingRecordSystem/src/TeachingRecordSystem.Core/Services/Files/BlobStorageFileService.cs

@@ -8,6 +8,7 @@ namespace TeachingRecordSystem.Core.Services.Files;
 public class BlobStorageFileService : IFileService
 {
     private const string UploadsContainerName = "uploads";
+
     private readonly BlobServiceClient _blobServiceClient;
     private readonly IHostEnvironment _hostEnvironment;
     private BlobContainerClient? _blobContainerClient;

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Extensions.cs

@@ -18,6 +18,7 @@
 using TeachingRecordSystem.SupportUi.Infrastructure.ModelBinding;
 using TeachingRecordSystem.SupportUi.Infrastructure.Security;
 using TeachingRecordSystem.SupportUi.Pages;
+using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 using TeachingRecordSystem.SupportUi.Services.AzureActiveDirectory;
 using TeachingRecordSystem.SupportUi.TagHelpers;
 using TeachingRecordSystem.WebCommon.Filters;
@@ -90,7 +91,9 @@ public static IServiceCollection AddSupportUiServices(this IServiceCollection se
             .AddTransient<RequireOpenAlertFilter>()
             .AddTransient<RedirectWithPersonIdFilter>()
             .AddSingleton<ITagHelperInitializer<FormTagHelper>, FormTagHelperInitializer>()
-            .AddSingleton<ITagHelperInitializer<TextInputTagHelper>, TextInputTagHelperInitializer>();
+            .AddSingleton<ITagHelperInitializer<TextInputTagHelper>, TextInputTagHelperInitializer>()
+            .AddTransient<EvidenceUploadManager>()
+            .AddScoped<SupportUiFormContext>();
 
         if (environment.IsProduction())
         {

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/AddPerson/AddPersonState.cs

@@ -1,4 +1,5 @@
 using System.Text.Json.Serialization;
+using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 
 namespace TeachingRecordSystem.SupportUi.Pages.Persons.AddPerson;
 
@@ -18,15 +19,17 @@ public class AddPersonState : IRegisterJourney
     public AddPersonFieldState<NationalInsuranceNumber> NationalInsuranceNumber { get; set; } = new("", null);
     public Gender? Gender { get; set; }
 
-    public AddPersonReasonOption? CreateReason { get; set; }
-    public string? CreateReasonDetail { get; set; }
-    public bool? UploadEvidence { get; set; }
-    public Guid? EvidenceFileId { get; set; }
-    public string? EvidenceFileName { get; set; }
-    public string? EvidenceFileSizeDescription { get; set; }
+    public AddPersonReasonOption? Reason { get; set; }
+    public string? ReasonDetail { get; set; }
+    public EvidenceUploadModel Evidence { get; set; } = new();
 
     public bool Initialized { get; set; }
 
+    [JsonIgnore]
+    public bool IsComplete =>
+        IsPersonalDetailsComplete &&
+        IsCreateReasonComplete;
+
     [JsonIgnore]
     public bool IsPersonalDetailsComplete =>
         FirstName is not null &&
@@ -35,15 +38,9 @@ LastName is not null &&
 
     [JsonIgnore]
     public bool IsCreateReasonComplete =>
-        CreateReason.HasValue &&
-        (CreateReason.Value is not AddPersonReasonOption.AnotherReason || CreateReasonDetail is not null) &&
-        UploadEvidence.HasValue &&
-        (UploadEvidence.Value is not true || EvidenceFileId.HasValue);
-
-    [JsonIgnore]
-    public bool IsComplete =>
-        IsPersonalDetailsComplete &&
-        IsCreateReasonComplete;
+        Reason.HasValue &&
+        (Reason is not AddPersonReasonOption.AnotherReason || ReasonDetail is not null) &&
+        Evidence.IsComplete;
 
     public void EnsureInitialized()
     {

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/AddPerson/CheckAnswers.cshtml

@@ -61,9 +61,9 @@
                 <govuk-summary-list>
                     <govuk-summary-list-row>
                         <govuk-summary-list-row-key>Reason for creating record</govuk-summary-list-row-key>
-                        <govuk-summary-list-row-value>@Model.CreateReason?.GetDisplayName()</govuk-summary-list-row-value>
+                        <govuk-summary-list-row-value>@Model.Reason?.GetDisplayName()</govuk-summary-list-row-value>
                         <govuk-summary-list-row-actions>
-                            <govuk-summary-list-row-action data-testid="change-create-reason-link" href=@Model.CreateReasonLink visually-hidden-text="reason">Change</govuk-summary-list-row-action>
+                            <govuk-summary-list-row-action data-testid="change-create-reason-link" href=@Model.ChangeReasonLink visually-hidden-text="reason">Change</govuk-summary-list-row-action>
                         </govuk-summary-list-row-actions>
                     </govuk-summary-list-row>
                     <govuk-summary-list-row>
@@ -79,23 +79,16 @@
                             }
                         </govuk-summary-list-row-value>
                         <govuk-summary-list-row-actions>
-                            <govuk-summary-list-row-action href=@Model.CreateReasonLink visually-hidden-text="reason details">Change</govuk-summary-list-row-action>
+                            <govuk-summary-list-row-action href=@Model.ChangeReasonLink visually-hidden-text="reason details">Change</govuk-summary-list-row-action>
                         </govuk-summary-list-row-actions>
                     </govuk-summary-list-row>
                     <govuk-summary-list-row>
                         <govuk-summary-list-row-key>Evidence</govuk-summary-list-row-key>
                         <govuk-summary-list-row-value>
-                            @if (Model.EvidenceFileUrl is not null)
-                            {
-                                <a href="@Model.EvidenceFileUrl" class="govuk-link" rel="noreferrer noopener" target="_blank">@($"{Model.EvidenceFileName} (opens in new tab)")</a>
-                            }
-                            else
-                            {
-                                <span use-empty-fallback></span>
-                            }
+                            <vc:evidence-file-link evidence-file="@Model.EvidenceFile" />
                         </govuk-summary-list-row-value>
                         <govuk-summary-list-row-actions>
-                            <govuk-summary-list-row-action href=@Model.CreateReasonLink visually-hidden-text="evidence">Change</govuk-summary-list-row-action>
+                            <govuk-summary-list-row-action href=@Model.ChangeReasonLink visually-hidden-text="evidence">Change</govuk-summary-list-row-action>
                         </govuk-summary-list-row-actions>
                     </govuk-summary-list-row>
                 </govuk-summary-list>

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/AddPerson/CheckAnswers.cshtml.cs

@@ -3,9 +3,8 @@
 using TeachingRecordSystem.Core.DataStore.Postgres;
 using TeachingRecordSystem.Core.DataStore.Postgres.Models;
 using TeachingRecordSystem.Core.Events.Legacy;
-using TeachingRecordSystem.Core.Services.Files;
 using TeachingRecordSystem.Core.Services.TrnGeneration;
-using TeachingRecordSystem.SupportUi.Pages.Persons.PersonDetail.EditDetails;
+using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 
 namespace TeachingRecordSystem.SupportUi.Pages.Persons.AddPerson;
 
@@ -14,9 +13,9 @@ public class CheckAnswersModel(
     TrsLinkGenerator linkGenerator,
     TrsDbContext dbContext,
     IClock clock,
-    IFileService fileService,
-    ITrnGenerator trnGenerator)
-    : CommonJourneyPage(dbContext, linkGenerator, fileService)
+    ITrnGenerator trnGenerator,
+    EvidenceUploadManager evidenceController)
+    : CommonJourneyPage(dbContext, linkGenerator, evidenceController)
 {
     public string? FirstName { get; set; }
     public string? MiddleName { get; set; }
@@ -25,24 +24,40 @@ public class CheckAnswersModel(
     public EmailAddress? EmailAddress { get; set; }
     public NationalInsuranceNumber? NationalInsuranceNumber { get; set; }
     public Gender? Gender { get; set; }
-    public EditDetailsNameChangeReasonOption? NameChangeReason { get; set; }
-    public AddPersonReasonOption? CreateReason { get; set; }
+    public AddPersonReasonOption? Reason { get; set; }
     public string? ReasonDetail { get; set; }
-    public Guid? EvidenceFileId { get; set; }
-    public string? EvidenceFileName { get; set; }
-    public string? EvidenceFileSizeDescription { get; set; }
-    public string? EvidenceFileUrl { get; set; }
+    public UploadedEvidenceFile? EvidenceFile { get; set; }
 
     public string Name => StringHelper.JoinNonEmpty(' ', FirstName, MiddleName, LastName);
 
     public string? ChangePersonalDetailsLink =>
         GetPageLink(AddPersonJourneyPage.PersonalDetails, true);
 
-    public string? CreateReasonLink =>
+    public string? ChangeReasonLink =>
         GetPageLink(AddPersonJourneyPage.Reason, true);
 
     public string BackLink => GetPageLink(AddPersonJourneyPage.Reason);
 
+    public override void OnPageHandlerExecuting(PageHandlerExecutingContext context)
+    {
+        if (!JourneyInstance!.State.IsComplete && NextIncompletePage < AddPersonJourneyPage.CheckAnswers)
+        {
+            context.Result = Redirect(GetPageLink(NextIncompletePage));
+            return;
+        }
+
+        FirstName = JourneyInstance!.State.FirstName;
+        MiddleName = JourneyInstance.State.MiddleName;
+        LastName = JourneyInstance.State.LastName;
+        DateOfBirth = JourneyInstance.State.DateOfBirth;
+        EmailAddress = JourneyInstance.State.EmailAddress.Parsed;
+        NationalInsuranceNumber = JourneyInstance.State.NationalInsuranceNumber.Parsed;
+        Gender = JourneyInstance.State.Gender;
+        Reason = JourneyInstance.State.Reason;
+        ReasonDetail = JourneyInstance.State.ReasonDetail;
+        EvidenceFile = JourneyInstance.State.Evidence.UploadedEvidenceFile;
+    }
+
     public void OnGet()
     {
     }
@@ -71,15 +86,9 @@ public async Task<IActionResult> OnPostAsync()
             RaisedBy = User.GetUserId(),
             PersonId = person.PersonId,
             PersonAttributes = personAttributes,
-            CreateReason = CreateReason?.GetDisplayName(),
+            CreateReason = Reason?.GetDisplayName(),
             CreateReasonDetail = ReasonDetail,
-            EvidenceFile = EvidenceFileId is Guid detailsFileId
-                ? new EventModels.File()
-                {
-                    FileId = detailsFileId,
-                    Name = EvidenceFileName!
-                }
-                : null,
+            EvidenceFile = EvidenceFile?.ToEventModel(),
             TrnRequestMetadata = null
         };
 
@@ -95,28 +104,4 @@ public async Task<IActionResult> OnPostAsync()
 
         return Redirect(LinkGenerator.PersonDetail(person.PersonId));
     }
-
-    protected override async Task OnPageHandlerExecutingAsync(PageHandlerExecutingContext context)
-    {
-        if (!JourneyInstance!.State.IsComplete && NextIncompletePage < AddPersonJourneyPage.CheckAnswers)
-        {
-            context.Result = Redirect(GetPageLink(NextIncompletePage));
-            return;
-        }
-
-        FirstName = JourneyInstance!.State.FirstName;
-        MiddleName = JourneyInstance.State.MiddleName;
-        LastName = JourneyInstance.State.LastName;
-        DateOfBirth = JourneyInstance.State.DateOfBirth;
-        EmailAddress = JourneyInstance.State.EmailAddress.Parsed;
-        NationalInsuranceNumber = JourneyInstance.State.NationalInsuranceNumber.Parsed;
-        Gender = JourneyInstance.State.Gender;
-        CreateReason = JourneyInstance.State.CreateReason;
-        ReasonDetail = JourneyInstance.State.CreateReasonDetail;
-        EvidenceFileId = JourneyInstance.State.EvidenceFileId;
-        EvidenceFileName = JourneyInstance.State.EvidenceFileName;
-        EvidenceFileUrl = JourneyInstance.State.EvidenceFileId is not null ?
-            await FileService.GetFileUrlAsync(JourneyInstance.State.EvidenceFileId.Value, FileUploadDefaults.FileUrlExpiry) :
-            null;
-    }
 }

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/AddPerson/CommonJourneyPage.cs

@@ -2,31 +2,27 @@
 using Microsoft.AspNetCore.Mvc.Filters;
 using Microsoft.AspNetCore.Mvc.RazorPages;
 using TeachingRecordSystem.Core.DataStore.Postgres;
-using TeachingRecordSystem.Core.Services.Files;
+using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 
 namespace TeachingRecordSystem.SupportUi.Pages.Persons.AddPerson;
 
 public abstract class CommonJourneyPage(
     TrsDbContext dbContext,
     TrsLinkGenerator linkGenerator,
-    IFileService fileService) : PageModel
+    EvidenceUploadManager evidenceController) : PageModel
 {
     public JourneyInstance<AddPersonState>? JourneyInstance { get; set; }
 
     protected TrsDbContext DbContext { get; } = dbContext;
     protected TrsLinkGenerator LinkGenerator { get; } = linkGenerator;
-    protected IFileService FileService { get; } = fileService;
+    protected EvidenceUploadManager EvidenceController { get; } = evidenceController;
 
     [FromQuery]
     public bool FromCheckAnswers { get; set; }
 
     public async Task<IActionResult> OnPostCancelAsync()
     {
-        if (JourneyInstance!.State.EvidenceFileId.HasValue)
-        {
-            await FileService.DeleteFileAsync(JourneyInstance!.State.EvidenceFileId.Value);
-        }
-
+        await EvidenceController.DeleteUploadedFileAsync(JourneyInstance!.State.Evidence.UploadedEvidenceFile);
         await JourneyInstance!.DeleteAsync();
         return Redirect(LinkGenerator.PersonCreate());
     }
@@ -66,9 +62,9 @@ public override async Task OnPageHandlerExecutionAsync(PageHandlerExecutingConte
         }
     }
 
-    protected virtual Task OnPageHandlerExecutingAsync(PageHandlerExecutingContext context)
+    public virtual Task OnPageHandlerExecutingAsync(PageHandlerExecutingContext context)
         => Task.CompletedTask;
 
-    protected virtual Task OnPageHandlerExecutedAsync(PageHandlerExecutedContext context)
+    public virtual Task OnPageHandlerExecutedAsync(PageHandlerExecutedContext context)
         => Task.CompletedTask;
 }

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/AddPerson/PersonalDetails.cshtml.cs

@@ -2,7 +2,7 @@
 using Microsoft.AspNetCore.Mvc;
 using TeachingRecordSystem.Core.DataStore.Postgres;
 using TeachingRecordSystem.Core.DataStore.Postgres.Models;
-using TeachingRecordSystem.Core.Services.Files;
+using TeachingRecordSystem.SupportUi.Pages.Shared.Evidence;
 
 namespace TeachingRecordSystem.SupportUi.Pages.Persons.AddPerson;
 
@@ -11,8 +11,8 @@ public class PersonalDetailsModel(
     TrsDbContext dbContext,
     IClock clock,
     TrsLinkGenerator linkGenerator,
-    IFileService fileService)
-    : CommonJourneyPage(dbContext, linkGenerator, fileService)
+    EvidenceUploadManager evidenceController)
+    : CommonJourneyPage(dbContext, linkGenerator, evidenceController)
 {
     [BindProperty]
     [Display(Name = "First name")]

TeachingRecordSystem/src/TeachingRecordSystem.SupportUi/Pages/Persons/AddPerson/Reason.cshtml

@@ -13,7 +13,7 @@
     <div class="govuk-grid-column-full">
         <form action=@LinkGenerator.PersonCreateCreateReason(Model.JourneyInstance!.InstanceId, Model.FromCheckAnswers) method="post" data-testid="submit-form">
             <span class="govuk-caption-l" data-testid="create-reason-caption">Create a record</span>
-            <govuk-radios for="CreateReason" data-testid="create-reason-options">
+            <govuk-radios for="Reason" data-testid="create-reason-options">
                 <govuk-radios-fieldset>
                     <govuk-radios-fieldset-legend class="govuk-fieldset__legend--l" is-page-heading="true" data-testid="create-reason-options-legend"/>
                     <govuk-radios-item value="@AddPersonReasonOption.MandatoryQualification">
@@ -29,42 +29,13 @@
                         @AddPersonReasonOption.AnotherReason.GetDisplayName()
 
                         <govuk-radios-item-conditional data-testid="create-reason-detail">
-                            <govuk-character-count for="CreateReasonDetail" max-length="FileUploadDefaults.DetailMaxCharacterCount" rows="FileUploadDefaults.DetailTextAreaMinimumRows" />
+                            <govuk-character-count for="ReasonDetail" max-length="FileUploadDefaults.DetailMaxCharacterCount" rows="FileUploadDefaults.DetailTextAreaMinimumRows" />
                         </govuk-radios-item-conditional>
                     </govuk-radios-item>
                 </govuk-radios-fieldset>
             </govuk-radios>
 
-            <govuk-radios for="UploadEvidence" data-testid="upload-evidence-options">
-                <govuk-radios-fieldset>
-                    <govuk-radios-fieldset-legend class="govuk-fieldset__legend--m" data-testid="upload-evidence-options-legend" />
-                    <govuk-radios-item value="@true">
-                        Yes
-                        <govuk-radios-item-conditional>
-                            @if (Model.EvidenceFileId is not null)
-                            {
-                                <span class="govuk-caption-m">Currently uploaded file</span>
-                                <p class="govuk-body">
-                                    <a href="@Model.EvidenceFileUrl" class="govuk-link" rel="noreferrer noopener" target="_blank" data-testid="uploaded-evidence-file-link">@($"{Model.EvidenceFileName} ({Model.EvidenceFileSizeDescription})")</a>
-                                </p>
-                                <input type="hidden" asp-for="EvidenceFileId" />
-                                <input type="hidden" asp-for="EvidenceFileName" />
-                                <input type="hidden" asp-for="EvidenceFileSizeDescription" />
-                                <input type="hidden" asp-for="EvidenceFileUrl" />
-                            }
-                            <govuk-file-upload for="EvidenceFile"
-                                               label-class="govuk-label--m"
-                                               input-accept=".bmp, .csv, .doc, .docx, .eml, .jpeg, .jpg, .mbox, .msg, .ods, .odt, .pdf, .png, .tif, .txt, .xls, .xlsx">
-                                <govuk-file-upload-label>Upload a file</govuk-file-upload-label>
-                                <govuk-file-upload-hint>Must be smaller than 50MB</govuk-file-upload-hint>
-                            </govuk-file-upload>
-                        </govuk-radios-item-conditional>
-                    </govuk-radios-item>
-                    <govuk-radios-item value="@false">
-                        No
-                    </govuk-radios-item>
-                </govuk-radios-fieldset>
-            </govuk-radios>
+            <vc:upload-evidence evidence="@Model.Evidence" expression="Evidence" />
 
             <div class="govuk-button-group">
                 <govuk-button type="submit" data-testid="continue-button">Continue</govuk-button>