chore: add alert in summary when sow not uploaded

bcgov · Oct 3, 2024 · 52db2da · 52db2da
1 parent 018dc75
commit 52db2da
Show file tree

Hide file tree

Showing 5 changed files with 341 additions and 79 deletions.
diff --git a/app/components/Review/Accordion.tsx b/app/components/Review/Accordion.tsx
@@ -6,6 +6,7 @@ import Link from 'next/link';
 import { FontAwesomeIcon } from '@fortawesome/react-fontawesome';
 import { faMinus, faPen, faPlus } from '@fortawesome/free-solid-svg-icons';
 import CbcRecordLock from 'components/Analyst/CBC/CbcRecordLock';
+import { Tooltip } from '@mui/material';
 import AlertIcon from './AlertIcon';
 
 export function getToggledState(
@@ -64,13 +65,18 @@ const StyledLink = styled(Link)`
   text-decoration: none;
 `;
 
+const StyledTooltip = styled(Tooltip)`
+  cursor: pointer;
+`;
+
 const Accordion = ({
   allowAnalystEdit,
   children,
   defaultToggled,
   isCBC,
   cbcId,
   error,
+  sectionErrors,
   name,
   onToggle,
   toggled,
@@ -131,9 +137,11 @@ const Accordion = ({
             ))}
 
           {error && (
-            <StyledAlert>
-              <AlertIcon />
-            </StyledAlert>
+            <StyledTooltip title={sectionErrors.join('\n')} placement="top">
+              <StyledAlert data-testid="styled-alert">
+                <AlertIcon />
+              </StyledAlert>
+            </StyledTooltip>
           )}
           <button type="button" onClick={handleToggle}>
             {isToggled ? (

diff --git a/app/components/Review/ReviewSectionField.tsx b/app/components/Review/ReviewSectionField.tsx
@@ -16,6 +16,7 @@ const ReviewSectionField: React.FC<FieldProps> = (props) => {
   const pageName = idSchema.$id?.split('_')?.[1];
   const formErrorSchema = formContext?.formErrorSchema ?? formContext.errors;
   const hasFormContextError = formErrorSchema?.[pageName];
+  const sectionErrors = hasFormContextError?.__errors;
   const hasErrors = useMemo(
     () => Object.keys(errorSchema || {}).length > 0 || !!hasFormContextError,
     [errorSchema, hasFormContextError]
@@ -33,6 +34,7 @@ const ReviewSectionField: React.FC<FieldProps> = (props) => {
       cbcId={formContext.cbcId}
       isCBC={formContext.isCBC}
       error={hasErrors}
+      sectionErrors={sectionErrors}
       title={schema.title}
       allowAnalystEdit={allowAnalystEdit}
       recordLocked={formContext.recordLocked}

diff --git a/app/lib/helpers/ccbcSummaryGenerateFormData.tsx b/app/lib/helpers/ccbcSummaryGenerateFormData.tsx
@@ -1,3 +1,5 @@
+import review from 'formSchema/analyst/summary/review';
+
 const findScreeningAssessment = (assessments) => {
   return assessments.nodes.find(
     (assessment) => assessment.assessmentDataType === 'screening'
@@ -128,91 +130,116 @@ const getCommunities = (communities) => {
   };
 };
 
+const getSowErrors = (sowData, schema, formDataSource) => {
+  if (sowData?.length) return null;
+  const errors = {};
+  Object.entries(schema?.properties || {}).forEach(([parentKey, value]) => {
+    const sectionSchema = value['properties'];
+    Object.keys(sectionSchema || {}).forEach((key) => {
+      if (formDataSource[key] === 'SOW') {
+        errors[parentKey] = errors[parentKey] || {
+          __errors: [
+            'Highlighted cells are null because SOW Excel table has not been uploaded in the portal',
+          ],
+        };
+        errors[parentKey][key] = {
+          __errors: ['SOW excel table has not been uploaded in the portal'],
+        };
+      }
+    });
+  });
+
+  return errors;
+};
+
 const getSowData = (sowData, baseSowData) => {
   const communitiesData = getCommunities(
     sowData?.nodes[0]?.sowTab8SBySowId?.nodes[0]?.jsonData?.geoNames
   );
-  const errors = {}; // errors may get added later
   const communities =
     sowData?.nodes[0]?.sowTab8SBySowId?.nodes[0]?.jsonData?.communitiesNumber;
   const indigenousCommunities =
     sowData?.nodes[0]?.sowTab8SBySowId?.nodes[0]?.jsonData
       ?.indigenousCommunitiesNumber;
-  return {
-    formData: {
-      counts: {
-        communities,
-        benefitingCommunities: communitiesData?.benefitingCommunities,
-        indigenousCommunities,
-        nonIndigenousCommunities:
-          communities && indigenousCommunities
-            ? communities - indigenousCommunities
-            : communities,
-        benefitingIndigenousCommunities:
-          communitiesData?.benefitingIndigenousCommunities,
-        totalHouseholdsImpacted:
-          sowData?.nodes[0]?.sowTab1SBySowId?.nodes[0]?.jsonData
-            ?.numberOfHouseholds,
-        numberOfIndigenousHouseholds:
-          sowData?.nodes[0]?.sowTab1SBySowId?.nodes[0]?.jsonData
-            ?.householdsImpactedIndigenous,
-      },
-      funding: {
-        bcFundingRequested:
-          sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
-            ?.amountRequestedFromProvince,
-        federalFunding:
-          sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
-            ?.amountRequestedFromFederalGovernment,
-        fundingRequestedCcbc:
-          sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
-            ?.totalFundingRequestedCCBC,
-        applicantAmount:
-          sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
-            ?.totalApplicantContribution,
-        cibFunding:
-          sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
-            ?.totalInfrastructureBankFunding,
-        fhnaFunding:
-          sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
-            ?.totalFNHAFunding,
-        otherFunding:
-          sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
-            ?.fundingFromAllOtherSources,
-        totalProjectBudget:
-          sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
-            ?.totalProjectCost,
-      },
-      eventsAndDates: {
-        effectiveStartDate: sowData?.nodes[0]?.jsonData?.effectiveStartDate,
-        proposedStartDate: sowData?.nodes[0]?.jsonData?.projectStartDate,
-        proposedCompletionDate:
-          sowData?.nodes[0]?.jsonData?.projectCompletionDate,
-        dateAgreementSigned:
-          baseSowData?.nodes[0]?.jsonData?.dateFundingAgreementSigned,
-      },
+  const formData = {
+    counts: {
+      communities,
+      benefitingCommunities: communitiesData?.benefitingCommunities,
+      indigenousCommunities,
+      nonIndigenousCommunities:
+        communities && indigenousCommunities
+          ? communities - indigenousCommunities
+          : communities,
+      benefitingIndigenousCommunities:
+        communitiesData?.benefitingIndigenousCommunities,
+      totalHouseholdsImpacted:
+        sowData?.nodes[0]?.sowTab1SBySowId?.nodes[0]?.jsonData
+          ?.numberOfHouseholds,
+      numberOfIndigenousHouseholds:
+        sowData?.nodes[0]?.sowTab1SBySowId?.nodes[0]?.jsonData
+          ?.householdsImpactedIndigenous,
     },
-    formDataSource: {
-      communities: 'SOW',
-      benefitingCommunities: 'SOW',
-      indigenousCommunities: 'SOW',
-      nonIndigenousCommunities: 'SOW',
-      benefitingIndigenousCommunities: 'SOW',
-      totalHouseholdsImpacted: 'SOW',
-      numberOfIndigenousHouseholds: 'SOW',
-      bcFundingRequested: 'SOW',
-      federalFunding: 'SOW',
-      fundingRequestedCcbc: 'SOW',
-      applicantAmount: 'SOW',
-      cibFunding: 'SOW',
-      fhnaFunding: 'SOW',
-      otherFunding: 'SOW',
-      totalProjectBudget: 'SOW',
-      effectiveStartDate: 'SOW',
-      proposedStartDate: 'SOW',
-      proposedCompletionDate: 'SOW',
-      dateAgreementSigned: 'SOW',
+    funding: {
+      bcFundingRequested:
+        sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
+          ?.amountRequestedFromProvince,
+      federalFunding:
+        sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
+          ?.amountRequestedFromFederalGovernment,
+      fundingRequestedCcbc:
+        sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
+          ?.totalFundingRequestedCCBC,
+      applicantAmount:
+        sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
+          ?.totalApplicantContribution,
+      cibFunding:
+        sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
+          ?.totalInfrastructureBankFunding,
+      fhnaFunding:
+        sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
+          ?.totalFNHAFunding,
+      otherFunding:
+        sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
+          ?.fundingFromAllOtherSources,
+      totalProjectBudget:
+        sowData?.nodes[0]?.sowTab7SBySowId?.nodes[0]?.jsonData?.summaryTable
+          ?.totalProjectCost,
+    },
+    eventsAndDates: {
+      effectiveStartDate: sowData?.nodes[0]?.jsonData?.effectiveStartDate,
+      proposedStartDate: sowData?.nodes[0]?.jsonData?.projectStartDate,
+      proposedCompletionDate:
+        sowData?.nodes[0]?.jsonData?.projectCompletionDate,
+      dateAgreementSigned:
+        baseSowData?.nodes[0]?.jsonData?.dateFundingAgreementSigned,
     },
+  };
+  const formDataSource = {
+    communities: 'SOW',
+    benefitingCommunities: 'SOW',
+    indigenousCommunities: 'SOW',
+    nonIndigenousCommunities: 'SOW',
+    benefitingIndigenousCommunities: 'SOW',
+    totalHouseholdsImpacted: 'SOW',
+    numberOfIndigenousHouseholds: 'SOW',
+    bcFundingRequested: 'SOW',
+    federalFunding: 'SOW',
+    fundingRequestedCcbc: 'SOW',
+    applicantAmount: 'SOW',
+    cibFunding: 'SOW',
+    fhnaFunding: 'SOW',
+    otherFunding: 'SOW',
+    totalProjectBudget: 'SOW',
+    effectiveStartDate: 'SOW',
+    proposedStartDate: 'SOW',
+    proposedCompletionDate: 'SOW',
+    dateAgreementSigned: 'SOW',
+  };
+  const errors = getSowErrors(sowData?.nodes, review, formDataSource);
+
+  return {
+    formData,
+    formDataSource,
     errors,
   };
 };

diff --git a/app/pages/analyst/application/[applicationId]/summary.tsx b/app/pages/analyst/application/[applicationId]/summary.tsx
@@ -204,7 +204,6 @@ const Summary = ({
             isEditable: false,
             errors,
             formDataSource,
-            showErrorHint: true,
           }}
           formData={formData}
           handleChange={() => {}}