Fix section complete logic (#633)

LucasCairns · web-flow · commit d1b602bd76d2 · 2024-10-11T14:38:11.000+01:00
diff --git a/app/controllers/saveAndContinueController.test.ts b/app/controllers/saveAndContinueController.test.ts
@@ -1,11 +1,11 @@
 import FormWizard from 'hmpo-form-wizard'
 import { Response } from 'express'
-import Controller from './saveAndContinueController'
+import Controller, { Progress, SectionCompleteRule } from './saveAndContinueController'
 
 describe('SaveAndContinueController', () => {
   const controller = new Controller({ route: '/' })
 
-  describe('getSectionProgress', () => {
+  describe('getSectionProgressAnswers', () => {
     const conditionFn = jest.fn()
 
     const buildRequestWith = ({
@@ -41,7 +41,7 @@ describe('SaveAndContinueController', () => {
         ],
       })
 
-      controller.getSectionProgress(req, true)
+      controller.getSectionProgressAnswers(req, true)
 
       expect(conditionFn).toHaveBeenCalledTimes(3)
     })
@@ -51,7 +51,7 @@ describe('SaveAndContinueController', () => {
         sectionProgressRules: [{ fieldCode: 'foo_section_complete', conditionFn }],
       })
 
-      controller.getSectionProgress(req, true)
+      controller.getSectionProgressAnswers(req, true)
 
       expect(conditionFn).toHaveBeenLastCalledWith(true, {})
     })
@@ -61,7 +61,7 @@ describe('SaveAndContinueController', () => {
         sectionProgressRules: [{ fieldCode: 'foo_section_complete', conditionFn }],
       })
 
-      controller.getSectionProgress(req, false)
+      controller.getSectionProgressAnswers(req, false)
 
       expect(conditionFn).toHaveBeenLastCalledWith(false, {})
     })
@@ -73,7 +73,7 @@ describe('SaveAndContinueController', () => {
         formValues,
       })
 
-      controller.getSectionProgress(req, true)
+      controller.getSectionProgressAnswers(req, true)
 
       expect(conditionFn).toHaveBeenLastCalledWith(true, formValues)
     })
@@ -87,10 +87,9 @@ describe('SaveAndContinueController', () => {
         ],
       })
 
-      const result = controller.getSectionProgress(req, true)
+      const result = controller.getSectionProgressAnswers(req, true)
 
       expect(result).toEqual({
-        assessment_complete: 'YES',
         foo_section_complete: 'YES',
         bar_section_complete: 'YES',
         baz_section_complete: 'YES',
@@ -106,17 +105,82 @@ describe('SaveAndContinueController', () => {
         ],
       })
 
-      const result = controller.getSectionProgress(req, true)
+      const result = controller.getSectionProgressAnswers(req, true)
 
       expect(result).toEqual({
-        assessment_complete: 'NO',
         foo_section_complete: 'YES',
         bar_section_complete: 'NO',
         baz_section_complete: 'YES',
       })
     })
   })
 
+  describe('getAssessmentProgress', () => {
+    it('marks the section as complete if all subsections are complete', () => {
+      const answers: FormWizard.Answers = {
+        foo_section_complete: 'YES',
+        bar_section_complete: 'YES',
+      }
+
+      const sectionCompleteRules: SectionCompleteRule[] = [
+        { sectionName: 'test_section', fieldCodes: ['foo_section_complete', 'bar_section_complete'] },
+      ]
+
+      const result = controller.getAssessmentProgress(answers, sectionCompleteRules)
+
+      expect(result).toEqual({
+        test_section: true,
+      })
+    })
+
+    it('marks the section as incomplete is a subsection is incomplete', () => {
+      const answers: FormWizard.Answers = {
+        foo_section_complete: 'YES',
+        bar_section_complete: 'NO',
+      }
+
+      const sectionCompleteRules: SectionCompleteRule[] = [
+        { sectionName: 'test_section', fieldCodes: ['foo_section_complete', 'bar_section_complete'] },
+      ]
+
+      const result = controller.getAssessmentProgress(answers, sectionCompleteRules)
+
+      expect(result).toEqual({
+        test_section: false,
+      })
+    })
+  })
+
+  describe('getAssessmentCompletionAnswers', () => {
+    it('marks the assessment as complete if all sections are complete', () => {
+      const progress: Progress = {
+        foo_section_complete: true,
+        bar_section_complete: true,
+        baz_section_complete: true,
+      }
+
+      const result = controller.getAssessmentCompletionAnswers(progress)
+
+      expect(result).toEqual({
+        assessment_complete: 'YES',
+      })
+    })
+
+    it('marks the assessment as incomplete if a section is incomplete', () => {
+      const progress: Progress = {
+        foo_section_complete: true,
+        bar_section_complete: false,
+        baz_section_complete: true,
+      }
+
+      const result = controller.getAssessmentCompletionAnswers(progress)
+
+      expect(result).toEqual({
+        assessment_complete: 'NO',
+      })
+    })
+  })
+
   describe('updateAssessmentProgress', () => {
     const buildRequestWith = ({ persistedAnswers = {} }: { persistedAnswers?: Record<string, string | string[]> }) =>
       ({
@@ -161,9 +225,9 @@ describe('SaveAndContinueController', () => {
         ],
       })
 
-      controller.updateAssessmentProgress(req, res)
+      const progress = controller.getAssessmentProgress(req.form.persistedAnswers, res.locals.form.sectionProgressRules)
 
-      expect(res.locals.sectionProgress?.accommodation).toEqual(true)
+      expect(progress.accommodation).toEqual(true)
     })
 
     it('sets the sections to incomplete when their required fields have not been completed', () => {
@@ -188,11 +252,11 @@ describe('SaveAndContinueController', () => {
         ],
       })
 
-      controller.updateAssessmentProgress(req, res)
+      const progress = controller.getAssessmentProgress(req.form.persistedAnswers, res.locals.form.sectionProgressRules)
 
-      expect(res.locals.sectionProgress?.finance).toEqual(false)
-      expect(res.locals.sectionProgress?.['alcohol-use']).toEqual(false)
-      expect(res.locals.sectionProgress?.['drug-use']).toEqual(false)
+      expect(progress.finance).toEqual(false)
+      expect(progress['alcohol-use']).toEqual(false)
+      expect(progress['drug-use']).toEqual(false)
     })
   })
 })
