donotmerge: for each user testing

Author: kevinkim-ogp

packages/backend/src/apps/for-each/actions/index.ts

@@ -0,0 +1,3 @@
+import loopItems from './loop-items'
+
+export default [loopItems]

packages/backend/src/apps/for-each/actions/loop-items/get-data-out-metadata.ts

@@ -0,0 +1,37 @@
+import { IDataOutMetadata, IExecutionStep } from '@plumber/types'
+
+async function getDataOutMetadata(
+  executionStep: IExecutionStep,
+): Promise<IDataOutMetadata> {
+  const { dataOut: rawDataOut } = executionStep
+  if (!rawDataOut) {
+    return null
+  }
+
+  let inputList = rawDataOut.inputList
+  if (rawDataOut.inputType === 'array') {
+    inputList = JSON.parse(rawDataOut.inputList as string)
+  }
+
+  return {
+    iterations: {
+      label: 'Number of items',
+    },
+    inputList: {
+      label: 'Input list',
+      type: 'hidden',
+    },
+    inputType: {
+      label: 'Input type',
+      type: 'hidden',
+    },
+    arrayValue: {
+      label: 'Array value',
+      displayedValue: Array.isArray(inputList)
+        ? JSON.stringify(inputList[0])
+        : undefined,
+    },
+  }
+}
+
+export default getDataOutMetadata

packages/backend/src/apps/for-each/actions/loop-items/index.ts

@@ -0,0 +1,63 @@
+import { IRawAction } from '@plumber/types'
+
+import StepError from '@/errors/step'
+
+import getDataOutMetadata from './get-data-out-metadata'
+
+const action: IRawAction = {
+  name: 'Loops',
+  key: 'forEach',
+  description: 'Loops through items',
+  groupsLaterSteps: true,
+  arguments: [
+    {
+      label: 'Loop items',
+      description:
+        'Supported lists include find multiple rows actions and FormSG checkboxes',
+      key: 'forEachInputList',
+      type: 'string' as const,
+      required: true,
+      variables: true,
+      variableTypes: ['array'],
+    },
+  ],
+
+  getDataOutMetadata,
+
+  async run($) {
+    const { forEachInputList } = $.step.parameters as {
+      forEachInputList: string
+    }
+
+    try {
+      const isJsonString =
+        forEachInputList.includes('[') || forEachInputList.includes('{')
+      const inputList = isJsonString
+        ? JSON.parse(forEachInputList)
+        : forEachInputList.split(',').map((item) => item.trim())
+
+      $.setActionItem({
+        raw: {
+          iterations: inputList.length,
+        },
+      })
+
+      return {
+        nextStep: {
+          command: 'start-loop',
+          stepId: $.step.id,
+        },
+      }
+    } catch (err) {
+      console.error(err)
+      throw new StepError(
+        'Invalid input list',
+        'Select a valid input list',
+        $.step.position,
+        $.app.name,
+      )
+    }
+  },
+}
+
+export default action

packages/backend/src/apps/for-each/assets/favicon.svg

@@ -0,0 +1,18 @@
+import { IApp } from '@plumber/types'
+
+import actions from './actions'
+
+const app: IApp = {
+  name: 'Loops',
+  description: 'Loop through items',
+  key: 'for-each',
+  iconUrl: '{BASE_URL}/apps/for-each/assets/favicon.svg',
+  authDocUrl: '',
+  baseUrl: '',
+  apiBaseUrl: '',
+  primaryColor: '',
+  actions,
+  category: 'logic',
+}
+
+export default app

packages/backend/src/apps/for-each/index.ts

@@ -3,6 +3,7 @@ import type { IApp } from '@plumber/types'
 import calculatorApp from './calculator'
 import customApiApp from './custom-api'
 import delayApp from './delay'
+import forEachApp from './for-each'
 import formatterApp from './formatter'
 import formsgApp from './formsg'
 import lettersgApp from './lettersg'
@@ -23,6 +24,7 @@ const apps: Record<string, IApp> = {
   [calculatorApp.key]: calculatorApp,
   [customApiApp.key]: customApiApp,
   [delayApp.key]: delayApp,
+  [forEachApp.key]: forEachApp,
   [formatterApp.key]: formatterApp,
   [formsgApp.key]: formsgApp,
   [lettersgApp.key]: lettersgApp,

packages/backend/src/apps/index.ts

@@ -22,7 +22,7 @@ describe('getTableRows getDataOutMetadata', () => {
 
     expect(result).toEqual({
       rowsFound: {
-        label: 'No. of rows found',
+        label: 'Number of rows found',
       },
     })
   })
@@ -58,20 +58,25 @@ describe('getTableRows getDataOutMetadata', () => {
 
     expect(result).toEqual({
       rows: {
-        label: 'Data rows',
-        displayedValue: '2 rows',
+        displayedValue: 'Preview 2 row(s)',
+        label: 'List of row(s) found',
+        type: 'array',
       },
       rowsFound: {
-        label: 'No. of rows found',
+        label: 'Number of rows found',
       },
       columns: [
         {
           label: 'Column1',
-          displayedValue: '',
+          displayedValue: ' ',
+          order: 1,
+          value: 'Column1',
         },
         {
           label: 'Column2',
-          displayedValue: '',
+          displayedValue: ' ',
+          order: 2,
+          value: 'Column2',
         },
       ],
     })
@@ -90,11 +95,12 @@ describe('getTableRows getDataOutMetadata', () => {
 
     expect(result).toEqual({
       rowsFound: {
-        label: 'No. of rows found',
+        label: 'Number of rows found',
       },
       rows: {
-        label: 'Data rows',
-        displayedValue: '1 rows',
+        displayedValue: 'Preview 1 row(s)',
+        label: 'List of row(s) found',
+        type: 'array',
       },
       columns: [],
     })

packages/backend/src/apps/m365-excel/__tests__/actions/get-table-rows-metadata.test.ts

@@ -29,6 +29,12 @@ async function getDataOutMetadata(
     rows: {
       label: 'List of row(s) found',
       displayedValue: `Preview ${dataOut.rowsFound} row(s)`,
+      type: 'array',
+    },
+    rowId: {
+      label: 'Row ID',
+      value: 'rowId',
+      displayedValue: ' ',
     },
   }
 
@@ -39,7 +45,8 @@ async function getDataOutMetadata(
         label: name,
         order: columnOrder[id] ?? null,
         // leave as blank to not display column id in the frontend
-        displayedValue: '',
+        displayedValue: ' ',
+        value: id,
       }
     })
   }

packages/backend/src/apps/tiles/actions/find-multiple-rows/get-data-out-metadata.ts

@@ -194,8 +194,7 @@ const action: IRawAction = {
       $.setActionItem({
         raw: {
           rowsFound: 0,
-          rows: JSON.stringify([]),
-          columns: {},
+          rows: [],
         } satisfies FindMultipleRowsOutput,
       })
       return
@@ -219,6 +218,7 @@ const action: IRawAction = {
         rowsFound: slicedRows.length,
         rows: JSON.stringify(slicedRows),
         columns: columnsToReturn,
+        rowId: 'rowId',
       } satisfies FindMultipleRowsOutput,
     })
   },

packages/backend/src/apps/tiles/actions/find-multiple-rows/index.ts

@@ -0,0 +1,13 @@
+import { Knex } from 'knex'
+
+export async function up(knex: Knex): Promise<void> {
+  return knex.schema.table('execution_steps', (table) => {
+    table.string('key').nullable()
+  })
+}
+
+export async function down(knex: Knex): Promise<void> {
+  return knex.schema.table('execution_steps', (table) => {
+    table.dropColumn('key')
+  })
+}