chore: retry emails without attachments

kevinkim-ogp · kevinkim-ogp · commit 18ec7c192f4a · 2025-07-23T18:02:42.000+08:00
diff --git a/packages/backend/src/apps/postman/actions/send-transactional-email/index.ts b/packages/backend/src/apps/postman/actions/send-transactional-email/index.ts
@@ -74,9 +74,6 @@ const action: IRawAction = {
       )
     }
 
-    const { attachmentFiles, invalidAttachments, submissionId, formId } =
-      await filterAttachments(result.data.attachments, $)
-
     let recipientsToSend = result.data.destinationEmail
     /**
      * Logic to handle retries here:
@@ -99,6 +96,19 @@ const action: IRawAction = {
       // Don't do partial retry in test runs! always send to all recipients
       !$.execution.testRun
 
+    const {
+      attachmentFiles,
+      invalidAttachments,
+      submissionId,
+      formId,
+      isRetryWithoutAttachments,
+    } = await filterAttachments({
+      $,
+      attachmentsList: result.data.attachments,
+      isPartialRetry,
+      lastExecutionStep,
+    })
+
     if (isPartialRetry) {
       const { status, recipient } = prevDataOutParseResult.data
       recipientsToSend = recipient.filter((_, i) => status[i] !== 'ACCEPTED')
@@ -198,8 +208,14 @@ const action: IRawAction = {
     /**
      * Send invalid attachments notification email
      * Do not send on partial retry as we would have already sent this once with the blacklist email
+     * Do not send on retry when removing all attachments
      */