diff --git a/app/controllers/saveAndContinueController.ts b/app/controllers/saveAndContinueController.ts
@@ -12,6 +12,7 @@ import sectionConfig from '../form/v1_0/config/sections'
 import ForbiddenError from '../../server/errors/forbiddenError'
 
 export type Progress = Record<string, boolean>
+export type SectionCompleteRule = { sectionName: string; fieldCodes: Array<string> }
 
 class SaveAndContinueController extends BaseController {
   apiService: StrengthsBasedNeedsAssessmentsApiService
@@ -133,41 +134,41 @@ class SaveAndContinueController extends BaseController {
     }
   }
 
-  updateAssessmentProgress(req: FormWizard.Request, res: Response) {
-    type SectionCompleteRule = { sectionName: string; fieldCodes: Array<string> }
-    type AnswerValues = Record<string, string>
-
+  getAssessmentProgress(formAnswers: FormWizard.Answers, sectionCompleteRules: SectionCompleteRule[]): Progress {
     const subsectionIsComplete =
-      (answers: AnswerValues = {}) =>
+      (answers: FormWizard.Answers = {}) =>
       (fieldCode: string) =>
         answers[fieldCode] === 'YES'
     const checkProgress =
-      (answers: AnswerValues) =>
+      (answers: FormWizard.Answers) =>
       (sectionProgress: Progress, { sectionName, fieldCodes }: SectionCompleteRule): Progress => ({
         ...sectionProgress,
         [sectionName]: fieldCodes.every(subsectionIsComplete(answers)),
       })
 
-    const sections = res.locals.form.sectionProgressRules
-    const sectionProgress: Progress = sections.reduce(
-      checkProgress(req.form.persistedAnswers as Record<string, string>),
-      {},
-    )
-    res.locals.sectionProgress = sectionProgress
-    res.locals.assessmentIsComplete = !Object.values(sectionProgress).includes(false)
+    return sectionCompleteRules.reduce(checkProgress(formAnswers), {})
+  }
+
+  checkAssessmentComplete(progress: Progress): boolean {
+    return !Object.values(progress).includes(false)
   }
 
   async getValues(req: FormWizard.Request, res: Response, next: NextFunction) {
     try {
-      this.updateAssessmentProgress(req, res)
+      const sectionProgress = this.getAssessmentProgress(
+        req.form.persistedAnswers,
+        res.locals.form.sectionProgressRules,
+      )
+      res.locals.sectionProgress = sectionProgress
+      res.locals.assessmentIsComplete = this.checkAssessmentComplete(sectionProgress)
 
       return super.getValues(req, res, next)
     } catch (error) {
       return next(error)
     }
   }
 
-  getSectionProgress(req: FormWizard.Request, isSectionComplete: boolean): FormWizard.Answers {
+  getSectionProgressAnswers(req: FormWizard.Request, isSectionComplete: boolean): FormWizard.Answers {
     const sectionProgressFields: FormWizard.Answers = Object.fromEntries(
       req.form.options.sectionProgressRules?.map(({ fieldCode, conditionFn }) => [
         fieldCode,
@@ -177,7 +178,12 @@ class SaveAndContinueController extends BaseController {
 
     return {
       ...sectionProgressFields,
-      assessment_complete: Object.values(sectionProgressFields).every(answer => answer === 'YES') ? 'YES' : 'NO',
+    }
+  }
+
+  getAssessmentCompletionAnswers(progress: Progress): FormWizard.Answers {
+    return {
+      assessment_complete: this.checkAssessmentComplete(progress) ? 'YES' : 'NO',
     }
   }
 
@@ -189,16 +195,25 @@ class SaveAndContinueController extends BaseController {
       ...req.form.values,
     }).getPageNavigation()
 
-    const allAnswers: FormWizard.Answers = {
+    const sectionCompleteAnswers = this.getSectionProgressAnswers(req, isSectionComplete)
+
+    const combinedAnswers: FormWizard.Answers = {
       ...req.form.persistedAnswers,
       ...(req.form.values || {}),
-      ...this.getSectionProgress(req, isSectionComplete),
+      ...sectionCompleteAnswers,
+    }
+
+    const answersToPersist = {
+      ...combinedAnswers,
+      ...this.getAssessmentCompletionAnswers(
+        this.getAssessmentProgress(combinedAnswers, res.locals.form.sectionProgressRules),
+      ),
     }
 
-    const { answersToAdd, answersToRemove } = buildRequestBody(req.form.options, allAnswers, options)
+    const { answersToAdd, answersToRemove } = buildRequestBody(req.form.options, answersToPersist, options)
 
     req.form.values = {
-      ...allAnswers,
+      ...answersToPersist,
       ...answersToRemove.reduce((removedAnswers, fieldCode) => ({ ...removedAnswers, [fieldCode]: null }), {}),
     }
     res.locals.values = req.form.values
