From 448f2d06c28341fe6b20b7ca1783f8a8701fc223 Mon Sep 17 00:00:00 2001 From: Kevin Foong <55353265+kevin9foong@users.noreply.github.com> Date: Fri, 13 Dec 2024 22:51:22 +0800 Subject: [PATCH] feat: add tc for testing the metadata builder --- .../multirespondent-submission.utils.spec.ts | 152 +++++++++++++++++- 1 file changed, 148 insertions(+), 4 deletions(-) diff --git a/src/app/modules/submission/multirespondent-submission/__tests__/multirespondent-submission.utils.spec.ts b/src/app/modules/submission/multirespondent-submission/__tests__/multirespondent-submission.utils.spec.ts index e46ccb49b5..9aa03060fb 100644 --- a/src/app/modules/submission/multirespondent-submission/__tests__/multirespondent-submission.utils.spec.ts +++ b/src/app/modules/submission/multirespondent-submission/__tests__/multirespondent-submission.utils.spec.ts @@ -10,6 +10,7 @@ import { ChildBirthRecordsResponseV3, EmailResponseV3, FieldResponsesV3, + FormFieldDto, FormWorkflowStepDto, LongTextResponseV3, NumberResponseV3, @@ -34,6 +35,7 @@ import { import * as fieldValidation from '../../../../utils/field-validation' import { ValidateFieldErrorV3 } from '../../submission.errors' +import { buildMrfMetadata } from '../../submission.utils' import { createMultirespondentSubmissionDto, getQuestionTitleAnswerString, @@ -42,13 +44,155 @@ import { } from '../multirespondent-submission.utils' describe('multirespondent-submission.utils', () => { - const WORKFLOW_STEP_1 = { + const YES_NO_FIELD = { + _id: 'yes_no_field_id', + title: 'Yes or No', + description: '', + required: true, + disabled: false, + fieldType: BasicField.YesNo, + } + const WORKFLOW_STEP_1: FormWorkflowStepDto = { _id: 'step_1_id', workflow_type: WorkflowType.Static, emails: ['example@example.com'], edit: [], } + const WORKFLOW_STEP_2: FormWorkflowStepDto = { + _id: 'step_2_id', + workflow_type: WorkflowType.Static, + emails: ['example@example.com'], + edit: [YES_NO_FIELD._id], + } + const WORKFLOW_APPROVAL_STEP: FormWorkflowStepDto = { + _id: 'approval_step_id', + workflow_type: WorkflowType.Static, + emails: ['example@example.com'], + edit: [YES_NO_FIELD._id], + approval_field: YES_NO_FIELD._id, + } + + describe('buildMrfMetadata', () => { + it('should build mrf metadata successfully for pending submission without approval step', () => { + const metadata = buildMrfMetadata({ + workflow: [WORKFLOW_STEP_1, WORKFLOW_STEP_2], + workflowStep: 0, + submittedSteps: [ + { + isApproval: false, + submittedAt: '2024-01-01T00:00:00.000Z', + }, + ], + }) + + expect(metadata).toEqual({ + workflowCurrentStepNumber: 1, + workflowNumTotalSteps: 2, + workflowStatus: WorkflowStatus.PENDING, + }) + }) + + it('should build mrf metadata successfully for completed submission without approval step', () => { + const metadata = buildMrfMetadata({ + workflow: [WORKFLOW_STEP_1, WORKFLOW_STEP_2], + workflowStep: 1, + submittedSteps: [ + { + isApproval: false, + submittedAt: '2024-01-01T00:00:00.000Z', + }, + { + isApproval: false, + submittedAt: '2024-01-02T00:00:00.000Z', + }, + ], + }) + + expect(metadata).toEqual({ + workflowCurrentStepNumber: 2, + workflowNumTotalSteps: 2, + workflowStatus: WorkflowStatus.COMPLETED, + }) + }) + + it('should build mrf metadata successfully for pending submission with approval step', () => { + const metadata = buildMrfMetadata({ + workflow: [WORKFLOW_STEP_1, WORKFLOW_APPROVAL_STEP, WORKFLOW_STEP_2], + workflowStep: 1, + submittedSteps: [ + { + isApproval: false, + submittedAt: '2024-01-01T00:00:00.000Z', + }, + { + isApproval: true, + status: WorkflowStatus.APPROVED, + submittedAt: '2024-01-02T00:00:00.000Z', + }, + ], + }) + + expect(metadata).toEqual({ + workflowCurrentStepNumber: 2, + workflowNumTotalSteps: 3, + workflowStatus: WorkflowStatus.PENDING, + }) + }) + + it('should build mrf metadata successfully for approval submission with approval step', () => { + const metadata = buildMrfMetadata({ + workflow: [WORKFLOW_STEP_1, WORKFLOW_APPROVAL_STEP, WORKFLOW_STEP_2], + workflowStep: 2, + submittedSteps: [ + { + isApproval: false, + submittedAt: '2024-01-01T00:00:00.000Z', + }, + { + isApproval: true, + status: WorkflowStatus.APPROVED, + submittedAt: '2024-01-02T00:00:00.000Z', + }, + { + isApproval: false, + submittedAt: '2024-01-03T00:00:00.000Z', + }, + ], + }) + + expect(metadata).toEqual({ + workflowCurrentStepNumber: 3, + workflowNumTotalSteps: 3, + workflowStatus: WorkflowStatus.APPROVED, + }) + }) + + it('should build mrf metadata successfully for rejected submission with approval step', () => { + const metadata = buildMrfMetadata({ + workflow: [WORKFLOW_STEP_1, WORKFLOW_APPROVAL_STEP, WORKFLOW_STEP_2], + workflowStep: 1, + submittedSteps: [ + { + isApproval: false, + submittedAt: '2024-01-01T00:00:00.000Z', + }, + { + isApproval: true, + status: WorkflowStatus.REJECTED, + submittedAt: '2024-01-02T00:00:00.000Z', + }, + ], + }) + + expect(metadata).toEqual({ + workflowCurrentStepNumber: 2, + workflowNumTotalSteps: 3, + workflowStatus: WorkflowStatus.REJECTED, + }) + }) + }) + describe('createMultirespondentSubmissionDto', () => { it('should create an encrypted submission DTO sucessfully', () => { // Arrange @@ -140,7 +284,7 @@ describe('multirespondent-submission.utils', () => { const result = validateMrfFieldResponses({ formId: mockFormId, visibleFieldIds: mockVisibleFieldIds, - formFields: mockFormFields, + formFields: mockFormFields as FormFieldDto[], responses: mockResponses, }) @@ -174,7 +318,7 @@ describe('multirespondent-submission.utils', () => { validateMrfFieldResponses({ formId: mockFormId, visibleFieldIds: mockVisibleFieldIds, - formFields: mockFormFields, + formFields: mockFormFields as FormFieldDto[], responses: mockResponses, }) @@ -217,7 +361,7 @@ describe('multirespondent-submission.utils', () => { validateMrfFieldResponses({ formId: mockFormId, visibleFieldIds: mockVisibleFieldIds, - formFields: mockFormFields, + formFields: mockFormFields as FormFieldDto[], responses: mockResponses, })