feat: move admin email notif to post actions for encrypt

Author: kevin9foong

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

@@ -17,7 +17,6 @@ import {
 } from '../../../../../shared/types'
 import {
   IAttachmentInfo,
-  IEncryptedForm,
   IEncryptedSubmissionSchema,
   IPopulatedEncryptedForm,
   StripePaymentMetadataDto,
@@ -35,7 +34,6 @@ import getPaymentModel from '../../../models/payment.server.model'
 import { getEncryptPendingSubmissionModel } from '../../../models/pending_submission.server.model'
 import { getEncryptSubmissionModel } from '../../../models/submission.server.model'
 import * as CaptchaMiddleware from '../../../services/captcha/captcha.middleware'
-import MailService from '../../../services/mail/mail.service'
 import * as TurnstileMiddleware from '../../../services/turnstile/turnstile.middleware'
 import { Pipeline } from '../../../utils/pipeline-middleware'
 import { createReqMeta } from '../../../utils/request'
@@ -56,7 +54,6 @@ import { getOidcService } from '../../spcp/spcp.oidc.service'
 import { getPopulatedUserById } from '../../user/user.service'
 import * as VerifiedContentService from '../../verified-content/verified-content.service'
 import { MYINFO_PREFIX } from '../email-submission/email-submission.constants'
-import * as EmailSubmissionService from '../email-submission/email-submission.service'
 import { SubmissionEmailObj } from '../email-submission/email-submission.util'
 import * as EncryptSubmissionMiddleware from '../encrypt-submission/encrypt-submission.middleware'
 import ParsedResponsesObject from '../ParsedResponsesObject.class'
@@ -778,50 +775,7 @@ const _createSubmission = async ({
   })
 
   const createdTime = submission.created || new Date()
-
-  const logMetaWithSubmission = {
-    ...logMeta,
-    submissionId,
-    responseMetadata,
-  }
-
-  const emailData = 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) => ({
-    question: item.question.startsWith(MYINFO_PREFIX)
-      ? item.question.slice(MYINFO_PREFIX.length)
-      : item.question,
-    answer: item.answer,
-  }))
-
   const emailAttachments = [...(unencryptedAttachments ?? [])]
