chore: show approval tag, and fix some frontend stuff

Author: pregnantboy

packages/backend/src/apps/formsg/common/get-data-out-metadata.ts

@@ -335,10 +335,13 @@ async function getDataOutMetadata(
 
   let questionIdsToShowForMrf: Set<string> | undefined
 
+  let approvalField: string | null = null
   if (parameters.mrf) {
     questionIdsToShowForMrf = new Set(
       (parameters.mrf as ParsedMrfWorkflowStep).fields,
     )
+    approvalField =
+      (parameters.mrf as ParsedMrfWorkflowStep).approvalField ?? null
   }
 
   const fieldMetadata: IDataOutMetadata = Object.create(null)
@@ -391,6 +394,11 @@ async function getDataOutMetadata(
       isVisible: { isHidden: true },
       isHeader: { isHidden: true },
     }
+
+    if (approvalField && fieldId === approvalField) {
+      fieldMetadata[fieldId].answer.type = 'approval'
+    }
+
     if (isAnswerArrayValid(fieldData)) {
       // table field will have a stringified table object in the answer field
       // so that it can be used in for-each

packages/backend/src/graphql/mutations/create-flow.ts

@@ -14,15 +14,14 @@ const createFlow: MutationResolvers['createFlow'] = async (
     name: trimmedFlowName,
   })
 
+  /**
+   * We do not need to create an empty action since the AddStepButton already looks like an empty step
+   */
   await flow.$relatedQuery('steps').insert([
     {
       type: 'trigger',
       position: 1,
     },
-    {
-      type: 'action',
-      position: 2,
-    },
   ])
 
   return flow

packages/frontend/src/components/Editor/components/AddStepButton.tsx

@@ -32,21 +32,21 @@ export function AddStepButton(props: AddStepButtonProps): JSX.Element {
   const { isOpen, onOpen, onClose } = useDisclosure()
 
   const { dividerColor, iconBgColor } = useMemo(() => {
-    if (approvalBranch === undefined) {
-      return {
-        dividerColor: 'base.divider.strong',
-        iconBgColor: undefined,
-      }
-    }
     if (approvalBranch === 'approve') {
       return {
         dividerColor: 'green.500',
         iconBgColor: 'green.50',
       }
     }
+    if (approvalBranch === 'reject') {
+      return {
+        dividerColor: 'red.500',
+        iconBgColor: 'red.50',
+      }
+    }
     return {
-      dividerColor: 'red.500',
-      iconBgColor: 'red.50',
+      dividerColor: 'base.divider.strong',
+      iconBgColor: undefined,
     }
   }, [approvalBranch])
 
@@ -93,7 +93,7 @@ export function AddStepButton(props: AddStepButtonProps): JSX.Element {
             </>
           )}
           {/* Top vertical line */}
-          <Box h={6}>
+          <Box h={4}>
             <Divider orientation="vertical" borderColor={dividerColor} />
           </Box>
           <TouchableTooltip
@@ -125,7 +125,7 @@ export function AddStepButton(props: AddStepButtonProps): JSX.Element {
           </TouchableTooltip>
           {/* Bottom vertical line */}
           {!isLastStep && (
-            <Box h={6}>
+            <Box h={4}>
               <Divider orientation="vertical" borderColor={dividerColor} />
             </Box>
           )}

packages/frontend/src/components/VariablesList/index.tsx

@@ -50,6 +50,11 @@ function VariableTag({
           label: 'Tile Row ID',
           tooltip: `This variable can be used in Tile's Update Single Row action`,
         }
+      case 'approval':
+        return {
+          label: 'Approval',
+          tooltip: 'This variable determines the approval status of this step',
+        }
       default:
         return {
           label: null,

packages/frontend/src/contexts/MrfContext.tsx

@@ -1,6 +1,7 @@
 import { IStep, IStepApprovalBranch } from '@plumber/types'
 
-import { createContext, useContext, useState } from 'react'
+import { createContext, useContext, useEffect, useMemo, useState } from 'react'
+import { isEqual } from 'lodash'
 import get from 'lodash/get'
 
 import { FORMSG_APP_KEY, MRF_ACTION_KEY } from '@/helpers/formsg'
@@ -29,28 +30,55 @@ interface MrfContextProviderProps {
   children: React.ReactNode
 }
 
+function generateDefaultApprovalBranches(
+  mrfApprovalSteps: IStep[],
+): Record<string, IStepApprovalBranch> {
+  return mrfApprovalSteps.reduce((acc, step) => {
+    acc[step.id] = 'approve'
+    return acc
+  }, {} as Record<string, IStepApprovalBranch>)
+}
+
 export const MrfContextProvider = ({ children }: MrfContextProviderProps) => {
   const { flow } = useContext(EditorContext)
 
   const [disabledMrfStepToDisplay, setDisabledMrfStepToDisplay] =
     useState<IStep | null>(null)
 
-  const mrfSteps = flow.steps.filter(
-    (step) => step.appKey === FORMSG_APP_KEY && step.key === MRF_ACTION_KEY,
+  const mrfSteps = useMemo(
+    () =>
+      flow.steps.filter(
+        (step) => step.appKey === FORMSG_APP_KEY && step.key === MRF_ACTION_KEY,
+      ),
+    [flow.steps],
   )
 
-  const mrfApprovalSteps = mrfSteps.filter(
-    (step) => !!get(step.parameters, 'mrf.approvalField', false),
+  const mrfApprovalSteps = useMemo(
+    () =>
+      mrfSteps.filter(
+        (step) => !!get(step.parameters, 'mrf.approvalField', false),
+      ),
+    [mrfSteps],
   )
 
   const [approvalBranches, setApprovalBranches] = useState<
     Record<string, IStepApprovalBranch>
-  >({
-    ...mrfApprovalSteps.reduce((acc, step) => {
-      acc[step.id] = 'approve'
-      return acc
-    }, {} as Record<string, IStepApprovalBranch>),
-  })
+  >(generateDefaultApprovalBranches(mrfApprovalSteps))
+
+  /**
+   * We need to reset the state when the mrf approval steps change
+   */
+  useEffect(() => {
+    if (
+      isEqual(
+        mrfApprovalSteps.map((step) => step.id),
+        Object.keys(approvalBranches),
+      )
+    ) {
+      return
+    }
+    setApprovalBranches(generateDefaultApprovalBranches(mrfApprovalSteps))
+  }, [approvalBranches, mrfApprovalSteps])
 
   const setApprovalBranch = (stepId: string, branch: IStepApprovalBranch) => {
     setApprovalBranches((prev) => ({

packages/types/index.d.ts

@@ -60,6 +60,7 @@ export type TDataOutMetadatumType =
   | 'array'
   | 'tile_row_id'
   | 'table'
+  | 'approval'
 
 /**
  * This should only be defined on _leaf_ nodes (i.e. **primitive array