feat: mrf be field validation

__tests__/unit/backend/helpers/generate-form-data.ts

@@ -26,17 +26,34 @@ import {
   ITableFieldSchema,
   SingleAnswerFieldResponse,
 } from 'src/types'
+import {
+  ParsedClearAttachmentFieldResponseV3,
+  ParsedClearAttachmentResponseV3,
+} from 'src/types/api'
 
 import {
   AllowMyInfoBase,
   AttachmentSize,
   BasicField,
+  CheckboxFieldResponsesV3,
   CheckboxResponse,
+  CheckboxResponseV3,
   Column,
   DropdownFieldBase,
+  EmailResponseV3,
   FormField,
+  GenericStringAnswerFieldResponseV3,
+  MobileResponseV3,
+  RadioFieldResponsesV3,
+  RadioResponseV3,
   ShortTextFieldBase,
+  StringAnswerResponseV3,
+  TableFieldResponsesV3,
+  TableResponseV3,
   TableRow,
+  VerifiableFieldResponseV3,
+  YesNoFieldResponseV3,
+  YesNoResponseV3,
 } from '../../../../shared/types'
 
 export const generateDefaultField = (
@@ -368,7 +385,7 @@ export const generateNewTableResponse = (
 })
 
 export const generateTableDropdownColumn = (
-  customParams?: Partial<DropdownFieldBase>,
+  customParams?: Partial<DropdownFieldBase> & { _id?: string },
 ): Column => {
   return {
     title: 'some title',
@@ -392,7 +409,7 @@ export const generateTableDropdownColumn = (
 }
 
 export const generateTableShortTextColumn = (
-  customParams?: Partial<ShortTextFieldBase>,
+  customParams?: Partial<ShortTextFieldBase> & { _id?: string },
 ): Column => {
   return {
     title: 'some title',
@@ -420,3 +437,79 @@ export const generateTableShortTextColumn = (
     },
   } as Column
 }
+
+export const generateGenericStringAnswerResponseV3 = ({
+  fieldType,
+  answer = 'answer',
+}: {
+  fieldType: GenericStringAnswerFieldResponseV3['fieldType']
+  answer: StringAnswerResponseV3
+}): GenericStringAnswerFieldResponseV3 => {
+  return {
+    fieldType,
+    answer,
+  }
+}
+
+export const generateYesNoAnswerResponseV3 = (
+  answer: YesNoFieldResponseV3 = 'Yes',
+): YesNoResponseV3 => {
+  return {
+    fieldType: BasicField.YesNo,
+    answer: answer,
+  }
+}
+
+export const generateAttachmentResponseV3 = (
+  answer: ParsedClearAttachmentFieldResponseV3 = {
+    filename: 'Attachment filename',
+    content: Buffer.from('Attachment content'),
+    answer: 'Attachment answer',
+    hasBeenScanned: false,
+  },
+): ParsedClearAttachmentResponseV3 => {
+  return {
+    fieldType: BasicField.Attachment,
+    answer,
+  }
+}
+
+export const generateVerifiableAnswerResponseV3 = ({
+  fieldType,
+  answer,
+}: {
+  fieldType: BasicField.Email | BasicField.Mobile
+  answer: VerifiableFieldResponseV3
+}): EmailResponseV3 | MobileResponseV3 => {
+  return {
+    fieldType,
+    answer,
+  }
+}
+
+export const generateTableResponseV3 = (
+  answer: TableFieldResponsesV3,
+): TableResponseV3 => {
+  return {
+    fieldType: BasicField.Table,
+    answer,
+  }
+}
+
+export const generateRadioResponseV3 = (
+  answer: RadioFieldResponsesV3,
+): RadioResponseV3 => {
+  return {
+    fieldType: BasicField.Radio,
+    answer,
+  }
+}
+
+export const generateCheckboxResponseV3 = (
+  answer: CheckboxFieldResponsesV3,
+): CheckboxResponseV3 => {
+  return {
+    fieldType: BasicField.Checkbox,
+    answer,
+  }
+}

frontend/src/features/public-form/utils/inputTransformation.ts

@@ -9,7 +9,7 @@ import {
   FieldResponseAnswerMapV3,
   RadioFieldResponsesV3,
   TableFieldResponsesV3,
-  VerifiableFieldResponsesV3,
+  VerifiableFieldResponseV3,
   YesNoFieldResponseV3,
 } from '~shared/types'
 import { BasicField, FormFieldDto } from '~shared/types/field'
@@ -65,7 +65,7 @@ const transformToVerifiableOutput = <
   F extends EmailFieldSchema | MobileFieldSchema,
 >(
   schema: F,
-  input?: VerifiableFieldValues | VerifiableFieldResponsesV3,
+  input?: VerifiableFieldValues | VerifiableFieldResponseV3,
 ): VerifiableAnswerOutput<F> => {
   return {
     ...pickBaseOutputFromSchema(schema),

shared/constants/form.ts

@@ -92,6 +92,9 @@ export const PAYMENT_VARIABLE_INPUT_AMOUNT_FIELD_ID =
 export const CLIENT_RADIO_OTHERS_INPUT_VALUE =
   '!!FORMSG_INTERNAL_RADIO_OTHERS_VALUE!!'
 
+export const CLIENT_CHECKBOX_OTHERS_INPUT_VALUE =
+  '!!FORMSG_INTERNAL_CHECKBOX_OTHERS_VALUE!!'
+
 // The current encrypt version to assign to the encrypted submission.
 // This is needed if we ever break backwards compatibility with
 // end-to-end encryption

shared/types/field/base.ts

@@ -23,6 +23,23 @@ export enum BasicField {
   Children = 'children',
 }
 
+/**
+ * Contains field types where the answer is a generic string type
+ */
+export enum GenericStringAnswerResponseFieldV3 {
+  Number = 'number',
+  Decimal = 'decimal',
+  ShortText = 'textfield',
+  LongText = 'textarea',
+  HomeNo = 'homeno',
+  Dropdown = 'dropdown',
+  Rating = 'rating',
+  Nric = 'nric',
+  Uen = 'uen',
+  Date = 'date',
+  CountryRegion = 'country_region',
+}
+
 export enum MyInfoAttribute {
   Name = 'name',
   PassportNumber = 'passportnumber',

shared/types/response-v3.ts

@@ -4,25 +4,28 @@ export type FieldResponsesV3 = Record<FormFieldDto['_id'], FieldResponseV3>
 
 export type FieldResponseV3 =
   | HeaderResponseV3
+  | RadioResponseV3
+  | CheckboxResponseV3
+  | AttachmentResponseV3
+  | TableResponseV3
+  | ChildBirthRecordsResponseV3
+  | YesNoResponseV3
   | EmailResponseV3
   | MobileResponseV3
-  | HomeNoResponseV3
+  | GenericStringAnswerFieldResponseV3
+
+export type GenericStringAnswerFieldResponseV3 =
   | NumberResponseV3
   | DecimalResponseV3
   | ShortTextResponseV3
   | LongTextResponseV3
+  | HomeNoResponseV3
   | DropdownResponseV3
-  | CountryRegionResponseV3
-  | YesNoResponseV3
-  | CheckboxResponseV3
-  | RadioResponseV3
-  | AttachmentResponseV3
-  | DateResponseV3
   | RatingResponseV3
   | NricResponseV3
-  | TableResponseV3
   | UenResponseV3
-  | ChildBirthRecordsResponseV3
+  | DateResponseV3
+  | CountryRegionResponseV3
 
 export type HeaderResponseV3 = FieldResponseFactoryV3<BasicField.Section>
 export type EmailResponseV3 = FieldResponseFactoryV3<BasicField.Email>
@@ -57,25 +60,14 @@ export type FieldResponseV3Base = {
   fieldType: BasicField
 }
 export type FieldResponseAnswerMapV3<F extends BasicField = BasicField> =
-  F extends
-    | BasicField.Number
-    | BasicField.Decimal
-    | BasicField.ShortText
-    | BasicField.LongText
-    | BasicField.HomeNo
-    | BasicField.Dropdown
-    | BasicField.Rating
-    | BasicField.Nric
-    | BasicField.Uen
-    | BasicField.Date
-    | BasicField.CountryRegion
-    ? SingleAnswerResponseV3
+  F extends GenericStringAnswerResponseFieldTypeV3
+    ? StringAnswerResponseV3
     : F extends BasicField.YesNo
       ? YesNoFieldResponseV3
       : F extends BasicField.Attachment
         ? AttachmentFieldResponseV3
         : F extends BasicField.Email | BasicField.Mobile
-          ? VerifiableFieldResponsesV3
+          ? VerifiableFieldResponseV3
           : F extends BasicField.Table
             ? TableFieldResponsesV3
             : F extends BasicField.Radio
@@ -86,9 +78,22 @@ export type FieldResponseAnswerMapV3<F extends BasicField = BasicField> =
                   ? ChildrenCompoundFieldResponsesV3
                   : never
 
-export type SingleAnswerResponseV3 = string
+export type GenericStringAnswerResponseFieldTypeV3 =
+  | NumberResponseV3['fieldType']
+  | DecimalResponseV3['fieldType']
+  | ShortTextResponseV3['fieldType']
+  | LongTextResponseV3['fieldType']
+  | HomeNoResponseV3['fieldType']
+  | DropdownResponseV3['fieldType']
+  | RatingResponseV3['fieldType']
+  | NricResponseV3['fieldType']
+  | UenResponseV3['fieldType']
+  | DateResponseV3['fieldType']
+  | CountryRegionResponseV3['fieldType']
+
+export type StringAnswerResponseV3 = string
 export type YesNoFieldResponseV3 = 'Yes' | 'No'
-export type VerifiableFieldResponsesV3 = {
+export type VerifiableFieldResponseV3 = {
   signature?: string
   value: string
 }

src/app/modules/submission/multirespondent-submission/multirespondent-submission.middleware.ts

@@ -11,6 +11,7 @@ import {
   SubmissionType,
 } from '../../../../../shared/types'
 import { isDev } from '../../../../app/config/config'
+import { FormFieldSchema } from '../../../../types'
 import {
   ParsedClearAttachmentResponseV3,
   ParsedClearFormFieldResponsesV3,
@@ -19,7 +20,9 @@ import {
 import { MultirespondentFormLoadedDto } from '../../../../types/api/multirespondent_submission'
 import formsgSdk from '../../../config/formsg-sdk'
 import { createLoggerWithLabel } from '../../../config/logger'
+import { validateFieldV3 } from '../../../utils/field-validation'
 import {
+  FieldIdSet,
   getLogicUnitPreventingSubmitV3,
   getVisibleFieldIdsV3,
 } from '../../../utils/logic-adaptor'
@@ -35,6 +38,7 @@ import {
   InvalidSubmissionTypeError,
   MaliciousFileDetectedError,
   ProcessingError,
+  ValidateFieldError,
   VirusScanFailedError,
 } from '../submission.errors'
 import {
@@ -308,11 +312,71 @@ export const scanAndRetrieveAttachments = async (
   return next()
 }
 
+/**
+ * Validates each field by individual field rules.
+ * @param formId formId, used for logging
+ * @param formFields all form fields in the form. Purpose: used to validate responses against the form field properties.
+ * @param responses responses to validate
+ * @returns initial responses if all responses are valid, else an error.
+ */
+const validateMrfFieldResponses = ({
+  formId,
+  visibleFieldIds,
+  formFields,
+  responses,
+}: {
+  formId: string
+  visibleFieldIds: FieldIdSet
+  formFields: FormFieldSchema[]
+  responses: ParsedClearFormFieldResponsesV3
+}): Result<
+  ParsedClearFormFieldResponsesV3,
+  ValidateFieldError | ProcessingError
+> => {
+  const idToFieldMap = formFields.reduce<{
+    [fieldId: string]: FormFieldSchema
+  }>((acc, field) => {
+    acc[field._id] = field
+    return acc
+  }, {})
+
+  for (const [responseId, response] of Object.entries(responses)) {
+    const formField = idToFieldMap[responseId]
+    if (!formField) {
+      return err(
+        new ProcessingError('Response Id does not match form field Ids'),
+      )
+    }
+
+    // Since Myinfo fields are not currently supported for MRF
+    if (response.fieldType === BasicField.Children) {
+      return err(
+        new ValidateFieldError(
+          'Children field type is not supported for MRF submisisons',
+        ),
+      )
+    }
+
+    const validateFieldV3Result = validateFieldV3({
+      formId,
+      formField,
+      response,
+      isVisible: visibleFieldIds.has(responseId),
+    })
+    if (validateFieldV3Result.isErr()) {
+      return err(validateFieldV3Result.error)
+    }
+  }
+
+  return ok(responses)
+}
+
 /**
  * What types of fields are there?
- *                Visible                     Not visible
- * Editable       Regular field validation    Not allowed
- * Non-editable   Not allowed / prev submiss  Not allowed
+ *              |  Visible                    | Not visible
+ * -------------|-----------------------------|-------------------
+ * Editable     |  Regular field validation   | Not allowed
+ * Non-editable |  Not allowed / prev submiss | Not allowed
  *
  * Initial submission:
  * 1. Retrieve form object
@@ -513,8 +577,12 @@ export const validateMultirespondentSubmission = async (
                 ).map(() => undefined)
               })
               .andThen(() =>
-                // TODO: Step 4: Validate each field content with each field's validator rules individually.
-                ok(undefined),
+                validateMrfFieldResponses({
+                  formId,
+                  visibleFieldIds,
+                  formFields: form_fields as FormFieldSchema[],
+                  responses: req.body.responses,
+                }),
               ),
           )
         },