feat: add gb flag

Author: kevin9foong

shared/constants/feature-flags.ts

@@ -28,4 +28,11 @@ export const featureFlags = {
   singpassMrf: 'singpass-mrf' as const,
   enableSaveDraftButtonFloating: 'enable-save-draft-button-floating' as const,
   enableSaveDraftButtonHeader: 'enable-save-draft-button-header' as const,
+  adminEmailPdf: 'admin-email-pdf' as const,
+}
+
+export enum AdminEmailPdfFeatureValue {
+  OFF = 'OFF',
+  SIGNATURES_ONLY = 'SIGNATURES_ONLY',
+  ON = 'ON',
 }

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

@@ -14,6 +14,7 @@ import {
 
 import { getEncryptSubmissionModel } from 'src/app/models/submission.server.model'
 import * as FormService from 'src/app/modules/form/form.service'
+import { AutoreplyPdfGenerationError } from 'src/app/services/mail/mail.errors'
 import MailService from 'src/app/services/mail/mail.service'
 import * as MailUtils from 'src/app/services/mail/mail.utils'
 import {
@@ -29,7 +30,6 @@ import {
   createEncryptSubmissionWithoutSave,
   performEncryptPostSubmissionActions,
 } from '../encrypt-submission.service'
-import { AutoreplyPdfGenerationError } from 'src/app/services/mail/mail.errors'
 
 const EncryptSubmission = getEncryptSubmissionModel(mongoose)
 

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

@@ -804,6 +804,7 @@ const _createSubmission = async ({
     emailFields,
     submissionAttachments,
     respondentEmails,
+    growthbook: req.growthbook,
   })
 }
 

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

@@ -1,3 +1,4 @@
+import { GrowthBook } from '@growthbook/growthbook'
 import mongoose from 'mongoose'
 import { err, ok, okAsync, Result, ResultAsync } from 'neverthrow'
 import Mail from 'nodemailer/lib/mailer'
@@ -11,11 +12,12 @@ import {
 import {
   EmailAdminDataField,
   FieldResponse,
+  FormFieldSchema,
   IEncryptedSubmissionSchema,
   IPopulatedEncryptedForm,
   IPopulatedForm,
 } from '../../../../types'
-import config from '../../../config/config'
+import config, { isTest } from '../../../config/config'
 import { createLoggerWithLabel } from '../../../config/logger'
 import { getEncryptSubmissionModel } from '../../../models/submission.server.model'
 import { AutoreplyPdfGenerationError } from '../../../services/mail/mail.errors'
@@ -44,7 +46,10 @@ import {
 } from '../submission.errors'
 import { sendEmailConfirmations } from '../submission.service'
 import { ProcessedFieldResponse } from '../submission.types'
-import { extractEmailConfirmationData } from '../submission.utils'
+import {
+  extractEmailConfirmationData,
+  isAdminEmailPdfEnabled,
+} from '../submission.utils'
 
 import { CHARTS_MAX_SUBMISSION_RESULTS } from './encrypt-submission.constants'
 import { SaveEncryptSubmissionParams } from './encrypt-submission.types'
@@ -136,7 +141,17 @@ export const createEncryptSubmissionWithoutSave = ({
   })
 }
 
-const checkIfAdminPdfIsRequired = (isPaymentEnabled: boolean): boolean => {
+const checkIfAdminPdfIsRequired = (
+  isPaymentEnabled: boolean,
+  formFields: FormFieldSchema[],
+  growthbook?: GrowthBook,
+): boolean => {
+  const isGbFlagEnabled =
+    isAdminEmailPdfEnabled({ growthbook, formFields }) || isTest
+
+  if (!isGbFlagEnabled) {
+    return false
+  }
   return !isPaymentEnabled
 }
 
@@ -159,14 +174,20 @@ const generatePdfAttachmentIfRequired = ({
   submission,
   form,
   responsesData,
+  growthbook,
 }: {
   isPaymentEnabled: boolean
   autoReplyMailDatas: AutoReplyMailData[]
   submission: IEncryptedSubmissionSchema
   form: IPopulatedEncryptedForm
   responsesData: EmailAdminDataField[]
+  growthbook?: GrowthBook
 }): ResultAsync<Mail.Attachment | undefined, AutoreplyPdfGenerationError> => {
-  const isAdminPdfRequired = checkIfAdminPdfIsRequired(isPaymentEnabled)
+  const isAdminPdfRequired = checkIfAdminPdfIsRequired(
+    isPaymentEnabled,
+    form.form_fields,
+    growthbook,
+  )
   const isRespondentCopyPdfRequired = checkIfRespondentFormSummaryIsRequired({
     isPaymentEnabled,
     autoReplyMailDatas,
@@ -229,12 +250,14 @@ export const performEncryptPostSubmissionActions = ({
   emailFields,
   submissionAttachments,
   respondentEmails,
+  growthbook,
 }: {
   submission: IEncryptedSubmissionSchema
   responses: FieldResponse[]
   emailFields: ProcessedFieldResponse[]
   submissionAttachments?: Mail.Attachment[]
   respondentEmails?: string[]
+  growthbook?: GrowthBook
 }): ResultAsync<
   true,
   | FormNotFoundError
@@ -304,6 +327,7 @@ export const performEncryptPostSubmissionActions = ({
         submission,
         form,
         responsesData: formData,
+        growthbook,
       }).orElse(() => okAsync(undefined))
 
       return pdfAttachmentResult.andThen((pdfAttachment) => {
@@ -319,7 +343,11 @@ export const performEncryptPostSubmissionActions = ({
             submissionAttachments,
             formData,
             dataCollationData: formattedDataCollationData,
-            pdfAttachment: checkIfAdminPdfIsRequired(isPaymentEnabled)
+            pdfAttachment: checkIfAdminPdfIsRequired(
+              isPaymentEnabled,
+              form.form_fields,
+              growthbook,
+            )
               ? pdfAttachment
               : undefined,
           }).mapErr((error) => {

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

@@ -10,6 +10,7 @@ import {
   WorkflowType,
 } from 'shared/types'
 
+import { AutoreplyPdfGenerationError } from 'src/app/services/mail/mail.errors'
 import MailService from 'src/app/services/mail/mail.service'
 import * as MailUtils from 'src/app/services/mail/mail.utils'
 import {
@@ -29,7 +30,6 @@ import {
   performMultiRespondentPostSubmissionUpdateActions,
   sendNextStepReminderEmail,
 } from '../multirespondent-submission.service'
-import { AutoreplyPdfGenerationError } from 'src/app/services/mail/mail.errors'
 
 jest.mock('src/app/modules/datadog/datadog.utils')
 jest.mock('src/app/services/mail/mail.utils')
@@ -2240,7 +2240,7 @@ describe('multirespondent-submission.service', () => {
         sendMrfWorkflowCompletionEmailSpy.mock.calls[0][0].emails.length,
       ).toBe(1)
     })
-    
+
     it('sends completion email with pdf attachment when single step mrf is completed', async () => {
       // Arrange
       const sendMrfWorkflowCompletionEmailSpy = jest.spyOn(

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

@@ -139,6 +139,7 @@ const submitMultirespondentForm = async (
     encryptedPayload,
     logMeta,
     attachments: req.formsg.unencryptedAttachments,
+    growthbook: req.growthbook,
   })
 }
 
@@ -234,6 +235,7 @@ const updateMultirespondentSubmission = async (
     encryptedPayload,
     logMeta,
     attachments: req.formsg.unencryptedAttachments,
+    growthbook: req.growthbook,
   })
 }