fix: encapsulate pdf render data generation

Author: kevin9foong

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

@@ -21,10 +21,7 @@ import { getEncryptSubmissionModel } from '../../../models/submission.server.mod
 import { AutoreplyPdfGenerationError } from '../../../services/mail/mail.errors'
 import MailService from '../../../services/mail/mail.service'
 import { AutoReplyMailData } from '../../../services/mail/mail.types'
-import {
-  generateAutoreplyPdf,
-  generatePdfRenderData,
-} from '../../../services/mail/mail.utils'
+import { generateAutoreplyPdf } from '../../../services/mail/mail.utils'
 import { createQueryWithDateParam } from '../../../utils/date'
 import { getMongoErrorMessage } from '../../../utils/handle-mongo-error'
 import { DatabaseError, PossibleDatabaseError } from '../../core/core.errors'
@@ -194,16 +191,16 @@ const generatePdfAttachmentIfRequired = ({
     return okAsync(undefined)
   }
 
-  const pdfRenderData = generatePdfRenderData({
+  const autoReplyData = {
     refNo: submission.id,
     formTitle: form.title,
     submissionDateTime: submission.created ?? new Date(),
     responsesData,
     formUrl: `${config.app.appUrl}/${form._id}`,
-  })
+  }
 
   const DEFAULT_RESPONSE_PDF_FILENAME = 'response.pdf'
-  return generateAutoreplyPdf(pdfRenderData, true).map((pdfBuffer) => ({
+  return generateAutoreplyPdf(autoReplyData, true).map((pdfBuffer) => ({
     filename: DEFAULT_RESPONSE_PDF_FILENAME,
     content: Buffer.copyBytesFrom(pdfBuffer),
   }))

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

@@ -37,10 +37,7 @@ import {
   MailSendError,
 } from '../../../services/mail/mail.errors'
 import MailService from '../../../services/mail/mail.service'
-import {
-  generateAutoreplyPdf,
-  generatePdfRenderData,
-} from '../../../services/mail/mail.utils'
+import { generateAutoreplyPdf } from '../../../services/mail/mail.utils'
 import { transformMongoError } from '../../../utils/handle-mongo-error'
 import { DatabaseError } from '../../core/core.errors'
 import { isFormMultirespondent } from '../../form/form.utils'
@@ -896,16 +893,16 @@ const generatePdfAttachmentIfRequired = ({
     responses,
   })
 
-  const pdfRenderData = generatePdfRenderData({
+  const autoReplyData = {
     refNo: submissionId,
     formTitle: form.title,
     submissionDateTime: submission.created ?? new Date(),
     responsesData,
     formUrl: `${config.app.appUrl}/${form._id}`,
-  })
+  }
 
   const DEFAULT_RESPONSE_PDF_FILENAME = 'response.pdf'
-  const pdfResult = generateAutoreplyPdf(pdfRenderData, true).map(
+  const pdfResult = generateAutoreplyPdf(autoReplyData, true).map(
     (pdfBuffer) => ({
       filename: DEFAULT_RESPONSE_PDF_FILENAME,
       content: Buffer.copyBytesFrom(pdfBuffer),

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

@@ -113,19 +113,21 @@ export const generateBounceNotificationHtml = (
   return safeRenderFile(pathToTemplate, htmlData)
 }
 
-export const generatePdfRenderData = ({
-  refNo,
-  formTitle,
-  submissionDateTime,
-  responsesData,
-  formUrl,
-}: {
+interface AutoReplyData {
   refNo: string
   formTitle: string
   submissionDateTime: Date
   responsesData: EmailRespondentConfirmationField[]
   formUrl: string
-}): AutoreplySummaryRenderData => {
+}
+
+const generatePdfRenderData = ({
+  refNo,
+  formTitle,
+  submissionDateTime,
+  responsesData,
+  formUrl,
+}: AutoReplyData): AutoreplySummaryRenderData => {
   const pdfResponsesData = responsesData.map(
     ({ question, answerTemplate, answer, fieldType }) => ({
       question,
@@ -147,7 +149,7 @@ export const generatePdfRenderData = ({
 }
 
 export const generateAutoreplyPdf = (
-  renderData: AutoreplySummaryRenderData,
+  autoReplyData: AutoReplyData,
   isUseLambdaOutput: boolean,
 ): ResultAsync<Buffer, AutoreplyPdfGenerationError> => {
   const pathToTemplate = `${__dirname}/../../views/templates/submit-form-summary-pdf.server.view.html`
@@ -162,22 +164,26 @@ export const generateAutoreplyPdf = (
     },
   })
 
-  return safeRenderFile(pathToTemplate, renderData).andThen((summaryHtml) => {
-    return ResultAsync.fromPromise(
-      generatePdfFromHtml(summaryHtml, isUseLambdaOutput),
-      (error) => {
-        logger.error({
-          meta: {
-            action: 'generateAutoreplyPdf',
-          },
-          message: 'Error occurred whilst generating autoreply PDF',
-          error,
-        })
+  const pdfRenderData = generatePdfRenderData(autoReplyData)
 
-        return new AutoreplyPdfGenerationError()
-      },
-    )
-  })
+  return safeRenderFile(pathToTemplate, pdfRenderData).andThen(
+    (summaryHtml) => {
+      return ResultAsync.fromPromise(
+        generatePdfFromHtml(summaryHtml, isUseLambdaOutput),
+        (error) => {
+          logger.error({
+            meta: {
+              action: 'generateAutoreplyPdf',
+            },
+            message: 'Error occurred whilst generating autoreply PDF',
+            error,
+          })
+
+          return new AutoreplyPdfGenerationError()
+        },
+      )
+    },
+  )
 }
 
 export const generateAutoreplyHtml = (