feat: remove typing

feat: move common pdf processing functions to shared submissions.util

feat: simplify getPdfResponsesData signatureDataPngUri passing

feat: fix import ordering and unused

feat: encapsulate mrf respondent copy email sending logic

feat: move pdf generation to outer

feat: pass pdf to mrf outcomes for sending

feat: move admin email notif to post actions for encrypt

feat: setup shared pdf generation

feat: propagate isPaymentForm check up and only attach pdf if required

fix: lint formatting

feat: rename to submissionAttachment for clarity and move tcs to service

fix: submission service tcs

fix: encryption-submission.service.spec tests

fix: mock generate pdf in mrf service spec

fix: lint and fix tc

fix: ts build errors and remove unused code

fix: change to relative imports

chore: update comment for bug

fix: lint and fix sp tc

chore: remove stray console logs

fix: make responses data compatible with pdf

chore: move function to mrf utils

fix: lint issues

chore: restore past naming

feat: move pdf render data copy to common function

fix: duplicate pdf due to mutation

fix: duplicate pdf due to mutation

fix: include fieldtype to remove answer for non signature for mrf

fix: tc for field type

fix: encapsulate pdf render data generation

feat: add tc for generating pdf render data for signature and non signature fields

feat: add tc for mail service

feat: add payment enabled check

feat: add tc for encrypt mode sending confirmation and pdf gen

fix: missing fieldtype

feat: add tc for new extractRespondentCopyEmailDatas function

feat: add tc for workflow outcome pdf generation

feat: add tc for respondent copy

Author: kevin9foong

src/app/modules/payments/payments.service.ts

@@ -1,4 +1,3 @@
-import { GrowthBook } from '@growthbook/growthbook'
 import { isEqual, omit } from 'lodash'
 import moment from 'moment-timezone'
 import mongoose, { Types } from 'mongoose'
