feat: log all critical bounces (#288)

* refactor: move bounce model into module

* refactor: inline tests

* refactor: move helpers into util

* feat: log admin responses to main log group

* feat: log all critical bounces

* refactor: use absolute paths in tests

* fix: fix constants import

* feat: log submission ID for critical bounces

* test: allow varying email type

* test: update tests for bounce service

* test: ignore __tests__ for coverage

* test: add test for short term logs

* build: ignore tests for compilation

* refactor: rename bounce-helpers to bounce-test-helpers

* refactor: avoid using lodash get

* refactor: convert EMAIL_TYPES to enum

* refactor: change log action to calling method

* refactor: change CRITICAL BOUNCE to sentence case

* refactor: move isCriticalBounce into domain

* refactor: move typeguards into util

* refactor: avoid typecast for IBounceNotification

* refactor: call logCriticalBounce only once

* refactor: remove setting of hasAlarmed

* refactor: extract function for logging raw notif

* docs: add TODO to convert bounceType to enum

* refactor: use typeguard to check recipients

* fix: convert formId to string

* fix: set hasAlarmed

* refactor: collapse save calls

* refactor: add bounceInfo key explicitly

jest.config.js

@@ -9,7 +9,7 @@ module.exports = {
     // Needed to use @shelf/jest-mongodb preset.
     ...tsJestPreset.transform,
   },
-  collectCoverageFrom: ['./src/**/*.{ts,js}'],
+  collectCoverageFrom: ['./src/**/*.{ts,js}', '!**/__tests__/**'],
   coveragePathIgnorePatterns: ['./node_modules/', './tests'],
   coverageThreshold: {
     global: {

src/app/constants/mail.ts

@@ -14,10 +14,10 @@ export const EMAIL_HEADERS = {
 }
 
 // Types of emails we send
-export const EMAIL_TYPES = {
-  adminResponse: 'Admin (response)',
-  loginOtp: 'Login OTP',
-  verificationOtp: 'Verification OTP',
-  emailConfirmation: 'Email confirmation',
-  adminBounce: 'Admin (bounce notification)',
+export enum EmailType {
+  AdminResponse = 'Admin (response)',
+  LoginOtp = 'Login OTP',
+  VerificationOtp = 'Verification OTP',
+  EmailConfirmation = 'Email confirmation',
+  AdminBounce = 'Admin (bounce notification)',
 }

tests/unit/backend/helpers/bounce.ts → src/app/modules/bounce/__tests__/bounce-test-helpers.ts

@@ -26,6 +26,7 @@ const makeEmailNotification = (
   formId: ObjectId,
   submissionId: ObjectId,
   recipientList: string[],
+  emailType: 'Admin (response)' | 'Email confirmation',
 ): IEmailNotification => {
   return {
     notificationType,
@@ -43,7 +44,7 @@ const makeEmailNotification = (
         },
         {
           name: 'X-Formsg-Email-Type',
-          value: 'Admin (response)',
+          value: emailType,
         },
       ],
       commonHeaders: {
@@ -61,9 +62,16 @@ export const makeBounceNotification = (
   recipientList: string[] = [],
   bouncedList: string[] = [],
   bounceType: 'Transient' | 'Permanent' = 'Permanent',
+  emailType: 'Admin (response)' | 'Email confirmation' = 'Admin (response)',
 ): ISnsNotification => {
   const Message = merge(
-    makeEmailNotification('Bounce', formId, submissionId, recipientList),
+    makeEmailNotification(
+      'Bounce',
+      formId,
+      submissionId,
+      recipientList,
+      emailType,
+    ),
     {
       bounce: {
         bounceType,
@@ -83,9 +91,16 @@ export const makeDeliveryNotification = (
   submissionId: ObjectId = new ObjectId(),
   recipientList: string[] = [],
   deliveredList: string[] = [],
+  emailType: 'Admin (response)' | 'Email confirmation' = 'Admin (response)',
 ): ISnsNotification => {
   const Message = merge(
-    makeEmailNotification('Delivery', formId, submissionId, recipientList),
+    makeEmailNotification(
+      'Delivery',
+      formId,
+      submissionId,
+      recipientList,
+      emailType,
+    ),
     {
       delivery: {
         recipients: deliveredList,

tests/unit/backend/models/bounce.server.model.spec.ts → src/app/modules/bounce/__tests__/bounce.model.spec.ts

@@ -1,15 +1,15 @@
 import { ObjectId } from 'bson'
 import { omit, pick } from 'lodash'
 import mongoose from 'mongoose'
+import dbHandler from 'tests/unit/backend/helpers/jest-db'
 
-import getBounceModel from 'src/app/models/bounce.server.model'
+import getBounceModel from 'src/app/modules/bounce/bounce.model'
 
 import {
   extractBounceObject,
   makeBounceNotification,
   makeDeliveryNotification,
-} from '../helpers/bounce'
-import dbHandler from '../helpers/jest-db'
+} from './bounce-test-helpers'
 
 const Bounce = getBounceModel(mongoose)