Merge branch 'feat/nric-opt-in-out' into staging-alt2

frontend/src/features/admin-form/common/AdminViewFormService.ts

@@ -24,10 +24,7 @@ import {
   filterHiddenInputs,
 } from '~features/public-form/utils'
 
-import {
-  PREVIEW_MASKED_MOCK_UINFIN,
-  PREVIEW_MOCK_UINFIN,
-} from '../preview/constants'
+import { PREVIEW_MOCK_UINFIN } from '../preview/constants'
 
 // endpoint exported for testing
 export const ADMIN_FORM_ENDPOINT = '/admin/forms'
@@ -62,9 +59,7 @@ export const previewForm = async (
       // and if server has not already sent back a mock authenticated state.
       if (data.form.authType !== FormAuthType.NIL && !data.spcpSession) {
         data.spcpSession = {
-          userName: data.form.isNricMaskEnabled
-            ? PREVIEW_MASKED_MOCK_UINFIN
-            : PREVIEW_MOCK_UINFIN,
+          userName: PREVIEW_MOCK_UINFIN,
         }
       }
 
@@ -95,9 +90,7 @@ export const viewFormTemplate = async (
       // and if server has not already sent back a mock authenticated state.
       if (data.form.authType !== FormAuthType.NIL && !data.spcpSession) {
         data.spcpSession = {
-          userName: data.form.isNricMaskEnabled
-            ? PREVIEW_MASKED_MOCK_UINFIN
-            : PREVIEW_MOCK_UINFIN,
+          userName: PREVIEW_MOCK_UINFIN,
         }
       }
 

frontend/src/features/admin-form/create/builder-and-design/BuilderAndDesignContent/StartPageView.tsx

@@ -6,10 +6,7 @@ import { FormAuthType, FormLogoState, FormStartPage } from '~shared/types'
 
 import { useIsMobile } from '~hooks/useIsMobile'
 
-import {
-  PREVIEW_MASKED_MOCK_UINFIN as PREVIEW_MASKED_MOCK_UINFIN,
-  PREVIEW_MOCK_UINFIN,
-} from '~features/admin-form/preview/constants'
+import { PREVIEW_MOCK_UINFIN } from '~features/admin-form/preview/constants'
 import { useEnv } from '~features/env/queries'
 import { FormInstructions } from '~features/public-form/components/FormInstructions/FormInstructions'
 import {
@@ -200,9 +197,7 @@ export const StartPageView = () => {
           showHeader
           loggedInId={
             form && form.authType !== FormAuthType.NIL
-              ? form.isNricMaskEnabled
-                ? PREVIEW_MASKED_MOCK_UINFIN
-                : PREVIEW_MOCK_UINFIN
+              ? PREVIEW_MOCK_UINFIN
               : undefined
           }
           {...formHeaderProps}

frontend/src/features/admin-form/create/end-page/EndPageContent.tsx

@@ -13,10 +13,7 @@ import { PaymentsThankYouSvgr } from '~components/FormEndPage/PaymentsThankYouSv
 import { ThankYouSvgr } from '~components/FormEndPage/ThankYouSvgr'
 
 import { useAdminForm } from '~features/admin-form/common/queries'
-import {
-  PREVIEW_MASKED_MOCK_UINFIN,
-  PREVIEW_MOCK_UINFIN,
-} from '~features/admin-form/preview/constants'
+import { PREVIEW_MOCK_UINFIN } from '~features/admin-form/preview/constants'
 import { useEnv } from '~features/env/queries'
 import {
   FormBannerLogo,
@@ -93,9 +90,7 @@ export const EndPageContent = (): JSX.Element => {
           onLogout={undefined}
           loggedInId={
             form && form.authType !== FormAuthType.NIL
-              ? form.isNricMaskEnabled
-                ? PREVIEW_MASKED_MOCK_UINFIN
-                : PREVIEW_MOCK_UINFIN
+              ? PREVIEW_MOCK_UINFIN
               : undefined
           }
         />

frontend/src/features/admin-form/preview/constants.ts

@@ -1,2 +1 @@
 export const PREVIEW_MOCK_UINFIN = 'S1234567A'
-export const PREVIEW_MASKED_MOCK_UINFIN = '*****567A'

frontend/src/features/admin-form/settings/SettingsAuthPage.stories.tsx

@@ -77,13 +77,13 @@ PublicStorageNilAuthForm.parameters = {
   }),
 }
 
-// purpose: tests that isNricMaskEnabled should not affect setting options available
-export const PublicStorageNilAuthFormNricMaskingEnabled = Template.bind({})
-PublicStorageNilAuthFormNricMaskingEnabled.parameters = {
+export const PublicStorageNilAuthFormSubmitterIdCollectionEnabled =
+  Template.bind({})
+PublicStorageNilAuthFormSubmitterIdCollectionEnabled.parameters = {
   msw: buildEncryptModeMswRoutes({
     responseMode: FormResponseMode.Encrypt,
     status: FormStatus.Public,
-    isNricMaskEnabled: true,
+    isSubmitterIdCollectionEnabled: true,
   }),
 }
 
@@ -143,22 +143,25 @@ PublicEmailMyInfoForm.parameters = {
   ],
 }
 
-export const PrivateEmailSingpassFormNricMaskingEnabled = Template.bind({})
-PrivateEmailSingpassFormNricMaskingEnabled.parameters = {
+export const PrivateEmailSingpassFormSubmitterIdCollectionEnabled =
+  Template.bind({})
+PrivateEmailSingpassFormSubmitterIdCollectionEnabled.parameters = {
   msw: buildEmailModeMswRoutes({
     status: FormStatus.Private,
     authType: FormAuthType.SGID,
-    isNricMaskEnabled: true,
+    isSubmitterIdCollectionEnabled: true,
   }),
 }
-export const PrivateEmailMyInfoFormNricMaskingEnabled = Template.bind({})
-PrivateEmailMyInfoFormNricMaskingEnabled.parameters = {
+export const PrivateEmailMyInfoFormSubmitterIdCollectionEnabled = Template.bind(
+  {},
+)
+PrivateEmailMyInfoFormSubmitterIdCollectionEnabled.parameters = {
   msw: [
     ...buildEmailModeMswRoutes({
       status: FormStatus.Private,
       authType: FormAuthType.MyInfo,
       esrvcId: 'STORYBOOK-TEST',
-      isNricMaskEnabled: true,
+      isSubmitterIdCollectionEnabled: true,
     }),
     ...createFormBuilderMocks({ form_fields: MOCK_FORM_FIELDS_WITH_MYINFO }),
   ],
@@ -180,7 +183,7 @@ PrivateStorageSingpassFormAllTogglesEnabled.parameters = {
     status: FormStatus.Private,
     authType: FormAuthType.SGID,
     isSingleSubmission: true,
-    isNricMaskEnabled: true,
+    isSubmitterIdCollectionEnabled: true,
   }),
 }
 
@@ -190,7 +193,7 @@ PublicEmailCorppassAllTogglesEnabledForm.parameters = {
     status: FormStatus.Public,
     authType: FormAuthType.CP,
     isSingleSubmission: true,
-    isNricMaskEnabled: true,
+    isSubmitterIdCollectionEnabled: true,
   }),
 }
 

frontend/src/features/admin-form/settings/SettingsService.ts

@@ -109,12 +109,11 @@ export const updateFormAuthType: UpdateFormFn<'authType'> = async (
   return updateFormSettings(formId, { authType: newAuthType })
 }
 
-export const updateFormNricMask: UpdateFormFn<'isNricMaskEnabled'> = async (
-  formId,
-  newIsNricMaskEnabled,
-) => {
+export const updateIsSubmitterIdCollectionEnabled: UpdateFormFn<
+  'isSubmitterIdCollectionEnabled'
+> = async (formId, nextIsSubmitterIdCollectionEnabled) => {
   return updateFormSettings(formId, {
-    isNricMaskEnabled: newIsNricMaskEnabled,
+    isSubmitterIdCollectionEnabled: nextIsSubmitterIdCollectionEnabled,
   })
 }
 

frontend/src/features/admin-form/settings/components/AuthSettingsSection/AuthSettingsSingpassSection.tsx

@@ -2,7 +2,7 @@ import { Divider } from '@chakra-ui/react'
 
 import { FormResponseMode, FormSettings } from '~shared/types/form'
 
-import { FormNricMaskToggle } from './FormNricMaskToggle'
+import { FormSubmitterIdCollectionToggle } from './FormNricCollectionToggle'
 import { FormSingleSubmissionToggle } from './FormSingleSubmissionToggle'
 import { FormWhitelistAttachmentField } from './FormWhitelistAttachmentField'
 import { SingpassAuthOptionsRadio } from './SingpassAuthOptionsRadio'
@@ -29,17 +29,13 @@ export const AuthSettingsSingpassSection = ({
         settings={settings}
         isDisabled={isSinglepassAuthOptionsDisabled}
       />
-      {/* Hide the NRIC mask toggle if they have not yet enabled it as part of
-      PMO circular */}
-      {settings.isNricMaskEnabled ? (
-        <>
-          <Divider my="2.5rem" />
-          <FormNricMaskToggle
-            settings={settings}
-            isDisabled={isSingpassSettingsDisabled}
-          />
-        </>
-      ) : null}
+      <>
+        <Divider my="2.5rem" />
+        <FormSubmitterIdCollectionToggle
+          settings={settings}
+          isDisabled={isFormPublic}
+        />
+      </>
       {isEncryptMode || settings.isSingleSubmission ? (
         <>
           <Divider my="2.5rem" />

frontend/src/features/admin-form/settings/components/AuthSettingsSection/FormNricCollectionToggle.tsx

@@ -0,0 +1,40 @@
+import { useCallback } from 'react'
+
+import { FormSettings } from '~shared/types/form'
+
+import Toggle from '~components/Toggle'
+
+import { useMutateFormSettings } from '../../mutations'
+
+interface FormSubmitterIdCollectionProps {
+  settings: FormSettings
+  isDisabled: boolean
+}
+
+export const FormSubmitterIdCollectionToggle = ({
+  settings,
+  isDisabled,
+}: FormSubmitterIdCollectionProps): JSX.Element => {
+  const isSubmitterIdCollectionEnabled =
+    !!settings?.isSubmitterIdCollectionEnabled
+
+  const { mutateIsSubmitterIdCollectionEnabled } = useMutateFormSettings()
+
+  const handleToggleCollection = useCallback(() => {
+    if (!settings || mutateIsSubmitterIdCollectionEnabled.isLoading) return
+    const nextIsNricMaskEnabled = !settings.isSubmitterIdCollectionEnabled
+    return mutateIsSubmitterIdCollectionEnabled.mutate(nextIsNricMaskEnabled)
+  }, [mutateIsSubmitterIdCollectionEnabled, settings])
+
+  return (
+    <Toggle
+      containerStyles={{ opacity: isDisabled ? 0.3 : 1 }}
+      isDisabled={isDisabled}
+      isLoading={!settings || mutateIsSubmitterIdCollectionEnabled.isLoading}
+      isChecked={isSubmitterIdCollectionEnabled}
+      label="Collect NRIC/FIN/UENs with form submissions"
+      description="NRIC/FIN/UENs are not collected or stored with form submissions by default"
+      onChange={handleToggleCollection}
+    />
+  )
+}

frontend/src/features/admin-form/settings/mutations.ts

@@ -36,14 +36,14 @@ import {
   updateFormInactiveMessage,
   updateFormIssueNotification,
   updateFormLimit,
-  updateFormNricMask,
   updateFormStatus,
   updateFormTitle,
   updateFormWebhookRetries,
   updateFormWebhookUrl,
   updateFormWhitelistSetting,
   updateGstEnabledFlag,
   updateIsSingleSubmission,
+  updateIsSubmitterIdCollectionEnabled,
   updateTwilioCredentials,
 } from './SettingsService'
 
@@ -321,16 +321,19 @@ export const useMutateFormSettings = () => {
     },
   )
 
-  const mutateNricMask = useMutation(
-    (nextIsNricMaskEnabled: boolean) =>
-      updateFormNricMask(formId, nextIsNricMaskEnabled),
+  const mutateIsSubmitterIdCollectionEnabled = useMutation(
+    (nextIsSubmitterIdCollectionEnabled: boolean) =>
+      updateIsSubmitterIdCollectionEnabled(
+        formId,
+        nextIsSubmitterIdCollectionEnabled,
+      ),
     {
       onSuccess: (newData) => {
         handleSuccess({
           newData,
-          toastDescription: newData.isNricMaskEnabled
-            ? 'NRIC masking is now enabled on your form.'
-            : 'NRIC masking is now disabled on your form.',
+          toastDescription: newData.isSubmitterIdCollectionEnabled
+            ? 'NRIC/FIN/UEN collection is now enabled on your form.'
+            : 'NRIC/FIN/UEN collection is now disabled on your form.',
         })
       },
       onError: handleError,
@@ -444,7 +447,7 @@ export const useMutateFormSettings = () => {
     mutateFormEmails,
     mutateFormTitle,
     mutateFormAuthType,
-    mutateNricMask,
+    mutateIsSubmitterIdCollectionEnabled,
     mutateIsSingleSubmission,
     mutateFormWhitelistSetting,
     mutateFormEsrvcId,