-  // We don't await for email submission, as the submission gets saved for encrypt
-  // submissions regardless, the email is more of a notification and shouldn't
-  // stop the storage of the data in the db
-  if (((form as IEncryptedForm)?.emails || []).length > 0) {
-    logger.info({
-      message: 'Sending admin notification mail',
-      meta: logMetaWithSubmission,
-    })
-
-    void MailService.sendSubmissionToAdmin({
-      replyToEmails: EmailSubmissionService.extractEmailAnswers(emailFields),
-      form,
-      submission: {
-        created: createdTime,
-        id: submission.id,
-      },
-      attachments: emailAttachments,
-      formData: emailData.formData,
-      dataCollationData,
-    })
-  }
 
   // TODO 6395 make responseMetadata mandatory
   if (responseMetadata) {
@@ -847,7 +801,7 @@ const _createSubmission = async ({
     submission,
     responses,
     growthbook: req.growthbook,
-    emailData,
+    emailFields, 
     attachments: emailAttachments,
     respondentEmails,
   })

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

@@ -4,6 +4,8 @@ import { err, ok, okAsync, Result, ResultAsync } from 'neverthrow'
 import Mail from 'nodemailer/lib/mailer'
 
 import { AutoReplyMailData } 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 {
@@ -12,10 +14,9 @@ import {
   SubmissionType,
 } from '../../../../../shared/types'
 import {
-  FieldResponse,
-  IEncryptedSubmissionSchema,
+  FieldResponse, IEncryptedSubmissionSchema,
   IPopulatedEncryptedForm,
-  IPopulatedForm,
+  IPopulatedForm
 } from '../../../../types'
 import { createLoggerWithLabel } from '../../../config/logger'
 import { getEncryptSubmissionModel } from '../../../models/submission.server.model'
@@ -41,6 +42,9 @@ import {
 import { sendEmailConfirmations } from '../submission.service'
 import { extractEmailConfirmationData } from '../submission.utils'
 
+import { AutoreplyPdfGenerationError } from 'src/app/services/mail/mail.errors'
+import { MYINFO_PREFIX } from '../email-submission/email-submission.constants'
+import { ProcessedFieldResponse } from '../submission.types'
 import { CHARTS_MAX_SUBMISSION_RESULTS } from './encrypt-submission.constants'
 import { SaveEncryptSubmissionParams } from './encrypt-submission.types'
 
@@ -98,10 +102,10 @@ export const assertFormIsSingleSubmissionDisabled = (
   return !form.isSingleSubmission
     ? ok(form)
     : err(
-        new UnsupportedSettingsError(
-          'isSingleSubmission cannot be enabled for payment forms as it is not currently supported',
-        ),
-      )
+      new UnsupportedSettingsError(
+        'isSingleSubmission cannot be enabled for payment forms as it is not currently supported',
+      ),
+    )
 }
 
 /**
@@ -131,6 +135,26 @@ export const createEncryptSubmissionWithoutSave = ({
   })
 }
 
+const checkIfAdminPdfIsRequired = (): boolean => {
+  return false
+}
+
+const checkIfRespondentFormSummaryIsRequired = (): boolean => {
+  return false
+}
+
+const checkIfPdfGenerationIsRequired = (): boolean => {
+  return checkIfAdminPdfIsRequired() || checkIfRespondentFormSummaryIsRequired()
+}
+
+const generatePdfAttachmentIfRequired = (): ResultAsync<Mail.Attachment | undefined, AutoreplyPdfGenerationError> => {
+  if (!checkIfPdfGenerationIsRequired()) {
+    return okAsync(undefined)
+  }
+  
+  return okAsync(undefined)
+}
+
 /**
  * Performs the post-submission actions for encrypt submissions. This is to be
  * called when the submission is completed
@@ -149,14 +173,14 @@ export const performEncryptPostSubmissionActions = ({
   submission,
   responses,
   growthbook,
-  emailData,
+  emailFields,
   attachments,
   respondentEmails,
 }: {
   submission: IEncryptedSubmissionSchema
   responses: FieldResponse[]
   growthbook?: GrowthBook
-  emailData?: SubmissionEmailObj
+  emailFields: ProcessedFieldResponse[]
   attachments?: Mail.Attachment[]
   respondentEmails?: string[]
 }): ResultAsync<
@@ -207,11 +231,11 @@ export const performEncryptPostSubmissionActions = ({
       .andThen((form) => {
         const respondentCopyEmailData: AutoReplyMailData[] = respondentEmails
           ? respondentEmails?.map((val) => {
-              return {
-                email: val,
-                includeFormSummary: true,
-              }
-            })
+            return {
+              email: val,
+              includeFormSummary: true,
+            }
+          })
           : []
 
         // TODO [PDF-LAMBDA-GENERATION]: Remove setting of Growthbook targetting once pdf generation rollout is complete
@@ -230,25 +254,60 @@ export const performEncryptPostSubmissionActions = ({
           },
         })
 
-        return sendEmailConfirmations({
-          form,
-          submission,
-          attachments,
-          responsesData: emailData?.autoReplyData,
-          recipientData: [
-            ...extractEmailConfirmationData(responses, form.form_fields),
-            ...respondentCopyEmailData,
-          ],
-          isUseLambdaOutput,
-        }).mapErr((error) => {
-          logger.error({
-            message: 'Error while sending email confirmations',
-            meta: {
-              action: 'sendEmailAutoReplies',
+        const emailData = 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) => ({
+          question: item.question.startsWith(MYINFO_PREFIX)
+            ? item.question.slice(MYINFO_PREFIX.length)
+            : item.question,
+          answer: item.answer,
+        }))
+
+        const pdfAttachmentResult = generatePdfAttachmentIfRequired()
+
+        return pdfAttachmentResult.andThen((pdfAttachment) => {
+          if (pdfAttachment) {
+            attachments = [...(attachments ?? []), pdfAttachment]
+          }
+
+          void MailService.sendSubmissionToAdmin({
+            replyToEmails: EmailSubmissionService.extractEmailAnswers(emailFields),
+            form,
+            submission: {
+              created: submission.created,
+              id: submission.id,
             },
-            error,
+            attachments,
+            formData: emailData.formData,
+            dataCollationData,
+          })
+
+          return sendEmailConfirmations({
+            form,
+            submission,
+            attachments,
+            responsesData: emailData?.autoReplyData,
+            recipientData: [
+              ...extractEmailConfirmationData(responses, form.form_fields),
+              ...respondentCopyEmailData,
+            ],
+            isUseLambdaOutput,
+          }).mapErr((error) => {
+            logger.error({
+              message: 'Error while sending email confirmations',
+              meta: {
+                action: 'sendEmailAutoReplies',
+              },
+              error,
+            })
+            return error
           })
-          return error
         })
       })
   )

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

@@ -737,17 +737,17 @@ export const createMultiRespondentFormSubmission = ({
     })
 }
 
-interface CheckHasRespondentCopyFormSummaryArgs {
+interface CheckIfRespondentFormSummaryIsRequiredArgs {
   responses: FieldResponsesV3
   formFields: FormFieldSchema[] | FormFieldDto[]
   currentStepActiveFields: string[]
 }
 
-const checkHasRespondentCopyFormSummary = ({
+const checkIfRespondentFormSummaryIsRequired = ({
   responses,
   formFields,
   currentStepActiveFields,
-}: CheckHasRespondentCopyFormSummaryArgs): boolean => {
+}: CheckIfRespondentFormSummaryIsRequiredArgs): boolean => {
   const respondentCopyEmailDatas = extractRespondentCopyEmailDatas({
     responses,
     formFields,
@@ -756,7 +756,7 @@ const checkHasRespondentCopyFormSummary = ({
   return respondentCopyEmailDatas && respondentCopyEmailDatas.some(emailData => emailData.includeFormSummary)
 }
 
-interface CheckIsWorkflowCompletionEmailRequiredArgs {
+interface CheckIsWorkflowCompletionEmailPdfRequiredArgs {
   currentStepNumber: number
   form: Pick<IPopulatedMultirespondentForm, '_id' | 'workflow' | 'emails' | 'stepsToNotify' | 'stepOneEmailNotificationFieldId'> & {
     form_fields: FormFieldSchema[] | FormFieldDto[]
@@ -766,13 +766,13 @@ interface CheckIsWorkflowCompletionEmailRequiredArgs {
   submissionId: string
 }
 
-const checkIsWorkflowCompletionEmailRequired = ({
+const checkIsWorkflowCompletionEmailPdfRequired = ({
   currentStepNumber,
   form,
   responses,
   isRejected,
   submissionId,
-}: CheckIsWorkflowCompletionEmailRequiredArgs) => {
+}: CheckIsWorkflowCompletionEmailPdfRequiredArgs) => {
   const isWorkflowCompleted = checkIsWorkflowCompleted({
     currentStepNumber,
     form,
@@ -789,7 +789,7 @@ const checkIsWorkflowCompletionEmailRequired = ({
   return isWorkflowCompleted && hasEmailsToSendMrfOutcomeNotification.isOk() && hasEmailsToSendMrfOutcomeNotification.value.length > 0
 }
 
-type CheckIsPdfGenerationRequiredArgs = Omit<CheckHasRespondentCopyFormSummaryArgs, 'formFields'> & CheckIsWorkflowCompletionEmailRequiredArgs
+type CheckIsPdfGenerationRequiredArgs = Omit<CheckIfRespondentFormSummaryIsRequiredArgs, 'formFields'> & CheckIsWorkflowCompletionEmailPdfRequiredArgs
 
 const checkIsPdfGenerationRequired = ({
   responses,
@@ -799,8 +799,8 @@ const checkIsPdfGenerationRequired = ({
   isRejected,
   submissionId,
 }: CheckIsPdfGenerationRequiredArgs): boolean => {
-  return checkHasRespondentCopyFormSummary({ responses, formFields: form.form_fields, currentStepActiveFields })
-    || checkIsWorkflowCompletionEmailRequired({
+  return checkIfRespondentFormSummaryIsRequired({ responses, formFields: form.form_fields, currentStepActiveFields })
+    || checkIsWorkflowCompletionEmailPdfRequired({
       currentStepNumber,
       form,
       responses,
@@ -809,7 +809,7 @@ const checkIsPdfGenerationRequired = ({
     })
 }
 
-const generatePdfIfRequired = ({
+const generatePdfAttachmentIfRequired = ({
   submission,
   form,
   responses,
@@ -882,7 +882,7 @@ export const performMultiRespondentPostSubmissionCreateActions = ({
     submissionId,
   }
 
-  const pdfResult = generatePdfIfRequired({
+  const pdfResult = generatePdfAttachmentIfRequired({
     submission,
     form,
     responses,
@@ -1197,7 +1197,7 @@ export const performMultiRespondentPostSubmissionUpdateActions = ({
       })
   }
 
-  const pdfResult = generatePdfIfRequired({
+  const pdfResult = generatePdfAttachmentIfRequired({
     submission,
     form: snapshottedFormDef,
     responses,