feat: setup shared pdf generation

Author: kevin9foong

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

@@ -3,21 +3,24 @@ import mongoose from 'mongoose'
 import { err, ok, okAsync, Result, ResultAsync } from 'neverthrow'
 import Mail from 'nodemailer/lib/mailer'
 
-import { AutoReplyMailData } from 'src/app/services/mail/mail.types'
+import { AutoReplyMailData, AutoreplySummaryRenderData } from 'src/app/services/mail/mail.types'
 import MailService from '../../../services/mail/mail.service'
 import * as EmailSubmissionService from '../email-submission/email-submission.service'
 
 import { featureFlags } from '../../../../../shared/constants'
 import {
   DateString,
   FormResponseMode,
+  PaymentChannel,
   SubmissionType,
 } from '../../../../../shared/types'
 import {
+  EmailAdminDataField,
   FieldResponse, IEncryptedSubmissionSchema,
   IPopulatedEncryptedForm,
   IPopulatedForm
 } from '../../../../types'
+import config from '../../../config/config'
 import { createLoggerWithLabel } from '../../../config/logger'
 import { getEncryptSubmissionModel } from '../../../models/submission.server.model'
 import { createQueryWithDateParam } from '../../../utils/date'
@@ -42,7 +45,9 @@ import {
 import { sendEmailConfirmations } from '../submission.service'
 import { extractEmailConfirmationData } from '../submission.utils'
 
+import moment from 'moment'
 import { AutoreplyPdfGenerationError } from 'src/app/services/mail/mail.errors'
+import { generateAutoreplyPdf } from 'src/app/services/mail/mail.utils'
 import { MYINFO_PREFIX } from '../email-submission/email-submission.constants'
 import { ProcessedFieldResponse } from '../submission.types'
 import { CHARTS_MAX_SUBMISSION_RESULTS } from './encrypt-submission.constants'
@@ -136,23 +141,71 @@ export const createEncryptSubmissionWithoutSave = ({
 }
 
 const checkIfAdminPdfIsRequired = (): boolean => {
-  return false
+  return true
 }
 
-const checkIfRespondentFormSummaryIsRequired = (): boolean => {
-  return false
+const checkIfRespondentFormSummaryIsRequired = ({
+  autoReplyMailDatas,
+  isPaymentEnabled,
+}: {
+  autoReplyMailDatas: AutoReplyMailData[]
+  isPaymentEnabled: boolean
+}): boolean => {
+  return !isPaymentEnabled && autoReplyMailDatas.some((data) => data.includeFormSummary)
 }
 
-const checkIfPdfGenerationIsRequired = (): boolean => {
-  return checkIfAdminPdfIsRequired() || checkIfRespondentFormSummaryIsRequired()
+const checkIfPdfGenerationIsRequired = ({
+  isPaymentEnabled,
+  autoReplyMailDatas,
+}: {
+  isPaymentEnabled: boolean
+  autoReplyMailDatas: AutoReplyMailData[]
+}): boolean => {
+  return checkIfAdminPdfIsRequired() || checkIfRespondentFormSummaryIsRequired({
+    isPaymentEnabled,
+    autoReplyMailDatas,
+  })
 }
 
-const generatePdfAttachmentIfRequired = (): ResultAsync<Mail.Attachment | undefined, AutoreplyPdfGenerationError> => {
-  if (!checkIfPdfGenerationIsRequired()) {
+const generatePdfAttachmentIfRequired = ({
+  isPaymentEnabled,
+  autoReplyMailDatas,
+  submission,
+  form,
+  responsesData,
+}: {
+  isPaymentEnabled: boolean
+  autoReplyMailDatas: AutoReplyMailData[]
+  submission: IEncryptedSubmissionSchema
+  form: IPopulatedEncryptedForm
+  responsesData: (Pick<EmailAdminDataField, 'question' | 'answerTemplate'> & {
+    answer?: EmailAdminDataField['answer']
+  })[]
+}): ResultAsync<Mail.Attachment | undefined, AutoreplyPdfGenerationError> => {
+  if (!checkIfPdfGenerationIsRequired({
+    isPaymentEnabled,
+    autoReplyMailDatas,
+  })) {
     return okAsync(undefined)
   }
-  
-  return okAsync(undefined)
+
+  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,
+    formUrl: `${config.app.appUrl}/${form._id}`,
+  }
+
+  return generateAutoreplyPdf(
+    renderData,
+    true,
+  ).map((pdfBuffer) => ({
+    filename: 'response.pdf',
+    content: Buffer.copyBytesFrom(pdfBuffer),
+  }))
 }
 
 /**
@@ -269,13 +322,25 @@ export const performEncryptPostSubmissionActions = ({
           answer: item.answer,
         }))
 
-        const pdfAttachmentResult = generatePdfAttachmentIfRequired()
+        const recipientEmailDatas = [
+          ...extractEmailConfirmationData(responses, form.form_fields),
+          ...respondentCopyEmailData,
+        ]
 
-        return pdfAttachmentResult.andThen((pdfAttachment) => {
-          if (pdfAttachment) {
-            attachments = [...(attachments ?? []), pdfAttachment]
-          }
+        const isPaymentEnabled =
+          form.responseMode === FormResponseMode.Encrypt &&
+          form.payments_channel.channel !== PaymentChannel.Unconnected &&
+          form.payments_field.enabled === true
+
+        const pdfAttachmentResult = generatePdfAttachmentIfRequired({
+          isPaymentEnabled,
+          autoReplyMailDatas: recipientEmailDatas,
+          submission,
+          form,
+          responsesData: emailData.formData,
+        })
 
+        return pdfAttachmentResult.andThen((pdfAttachment) => {
           void MailService.sendSubmissionToAdmin({
             replyToEmails: EmailSubmissionService.extractEmailAnswers(emailFields),
             form,
@@ -293,11 +358,8 @@ export const performEncryptPostSubmissionActions = ({
             submission,
             attachments,
             responsesData: emailData?.autoReplyData,
-            recipientData: [
-              ...extractEmailConfirmationData(responses, form.form_fields),
-              ...respondentCopyEmailData,
-            ],
-            isUseLambdaOutput,
+            recipientData: recipientEmailDatas,
+            pdfAttachment,
           }).mapErr((error) => {
             logger.error({
               message: 'Error while sending email confirmations',

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

@@ -458,8 +458,8 @@ export type TriggerVirusScanThenDownloadCleanFileChainError =
  */
 export const triggerVirusScanThenDownloadCleanFileChain = <
   T extends
-    | ParsedClearAttachmentResponse
-    | ParsedClearAttachmentFieldResponseV3,
+  | ParsedClearAttachmentResponse
+  | ParsedClearAttachmentFieldResponseV3,
 >(
   response: T,
   formId: string,
@@ -593,14 +593,14 @@ export const sendEmailConfirmations = <S extends ISubmissionSchema>({
   responsesData = [],
   attachments,
   recipientData,
-  isUseLambdaOutput,
+  pdfAttachment,
 }: {
   form: IPopulatedForm
   submission: S
   responsesData?: EmailRespondentConfirmationField[]
   attachments?: Mail.Attachment[]
   recipientData: AutoReplyMailData[]
-  isUseLambdaOutput: boolean
+  pdfAttachment?: Mail.Attachment
 }): ResultAsync<true, SendEmailConfirmationError> => {
   const logMeta = {
     action: 'sendEmailConfirmations',
@@ -616,7 +616,7 @@ export const sendEmailConfirmations = <S extends ISubmissionSchema>({
     attachments,
     responsesData,
     autoReplyMailDatas: recipientData,
-    isUseLambdaOutput,
+    pdfAttachment,
   })
   return ResultAsync.fromPromise(sentEmailsPromise, (error) => {
     logger.error({
@@ -1381,8 +1381,8 @@ export type TriggerGuardDutyScanThenDownloadCleanFileChainError =
  */
 export const triggerGuardDutyScanThenDownloadCleanFileChain = <
   T extends
-    | ParsedClearAttachmentResponse
-    | ParsedClearAttachmentFieldResponseV3,
+  | ParsedClearAttachmentResponse
+  | ParsedClearAttachmentFieldResponseV3,
 >(
   response: T,
   formId: string,

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

@@ -2,7 +2,7 @@ import { render } from '@react-email/render'
 import tracer from 'dd-trace'
 import { get, inRange, isEmpty } from 'lodash'
 import moment from 'moment-timezone'
-import { Result, ResultAsync, err, errAsync, fromPromise, okAsync } from 'neverthrow'
+import { Result, ResultAsync, errAsync, fromPromise, okAsync } from 'neverthrow'
 import Mail from 'nodemailer/lib/mailer'
 import promiseRetry from 'promise-retry'
 import validator from 'validator'
@@ -61,14 +61,12 @@ import {
   SubmissionToAdminHtmlData,
 } from './mail.types'
 import {
-  generateAutoreplyHtml,
-  generateAutoreplyPdf,
-  generateIssueReportedNotificationHtml,
+  generateAutoreplyHtml, generateIssueReportedNotificationHtml,
   generateLoginOtpHtml,
   generatePaymentConfirmationHtml,
   generatePaymentOnboardingHtml,
   generateSubmissionToAdminHtml,
-  isToFieldValid,
+  isToFieldValid
 } from './mail.utils'
 
 const logger = createLoggerWithLabel(module)
@@ -688,6 +686,7 @@ export class MailService {
     attachments,
     dataCollationData,
     formData,
+    pdfAttachment,
   }: {
     replyToEmails?: string[]
     form: Pick<IFormHasEmailSchema, '_id' | 'title' | 'emails'>
@@ -698,6 +697,7 @@ export class MailService {
       question: string
       answer: string | number
     }[]
+    pdfAttachment?: Mail.Attachment
   }): ResultAsync<true, MailGenerationError | MailSendError> => {
     const logMeta = {
       action: 'sendSubmissionToAdmin',
@@ -710,6 +710,10 @@ export class MailService {
       return okAsync(true)
     }
 
+    if (pdfAttachment) {
+      attachments = [...(attachments ?? []), pdfAttachment]
+    }
+
     logger.info({
       message: 'Sending admin notification mail',
       meta: logMeta,
@@ -802,7 +806,7 @@ export class MailService {
     responsesData,
     autoReplyMailDatas,
     attachments = [],
-    isUseLambdaOutput,
+    pdfAttachment,
   }: SendAutoReplyEmailsArgs): Promise<
     PromiseSettledResult<
       Result<
@@ -813,57 +817,30 @@ export class MailService {
   > => {
     // Data to render both the submission details mail HTML body and PDF.
 
-    const renderData: AutoreplySummaryRenderData = {
+    const strippedRenderData: 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,
+      // strip answer from renderData to always use answerTemplate for email body responses
+      formData: responsesData.map(
+        ({ question, answerTemplate }) => ({
+          question,
+          answerTemplate,
+        })),
       formUrl: `${this.#appUrl}/${form._id}`,
     }
 
     // Create a copy of attachments for attaching of autoreply pdf if needed.
-    const attachmentsWithAutoreplyPdf = [...attachments]
+    const attachmentsWithAutoreplyPdf = [...attachments, ...(pdfAttachment ? [pdfAttachment] : [])]
     const isEncryptForm = form?.responseMode === FormResponseMode.Encrypt
     const encryptFormDef = form as IPopulatedEncryptedForm
     const isPaymentEnabled =
       isEncryptForm &&
       encryptFormDef.payments_channel.channel !== PaymentChannel.Unconnected &&
       encryptFormDef.payments_field.enabled === true
 
-    // Generate autoreply pdf and append into attachments if any of the mail has
-    // to include a form summary.
-    if (
-      autoReplyMailDatas.some((data) => data.includeFormSummary) &&
-      !isPaymentEnabled
-    ) {
-      const pdfBufferResult = await generateAutoreplyPdf(
-        renderData,
-        isUseLambdaOutput,
-      )
-      if (pdfBufferResult.isErr()) {
-        return Promise.allSettled([err(pdfBufferResult.error)])
-      }
-      attachmentsWithAutoreplyPdf.push({
-        filename: 'response.pdf',
-        content: Buffer.copyBytesFrom(pdfBufferResult.value),
-      })
-    }
-
-    // strip answer from renderData to always use answerTemplate for email body responses
-    const strippedResponsesData = responsesData.map(
-      ({ question, answerTemplate }) => ({
-        question,
-        answerTemplate,
-      }),
-    )
-
-    const strippedRenderData = {
-      ...renderData,
-      formData: strippedResponsesData,
-    }
-
     // Prepare mail sending for each autoreply mail.
     return Promise.allSettled(
       autoReplyMailDatas.map((mailData, index) => {

src/app/services/mail/mail.types.ts

@@ -33,7 +33,7 @@ export type SendAutoReplyEmailsArgs = {
     answer?: EmailAdminDataField['answer']
   })[]
   autoReplyMailDatas: AutoReplyMailData[]
-  isUseLambdaOutput: boolean
+  pdfAttachment?: Mail.Attachment
 }
 
 export type MailServiceParams = {