-    if (hasInvalidAttachments && !isPartialRetry && !$.execution.testRun) {
+    if (
+      hasInvalidAttachments &&
+      !isPartialRetry &&
+      !$.execution.testRun &&
+      !isRetryWithoutAttachments
+    ) {
       await sendInvalidAttachmentsEmail({
         ...defaultSendEmailParams,
         ...invalidAttachmentParams,
@@ -225,6 +241,7 @@ const action: IRawAction = {
         blacklistedRecipients,
         invalidAttachments,
         formAdminLink,
+        isRetryWithoutAttachments,
       })
     }
   },
diff --git a/packages/backend/src/apps/postman/common/parameters-helper.ts b/packages/backend/src/apps/postman/common/parameters-helper.ts
@@ -1,4 +1,4 @@
-import { IGlobalVariable } from '@plumber/types'
+import { IExecutionStep, IGlobalVariable, IJSONObject } from '@plumber/types'
 
 import { COMMON_S3_BUCKET, getObjectFromS3Id } from '@/helpers/s3'
 import ExecutionStep from '@/models/execution-step'
@@ -24,28 +24,66 @@ async function getFormId(executionId: string) {
   return String(formData?.dataOut?.formId)
 }
 
-export async function filterAttachments(
-  attachmentsList: string[],
-  $: IGlobalVariable,
-) {
-  let formId: string | null = null
+export async function filterAttachments({
+  $,
+  attachmentsList,
+  isPartialRetry,
+  lastExecutionStep,
+}: {
+  $: IGlobalVariable
+  attachmentsList: string[]
+  isPartialRetry: boolean
+  lastExecutionStep: IExecutionStep | null
+}) {
+  const formId: string | null = await getFormId($.execution.id)
   let submissionId: string | null = null
   const invalidAttachments: string[] = []
   const attachmentFiles: { fileName: string; data: Uint8Array }[] = []
 
+  const errorName = lastExecutionStep?.errorDetails?.name
+  const partialRetryButtonMessage = (
+    lastExecutionStep?.errorDetails?.partialRetry as IJSONObject
+  )?.buttonMessage
+
+  /**
+   * NOTE: there are different scenarios where we should retry without attachments:
+   * 1. Password-protected attachment(s)
+   *    Postman does not tell us reliably which attachment(s) are password-protected
+   *    so we remove all attachments instead.
+   *
+   * 2. Unsupported attachment file type
+   *    This is the old error code that is thrown when there are unsupported or password-protected attachments.
+   *    We remove all attachments when retrying old executions to avoid having to retry twice in the event
+   *    that there are password-protected attachments, which will cause another failure.
+   *
+   * 3. isPartialRetry and Resend to blacklisted recipients without attachments
+   *    This is to handle executions that failed due to invalid attachments and had blacklisted recipients.
+   *    Upon retry, the execution runs without attachments, but the blacklisted recipient still exists.
+   *    In such scenarios, we show the partial retry button with 'Resend to blacklisted recipients without attachments',
+   *    and use this to tell the worker to remove all attachments.
+   */
+  const isRetryWithoutAttachments =
+    errorName === 'Password-protected attachment(s)' ||
+    errorName === 'Unsupported attachment file type' ||
+    (isPartialRetry &&
+      partialRetryButtonMessage ===
+        'Resend to blacklisted recipients without attachments')
+
   await Promise.all(
     attachmentsList?.map(async (attachment) => {
       // We verify the flowId here to ensure that the attachment is from the same flow and not
       // maliciously/ manually injected by another user who does not have access to this attachment
       const obj = await getObjectFromS3Id(attachment, { flowId: $.flow.id }, $)
       const fileName = obj.name
       const fileType = obj.name.split('.').pop()
-      if (!POSTMAN_ACCEPTED_EXTENSIONS.includes(fileType)) {
+
+      if (isRetryWithoutAttachments) {
         invalidAttachments.push(fileName)
+        return
+      }
 
-        if (formId === null) {
-          formId = await getFormId($.execution.id)
-        }
+      if (!POSTMAN_ACCEPTED_EXTENSIONS.includes(fileType)) {
+        invalidAttachments.push(fileName)
 
         if (submissionId === null) {
           submissionId = attachment.slice(
@@ -59,5 +97,22 @@ export async function filterAttachments(
       return
     }),
   )
-  return { attachmentFiles, invalidAttachments, submissionId, formId }
+
+  if (isRetryWithoutAttachments) {
+    return {
+      attachmentFiles: [],
+      invalidAttachments,
+      submissionId,
+      formId,
+      isRetryWithoutAttachments,
+    }
+  }
+
+  return {
+    attachmentFiles,
+    invalidAttachments,
+    submissionId,
+    formId,
+    isRetryWithoutAttachments,
+  }
 }
diff --git a/packages/backend/src/apps/postman/common/send-invalid-attachments-email.ts b/packages/backend/src/apps/postman/common/send-invalid-attachments-email.ts
@@ -62,7 +62,7 @@ export async function sendInvalidAttachmentsEmail(
 ) {
   const { flowName, userEmail, formAdminLink } = props
   const truncatedFlowName = truncateFlowName(flowName)
-  const bodyContent = await createInvalidAttachmentsMessage({
+  const bodyContent = createInvalidAttachmentsMessage({
     ...props,
     formAdminLink,
   })
diff --git a/packages/backend/src/apps/postman/common/throw-errors.ts b/packages/backend/src/apps/postman/common/throw-errors.ts
@@ -50,13 +50,22 @@ export function getPostmanErrorStatus(
 function getInvalidAttachmentSolution({
   invalidAttachments,
   formAdminLink,
+  showAttachmentsList = true,
 }: {
   invalidAttachments: string[]
   formAdminLink: string | null
+  showAttachmentsList?: boolean
 }) {
-  return `The following attachment(s) are not supported by Postman and have been removed from the email:
-  \n${invalidAttachments.map((attachment) => `**${attachment}**`).join('\n\n')}
-  \nIf you require the attachment(s), log in to your [form](${formAdminLink}) to download them for this submission.
+  if (showAttachmentsList) {
+    return `The following attachment(s) are not supported by Postman and have been removed from the email:
+    \n${invalidAttachments
+      .map((attachment) => `**${attachment}**`)
+      .join('\n\n')}
+    \nIf you require the attachment(s), log in to your [form](${formAdminLink}) to download them for this submission.
+    `
+  }
+  return `There were attachment(s) that could not be sent by Postman and have been removed from the email.
+    \nIf you require the attachment(s), log in to your [form](${formAdminLink}) to download them for this submission.
   `
 }
 
@@ -68,6 +77,7 @@ export function throwPostmanStepError({
   blacklistedRecipients,
   invalidAttachments,
   formAdminLink,
+  isRetryWithoutAttachments,
 }: {
   $: IGlobalVariable
   status: PostmanEmailSendStatus
@@ -76,6 +86,7 @@ export function throwPostmanStepError({
   blacklistedRecipients: string[]
   invalidAttachments: string[]
   formAdminLink: string | null
+  isRetryWithoutAttachments: boolean
 }) {
   const position = $.step.position
   const appName = $.app.name
@@ -84,6 +95,8 @@ export function throwPostmanStepError({
   const invalidAttachmentsSolution = getInvalidAttachmentSolution({
     invalidAttachments,
     formAdminLink,
+    // should not show attachments list if we are retrying without attachments
+    showAttachmentsList: !isRetryWithoutAttachments,
   })
 
   switch (status) {
@@ -106,14 +119,19 @@ export function throwPostmanStepError({
         solution += `\n\n&nbsp;\n\n${invalidAttachmentsSolution}`
       }
 
+      let buttonMessage = 'Resend to blacklisted recipients'
+      if (isRetryWithoutAttachments) {
+        buttonMessage += ' without attachments'
+      }
+
       if (isPartialSuccess) {
         throw new PartialStepError({
           name,
           solution,
           position,
           appName,
           partialRetry: {
-            buttonMessage: 'Resend to blacklisted recipients',
+            buttonMessage,
           },
         })
       }
@@ -162,14 +180,9 @@ export function throwPostmanStepError({
       // attachments that are password-protected
       if (hasInvalidAttachments) {
         const name = 'Invalid attachment(s)'
-        const solution = getInvalidAttachmentSolution({
-          invalidAttachments,
-          formAdminLink,
-        })
-
         throw new PartialStepError({
           name,
-          solution,
+          solution: invalidAttachmentsSolution,
           position,
           appName,
           partialRetry: { buttonMessage: '' }, // nothing to retry
diff --git a/packages/frontend/src/components/ExecutionStep/index.tsx b/packages/frontend/src/components/ExecutionStep/index.tsx
@@ -42,14 +42,21 @@ export default function ExecutionStep({
 }: ExecutionStepProps): React.ReactElement | null {
   const { appKey, jobId, errorDetails, status } = executionStep
 
-  const { app, appName, statusIcon, hasError, isPartialSuccess, canRetry } =
-    useExecutionStepStatus({
-      appKey,
-      status,
-      errorDetails,
-      execution,
-      jobId,
-    })
+  const {
+    app,
+    appName,
+    statusIcon,
+    hasError,
+    isPartialSuccess,
+    canRetry,
+    customRetryButtonText,
+  } = useExecutionStepStatus({
+    appKey,
+    status,
+    errorDetails,
+    execution,
+    jobId,
+  })
 
   if (!app) {
     return null
@@ -77,7 +84,10 @@ export default function ExecutionStep({
             {!isInForEach && canRetry && (
               <>
                 <RetryAllButton execution={execution} />
-                <RetryButton executionStepId={executionStep.id} />
+                <RetryButton
+                  executionStepId={executionStep.id}
+                  customButtonText={customRetryButtonText}
+                />
               </>
             )}
           </HStack>
