feat: introduce mrf action that cannot be added by user

Author: pregnantboy

packages/backend/src/apps/formsg/actions/index.ts

@@ -0,0 +1,3 @@
+import mrfSubmission from './mrf-submission'
+
+export default [mrfSubmission]

packages/backend/src/apps/formsg/actions/mrf-submission/index.ts

@@ -0,0 +1,18 @@
+import { IGlobalVariable, IRawAction } from '@plumber/types'
+
+import getDataOutMetadata from '../../triggers/new-submission/get-data-out-metadata'
+
+const action: IRawAction = {
+  name: 'New form response',
+  key: 'mrfSubmission',
+  hiddenFromUser: true,
+  description:
+    'This is a hidden action that signifies a subsequent MRF submission',
+  getDataOutMetadata,
+
+  async testRun(_$: IGlobalVariable) {
+    // TODO: this should run testRun for the trigger execution step
+  },
+}
+
+export default action

packages/backend/src/apps/formsg/index.ts

@@ -1,6 +1,7 @@
 import type { IApp } from '@plumber/types'
 
 import beforeRequest from './common/before-request'
+import actions from './actions'
 import auth from './auth'
 import triggers from './triggers'
 
@@ -16,7 +17,7 @@ const app: IApp = {
   beforeRequest,
   auth,
   triggers,
-  actions: [],
+  actions,
   demoVideoDetails: {
     url: 'https://demo.arcade.software/6cWULLTHkTH4XsSB1rs1?embed&show_copy_link=true',
     title: 'Setting up FormSG',

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

@@ -1,5 +1,7 @@
 import { raw } from 'objection'
 
+import { BadUserInputError } from '@/errors/graphql-errors'
+import App from '@/models/app'
 import FlowConnections from '@/models/flow-connections'
 import Step from '@/models/step'
 import { getConnection } from '@/services/connection'
@@ -13,6 +15,18 @@ const createStep: MutationResolvers['createStep'] = async (
 ) => {
   const { input } = params
 
+  const triggerOrAction = await App.findTriggerOrActionByKey(
+    input.appKey,
+    input.key,
+  )
+
+  if (!triggerOrAction) {
+    throw new BadUserInputError('No such trigger or action')
+  }
+  if ('hiddenFromUser' in triggerOrAction && triggerOrAction.hiddenFromUser) {
+    throw new BadUserInputError('Action can only be created by system')
+  }
+
   return await Step.transaction(async (trx) => {
     await trx.raw('SET TRANSACTION ISOLATION LEVEL SERIALIZABLE;')
 

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

@@ -1,3 +1,4 @@
+import { IAction } from '@/../../types'
 import { BadUserInputError } from '@/errors/graphql-errors'
 import {
   addFlowConnection,
@@ -16,6 +17,14 @@ const updateStep: MutationResolvers['updateStep'] = async (
 ) => {
   const { input } = params
 
+  const triggerOrAction = await App.findTriggerOrActionByKey(
+    input.appKey,
+    input.key,
+  )
+  if (!triggerOrAction) {
+    throw new BadUserInputError('No such trigger or action')
+  }
+
   const step = await Step.transaction(async (trx) => {
     const step = await context.currentUser
       .withAccessibleSteps({ requiredRole: 'editor', trx })
@@ -52,8 +61,10 @@ const updateStep: MutationResolvers['updateStep'] = async (
     // NOTE: we use this function to first validate the step parameters
     // to avoid misuse and saving invalid step parameters
     if (step.type === 'action') {
-      const app = await App.findOneByKey(input.appKey)
-      const action = app?.actions?.find((action) => action.key === step.key)
+      const action = triggerOrAction as IAction
+      if (action?.hiddenFromUser) {
+        throw new BadUserInputError('Action can only be updated by system')
+      }
       action?.validateStepParameters?.(input.parameters)
     }
 

packages/backend/src/graphql/queries/get-apps.ts

@@ -57,6 +57,7 @@ export const ACTION_APPS_RANKING = [
   customApiApp.key,
   vaultWorkspaceApp.key,
   twilioApp.key,
+  formsgApp.key,
 ]
 
 function sortApps(apps: IApp[]): IApp[] {

packages/backend/src/graphql/schema.graphql

@@ -174,6 +174,7 @@ type Action {
   name: String
   key: String
   description: String
+  hiddenFromUser: Boolean
   groupsLaterSteps: Boolean
   setupMessage: SetupMessage
   isNew: Boolean

packages/backend/src/models/app.ts

@@ -1,4 +1,4 @@
-import { IApp } from '@plumber/types'
+import { IAction, IApp, ITrigger } from '@plumber/types'
 
 import { memoize } from 'lodash'
 
@@ -37,6 +37,17 @@ class App {
     return appInfoConverter(rawAppData)
   }
 
+  static async findTriggerOrActionByKey(
+    appKey: string,
+    key: string,
+  ): Promise<ITrigger | IAction> {
+    const app = await this.findOneByKey(appKey)
+    return (
+      app.triggers?.find((trigger) => trigger.key === key) ||
+      app.actions?.find((action) => action.key === key)
+    )
+  }
+
   static getAllAppsWithFunctions = memoize(async () => {
     return await this.findAll(null, false)
   })

packages/frontend/src/components/FlowStepConfigurationModal/ChooseAppAndEvent/ChooseApp.tsx

@@ -288,14 +288,18 @@ export default function ChooseApp(props: ChooseAppProps) {
 
                     const triggersOrActions = isTrigger
                       ? app.triggers
-                      : app.actions
+                      : app.actions?.filter((action) => !action.hiddenFromUser)
                     const singleTriggerOrAction =
                       triggersOrActions?.length === 1
                         ? triggersOrActions[0]
                         : null
 
                     const isAppDisabled = appSelectableMap?.[app.key] === false
 
+                    if (!triggersOrActions?.length) {
+                      return null
+                    }
+
                     return (
                       <Flex
                         key={app.key}

packages/frontend/src/graphql/queries/get-apps.ts

@@ -178,6 +178,7 @@ export const GET_APPS = gql`
         groupsLaterSteps
         isNew
         linkToGuide
+        hiddenFromUser
         substeps {
           key
           name