@@ -209,7 +208,6 @@ export const confirmPaymentPendingSubmission = (
  */
 export const performPaymentPostSubmissionActions = (
   paymentId: IPaymentSchema['_id'],
-  growthbook: GrowthBook | undefined,
 ): ResultAsync<
   void,
   | PaymentNotFoundError
@@ -244,7 +242,7 @@ export const performPaymentPostSubmissionActions = (
                 performEncryptPostSubmissionActions({
                   submission,
                   responses: payment.responses,
-                  growthbook,
+                  emailFields: [], // TODO [EMAIL-CONFIRMATION-BUG]: Email confirmation email to email fields does not work for payment forms, this is an existing issue to be fixed.
                 })
                   .andThen(() =>
                     // If successfully sent email confirmations, delete response data from payment document.

src/app/modules/payments/stripe.controller.ts

@@ -304,10 +304,7 @@ export const reconcileAccount: ControllerHandler<
         meta: { ...logMeta, event },
       })
 
-      await StripeService.handleStripeEvent(
-        event as Stripe.DiscriminatedEvent,
-        req.growthbook,
-      )
+      await StripeService.handleStripeEvent(event as Stripe.DiscriminatedEvent)
         .andThen(() => {
           logger.warn({
             message:

src/app/modules/payments/stripe.events.controller.ts

@@ -89,7 +89,7 @@ const _handleStripeEventUpdates: ControllerHandler<
 
   // Step 3: Process the event
   return (
-    StripeService.handleStripeEvent(event, req.growthbook)
+    StripeService.handleStripeEvent(event)
       // Step 4: Return response to Stripe based on result
       .match(
         () => res.sendStatus(StatusCodes.OK),

src/app/modules/payments/stripe.service.ts

@@ -1,6 +1,5 @@
 // Use 'stripe-event-types' for better type discrimination.
 /// <reference types="stripe-event-types" />
-import { GrowthBook } from '@growthbook/growthbook'
 import cuid from 'cuid'
 import mongoose from 'mongoose'
 import { errAsync, ok, okAsync, ResultAsync } from 'neverthrow'
@@ -451,7 +450,6 @@ type HandleStripeEventResultError =
  */
 export const handleStripeEvent = (
   event: Stripe.DiscriminatedEvent,
-  growthbook: GrowthBook | undefined,
 ): ResultAsync<void, HandleStripeEventResultError> => {
   const logMeta = {
     action: 'handleStripeEvent',
@@ -498,7 +496,6 @@ export const handleStripeEvent = (
 
             return PaymentsService.performPaymentPostSubmissionActions(
               paymentId,
-              growthbook,
             )
               .andThen(() => okAsync(undefined))
               .orElse((e) => {

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

@@ -92,6 +92,7 @@ const MOCK_AUTOREPLY_DATA = [
     question: 'Email',
     answerTemplate: ['[email protected]'],
     fieldType: BasicField.Email,
+    fieldType: BasicField.Email,
   },
 ]
 const AUTOREPLY_OPTIONS_1: AutoReplyOptions = {
@@ -455,7 +456,9 @@ describe('submission.service', () => {
         form: mockForm,
         recipientData,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
         responsesData: MOCK_AUTOREPLY_DATA,
         isUseLambdaOutput: false,
       })
@@ -468,7 +471,9 @@ describe('submission.service', () => {
       expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
         form: mockForm,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
         responsesData: MOCK_AUTOREPLY_DATA,
         autoReplyMailDatas: expectedAutoReplyData,
       })
@@ -497,7 +502,9 @@ describe('submission.service', () => {
         form: mockForm,
         recipientData,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
         responsesData: MOCK_AUTOREPLY_DATA,
         isUseLambdaOutput: false,
       })
@@ -543,7 +550,9 @@ describe('submission.service', () => {
         form: mockForm,
         recipientData,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
         responsesData: MOCK_AUTOREPLY_DATA,
         isUseLambdaOutput: false,
       })
@@ -595,7 +604,9 @@ describe('submission.service', () => {
         form: mockForm,
         recipientData,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
         responsesData: MOCK_AUTOREPLY_DATA,
         isUseLambdaOutput: false,
       })
@@ -605,7 +616,9 @@ describe('submission.service', () => {
       expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
         form: mockForm,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
         responsesData: MOCK_AUTOREPLY_DATA,
         autoReplyMailDatas: expectedAutoReplyData,
       })
@@ -659,9 +672,10 @@ describe('submission.service', () => {
         form: mockForm,
         recipientData,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
-        responsesData: undefined,
-        isUseLambdaOutput: false,
+        submissionAttachments: MOCK_ATTACHMENTS,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
+        responsesData: [],
       })
 
       const expectedAutoReplyData = [
@@ -672,14 +686,16 @@ describe('submission.service', () => {
       expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
         form: mockForm,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
         responsesData: [],
         autoReplyMailDatas: expectedAutoReplyData,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
       })
       expect(result._unsafeUnwrap()).toBe(true)
     })
 
-    it('should call mail service with attachments undefined when there are no attachments', async () => {
+    it('should call mail service with pdfAttachment when a pdfAttachment is provided', async () => {
       const mockForm = {
         _id: MOCK_FORM_ID,
         form_fields: [
@@ -722,13 +738,19 @@ describe('submission.service', () => {
         responses,
         mockForm.form_fields,
       )
+
+      const MOCK_PDF_ATTACHMENT = {
+        content: Buffer.from('mock pdf buffer'),
+        filename: 'response.pdf',
+      }
       const result = await SubmissionService.sendEmailConfirmations({
         form: mockForm,
         recipientData,
         submission: MOCK_SUBMISSION,
-        attachments: undefined,
+        submissionAttachments: undefined,
         responsesData: MOCK_AUTOREPLY_DATA,
-        isUseLambdaOutput: false,
+        isPaymentEnabled: false,
+        pdfAttachment: MOCK_PDF_ATTACHMENT,
       })
 
       const expectedAutoReplyData = [
@@ -739,13 +761,93 @@ describe('submission.service', () => {
       expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
         form: mockForm,
         submission: MOCK_SUBMISSION,
-        attachments: undefined,
+        submissionAttachments: undefined,
+        pdfAttachment: MOCK_PDF_ATTACHMENT,
+        isPaymentEnabled: false,
         responsesData: MOCK_AUTOREPLY_DATA,
         autoReplyMailDatas: expectedAutoReplyData,
       })
       expect(result._unsafeUnwrap()).toBe(true)
     })
 
+    it('should call mail service with submissionAttachments undefined and pdfAttachment undefined when there are no submissionAttachments or pdfAttachment', async () => {
+      const mockForm = {
+        _id: MOCK_FORM_ID,
+        form_fields: [
+          {
+            ...generateDefaultField(BasicField.Email),
+            autoReplyOptions: AUTOREPLY_OPTIONS_1,
+          },
+          {
+            ...generateDefaultField(BasicField.Email),
+            autoReplyOptions: AUTOREPLY_OPTIONS_2,
+          },
+        ],
+      } as unknown as IPopulatedForm
+      MockMailService.sendAutoReplyEmails.mockResolvedValueOnce([
+        {
+          status: 'fulfilled',
+          value: ok(true),
+        },
+        {
+          status: 'fulfilled',
+          value: ok(true),
+        },
+      ])
+
+      const responses = [
+        {
+          ...generateNewSingleAnswerResponse(BasicField.Email, {
+            _id: mockForm.form_fields![0]._id,
+            answer: MOCK_EMAIL_1,
+          }),
+        },
+        {
+          ...generateNewSingleAnswerResponse(BasicField.Email, {
+            _id: mockForm.form_fields![1]._id,
+            answer: MOCK_EMAIL_2,
+          }),
+        },
+      ]
+      const recipientData = extractEmailConfirmationData(
+        responses,
+        mockForm.form_fields,
+      )
+      const result = await SubmissionService.sendEmailConfirmations({
+        form: mockForm,
+        recipientData,
+        submission: MOCK_SUBMISSION,
+        submissionAttachments: undefined,
+        responsesData: MOCK_AUTOREPLY_DATA,
+        isPaymentEnabled: false,
+        pdfAttachment: undefined,
+      })
+
+      const expectedAutoReplyData = [
+        EXPECTED_AUTOREPLY_DATA_1,
+        EXPECTED_AUTOREPLY_DATA_2,
+      ]
+
+      expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
+        form: mockForm,
+        submission: MOCK_SUBMISSION,
+        submissionAttachments: undefined,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
+        responsesData: MOCK_AUTOREPLY_DATA,
+        autoReplyMailDatas: expectedAutoReplyData,
+      })
+      expect(result._unsafeUnwrap()).toBe(true)
+    })
+
+    it('should generate pdfAttachment when form summary for respondent is enabled', async () => {})
+
+    it('should not generate pdfAttachment for payment form', () => {})
+
+    it('should generate pdfAttachment for admin email notification', () => {})
+
+    it('should return pdf generation error when pdf generation fails', () => {})
+
     it('should return SendEmailConfirmationError when mail service errors', async () => {
       const mockForm = {
         _id: MOCK_FORM_ID,
@@ -786,9 +888,10 @@ describe('submission.service', () => {
         form: mockForm,
         recipientData,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
         responsesData: MOCK_AUTOREPLY_DATA,
-        isUseLambdaOutput: false,
+        isPaymentEnabled: false,
+        pdfAttachment: undefined,
       })
 
       const expectedAutoReplyData = [
@@ -799,7 +902,9 @@ describe('submission.service', () => {
       expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
         form: mockForm,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
         responsesData: MOCK_AUTOREPLY_DATA,
         autoReplyMailDatas: expectedAutoReplyData,
       })
@@ -856,9 +961,10 @@ describe('submission.service', () => {
         form: mockForm,
         recipientData,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
         responsesData: MOCK_AUTOREPLY_DATA,
-        isUseLambdaOutput: false,
+        isPaymentEnabled: false,
+        pdfAttachment: undefined,
       })
 
       const expectedAutoReplyData = [
@@ -869,9 +975,11 @@ describe('submission.service', () => {
       expect(MockMailService.sendAutoReplyEmails).toHaveBeenCalledWith({
         form: mockForm,
         submission: MOCK_SUBMISSION,
-        attachments: MOCK_ATTACHMENTS,
+        submissionAttachments: MOCK_ATTACHMENTS,
         responsesData: MOCK_AUTOREPLY_DATA,
         autoReplyMailDatas: expectedAutoReplyData,
+        pdfAttachment: undefined,
+        isPaymentEnabled: false,
       })
       expect(result._unsafeUnwrapErr()).toEqual(
         new SendEmailConfirmationError(),
@@ -2755,7 +2863,7 @@ describe('submission.service', () => {
 
       // Act
       // empty string for version id to simulate failure
-      const actualResult = await downloadCleanFile('invalid-key', '')
+      const actualResult = await downloadCleanFile('invalid-key', '', 'mock-bucket-name')
 
       // Assert
       expect(awsSpy).not.toHaveBeenCalled()
@@ -2769,7 +2877,11 @@ describe('submission.service', () => {
 
       // Act
       // empty string for version id to simulate failure
-      const actualResult = await downloadCleanFile(MOCK_VALID_UUID, '')
+      const actualResult = await downloadCleanFile(
+        MOCK_VALID_UUID,
+        '',
+        'mock-bucket-name',
+      )
 
       // Assert
       expect(awsSpy).toHaveBeenCalledOnce()
@@ -2804,7 +2916,11 @@ describe('submission.service', () => {
 
       // Act
       // empty strings for invalid keys and version ids
-      const actualResult = await downloadCleanFile(MOCK_VALID_UUID, versionId)
+      const actualResult = await downloadCleanFile(
+        MOCK_VALID_UUID,
+        versionId,
+        'mock-bucket-name',
+      )
 
       // Assert
       expect(awsSpy).toHaveBeenCalledOnce()