refactor: validateAndProcessEncryptSubmission to typescript (#887)

* chore: use correct type for validators

* refactor: migrate validateAndProcessEncryptSubmission to ts

* refactor: update tests

src/app/modules/submission/email-submission/email-submission.types.ts

@@ -39,6 +39,7 @@ export interface EmailDataForOneField {
 // When a response has been formatted for email, all answerArray
 // should have been converted to answer
 interface IResponseFormattedForEmail extends IBaseResponse {
+  question: string
   fieldType: BasicField
   answer: string
 }

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

@@ -0,0 +1,70 @@
+import { RequestHandler } from 'express'
+import { SetOptional } from 'type-fest'
+
+import { createReqMeta } from '../../../../app/utils/request'
+import { createLoggerWithLabel } from '../../../../config/logger'
+import { FieldResponse, WithForm, WithParsedResponses } from '../../../../types'
+import { checkIsEncryptedEncoding } from '../../../utils/encryption'
+import { getProcessedResponses } from '../submission.service'
+
+import { mapRouteError } from './encrypt-submission.utils'
+
+const logger = createLoggerWithLabel(module)
+
+type EncryptSubmissionBody = {
+  responses: FieldResponse[]
+  encryptedContent: string
+  attachments?: {
+    encryptedFile?: {
+      binary: string
+      nonce: string
+      submissionPublicKey: string
+    }
+  }
+  isPreview: boolean
+  version: number
+}
+
+export const validateAndProcessEncryptSubmission: RequestHandler<
+  { formId: string },
+  unknown,
+  EncryptSubmissionBody
+> = (req, res, next) => {
+  const { form } = req as WithForm<typeof req>
+  const { encryptedContent, responses } = req.body
+
+  // Step 1: Check whether submitted encryption is valid.
+  return (
+    checkIsEncryptedEncoding(encryptedContent)
+      // Step 2: Encryption is valid, process given responses.
+      .andThen(() => getProcessedResponses(form, responses))
+      // If pass, then set parsedResponses and delete responses.
+      .map((processedResponses) => {
+        // eslint-disable-next-line @typescript-eslint/no-extra-semi
+        ;(req.body as WithParsedResponses<
+          typeof req.body
+        >).parsedResponses = processedResponses
+        // Prevent downstream functions from using responses by deleting it.
+        delete (req.body as SetOptional<EncryptSubmissionBody, 'responses'>)
+          .responses
+        return next()
+      })
+      // If error, log and return res error.
+      .mapErr((error) => {
+        logger.error({
+          message: 'Error validating encrypt submission responses',
+          meta: {
+            action: 'validateEncryptSubmission',
+            ...createReqMeta(req),
+            formId: form._id,
+          },
+          error,
+        })
+
+        const { statusCode, errorMessage } = mapRouteError(error)
+        return res.status(statusCode).json({
+          message: errorMessage,
+        })
+      })
+  )
+}

src/app/modules/submission/encrypt-submission/encrypt-submission.utils.ts

@@ -4,7 +4,13 @@ import { createLoggerWithLabel } from '../../../../config/logger'
 import { MapRouteError } from '../../../../types/routing'
 import { DatabaseError, MalformedParametersError } from '../../core/core.errors'
 import { CreatePresignedUrlError } from '../../form/admin-form/admin-form.errors'
-import { SubmissionNotFoundError } from '../submission.errors'
+import {
+  ConflictError,
+  InvalidEncodingError,
+  ProcessingError,
+  SubmissionNotFoundError,
+  ValidateFieldError,
+} from '../submission.errors'
 
 const logger = createLoggerWithLabel(module)
 
@@ -25,6 +31,25 @@ export const mapRouteError: MapRouteError = (error) => {
         statusCode: StatusCodes.NOT_FOUND,
         errorMessage: error.message,
       }
+    case InvalidEncodingError:
+      return {
+        statusCode: StatusCodes.BAD_REQUEST,
+        errorMessage:
+          'Invalid data was found. Please check your responses and submit again.',
+      }
+    case ValidateFieldError:
+    case ProcessingError:
+      return {
+        statusCode: StatusCodes.BAD_REQUEST,
+        errorMessage:
+          'There is something wrong with your form submission. Please check your responses and try again. If the problem persists, please refresh the page.',
+      }
+    case ConflictError:
+      return {
+        statusCode: StatusCodes.CONFLICT,
+        errorMessage:
+          'The form has been updated. Please refresh and submit again.',
+      }
     case CreatePresignedUrlError:
     case DatabaseError:
       return {

src/app/modules/submission/submission.types.ts

@@ -6,6 +6,7 @@ import {
 } from 'src/types/response'
 
 export type ProcessedResponse = {
+  question: string
   isVisible?: boolean
   isUserVerified?: boolean
 }

src/app/routes/admin-forms.server.routes.js

@@ -18,6 +18,7 @@ const EncryptSubmissionController = require('../modules/submission/encrypt-submi
 const {
   PermissionLevel,
 } = require('../modules/form/admin-form/admin-form.types')
+const EncryptSubmissionMiddleware = require('../modules/submission/encrypt-submission/encrypt-submission.middleware')
 const SpcpController = require('../modules/spcp/spcp.controller')
 const { BasicField, ResponseMode } = require('../../types')
 
@@ -476,8 +477,6 @@ module.exports = function (app) {
    * @security OTP
    */
   app.route('/v2/submissions/encrypt/preview/:formId([a-fA-F0-9]{24})').post(
-    authActiveForm(PermissionLevel.Read),
-    encryptSubmissions.validateEncryptSubmission,
     celebrate({
       [Segments.BODY]: Joi.object({
         responses: Joi.array()
@@ -522,6 +521,8 @@ module.exports = function (app) {
         version: Joi.number().required(),
       }),
     }),
+    authActiveForm(PermissionLevel.Read),
+    EncryptSubmissionMiddleware.validateAndProcessEncryptSubmission,
     AdminFormController.passThroughSpcp,
     submissions.injectAutoReplyInfo,
     webhookVerifiedContentFactory.encryptedVerifiedFields,

src/app/utils/encryption.ts

@@ -5,7 +5,7 @@ import { InvalidEncodingError } from '../modules/submission/submission.errors'
 
 export const checkIsEncryptedEncoding = (
   encryptedStr: string,
-): Result<boolean, Error> => {
+): Result<true, InvalidEncodingError> => {
   // TODO (#42): Remove this type check once whole backend is in TypeScript.
   if (typeof encryptedStr !== 'string') {
     return err(new InvalidEncodingError('encryptedStr is not of type `string`'))

src/app/utils/field-validation/validators/common.ts

@@ -1,9 +1,9 @@
 import { left, right } from 'fp-ts/lib/Either'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
-export const notEmptySingleAnswerResponse: ResponseValidator<ISingleAnswerResponse> = (
+export const notEmptySingleAnswerResponse: ResponseValidator<ProcessedSingleAnswerResponse> = (
   response,
 ) => {
   if (response.answer.trim().length === 0)

src/app/utils/field-validation/validators/dateValidator.ts

@@ -2,15 +2,15 @@ import { chain, left, right } from 'fp-ts/lib/Either'
 import { flow } from 'fp-ts/lib/function'
 import moment from 'moment-timezone'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { IDateField } from 'src/types/field'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
 import { DateSelectedValidation } from '../../../../shared/constants'
 
 import { notEmptySingleAnswerResponse } from './common'
 
-type DateValidator = ResponseValidator<ISingleAnswerResponse>
+type DateValidator = ResponseValidator<ProcessedSingleAnswerResponse>
 type DateValidatorConstructor = (dateField: IDateField) => DateValidator
 
 /**

src/app/utils/field-validation/validators/decimalValidator.ts

@@ -3,13 +3,13 @@ import { flow } from 'fp-ts/lib/function'
 import isFloat from 'validator/lib/isFloat'
 import isInt from 'validator/lib/isInt'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { IDecimalField } from 'src/types/field'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
 import { notEmptySingleAnswerResponse } from './common'
 
-type DecimalValidator = ResponseValidator<ISingleAnswerResponse>
+type DecimalValidator = ResponseValidator<ProcessedSingleAnswerResponse>
 type DecimalValidatorConstructor = (
   decimalField: IDecimalField,
 ) => DecimalValidator

src/app/utils/field-validation/validators/homeNoValidator.ts

@@ -1,9 +1,9 @@
 import { chain, left, right } from 'fp-ts/lib/Either'
 import { flow } from 'fp-ts/lib/function'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { IHomenoField } from 'src/types/field'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
 import {
   isHomePhoneNumber,
@@ -12,7 +12,7 @@ import {
 
 import { notEmptySingleAnswerResponse } from './common'
 
-type HomeNoValidator = ResponseValidator<ISingleAnswerResponse>
+type HomeNoValidator = ResponseValidator<ProcessedSingleAnswerResponse>
 type HomeNoValidatorConstructor = (
   homeNumberField: IHomenoField,
 ) => HomeNoValidator

src/app/utils/field-validation/validators/mobileNoValidator.ts

@@ -1,9 +1,9 @@
 import { chain, left, right } from 'fp-ts/lib/Either'
 import { flow } from 'fp-ts/lib/function'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { IMobileField } from 'src/types/field'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
 import {
   isMobilePhoneNumber,
@@ -12,7 +12,7 @@ import {
 
 import { notEmptySingleAnswerResponse } from './common'
 
-type MobileNoValidator = ResponseValidator<ISingleAnswerResponse>
+type MobileNoValidator = ResponseValidator<ProcessedSingleAnswerResponse>
 type MobileNoValidatorConstructor = (
   mobileNumberField: IMobileField,
 ) => MobileNoValidator

src/app/utils/field-validation/validators/nricValidator.ts

@@ -1,14 +1,14 @@
 import { chain, left, right } from 'fp-ts/lib/Either'
 import { flow } from 'fp-ts/lib/function'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
 import { isNricValid } from '../../../../shared/util/nric-validation'
 
 import { notEmptySingleAnswerResponse } from './common'
 
-type NricValidator = ResponseValidator<ISingleAnswerResponse>
+type NricValidator = ResponseValidator<ProcessedSingleAnswerResponse>
 type NricValidatorConstructor = () => NricValidator
 
 const nricValidator: NricValidator = (response) => {

src/app/utils/field-validation/validators/radioButtonValidator.ts

@@ -1,14 +1,14 @@
 import { chain, left, right } from 'fp-ts/lib/Either'
 import { flow } from 'fp-ts/lib/function'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { IRadioField } from 'src/types/field'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
 import { notEmptySingleAnswerResponse } from './common'
 import { isOneOfOptions, isOtherOption } from './options'
 
-type RadioButtonValidator = ResponseValidator<ISingleAnswerResponse>
+type RadioButtonValidator = ResponseValidator<ProcessedSingleAnswerResponse>
 type RadioButtonValidatorConstructor = (
   radioButtonField: IRadioField,
 ) => RadioButtonValidator

src/app/utils/field-validation/validators/ratingValidator.ts

@@ -2,13 +2,13 @@ import { chain, left, right } from 'fp-ts/lib/Either'
 import { flow } from 'fp-ts/lib/function'
 import isInt from 'validator/lib/isInt'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { IRatingField } from 'src/types/field'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
 import { notEmptySingleAnswerResponse } from './common'
 
-type RatingValidator = ResponseValidator<ISingleAnswerResponse>
+type RatingValidator = ResponseValidator<ProcessedSingleAnswerResponse>
 type RatingValidatorConstructor = (ratingField: IRatingField) => RatingValidator
 
 const makeRatingLimitsValidator: RatingValidatorConstructor = (ratingField) => (

src/app/utils/field-validation/validators/textValidator.ts

@@ -1,17 +1,17 @@
 import { chain, left, right } from 'fp-ts/lib/Either'
 import { flow } from 'fp-ts/lib/function'
 
+import { ProcessedSingleAnswerResponse } from 'src/app/modules/submission/submission.types'
 import { ILongTextField, IShortTextField } from 'src/types/field'
 import { ResponseValidator } from 'src/types/field/utils/validation'
-import { ISingleAnswerResponse } from 'src/types/response'
 
 import { TextSelectedValidation } from '../../../../types/field/baseField'
 
 import { notEmptySingleAnswerResponse } from './common'
 
 type TextFieldValidatorConstructor = (
   textField: IShortTextField | ILongTextField,
-) => ResponseValidator<ISingleAnswerResponse>
+) => ResponseValidator<ProcessedSingleAnswerResponse>
 
 const minLengthValidator: TextFieldValidatorConstructor = (textField) => (
   response,

src/types/express.locals.ts

@@ -1,12 +1,18 @@
 // TODO (#42): remove these types when migrating away from middleware pattern
 
+import { ProcessedFieldResponse } from '../app/modules/submission/submission.types'
+
 import { IPopulatedForm } from './form'
 import { SpcpSession } from './spcp'
 
 export type WithForm<T> = T & {
   form: IPopulatedForm
 }
 
+export type WithParsedResponses<T> = T & {
+  parsedResponses: ProcessedFieldResponse[]
+}
+
 export type ResWithSpcpSession<T> = T & {
   locals: { spcpSession?: SpcpSession }
 }

src/types/response/index.ts

@@ -5,8 +5,9 @@ export type AttachmentsMap = Record<IFieldSchema['_id'], File>
 export interface IBaseResponse {
   _id: IFieldSchema['_id']
   fieldType: BasicField
-  question: string
   myInfo?: IMyInfo
+  // Signature exists for verifiable fields if the answer is verified.
+  signature?: string
 }
 
 export interface ISingleAnswerResponse extends IBaseResponse {

tests/unit/backend/controllers/encrypt-submissions.server.controller.spec.js

@@ -4,6 +4,7 @@ const express = require('express')
 const request = require('supertest')
 
 const dbHandler = require('../helpers/db-handler')
+const EncryptSubmissionsMiddleware = require('../../../../dist/backend/app/modules/submission/encrypt-submission/encrypt-submission.middleware')
 
 const User = dbHandler.makeModel('user.server.model', 'User')
 const Agency = dbHandler.makeModel('agency.server.model', 'Agency')
@@ -141,15 +142,15 @@ describe('Encrypt Submissions Controller', () => {
       })
     }
 
-    describe('validateEncryptSubmission', () => {
+    describe('validateAndProcessEncryptSubmission', () => {
       const app = express()
 
       beforeAll(() => {
         app
           .route(endpointPath)
           .post(
             injectFixtures,
-            Controller.validateEncryptSubmission,
+            EncryptSubmissionsMiddleware.validateAndProcessEncryptSubmission,
             sendSubmissionBack,
           )
       })