feat: refactor and strip emails from workflow schemas

Author: eliotlim

frontend/src/features/admin-form/responses/common/utils/mrfSubmissionView.ts

@@ -1,5 +1,5 @@
 import {
-  StatusTrackerWorkflowDto,
+  StrippedFormWorkflowDto,
   SubmittedStep,
   WorkflowStatus,
 } from '~shared/types'
@@ -76,7 +76,7 @@ export const getStatusFromWorkflowStatus = (
 
 export type getWorkflowStatusFromFormResponseProps = {
   index: number
-  workflow: StatusTrackerWorkflowDto
+  workflow: StrippedFormWorkflowDto
   submittedSteps: SubmittedStep[]
 }
 

shared/types/form/workflow.ts

@@ -38,7 +38,7 @@ export type FormWorkflowStep =
   | FormWorkflowStepDynamic
   | FormWorkflowStepConditional
 
-export type StatusTrackerWorkflowStep =
+export type StrippedFormWorkflowStep =
   | FormWorkflowStepStaticNoEmails
   | FormWorkflowStepDynamic
   | FormWorkflowStepConditional
@@ -51,8 +51,8 @@ export type FormWorkflowStepDto = FormWorkflowStep & { _id: string }
 
 export type FormWorkflowDto = Array<FormWorkflowStepDto>
 
-export type StatusTrackerWorkflowStepDto = StatusTrackerWorkflowStep & {
+export type StrippedFormWorkflowStepDto = StrippedFormWorkflowStep & {
   _id: string
 }
 
-export type StatusTrackerWorkflowDto = Array<StatusTrackerWorkflowStepDto>
+export type StrippedFormWorkflowDto = Array<StrippedFormWorkflowStepDto>

shared/types/submission.ts

@@ -11,7 +11,7 @@ import {
   FormWorkflowDto,
   LogicDto,
   ProductItem,
-  StatusTrackerWorkflowDto,
+  StrippedFormWorkflowDto,
 } from './form'
 import { ErrorCode } from './errorCodes'
 export type SubmissionId = Opaque<string, 'SubmissionId'>
@@ -363,7 +363,7 @@ export type PaymentSubmissionData = {
 
 export type StatusTrackerData = {
   submittedSteps: SubmittedStep[] | undefined
-  workflow: StatusTrackerWorkflowDto
+  workflow: StrippedFormWorkflowDto
   responseId: string | undefined
   form: string
 }

shared/utils/strip-workflow-emails.ts

@@ -0,0 +1,18 @@
+import {
+  FormWorkflowDto,
+  StrippedFormWorkflowDto,
+  WorkflowType,
+} from '../types'
+
+export function stripWorkflowEmails(
+  workflow: FormWorkflowDto,
+): StrippedFormWorkflowDto {
+  return workflow.map((step) => {
+    if (step.workflow_type === WorkflowType.Static) {
+      // eslint-disable-next-line @typescript-eslint/no-unused-vars
+      const { emails, ...rest } = step
+      return rest
+    }
+    return step
+  })
+}

src/app/modules/form/public-form/public-form.controller.ts

@@ -7,13 +7,17 @@ import {
   ErrorCode,
   ErrorDto,
   FormAuthType,
-  FormFieldDto, FormResponseMode,
+  FormFieldDto,
+  FormResponseMode,
   PrivateFormErrorDto,
   PublicFormAuthLogoutDto,
   PublicFormAuthRedirectDto,
   PublicFormDto,
   PublicFormViewDto,
+  StrippedFormWorkflowDto,
 } from '../../../../../shared/types'
+import { stripWorkflowEmails } from '../../../../../shared/utils/strip-workflow-emails'
+import { IPopulatedMultirespondentForm } from '../../../../types'
 import { createLoggerWithLabel } from '../../../config/logger'
 import { isMongoError } from '../../../utils/handle-mongo-error'
 import { createReqMeta, getRequestIp } from '../../../utils/request'
@@ -64,10 +68,6 @@ import * as FormService from '../form.service'
 
 import * as PublicFormService from './public-form.service'
 import { mapFormAuthError, mapRouteError } from './public-form.utils'
-import {
-  PublicMultiRespondentForm
-} from "../../../../../frontend/src/features/admin-form/settings/SettingsEmailsPage.stories";
-import {IPopulatedMultirespondentForm} from "../../../../types";
 
 const logger = createLoggerWithLabel(module)
 
@@ -548,7 +548,7 @@ export const handleGetPublicFormSampleSubmission: ControllerHandler<
   { formId: string },
   | {
       responses: ReturnType<typeof FormService.createSampleSubmissionResponses>
-      workflowContent?: { workflow: IPopulatedMultirespondentForm['workflow'] }
+      workflowContent?: { workflow: StrippedFormWorkflowDto }
     }
   | ErrorDto
   | PrivateFormErrorDto
@@ -618,16 +618,16 @@ export const handleGetPublicFormSampleSubmission: ControllerHandler<
 
   // Include workflow if form is a multirespondent form
   if (form.responseMode === FormResponseMode.Multirespondent) {
-    let mrfForm  = form as IPopulatedMultirespondentForm
+    const mrfForm = form as IPopulatedMultirespondentForm
     res.json({
       responses: sampleData,
       workflowContent: {
-        workflow: mrfForm.workflow,
-      }
+        workflow: stripWorkflowEmails(mrfForm.toObject().workflow),
+      },
     })
+  } else {
+    return res.json({ responses: sampleData })
   }
-
-  return res.json({ responses: sampleData })
 }
 /**
  * NOTE: This is exported only for testing

src/app/modules/status-tracker/status-tracker.controller.ts

@@ -2,11 +2,11 @@ import { celebrate, Joi, Segments } from 'celebrate'
 import { StatusCodes } from 'http-status-codes'
 import { okAsync } from 'neverthrow'
 
-import { StatusTrackerData } from '../../../../shared/types'
 import {
-  StatusTrackerWorkflowDto,
-  WorkflowType,
-} from '../../../../shared/types/form/workflow'
+  StatusTrackerData,
+  StrippedFormWorkflowDto,
+} from '../../../../shared/types'
+import { stripWorkflowEmails } from '../../../../shared/utils/strip-workflow-emails'
 import { createLoggerWithLabel } from '../../config/logger'
 import { createReqMeta } from '../../utils/request'
 import { ControllerHandler } from '../core/core.types'
@@ -42,15 +42,9 @@ const getStatusTrackerSubmissionData: ControllerHandler<
         ({ nextStepRecipientEmails, ...rest }) => rest,
       )
 
-      const strippedWorkflow: StatusTrackerWorkflowDto =
-        submissionData.workflow.map((step) => {
-          if (step.workflow_type === WorkflowType.Static) {
-            // eslint-disable-next-line @typescript-eslint/no-unused-vars
-            const { emails, ...rest } = step
-            return rest
-          }
-          return step
-        })
+      const strippedWorkflow: StrippedFormWorkflowDto = stripWorkflowEmails(
+        submissionData.workflow,
+      )
 
       const statusTrackerData: StatusTrackerData = {
         submittedSteps: strippedSubmittedSteps,