feat: respondent copy v3 (phase2) (#8869)

* enabled email confirmation & pdf response toggle

* enabled email confirmation & pdf response toggle fix

* betaFlag form status toggle & hiding of email confirmation infobox

* added extractRespondentCopyEmails function in mrf utils

* implement extractRespondentCopyEmails in submitMultirespondentForm to pass to post actions

* created MrfRespondentCopyTemplate

* update sendMrfRespondentCopyEmail in mail.service to use MrfRespondentCopyEmail template

* create extractRespondentCopyEmails function to obtain autoReplyMailData from mrf submission

* update postSubmissionCreateActions to obtain AutoReplyMailData from submission to sendMrfRespondentCopyEmails

* update postSubmissionUpdateActions to obtain AutoReplyMailData from submission to sendMrfRespondentCopyEmails

* updated extractRespondentCopyEmails to account for active fields in current workflow step

* updated sendMrfRespondentCopyEmails to handle multiple autoReplyMailDatas

* removed respondent copy email extraction in controller

* updated rc flow to account for agencyName

* remove default setting of includeFormSummary=false for MRF in email field model

* updated rc functions to handle agency names

* update editEmail include responses toggle to be updatable in MRF mode

* replaced hasRepsondentCopy in snapshotted form def with admin for agencyName

* initial fix for mrf service.spec.ts tests

* remove toggle and respondent copy multi-input on formpage

* removed unused variables after removing respondent copy v2 FE components

* fixed tests

* removed respondent copy toggle from mrf email settings page

* update question title in workflow question block for email fields with autoReply enabled

* attempt to use pdf lambda to generate PDF for mrf rc

* fixed lint issues

* testing extractRepsondenCopyEmails take 2

* fixed custom sender in mail, added formUrl and submission timestamp

* replace hypens with divider in mrf respondent copy email

* refactored mrf utils to clean up pdf responses for respondent copy

* fixed lint

* fixed utilsingle field question answer function

* bug fix to handle undefined for activeFields

* update placeholder text to grey for editMail & stepName default text

* updated some variable names and added comments to improve codebase readability

* remove respondent copy from mrf workflow completion email

* fixed mrf util tests by moveing questionAnswerPair return out of case switch block in questiontitleanswerString function

* removed changes from vscode settings

* updated disabling of email confirmation toggle only based on beta flag

* fixed lint for e2e test file

* update email confirmation toggle to be disabled only when mrf mode and no beta flag

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

Co-authored-by: Eliot Lim <[email protected]>

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

Co-authored-by: Eliot Lim <[email protected]>

---------

Co-authored-by: Eliot Lim <[email protected]>

Author: scottheng96

__tests__/e2e/helpers/createForm.ts

@@ -49,6 +49,7 @@ import {
   getMyInfoAttribute,
   getTitleWithQuestionNumber,
 } from '../utils'
+
 import { closeModals } from './closeModals';
 
 type CreateFormReturn = {

frontend/src/features/admin-form/create/builder-and-design/BuilderAndDesignDrawer/EditFieldDrawer/edit-fieldtype/EditEmail/EditEmail.tsx

@@ -16,6 +16,8 @@ import Input from '~components/Input'
 import Textarea from '~components/Textarea'
 import Toggle from '~components/Toggle'
 
+import { useUser } from '~features/user/queries'
+
 import { CreatePageDrawerContentContainer } from '../../../../../common'
 import { useCreateTabForm } from '../../../../useCreateTabForm'
 import { SPLIT_TEXTAREA_TRANSFORM } from '../common/constants'
@@ -87,6 +89,8 @@ export const EditEmail = ({ field }: EditEmailProps): JSX.Element => {
   const watchedHasAllowedEmailDomains = watch('hasAllowedEmailDomains')
   const watchedHasAutoReply = watch('autoReplyOptions.hasAutoReply')
 
+  const { user } = useUser()
+
   const requiredValidationRule = useMemo(
     () =>
       createBaseValidationRules<EditEmailInputs, 'title'>({
@@ -139,23 +143,21 @@ export const EditEmail = ({ field }: EditEmailProps): JSX.Element => {
   const isEncryptMode = form?.responseMode === FormResponseMode.Encrypt
   const isPaymentDisabledForm =
     isEncryptMode &&
-    form.payments_channel.channel === PaymentChannel.Unconnected
+    form.payments_channel.channel !== PaymentChannel.Unconnected
 
-  const isPdfResponseEnabled =
-    form?.responseMode === FormResponseMode.Email || isPaymentDisabledForm
-
-  const pdfResponseToggleDescription = isPdfResponseEnabled
+  // For payment forms inclusion of PDF responses are disallowed
+  const pdfResponseToggleDescription = isPaymentDisabledForm
     ? t(
-        'features.adminForm.sidebar.fields.email.emailConfirmation.includeResponseDescription',
+        'features.adminForm.sidebar.fields.email.emailConfirmation.includePdfResponseWarning',
       )
     : t(
-        'features.adminForm.sidebar.fields.email.emailConfirmation.includePdfResponseWarning',
+        'features.adminForm.sidebar.fields.email.emailConfirmation.includeResponseDescription',
       )
 
-  // email confirmation is not supported on MRF
+  // TODO: FRM-2172 Remove when respondent copy is out of beta
   const isToggleEmailConfirmationDisabled =
     form?.responseMode === FormResponseMode.Multirespondent &&
-    !field.autoReplyOptions.hasAutoReply
+    !user?.betaFlags?.respondentCopy
 
   return (
     <CreatePageDrawerContentContainer>
@@ -211,7 +213,7 @@ export const EditEmail = ({ field }: EditEmailProps): JSX.Element => {
                   'features.adminForm.sidebar.fields.email.emailConfirmation.includeResponse',
                 )}
                 description={pdfResponseToggleDescription}
-                isDisabled={!isPdfResponseEnabled}
+                isDisabled={isPaymentDisabledForm}
               />
             </FormControl>
             <FormControl isRequired isReadOnly={isLoading} mt="1.5rem">
@@ -222,7 +224,6 @@ export const EditEmail = ({ field }: EditEmailProps): JSX.Element => {
                   'features.adminForm.sidebar.fields.email.emailConfirmation.subject.placeholder',
                   { formTitle: form?.title },
                 )}
-                _placeholder={{ color: 'secondary.700' }}
                 {...register('autoReplyOptions.autoReplySubject')}
               />
             </FormControl>
@@ -234,7 +235,6 @@ export const EditEmail = ({ field }: EditEmailProps): JSX.Element => {
               </FormLabel>
               <Input
                 placeholder={form?.admin.agency.fullName}
-                _placeholder={{ color: 'secondary.700' }}
                 {...register('autoReplyOptions.autoReplySender')}
               />
             </FormControl>
@@ -249,12 +249,6 @@ export const EditEmail = ({ field }: EditEmailProps): JSX.Element => {
                   'features.adminForm.sidebar.fields.email.emailConfirmation.content.placeholder',
                   { agencyName: form?.admin.agency.fullName },
                 )}
-                sx={{
-                  '::placeholder': {
-                    color: 'secondary.700',
-                    opacity: 1,
-                  },
-                }}
                 {...register('autoReplyOptions.autoReplyMessage')}
               />
             </FormControl>

frontend/src/features/admin-form/create/logic/components/LogicContent/utils/getLogicFieldLabel.ts

@@ -13,6 +13,12 @@ export const getLogicFieldLabel = (field: FormFieldWithQuestionNo) => {
     case BasicField.Image:
       title = field.name
       break
+    case BasicField.Email:
+      // Inform admins if email confirmation will be sent
+      if (field.autoReplyOptions.hasAutoReply) {
+        title = title + ' (confirmation will be sent)'
+      }
+      break
     default:
       break
   }

frontend/src/features/admin-form/create/workflow/components/WorkflowContent/EditStepBlock/StepNameBlock.tsx

@@ -81,7 +81,6 @@ export const StepNameBlock = ({
                 <Input
                   {...field}
                   placeholder={displayStepName}
-                  _placeholder={{ color: 'secondary.700' }}
                   _focus={{
                     _placeholder: { color: 'transparent' },
                   }}

frontend/src/features/admin-form/settings/components/FormEmailSection.tsx

@@ -103,10 +103,6 @@ export const FormEmailSection = ({
   settings,
   isHighContrast = true,
 }: EmailFormSectionProps): JSX.Element => {
-  //TODO: (Respondent Copy): Remove isTest and user when respondent copy is out of beta
-  const { user } = useUser()
-  const isTest = import.meta.env.STORYBOOK_NODE_ENV === 'test'
-
   const { t } = useTranslation()
   const initialEmailSet = useMemo(
     () => new Set(settings.emails),
@@ -169,13 +165,6 @@ export const FormEmailSection = ({
             </FormLabel.Description>
           ) : null}
         </FormControl>
-        {isTest || user?.betaFlags?.respondentCopy ? (
-          <FormControl isDisabled={isDisabled}>
-            <Box mt={'1.5rem'}>
-              <RespondentCopyToggle />
-            </Box>
-          </FormControl>
-        ) : null}
       </FormProvider>
     </>
   )

frontend/src/features/admin-form/settings/components/FormStatusToggle.tsx

@@ -5,7 +5,6 @@ import { Flex, Skeleton, Stack, Text, useDisclosure } from '@chakra-ui/react'
 import { BasicField } from '~shared/types'
 import {
   EmailFormDto,
-  FormAuthType,
   FormResponseMode,
   FormStatus,
 } from '~shared/types/form/form'
@@ -14,6 +13,7 @@ import InlineMessage from '~components/InlineMessage'
 import { Switch } from '~components/Toggle/Switch'
 
 import { useAdminForm } from '~features/admin-form/common/queries'
+import { useUser } from '~features/user/queries'
 
 import { useMutateFormSettings } from '../mutations'
 import { useAdminFormSettings } from '../queries'
@@ -30,7 +30,7 @@ export const FormStatusToggle = (): JSX.Element => {
   } = useAdminForm()
   const { data: formSettings, isLoading: isLoadingFormSettings } =
     useAdminFormSettings()
-
+  const { user } = useUser()
   const { status, responseMode, authType, esrvcId } = formSettings ?? {}
 
   const secretKeyActivationModalProps = useDisclosure()
@@ -54,7 +54,8 @@ export const FormStatusToggle = (): JSX.Element => {
       form_fields?.some(
         (ff) =>
           ff.fieldType === BasicField.Email && ff.autoReplyOptions.hasAutoReply,
-      )
+      ) &&
+      !user?.betaFlags?.respondentCopy
     ) {
       return t('features.adminForm.settings.general.status.noEmailsInMRF')
     }

frontend/src/features/admin-form/settings/components/MrfFormEmailSection.tsx

@@ -285,13 +285,6 @@ const MrfEmailNotificationsForm = ({
             </FormErrorMessage>
           )}
         </FormControl>
-        {isTest || user?.betaFlags?.respondentCopy ? (
-          <FormControl isDisabled={isDisabled}>
-            <Box mt={'1.5rem'}>
-              <RespondentCopyToggle />
-            </Box>
-          </FormControl>
-        ) : null}
       </Box>
     </form>
   )

frontend/src/features/public-form/components/FormFields/FormFields.tsx

@@ -24,7 +24,6 @@ import { PaymentPreview } from '../../../../templates/Field/PaymentPreview/Payme
 import { PublicFormPaymentResumeModal } from '../FormPaymentPage/FormPaymentResumeModal'
 
 import { PublicFormSubmitButton } from './PublicFormSubmitButton'
-import { PublicRespondentEmailField } from './PublicRespondentEmailField'
 import { VisibleFormFields } from './VisibleFormFields'
 
 export interface FormFieldsProps {
@@ -119,12 +118,6 @@ export const FormFields = ({
             />
           </Box>
         )}
-      {/* TODO: (respondent copy): Remove when respondent copy is out of beta */}
-      {form?.hasRespondentCopy && isRespondentCopyEnabled ? (
-        <Box mt="2.5rem" px={{ base: '1rem', md: 0 }}>
-          <PublicRespondentEmailField />
-        </Box>
-      ) : null}
       <PublicFormPaymentResumeModal />
       <PublicFormSubmitButton
         onSubmit={onSubmit ? handleSubmit(onSubmit) : undefined}

src/app/models/field/__tests__/emailField.spec.ts

@@ -102,7 +102,7 @@ describe('models.fields.emailField', () => {
     expect(actual.field.toObject()).toEqual(expected)
   })
 
-  it('should set includeFormSummary to false on ResponseMode.Multirespondent forms', async () => {
+  it('should set includeFormSummary to given on ResponseMode.Multirespondent forms', async () => {
     // Arrange
     const mockEmailField = {
       autoReplyOptions: {
@@ -125,7 +125,7 @@ describe('models.fields.emailField', () => {
       _id: expect.anything(),
       autoReplyOptions: {
         // Should be always set to false for MRF forms
-        includeFormSummary: false,
+        includeFormSummary: true,
       },
     })
     expect(actual.field.toObject()).toEqual(expected)

src/app/models/field/emailField.ts

@@ -1,6 +1,5 @@
 import { Schema } from 'mongoose'
 
-import { FormResponseMode } from '../../../../shared/types'
 import { validateEmailDomains } from '../../../../shared/utils/email-domain-validation'
 import { IEmailFieldSchema } from '../../../types'
 
@@ -30,12 +29,6 @@ const createEmailFieldSchema = (): Schema<IEmailFieldSchema> => {
       includeFormSummary: {
         type: Boolean,
         default: false,
-        set: function (this: IEmailFieldSchema, v: boolean) {
-          // Set to false if mrf mode regardless of initial value.
-          return this.parent().responseMode === FormResponseMode.Multirespondent
-            ? false
-            : v
-        },
       },
     },