fix: make responses data compatible with pdf

Author: kevin9foong

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

@@ -259,7 +259,7 @@ export const getAnswerForSignature = (
 
 /**
  *  Formats the response for sending to the submitter (autoReplyData),
- *  the table that is sent to the admin (formData),
+ *  the table that is sent to the admin (responseData),
  *  and the json used by data collation tool (dataCollationData).
  *
  * @param response
@@ -292,7 +292,7 @@ export const getFormattedResponse = (
   }
 
   // Send all the fields to admin
-  const formData = {
+  const responseData = {
     question: getFormDataPrefixedQuestion(response, hashedFields),
     answerTemplate: answerSplitByNewLine,
     answer,
@@ -301,7 +301,7 @@ export const getFormattedResponse = (
   return {
     autoReplyData,
     dataCollationData,
-    formData,
+    responseData,
   }
 }
 
@@ -462,18 +462,18 @@ export const mapRouteError: MapRouteError = (error) => {
 
 /**
  * Concatenate response into a string for hashing
- * @param formData Field-value tuples for admin email
+ * @param responsesData Field-value tuples for admin email
  * @param attachments Array of attachments as buffers
  * @returns concatenated response to hash
  */
 export const concatAttachmentsAndResponses = (
-  formData: EmailAdminDataField[],
+  responsesData: EmailAdminDataField[],
   attachments: IAttachmentInfo[],
 ): string => {
   let response = ''
-  response += formData.reduce((acc, fieldData) => {
-    const question = fieldData.question.toString().trim()
-    const answer = fieldData.answer.toString().trim()
+  response += responsesData.reduce((acc, fieldResponseData) => {
+    const question = fieldResponseData.question.toString().trim()
+    const answer = fieldResponseData.answer.toString().trim()
     return acc + `${question} ${answer}; `
   }, '')
   response += attachments.reduce((acc, { content }) => acc + content, '')
@@ -698,9 +698,9 @@ export class SubmissionEmailObj {
       : unmaskedAutoReplyData
   }
   /**
-   * Getter function to return formData which is used to send responses to admin
+   * Getter function to return responsesData which is used to send responses to admin
    */
-  get formData(): EmailAdminDataField[] {
+  get responsesData(): EmailAdminDataField[] {
     return this.parsedResponses.flatMap((response) =>
       createFormattedDataForOneField(
         response,

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

@@ -48,7 +48,9 @@ import {
 } from '../submission.errors'
 import { sendEmailConfirmations } from '../submission.service'
 import { ProcessedFieldResponse } from '../submission.types'
-import { extractEmailConfirmationData } from '../submission.utils'
+import {
+  extractEmailConfirmationData
+} from '../submission.utils'
 
 import { CHARTS_MAX_SUBMISSION_RESULTS } from './encrypt-submission.constants'
 import { SaveEncryptSubmissionParams } from './encrypt-submission.types'
@@ -184,9 +186,7 @@ const generatePdfAttachmentIfRequired = ({
   autoReplyMailDatas: AutoReplyMailData[]
   submission: IEncryptedSubmissionSchema
   form: IPopulatedEncryptedForm
-  responsesData: (Pick<EmailAdminDataField, 'question' | 'answerTemplate'> & {
-    answer?: EmailAdminDataField['answer']
-  })[]
+  responsesData: EmailAdminDataField[]
 }): ResultAsync<Mail.Attachment | undefined, AutoreplyPdfGenerationError> => {
   if (
     !checkIfPdfGenerationIsRequired({
@@ -197,13 +197,20 @@ const generatePdfAttachmentIfRequired = ({
     return okAsync(undefined)
   }
 
+  const pdfResponsesData = responsesData.map(
+    ({ question, answerTemplate }) => ({
+      question,
+      answerTemplate,
+    }),
+  )
+
   const renderData: AutoreplySummaryRenderData = {
     refNo: submission.id,
     formTitle: form.title,
     submissionTime: moment(submission.created)
       .tz('Asia/Singapore')
       .format('ddd, DD MMM YYYY hh:mm:ss A'),
-    formData: responsesData,
+    formData: pdfResponsesData,
     formUrl: `${config.app.appUrl}/${form._id}`,
   }
 
@@ -281,14 +288,14 @@ export const performEncryptPostSubmissionActions = ({
           })
         : []
 
-      const emailData = new SubmissionEmailObj(
+      const { responsesData, dataCollationData } = new SubmissionEmailObj(
         emailFields,
         new Set(), // the MyInfo prefixes are already inserted in middleware
         form.authType,
       )
       // Since we insert the [MyInfo] prefix in `encrypt-submission.middleware.ts`:L434
       // we want to remove it for the dataCollationData
-      const dataCollationData = emailData.dataCollationData.map((item) => ({
+      const formattedDataCollationData = dataCollationData.map((item) => ({
         question: item.question.startsWith(MYINFO_PREFIX)
           ? item.question.slice(MYINFO_PREFIX.length)
           : item.question,
@@ -309,7 +316,7 @@ export const performEncryptPostSubmissionActions = ({
         autoReplyMailDatas: recipientEmailDatas,
         submission,
         form,
-        responsesData: emailData.formData,
+        responsesData,
       })
 
       return pdfAttachmentResult.andThen((pdfAttachment) => {
@@ -323,8 +330,8 @@ export const performEncryptPostSubmissionActions = ({
               id: submission.id,
             },
             submissionAttachments,
-            formData: emailData.formData,
-            dataCollationData,
+            formData: responsesData,
+            dataCollationData: formattedDataCollationData,
             pdfAttachment: checkIfAdminPdfIsRequired()
               ? pdfAttachment
               : undefined,
@@ -342,7 +349,7 @@ export const performEncryptPostSubmissionActions = ({
             submission,
             submissionAttachments,
             recipientData: recipientEmailDatas,
-            responsesData: emailData.formData,
+            responsesData,
             pdfAttachment: checkIfRespondentFormSummaryIsRequired({
               isPaymentEnabled,
               autoReplyMailDatas: recipientEmailDatas,

src/types/email_mode_data.ts

@@ -27,13 +27,13 @@ export type EmailDataFields =
 export interface EmailData {
   autoReplyData: EmailRespondentConfirmationField[]
   dataCollationData: EmailDataCollationToolField[]
-  formData: EmailAdminDataField[]
+  responsesData: EmailAdminDataField[]
 }
 
 export interface EmailDataForOneField {
   autoReplyData?: EmailRespondentConfirmationField
   dataCollationData?: EmailDataCollationToolField
-  formData: EmailAdminDataField
+  responseData: EmailAdminDataField
 }
 
 export interface IAttachmentInfo {