Release v1.48.1 (#1130)

feat: allow overriding webhook response in step config
hotfix: accept null values in for each row data

Author: kevinkim-ogp

package-lock.json

@@ -108,5 +108,5 @@
     "tsconfig-paths": "^4.2.0",
     "type-fest": "4.10.3"
   },
-  "version": "1.48.0"
+  "version": "1.48.1"
 }

packages/backend/package.json

@@ -1,10 +1,15 @@
 import { z } from 'zod'
 
+export const tableRowDataSchema = z.record(
+  z.string(),
+  z.union([z.string(), z.number(), z.null()]).default(null),
+)
+
 const tableRowOutputSchema = z.object({
   rowId: z.string(),
   // for tiles v1, empty cells is either an empty string or wont even have their key returned
   // for tiles v2, empty cells return null
-  data: z.record(z.string(), z.union([z.string(), z.number(), z.null()])),
+  data: tableRowDataSchema,
 })
 
 export const dataOutSchema = z.object({

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

@@ -1,5 +1,7 @@
 import { z } from 'zod'
 
+import { tableRowDataSchema } from '@/apps/tiles/actions/find-multiple-rows/schema'
+
 import {
   FOR_EACH_INPUT_SOURCE,
   FOR_EACH_TABLE_SOURCES,
@@ -15,7 +17,7 @@ const tableColumnsSchema = z.array(
 
 const tableRowsSchema = z.array(
   z.object({
-    data: z.record(z.string(), z.string().or(z.number())),
+    data: tableRowDataSchema,
     rowId: z.string().optional(), // only for tiles
   }),
 )

packages/backend/src/apps/toolbox/actions/for-each/schema.ts

@@ -13,7 +13,7 @@ import logger from '@/helpers/logger'
 import tracer from '@/helpers/tracer'
 import Flow from '@/models/flow'
 import { enqueueActionJob } from '@/queues/action'
-import { processTrigger } from '@/services/trigger'
+import { type CustomWebhookResponse, processTrigger } from '@/services/trigger'
 
 const DEFAULT_MAX_QPS = 10
 
@@ -31,6 +31,17 @@ const getRateLimiter = memoize((maxQps: number): RateLimiterRedis => {
   })
 })
 
+async function sendWebhookResponse(
+  response: Response,
+  customWebhookResponse?: CustomWebhookResponse,
+) {
+  if (customWebhookResponse) {
+    response.setHeader('Content-Type', customWebhookResponse.contentType)
+    return response.status(200).send(customWebhookResponse.body)
+  }
+  return response.sendStatus(200)
+}
+
 export default async (request: IRequest, response: Response) => {
   const span = tracer.scope().active()
   span?.setOperationName('webhooks.handler')
@@ -139,12 +150,13 @@ export default async (request: IRequest, response: Response) => {
    * Plumber will still return a 200 status code, so that FormSG does not auto-retry,
    * but Plumber not enqueue the job.
    */
-  const { executionId, shouldExecute } = await processTrigger({
-    flowId,
-    stepId: triggerStep.id,
-    triggerItem,
-    testRun,
-  })
+  const { executionId, shouldExecute, customWebhookResponse } =
+    await processTrigger({
+      flowId,
+      stepId: triggerStep.id,
+      triggerItem,
+      testRun,
+    })
 
   span?.addTags({
     flowId,
@@ -155,7 +167,7 @@ export default async (request: IRequest, response: Response) => {
   })
 
   if (testRun || !shouldExecute) {
-    return response.sendStatus(200)
+    return sendWebhookResponse(response, customWebhookResponse)
   }
 
   const nextStep = await triggerStep.getNextStep()
@@ -174,5 +186,5 @@ export default async (request: IRequest, response: Response) => {
     jobOptions: DEFAULT_JOB_OPTIONS,
   })
 
-  return response.sendStatus(200)
+  return sendWebhookResponse(response, customWebhookResponse)
 }

packages/backend/src/controllers/webhooks/handler.ts

@@ -1,7 +1,10 @@
 import type { IJSONObject, ITriggerItem } from '@plumber/types'
 
+import { z } from 'zod'
+
 import logger from '@/helpers/logger'
 import Execution from '@/models/execution'
+import ExecutionStep from '@/models/execution-step'
 import Step from '@/models/step'
 
 type ProcessTriggerOptions = {
@@ -12,8 +15,41 @@ type ProcessTriggerOptions = {
   testRun?: boolean
 }
 
+const customWebhookResponseSchema = z.object({
+  contentType: z.string(),
+  body: z.string(),
+})
+
+export type CustomWebhookResponse = z.infer<typeof customWebhookResponseSchema>
+
+type ProcessTriggerResult = {
+  flowId: string
+  stepId: string
+  executionId: string
+  executionStep: ExecutionStep | null
+  shouldExecute: boolean
+  customWebhookResponse?: CustomWebhookResponse
+}
+
+function getCustomWebhookResponse(
+  step: Step,
+): CustomWebhookResponse | undefined {
+  const customWebhookResponse =
+    step.config?.adminOverride?.customWebhookResponse
+  if (step.appKey !== 'webhook' || !customWebhookResponse) {
+    return undefined
+  }
+  const parsed = customWebhookResponseSchema.safeParse(customWebhookResponse)
+  if (parsed.success) {
+    return parsed.data
+  }
+  return undefined
+}
+
 // TODO(ian): change this function name, it's basically just storing trigger data
-export const processTrigger = async (options: ProcessTriggerOptions) => {
+export const processTrigger = async (
+  options: ProcessTriggerOptions,
+): Promise<ProcessTriggerResult> => {
   const { flowId, stepId, triggerItem, error, testRun } = options
 
   const step = await Step.query().findById(stepId).throwIfNotFound()
@@ -95,11 +131,14 @@ export const processTrigger = async (options: ProcessTriggerOptions) => {
       key: step.key,
     })
 
+  const customWebhookResponse = getCustomWebhookResponse(step)
+
   return {
     flowId,
     stepId,
     executionId: execution.id,
     executionStep,
     shouldExecute: true,
+    customWebhookResponse,
   }
 }

packages/backend/src/services/trigger.ts

@@ -1,6 +1,6 @@
 {
   "name": "frontend",
-  "version": "1.48.0",
+  "version": "1.48.1",
   "type": "module",
   "scripts": {
     "dev": "wait-on tcp:3000 && vite --host --force",

packages/frontend/package.json

@@ -7,7 +7,10 @@ const RowDataSchema = z.object({
     z.object({
       // for tiles v1, empty cells is either an empty string or wont even have their key returned
       // for tiles v2, empty cells return null
-      data: z.record(z.string(), z.union([z.string(), z.number(), z.null()])),
+      data: z.record(
+        z.string(),
+        z.union([z.string(), z.number(), z.null()]).default(null),
+      ),
       rowId: z.string().optional(), // only Tiles will have this
     }),
   ),

packages/frontend/src/components/VariablesList/schema.ts

@@ -2,5 +2,5 @@
   "name": "@plumber/types",
   "description": "Shared types for plumber",
   "types": "./index.d.ts",
-  "version": "1.48.0"
+  "version": "1.48.1"
 }