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/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

@@ -6,11 +6,12 @@ import {
   DateString,
   FormResponseMode,
   PaymentChannel,
-  SubmissionType,
+  SubmissionType
 } from '../../../../../shared/types'
 import {
   EmailAdminDataField,
   FieldResponse,
+  FormFieldSchema,
   IEncryptedSubmissionSchema,
   IPopulatedEncryptedForm,
   IPopulatedForm,
@@ -44,10 +45,15 @@ 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'
+import { GrowthBook } from '@growthbook/growthbook'
+import { isTest } from '../../../config/config'
 
 const logger = createLoggerWithLabel(module)
 const EncryptSubmissionModel = getEncryptSubmissionModel(mongoose)
@@ -136,7 +142,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 +175,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 +251,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 +328,7 @@ export const performEncryptPostSubmissionActions = ({
         submission,
         form,
         responsesData: formData,
+        growthbook,
       }).orElse(() => okAsync(undefined))
 
       return pdfAttachmentResult.andThen((pdfAttachment) => {
@@ -319,7 +344,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/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,
   })
 }
 

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

@@ -26,7 +26,7 @@ import {
   MultirespondentSubmissionDto,
   SnapshottedFormDef,
 } from '../../../../types/api'
-import config from '../../../config/config'
+import config, { isTest } from '../../../config/config'
 import {
   createLoggerWithLabel,
   CustomLoggerParams,
@@ -55,7 +55,10 @@ import {
 } from '../submission.errors'
 import { uploadAttachments } from '../submission.service'
 import { AttachmentMetadata } from '../submission.types'
-import { getMrfSubmissionWorkflowStatus } from '../submission.utils'
+import {
+  getMrfSubmissionWorkflowStatus,
+  isAdminEmailPdfEnabled,
+} from '../submission.utils'
 import { reportSubmissionResponseTime } from '../submissions.statsd-client'
 
 import { MultirespondentSubmissionContent } from './multirespondent-submission.types'
@@ -66,6 +69,7 @@ import {
   getResponsesDataFromMrfResponses,
   retrieveWorkflowStepEmailAddresses,
 } from './multirespondent-submission.utils'
+import { GrowthBook } from '@growthbook/growthbook'
 
 const logger = createLoggerWithLabel(module)
 const MultirespondentSubmission = getMultirespondentSubmissionModel(mongoose)
@@ -798,6 +802,7 @@ interface CheckIsWorkflowCompletionEmailPdfRequiredArgs {
   responses: FieldResponsesV3
   isRejected: boolean
   submissionId: string
+  growthbook?: GrowthBook
 }
 
 const checkIsWorkflowCompletionEmailPdfRequired = ({
@@ -806,7 +811,16 @@ const checkIsWorkflowCompletionEmailPdfRequired = ({
   responses,
   isRejected,
   submissionId,
+  growthbook,
 }: CheckIsWorkflowCompletionEmailPdfRequiredArgs) => {
+  const isGbFlagEnabled = isAdminEmailPdfEnabled({
+    growthbook,
+    formFields: form.form_fields as FormFieldSchema[],
+  }) || isTest
+
+  if (!isGbFlagEnabled) {
+    return false
+  }
   const isWorkflowCompleted = checkIsWorkflowCompleted({
     currentStepNumber,
     form,
@@ -834,37 +848,14 @@ type CheckIsPdfGenerationRequiredArgs = Omit<
 > &
   CheckIsWorkflowCompletionEmailPdfRequiredArgs
 
-const checkIsPdfGenerationRequired = ({
-  responses,
-  form,
-  currentStepActiveFields,
-  currentStepNumber,
-  isRejected,
-  submissionId,
-}: CheckIsPdfGenerationRequiredArgs): boolean => {
-  return (
-    checkIfRespondentFormSummaryIsRequired({
-      responses,
-      formFields: form.form_fields,
-      currentStepActiveFields,
-    }) ||
-    checkIsWorkflowCompletionEmailPdfRequired({
-      currentStepNumber,
-      form,
-      responses,
-      isRejected,
-      submissionId,
-    })
-  )
-}
-
 const generatePdfAttachmentIfRequired = ({
   submission,
   form,
   responses,
   currentStepActiveFields,
   currentStepNumber,
   isRejected,
+  growthbook, 
 }: CheckIsPdfGenerationRequiredArgs & {
   submission: IMultirespondentSubmissionSchema
   form: Pick<
@@ -893,6 +884,7 @@ const generatePdfAttachmentIfRequired = ({
       responses,
       isRejected,
       submissionId,
+      growthbook,
     })
 
   if (!isRespondentCopyPdfRequired && !isWorkflowCompletionEmailPdfRequired) {
@@ -945,13 +937,15 @@ export const performMultiRespondentPostSubmissionCreateActions = ({
   encryptedPayload,
   logMeta,
   attachments,
+  growthbook,
 }: {
   submission: IMultirespondentSubmissionSchema
   submissionId: string
   form: IPopulatedMultirespondentForm
   encryptedPayload: MultirespondentSubmissionDto
   logMeta: CustomLoggerParams['meta']
   attachments?: IAttachmentInfo[]
+  growthbook?: GrowthBook
 }): ResultAsync<boolean, InvalidWorkflowTypeError | MailSendError> => {
   const { submissionSecretKey, responses } = encryptedPayload
   const currentStepNumber = 0
@@ -974,14 +968,33 @@ export const performMultiRespondentPostSubmissionCreateActions = ({
     submissionId,
   })
 
+  const sendMrfRespondentCopyEmailsPdfResult = checkIfRespondentFormSummaryIsRequired({
+    responses,
+    formFields: form.form_fields,
+    currentStepActiveFields: form.workflow[currentStepNumber]?.edit ?? [],
+  })
+    ? pdfResult
+    : okAsync(undefined)
+  
+  const sendMrfOutcomeEmailsPdfResult = checkIsWorkflowCompletionEmailPdfRequired({
+    currentStepNumber,
+    form,
+    responses,
+    isRejected: false,
+    submissionId,
+    growthbook,
+  })
+    ? pdfResult
+    : okAsync(undefined)
+
   sendMrfRespondentCopyEmails({
     form,
     responses,
     submission,
     attachments,
     formFields: form.form_fields,
     currentStepActiveFields: form.workflow[currentStepNumber]?.edit ?? [],
-    pdfResult,
+    pdfResult: sendMrfRespondentCopyEmailsPdfResult,
   }).mapErr((error) => {
     logger.error({
       message: 'Send multirespondent respondent copy email error',
@@ -1040,7 +1053,7 @@ export const performMultiRespondentPostSubmissionCreateActions = ({
         responses,
         submissionId,
         attachments,
-        pdfResult,
+        pdfResult: sendMrfOutcomeEmailsPdfResult,
       })
     })
     .mapErr((error) => {
@@ -1208,6 +1221,7 @@ export const performMultiRespondentPostSubmissionUpdateActions = ({
   encryptedPayload,
   logMeta,
   attachments,
+  growthbook,
 }: {
   submission: IMultirespondentSubmissionSchema
   submissionId: string
@@ -1216,6 +1230,7 @@ export const performMultiRespondentPostSubmissionUpdateActions = ({
   encryptedPayload: MultirespondentSubmissionDto
   logMeta: CustomLoggerParams['meta']
   attachments?: IAttachmentInfo[]
+  growthbook?: GrowthBook
 }): ResultAsync<
   boolean,
   | InvalidWorkflowTypeError
@@ -1290,6 +1305,26 @@ export const performMultiRespondentPostSubmissionUpdateActions = ({
       snapshottedFormDef.workflow[currentStepNumber]?.edit ?? [],
   })
 
+  const sendMrfRespondentCopyEmailsPdfResult = checkIfRespondentFormSummaryIsRequired({
+    responses,
+    formFields: snapshottedFormDef.form_fields,
+    currentStepActiveFields:
+      snapshottedFormDef.workflow[currentStepNumber]?.edit ?? [],
+  })
+    ? pdfResult
+    : okAsync(undefined)
+
+  const sendMrfOutcomeEmailsPdfResult = checkIsWorkflowCompletionEmailPdfRequired({
+    currentStepNumber,
+    form: snapshottedFormDef,
+    responses,
+    isRejected: isStepRejected,
+    submissionId,
+    growthbook,
+  })
+    ? pdfResult
+    : okAsync(undefined)
+
   sendMrfRespondentCopyEmails({
     form: snapshottedFormDef,
     responses,
@@ -1298,14 +1333,7 @@ export const performMultiRespondentPostSubmissionUpdateActions = ({
     formFields: snapshottedFormDef.form_fields,
     currentStepActiveFields:
       snapshottedFormDef.workflow[currentStepNumber]?.edit ?? [],
-    pdfResult: checkIfRespondentFormSummaryIsRequired({
-      responses,
-      formFields: snapshottedFormDef.form_fields,
-      currentStepActiveFields:
-        snapshottedFormDef.workflow[currentStepNumber]?.edit ?? [],
-    })
-      ? pdfResult
-      : okAsync(undefined),
+    pdfResult: sendMrfRespondentCopyEmailsPdfResult,
   }).mapErr((error) => {
     logger.error({
       message: 'Send multirespondent respondent copy email error',
@@ -1323,7 +1351,7 @@ export const performMultiRespondentPostSubmissionUpdateActions = ({
       isApproval: true,
       isRejected: true,
       attachments: attachments,
-      pdfResult: pdfResult,
+      pdfResult: sendMrfOutcomeEmailsPdfResult,
     }).mapErr((error) => {
       logger.error({
         message: 'Send mrf outcome email error',
@@ -1340,15 +1368,7 @@ export const performMultiRespondentPostSubmissionUpdateActions = ({
     submissionId,
     isApproval: checkIsFormApproval(snapshottedFormDef),
     attachments: attachments,
-    pdfResult: checkIsWorkflowCompletionEmailPdfRequired({
-      currentStepNumber,
-      form: snapshottedFormDef,
-      responses,
-      isRejected: isStepRejected,
-      submissionId,
-    })
-      ? pdfResult
-      : okAsync(undefined),
+    pdfResult: sendMrfOutcomeEmailsPdfResult,
   })
     .mapErr((error) => {
       logger.error({