Merge pull request #1471 from bcgov/enhancement/prevent-save-draft

added guards to prevent user from submitting multiple draft eligibili…

Author: SoLetsDev

src/ECER.Clients.RegistryPortal/ECER.Clients.RegistryPortal.Server/ICRA/ICRAEligibilitiesEndpoints.cs

@@ -157,7 +157,8 @@ public enum ICRAStatus
   Ineligible,
   InReview,
   ReadyforReview,
-  Submitted
+  Submitted,
+  ReadyforAssessment
 }
 
 public record ICRAEligibilitySubmissionRequest(string Id);

src/ECER.Clients.RegistryPortal/ecer.clients.registryportal.client/src/router.ts

@@ -8,6 +8,7 @@ import { useFormStore } from "./store/form";
 import { useMessageStore } from "./store/message";
 import { useWizardStore } from "./store/wizard";
 import { useConfigStore } from "./store/config";
+import { useIcraStore } from "./store/icra";
 
 const router = createRouter({
   history: createWebHistory(),
@@ -294,6 +295,16 @@ const router = createRouter({
       path: "/icra-eligibility",
       component: () => import("./components/pages/IcraEligibility.vue"),
       meta: { requiresAuth: true, requiresVerification: true, requiresICRAFeature: true },
+      beforeEnter: (to, from, next) => {
+        //guard to prevent users from coming here if they have a submitted in-progress ICRA Eligibility application
+        const icraStore = useIcraStore();
+        if (icraStore.hasSubmittedIcraEligibility) {
+          console.warn("User has a submitted ICRA Eligibility application, redirecting to home page.");
+          next({ path: "/" });
+        } else {
+          next();
+        }
+      },
     },
     {
       path: "/icra-eligibility/check",

src/ECER.Clients.RegistryPortal/ecer.clients.registryportal.client/src/store/icra.ts

@@ -36,6 +36,14 @@ export const useIcraStore = defineStore("icra", {
     icraEligibilityStatus(state): Components.Schemas.ICRAStatus | undefined {
       return state.icraEligibility?.status;
     },
+    hasSubmittedIcraEligibility(state): boolean {
+      return (
+        state.icraEligibility?.status === "Submitted" ||
+        state.icraEligibility?.status === "InReview" ||
+        state.icraEligibility?.status === "ReadyforReview" ||
+        state.icraEligibility?.status === "ReadyforAssessment"
+      );
+    },
   },
   actions: {
     async fetchIcraEligibilities() {

src/ECER.Clients.RegistryPortal/ecer.clients.registryportal.client/src/types/openapi.d.ts

@@ -330,7 +330,7 @@ declare namespace Components {
         export interface ICRAEligibilitySubmissionRequest {
             id?: string | null;
         }
-        export type ICRAStatus = "Active" | "Draft" | "Eligible" | "Inactive" | "Ineligible" | "InReview" | "ReadyforReview" | "Submitted";
+        export type ICRAStatus = "Active" | "Draft" | "Eligible" | "Inactive" | "Ineligible" | "InReview" | "ReadyforReview" | "Submitted" | "ReadyforAssessment";
         export interface IdentificationType {
             id?: string | null;
             name?: string | null;

src/ECER.Managers.Registry.Contract/ICRA/Contract.cs

@@ -29,6 +29,7 @@ public enum SubmissionError
   DraftIcraEligibilityNotFound,
   DraftIcraEligibilityValidationFailed
 }
+
 public record ICRAEligibility()
 {
   public string? Id { get; set; }
@@ -86,5 +87,6 @@ public enum ICRAStatus
   Ineligible,
   InReview,
   ReadyforReview,
-  Submitted
+  Submitted,
+  ReadyforAssessment
 }

src/ECER.Managers.Registry/ICRAEligibilityHandlers.cs

@@ -1,12 +1,9 @@
 using AutoMapper;
+using ECER.Engines.Validation.ICRA;
 using ECER.Infrastructure.Common;
-using ECER.Managers.Registry.Contract.Applications;
 using ECER.Managers.Registry.Contract.ICRA;
-using ECER.Resources.Documents.Applications;
 using ECER.Resources.Documents.ICRA;
 using MediatR;
-using ECER.Engines.Validation.ICRA;
-
 
 namespace ECER.Managers.Registry;
 
@@ -21,7 +18,6 @@ public class ICRAEligibilityHandlers(
     IRequestHandler<ICRAEligibilitiesQuery, ICRAEligibilitiesQueryResults>,
     IRequestHandler<SubmitICRAEligibilityCommand, SubmitICRAEligibilityResult>
 {
-
   public async Task<Contract.ICRA.ICRAEligibility?> Handle(SaveICRAEligibilityCommand request, CancellationToken cancellationToken)
   {
     ArgumentNullException.ThrowIfNull(request);
@@ -30,14 +26,25 @@ public class ICRAEligibilityHandlers(
       var icraEligibilities = await iCRARepository.Query(new ICRAQuery
       {
         ByApplicantId = request.eligibility.ApplicantId,
-        ByStatus = [Resources.Documents.ICRA.ICRAStatus.Draft] // IDE0028: already simplified
+        ByStatus = new Resources.Documents.ICRA.ICRAStatus[] {
+          Resources.Documents.ICRA.ICRAStatus.Draft,
+          Resources.Documents.ICRA.ICRAStatus.Submitted,
+          Resources.Documents.ICRA.ICRAStatus.InReview,
+          Resources.Documents.ICRA.ICRAStatus.ReadyforReview,
+          Resources.Documents.ICRA.ICRAStatus.ReadyforAssessment
+        }
       }, cancellationToken);
 
-      var existingDraftICRA = icraEligibilities.FirstOrDefault();
-      if (existingDraftICRA != null)
+      //this checks for any submitted Icra eligibilities
+      if (icraEligibilities.Any(e => e.Status != Resources.Documents.ICRA.ICRAStatus.Draft))
+      {
+        throw new InvalidOperationException($"Applicant id: {request.eligibility.ApplicantId} has a submitted Icra eligibility assessment in progress. A new draft cannot be created.");
+      }
+
+      if (icraEligibilities.Any(e => e.Status == Resources.Documents.ICRA.ICRAStatus.Draft))
       {
         // user already has a draft icra eligibility
-        throw new InvalidOperationException($"User already has a draft ICRA with id '{existingDraftICRA.Id}'");
+        throw new InvalidOperationException($"Applicant id: {request.eligibility.ApplicantId} has a draft ICRA in progress. A new draft cannot be created");
       }
     }
     var iCRAEligibilityId = await iCRARepository.Save(mapper.Map<Resources.Documents.ICRA.ICRAEligibility>(request.eligibility)!, cancellationToken);
@@ -62,7 +69,8 @@ public async Task<SubmitICRAEligibilityResult> Handle(SubmitICRAEligibilityComma
         Resources.Documents.ICRA.ICRAStatus.Draft,
         Resources.Documents.ICRA.ICRAStatus.Submitted,
         Resources.Documents.ICRA.ICRAStatus.InReview,
-        Resources.Documents.ICRA.ICRAStatus.ReadyforReview
+        Resources.Documents.ICRA.ICRAStatus.ReadyforReview,
+        Resources.Documents.ICRA.ICRAStatus.ReadyforAssessment
       }
     }, cancellationToken);
 
@@ -90,7 +98,6 @@ public async Task<SubmitICRAEligibilityResult> Handle(SubmitICRAEligibilityComma
     return new SubmitICRAEligibilityResult { Eligibility = mapper.Map<Contract.ICRA.ICRAEligibility>(fresh.SingleOrDefault()) };
   }
 
-
   public async Task<ICRAEligibilitiesQueryResults> Handle(ICRAEligibilitiesQuery request, CancellationToken cancellationToken)
   {
     ArgumentNullException.ThrowIfNull(request);
@@ -103,5 +110,4 @@ public async Task<ICRAEligibilitiesQueryResults> Handle(ICRAEligibilitiesQuery r
     }, cancellationToken);
     return new ICRAEligibilitiesQueryResults(mapper.Map<IEnumerable<Contract.ICRA.ICRAEligibility>>(eligibilities)!);
   }
-
 }

src/ECER.Resources.Documents/ICRA/ICRARepository.cs

@@ -9,7 +9,6 @@ namespace ECER.Resources.Documents.ICRA;
 
 internal sealed partial class ICRARepository : IICRARepository
 {
-
   private readonly EcerContext context;
   private readonly IMapper mapper;
   private readonly IObjecStorageProvider objectStorageProvider;
@@ -74,7 +73,7 @@ public async Task<string> Save(ICRAEligibility iCRAEligibility, CancellationToke
     else
     {
       var existingIcraEligibility = context.ecer_ICRAEligibilityAssessmentSet.SingleOrDefault(c => c.ecer_ICRAEligibilityAssessmentId == icraEligibility.ecer_ICRAEligibilityAssessmentId);
-      if (existingIcraEligibility == null || existingIcraEligibility.StatusCode!=ecer_ICRAEligibilityAssessment_StatusCode.Draft) throw new InvalidOperationException($"ecer_ICRAEligibilityAssessmentId '{icraEligibility.ecer_ICRAEligibilityAssessmentId}' not found or is not draft!");
+      if (existingIcraEligibility == null || existingIcraEligibility.StatusCode != ecer_ICRAEligibilityAssessment_StatusCode.Draft) throw new InvalidOperationException($"ecer_ICRAEligibilityAssessmentId '{icraEligibility.ecer_ICRAEligibilityAssessmentId}' not found or is not draft!");
 
       if (icraEligibility.ecer_DateSigned.HasValue && existingIcraEligibility.ecer_DateSigned.HasValue) icraEligibility.ecer_DateSigned = existingIcraEligibility.ecer_DateSigned;
 
@@ -102,4 +101,17 @@ public async Task<string> Submit(string icraEligibilityId, CancellationToken can
     context.SaveChanges();
     return icraEligibilityId;
   }
+
+  //This method is used for our unit tests to disable eligibility applications so multiple tests so not conflict
+  public async Task<string> SetIneligibleForUnitTests(string icraEligibilityId, CancellationToken cancellationToken)
+  {
+    await Task.CompletedTask;
+    var icra = context.ecer_ICRAEligibilityAssessmentSet.FirstOrDefault(d => d.ecer_ICRAEligibilityAssessmentId == Guid.Parse(icraEligibilityId) && d.ecer_ApplicantIdName.Contains("TEST"));
+    if (icra == null) throw new InvalidOperationException($"ICRA Eligibility '{icraEligibilityId}' not found or this application does not belong to a test account");
+
+    icra.StatusCode = ecer_ICRAEligibilityAssessment_StatusCode.Ineligible;
+    context.UpdateObject(icra);
+    context.SaveChanges();
+    return icraEligibilityId;
+  }
 }

src/ECER.Resources.Documents/ICRA/IICRARepository.cs

@@ -7,6 +7,8 @@ public interface IICRARepository
   Task<string> Save(ICRAEligibility iCRAEligibility, CancellationToken cancellationToken);
 
   Task<string> Submit(string icraEligibilityId, CancellationToken cancellationToken);
+
+  Task<string> SetIneligibleForUnitTests(string icraEligibilityId, CancellationToken cancellationToken);
 }
 
 public record ICRAQuery
@@ -73,5 +75,6 @@ public enum ICRAStatus
   Ineligible,
   InReview,
   ReadyforReview,
-  Submitted
+  Submitted,
+  ReadyforAssessment
 }