feat: move pdf render data copy to common function

Author: kevin9foong

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

@@ -1,9 +1,9 @@
-import moment from 'moment'
 import mongoose from 'mongoose'
 import { err, ok, okAsync, Result, ResultAsync } from 'neverthrow'
 import Mail from 'nodemailer/lib/mailer'
 
 import {
+  BasicField,
   DateString,
   FormResponseMode,
   PaymentChannel,
@@ -25,7 +25,7 @@ import {
   AutoReplyMailData,
   AutoreplySummaryRenderData,
 } from '../../../services/mail/mail.types'
-import { generateAutoreplyPdf } from '../../../services/mail/mail.utils'
+import { generateAutoreplyPdf, generatePdfRenderData } from '../../../services/mail/mail.utils'
 import { createQueryWithDateParam } from '../../../utils/date'
 import { getMongoErrorMessage } from '../../../utils/handle-mongo-error'
 import { DatabaseError, PossibleDatabaseError } from '../../core/core.errors'
@@ -173,6 +173,15 @@ const checkIfPdfGenerationIsRequired = ({
   )
 }
 
+const getPdfResponsesData = (responsesData: EmailAdminDataField[]): AutoreplySummaryRenderData['formData'] => {
+  return responsesData.map(({ question, answerTemplate, answer, fieldType }) => ({
+    question,
+    // Only signature field types 
+    answer: fieldType === BasicField.Signature ? answer : undefined,
+    answerTemplate
+  }))
+}
+
 const generatePdfAttachmentIfRequired = ({
   isPaymentEnabled,
   autoReplyMailDatas,
@@ -195,25 +204,17 @@ const generatePdfAttachmentIfRequired = ({
     return okAsync(undefined)
   }
 
-  const pdfResponsesData = responsesData.map(
-    ({ question, answerTemplate }) => ({
-      question,
-      answerTemplate,
-    }),
-  )
-
-  const renderData: AutoreplySummaryRenderData = {
+  const pdfRenderData = generatePdfRenderData({
     refNo: submission.id,
     formTitle: form.title,
-    submissionTime: moment(submission.created)
-      .tz('Asia/Singapore')
-      .format('ddd, DD MMM YYYY hh:mm:ss A'),
-    formData: pdfResponsesData,
+    submissionDateTime: submission.created ?? new Date(),
+    responsesData,
     formUrl: `${config.app.appUrl}/${form._id}`,
-  }
+  })
 
-  return generateAutoreplyPdf(renderData, true).map((pdfBuffer) => ({
-    filename: 'response.pdf',
+  const DEFAULT_RESPONSE_PDF_FILENAME = 'response.pdf'
+  return generateAutoreplyPdf(pdfRenderData, true).map((pdfBuffer) => ({
+    filename: DEFAULT_RESPONSE_PDF_FILENAME,
     content: Buffer.copyBytesFrom(pdfBuffer),
   }))
 }

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

@@ -1,4 +1,3 @@
-import moment from 'moment'
 import mongoose from 'mongoose'
 import { err, errAsync, ok, okAsync, Result, ResultAsync } from 'neverthrow'
 import Mail from 'nodemailer/lib/mailer'
@@ -38,8 +37,7 @@ import {
   MailSendError,
 } from '../../../services/mail/mail.errors'
 import MailService from '../../../services/mail/mail.service'
-import { AutoreplySummaryRenderData } from '../../../services/mail/mail.types'
-import { generateAutoreplyPdf } from '../../../services/mail/mail.utils'
+import { generateAutoreplyPdf, generatePdfRenderData } from '../../../services/mail/mail.utils'
 import { transformMongoError } from '../../../utils/handle-mongo-error'
 import { DatabaseError } from '../../core/core.errors'
 import { isFormMultirespondent } from '../../form/form.utils'
@@ -63,10 +61,9 @@ import { reportSubmissionResponseTime } from '../submissions.statsd-client'
 import { MultirespondentSubmissionContent } from './multirespondent-submission.types'
 import {
   extractRespondentCopyEmailDatas,
-  getEmailFromResponses,
-  getPdfResponsesData,
-  getQuestionAnswerPairsForMultipleFields,
-  retrieveWorkflowStepEmailAddresses,
+  getEmailFromResponses, getQuestionAnswerPairsForMultipleFields,
+  getResponsesDataFromMrfResponses,
+  retrieveWorkflowStepEmailAddresses
 } from './multirespondent-submission.utils'
 
 const logger = createLoggerWithLabel(module)
@@ -890,21 +887,16 @@ const generatePdfAttachmentIfRequired = ({
     return okAsync(undefined)
   }
 
-  const submissionTime = moment(submission.created)
-    .tz('Asia/Singapore')
-    .format('ddd, DD MMM YYYY hh:mm:ss A')
-  const formUrl: string = `${config.app.appUrl}/${form._id}`
-
-  const pdfRenderData: AutoreplySummaryRenderData = {
+  const pdfRenderData = generatePdfRenderData({
     refNo: submissionId,
     formTitle: form.title,
-    submissionTime: submissionTime,
-    formData: getPdfResponsesData({
+    submissionDateTime: submission.created ?? new Date(),
+    responsesData: getResponsesDataFromMrfResponses({
       formFields: form.form_fields,
       responses,
     }),
-    formUrl: formUrl,
-  }
+    formUrl: `${config.app.appUrl}/${form._id}`,
+  })
 
   const DEFAULT_RESPONSE_PDF_FILENAME = 'response.pdf'
   const pdfResult = generateAutoreplyPdf(pdfRenderData, true).map(

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

@@ -479,7 +479,7 @@ export const getQuestionAnswerPairsForMultipleFields = ({
  * @param responses - The mrf responses to the form fields
  * @returns list of EmailRespondentConfirmationField used for email & pdf generation
  */
-export const getPdfResponsesData = ({
+export const getResponsesDataFromMrfResponses = ({
   formFields,
   responses,
 }: {

src/app/services/mail/mail.service.ts

@@ -755,6 +755,7 @@ export class MailService {
     const adminEmails: string[] = getAdminEmails(form)
 
     return generateSubmissionToAdminHtml(htmlData).andThen((mailHtml) => {
+
       const mail: MailOptions = {
         to: adminEmails,
         from: this.#senderFromString,

src/app/services/mail/mail.utils.ts

@@ -4,7 +4,7 @@ import { flattenDeep } from 'lodash'
 import { ResultAsync } from 'neverthrow'
 import validator from 'validator'
 
-import { BounceType } from '../../../types'
+import { BounceType, EmailRespondentConfirmationField } from '../../../types'
 import { paymentConfig } from '../../config/features/payment.config'
 import { createLoggerWithLabel } from '../../config/logger'
 import { generatePdfFromHtml } from '../../utils/convert-html-to-pdf'
@@ -22,6 +22,8 @@ import {
   PaymentConfirmationData,
   SubmissionToAdminHtmlData,
 } from './mail.types'
+import moment from 'moment'
+import { BasicField } from '../../../../shared/types'
 
 const logger = createLoggerWithLabel(module)
 
@@ -111,6 +113,36 @@ export const generateBounceNotificationHtml = (
   return safeRenderFile(pathToTemplate, htmlData)
 }
 
+export const generatePdfRenderData = ({
+  refNo, 
+  formTitle, 
+  submissionDateTime,
+  responsesData,
+  formUrl,
+}: {
+  refNo: string
+  formTitle: string
+  submissionDateTime: Date
+  responsesData: EmailRespondentConfirmationField[]
+  formUrl: string
+}): AutoreplySummaryRenderData => {
+
+  const pdfResponsesData = responsesData.map(({ question, answerTemplate, answer, fieldType }) => ({
+    question,
+    answerTemplate, 
+    // In the submit-form-summary-pdf.server.view.html, for signature field, it expects the answer key, while for others, it expects the answerTemplate key.
+    answer: fieldType === BasicField.Signature ? answer : undefined,
+  }))
+
+  return {
+    refNo, 
+    formTitle, 
+    submissionTime: moment(submissionDateTime).tz('Asia/Singapore').format('ddd, DD MMM YYYY hh:mm:ss A'),
+    formData: pdfResponsesData,
+    formUrl
+  }
+}
+
 export const generateAutoreplyPdf = (
   renderData: AutoreplySummaryRenderData,
   isUseLambdaOutput: boolean,