chore: edit validate approval config query

Author: pregnantboy

packages/backend/src/apps/formsg/common/types.ts

@@ -52,6 +52,6 @@ export interface ParsedMrfWorkflow {
 }
 
 export const stepApprovalConfigSchema = z.object({
-  branch: z.enum(['approve', 'reject']),
+  branch: z.literal('reject'),
   stepId: z.string().uuid(),
 })

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

@@ -1,3 +1,5 @@
+import { IStepConfig } from '@plumber/types'
+
 import { raw } from 'objection'
 
 import { BadUserInputError } from '@/errors/graphql-errors'
@@ -60,7 +62,7 @@ const createStep: MutationResolvers['createStep'] = async (
       .throwIfNotFound()
 
     const validationResult = await validateApprovalConfig(
-      input.config,
+      input.config as IStepConfig,
       previousStep,
     )
     if (!validationResult.isApprovalConfigValid) {
@@ -81,7 +83,7 @@ const createStep: MutationResolvers['createStep'] = async (
       position: validationResult.newStepPosition,
       parameters: input.parameters,
       connectionId: input.connection?.id,
-      config: input.config,
+      config: input.config as IStepConfig,
     })
 
     await step.patchFlowLastUpdated(trx)

packages/backend/src/graphql/schema.graphql

@@ -546,13 +546,10 @@ input CreateStepInput {
   config: StepConfigInput
 }
 
-enum StepApprovalBranch {
-  approve
-  reject
-}
+
 
 input StepApprovalConfigInput {
-  branch: StepApprovalBranch!
+  branch: String!
   stepId: String!
 }
 

packages/backend/src/helpers/validate-approval-config.ts

@@ -50,7 +50,7 @@ export async function validateApprovalConfig(
       }
     }
     logger.error(
-      'Invalid approval config: previous step has no approval config and is not an mrf approval step',
+      'Invalid approval config: previous step has no approval config and is not an mrf approval step. This step should not have an approval config.',
     )
     return {
       isApprovalConfigValid: false,
@@ -83,12 +83,19 @@ export async function validateApprovalConfig(
    * Case 4: Previous step is an approval step
    */
   if (isPreviousStepMrfApprovalStep) {
+    // If previous step is an approval step, but this step has no approval config, it is part of the approve flow
+    if (!config?.approval) {
+      return {
+        isApprovalConfigValid: true,
+        newStepPosition: prevStep.position + 1,
+      }
+    }
     // validate approval config
     const { success } = stepApprovalConfigSchema.safeParse(config?.approval)
     // validate approval config step id is the same as prev step id
     if (!success || config.approval.stepId !== prevStep.id) {
       logger.error(
-        'Invalid approval config (after approval step): invalid approval config or new step id is not the same as approval step id',
+        'Invalid approval config: invalid approval config or new step id is not the same as approval step id',
         {
           approvalConfig: config?.approval,
         },
@@ -97,16 +104,7 @@ export async function validateApprovalConfig(
         isApprovalConfigValid: false,
       }
     }
-    /**
-     * If approval branch, simply add 1 to the prev step position
-     */
-    if (config.approval.branch === 'approve') {
-      return {
-        isApprovalConfigValid: true,
-        newStepPosition: prevStep.position + 1,
-      }
-    }
-    // If reject branch, find the end of the approval branch and add one to that step
+    // For reject branch, find the end of the approval branch and add one to that step
     // first find the next mrf step (if any)
     const nextMrfStep = await Step.query()
       .where('flow_id', prevStep.flowId)
@@ -115,23 +113,23 @@ export async function validateApprovalConfig(
       .andWhere('position', '>', prevStep.position)
       .orderBy('position', 'asc')
       .first()
-    // then find the last approval step in the curr branch (if any)
-    const lastApprovalStepQuery = Step.query()
+    // then find the step in the approve branch (if any)
+    const lastStepOfApproveFlowQuery = Step.query()
       .where('flow_id', prevStep.flowId)
       .andWhere('position', '>', prevStep.position)
-      .andWhereRaw(`config->'approval'->>'branch' = ?`, ['approve'])
+
       .orderBy('position', 'desc')
       .first()
 
     if (nextMrfStep) {
-      lastApprovalStepQuery.andWhere('position', '<', nextMrfStep.position)
+      lastStepOfApproveFlowQuery.andWhere('position', '<', nextMrfStep.position)
     }
-    const lastApprovalStep = await lastApprovalStepQuery.first()
+    const lastStepOfapproveFlow = await lastStepOfApproveFlowQuery.first()
     // If last approval step exists, return the position after that
-    if (lastApprovalStep) {
+    if (lastStepOfapproveFlow) {
       return {
         isApprovalConfigValid: true,
-        newStepPosition: lastApprovalStep.position + 1,
+        newStepPosition: lastStepOfapproveFlow.position + 1,
       }
     } else {
       // If no last approval step, return the position after the previous step

packages/types/index.d.ts

@@ -168,7 +168,7 @@ export interface IExecution {
 export type IStepApprovalBranch = 'approve' | 'reject'
 
 export interface IStepApprovalConfig {
-  branch: IStepApprovalBranch
+  branch: 'reject'
   stepId: string
 }