feat: automate critical bounce handling

.template-env

@@ -30,7 +30,7 @@ FORMSG_SDK_MODE=
 ## App Config
 # APP_NAME=FormSG
 # OTP_LIFE_SPAN=900000
-# BOUNCE_LIFE_SPAN=1800000
+# BOUNCE_LIFE_SPAN=86400000
 # AGGREGATE_COLLECTION=
 
 # If provided, a banner with the provided message will show up in every form.

docker-compose.yml

@@ -25,7 +25,7 @@ services:
       - IMAGE_S3_BUCKET=local-image-bucket
       - LOGO_S3_BUCKET=local-logo-bucket
       - FORMSG_SDK_MODE=development
-      - BOUNCE_LIFE_SPAN=1800000
+      - BOUNCE_LIFE_SPAN=86400000
       - AWS_ACCESS_KEY_ID=fakeKey
       - AWS_SECRET_ACCESS_KEY=fakeSecret
       - SESSION_SECRET=thisisasecret

src/app/models/form.server.model.ts

@@ -89,6 +89,7 @@ const formSchemaOptions: SchemaOptions = {
 export interface IFormModel extends Model<IFormSchema> {
   getOtpData(formId: string): Promise<FormOtpData | null>
   getFullFormById(formId: string): Promise<IPopulatedForm | null>
+  deactivateById(formId: string): Promise<IFormSchema | null>
 }
 
 type IEncryptedFormModel = Model<IEncryptedFormSchema>
@@ -469,6 +470,19 @@ const compileFormModel = (db: Mongoose): IFormModel => {
     return data
   }
 
+  // Deactivate form by ID
+  FormSchema.statics.deactivateById = async function (
+    this: IFormModel,
+    formId: string,
+  ): Promise<IFormSchema | null> {
+    const form = await this.findById(formId)
+    if (!form) return null
+    if (form.status === Status.Public) {
+      form.status = Status.Private
+    }
+    return form.save()
+  }
+
   // Hooks
   FormSchema.pre<IFormSchema>('validate', function (next) {
     // Reject save if form document is too large

src/app/modules/bounce/__tests__/bounce-test-helpers.ts

@@ -1,7 +1,9 @@
 import { ObjectId } from 'bson'
 import { cloneDeep, merge, pick } from 'lodash'
 
+import { EmailType } from 'src/app/constants/mail'
 import {
+  BounceType,
   IBounce,
   IBounceNotification,
   IBounceSchema,
@@ -26,7 +28,7 @@ const makeEmailNotification = (
   formId: ObjectId,
   submissionId: ObjectId,
   recipientList: string[],
-  emailType: 'Admin (response)' | 'Email confirmation',
+  emailType: EmailType,
 ): IEmailNotification => {
   return {
     notificationType,
@@ -56,15 +58,27 @@ const makeEmailNotification = (
   }
 }
 
-export const makeBounceNotification = (
-  formId: ObjectId = new ObjectId(),
-  submissionId: ObjectId = new ObjectId(),
-  recipientList: string[] = [],
-  bouncedList: string[] = [],
-  bounceType: 'Transient' | 'Permanent' = 'Permanent',
-  emailType: 'Admin (response)' | 'Email confirmation' = 'Admin (response)',
-): ISnsNotification => {
-  const Message = merge(
+export const makeBounceNotification = ({
+  formId,
+  submissionId,
+  recipientList,
+  bouncedList,
+  bounceType,
+  emailType,
+}: {
+  formId?: ObjectId
+  submissionId?: ObjectId
+  recipientList?: string[]
+  bouncedList?: string[]
+  bounceType?: BounceType
+  emailType?: EmailType
+} = {}): IBounceNotification => {
+  formId ??= new ObjectId()
+  submissionId ??= new ObjectId()
+  recipientList ??= []
+  bouncedList ??= []
+  emailType ??= EmailType.AdminResponse
+  return merge(
     makeEmailNotification(
       'Bounce',
       formId,
@@ -81,19 +95,27 @@ export const makeBounceNotification = (
       },
     },
   ) as IBounceNotification
-  const body = cloneDeep(MOCK_SNS_BODY)
-  body.Message = JSON.stringify(Message)
-  return body
 }
 
-export const makeDeliveryNotification = (
-  formId: ObjectId = new ObjectId(),
-  submissionId: ObjectId = new ObjectId(),
-  recipientList: string[] = [],
-  deliveredList: string[] = [],
-  emailType: 'Admin (response)' | 'Email confirmation' = 'Admin (response)',
-): ISnsNotification => {
-  const Message = merge(
+export const makeDeliveryNotification = ({
+  formId,
+  submissionId,
+  recipientList,
+  deliveredList,
+  emailType,
+}: {
+  formId?: ObjectId
+  submissionId?: ObjectId
+  recipientList?: string[]
+  deliveredList?: string[]
+  emailType?: EmailType
+} = {}): IDeliveryNotification => {
+  formId ??= new ObjectId()
+  submissionId ??= new ObjectId()
+  recipientList ??= []
+  deliveredList ??= []
+  emailType ??= EmailType.AdminResponse
+  return merge(
     makeEmailNotification(
       'Delivery',
       formId,
@@ -107,9 +129,6 @@ export const makeDeliveryNotification = (
       },
     },
   ) as IDeliveryNotification
-  const body = cloneDeep(MOCK_SNS_BODY)
-  body.Message = JSON.stringify(Message)
-  return body
 }
 
 // Omit mongoose values from Bounce document
@@ -118,7 +137,7 @@ export const extractBounceObject = (
 ): Omit<IBounce, '_id'> => {
   const extracted = pick(bounce.toObject(), [
     'formId',
-    'hasAlarmed',
+    'hasAutoEmailed',
     'expireAt',
     'bounces',
   ])