feat: purge all mrf steps and config on checkstep or delete trigger

Author: pregnantboy

packages/backend/src/apps/formsg/triggers/new-submission/index.ts

@@ -117,7 +117,16 @@ const trigger: IRawTrigger = {
       await createMrfSteps($, mrfWorkflowData)
     } else {
       // remove mrf object from parameters and remove mrf steps (if any)
-      await removeMrfSteps($)
+      try {
+        await removeMrfSteps($.flow.id)
+      } catch (error) {
+        throw new StepError(
+          'Error removing MRF steps',
+          'This should not happen, please contact support.',
+          $.step.position,
+          $.app.name,
+        )
+      }
     }
 
     // if test with mock data is selected OR no past submission exists

packages/backend/src/apps/formsg/triggers/new-submission/remove-mrf-steps.ts

@@ -1,33 +1,47 @@
-import { IGlobalVariable } from '@plumber/types'
+import { Transaction } from 'objection'
 
-import StepError from '@/errors/step'
 import Step from '@/models/step'
 
-export async function removeMrfSteps($: IGlobalVariable) {
-  if (!$.flow?.id || !$.step?.id) {
-    throw new StepError(
-      'Missing flow or step',
-      'This should not happen, please contact support.',
-      $.step.position,
-      $.app.name,
-    )
-  }
-
-  await Step.transaction(async (trx) => {
+export async function removeMrfSteps(flowId: string, trx?: Transaction) {
+  const executeQueries = async (trx: Transaction) => {
     // delete all mrf action steps
     await Step.query(trx)
-      .where('flow_id', $.flow.id)
+      .where('flow_id', flowId)
       .where('type', 'action')
       .where('key', 'mrfSubmission')
       .delete()
 
     // reset trigger step parameters
     await Step.query(trx)
-      .where('flow_id', $.flow.id)
+      .where('flow_id', flowId)
       .where('type', 'trigger')
       .where('key', 'newSubmission')
       .patch({
         parameters: {},
       })
-  })
+
+    // Delete all steps in the reject branch
+    await Step.query(trx)
+      .where('flow_id', flowId)
+      .where('type', 'action')
+      .andWhereRaw(`steps.config->'approval'->>'branch' = ?`, ['reject'])
+      .delete()
+      .debug()
+
+    await Step.query(trx)
+      .where('flow_id', flowId)
+      .where('type', 'action')
+      .patch({
+        // remove approval config from all action steps
+        config: Step.knex().raw(`(steps.config::jsonb - 'approval')::jsonb`),
+      })
+
+    await Step.resetStepOrdering(flowId, trx)
+  }
+
+  if (trx) {
+    await executeQueries(trx)
+  } else {
+    await Step.transaction(executeQueries)
+  }
 }

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

@@ -1,5 +1,6 @@
 import { raw } from 'objection'
 
+import { removeMrfSteps } from '@/apps/formsg/triggers/new-submission/remove-mrf-steps'
 import { hasStepReference } from '@/helpers/check-step-parameters'
 import Step from '@/models/step'
 
@@ -47,6 +48,10 @@ const deleteStep: MutationResolvers['deleteStep'] = async (
     if (steps.length === 1 && steps[0].type === 'trigger') {
       const deletedStepId = steps[0].id
 
+      if (steps[0].appKey === 'formsg' && steps[0].key === 'newSubmission') {
+        await removeMrfSteps(flow.id, trx)
+      }
+
       // check for steps whose parameters reference the deletedStepId
       const allSteps = await flow
         .$relatedQuery('steps', trx)

packages/backend/src/models/step.ts

@@ -199,6 +199,26 @@ class Step extends Base {
     })
   }
 
+  // Reset step ordering in case of mass deletion or reordering
+  static async resetStepOrdering(flowId: string, trx?: Transaction) {
+    const allSteps = await Step.query(trx)
+      .where('flow_id', flowId)
+      .where('type', 'action')
+      .orderBy('position', 'asc')
+
+    for (let i = 0; i < allSteps.length; i++) {
+      const currStep = allSteps[i]
+      if (currStep.position !== i + 2) {
+        await Step.query(trx)
+          .findById(currStep.id)
+          .patch({
+            // actions start from 2 (after the trigger step)
+            position: i + 2,
+          })
+      }
+    }
+  }
+
   static async beforeUpdate(args: StaticHookArguments<Step>): Promise<void> {
     await super.beforeUpdate(args)