chore: [AB#17076] create configuration sets for each email type

Author: ashlsun

api/.dependency-cruiser.js

@@ -269,6 +269,10 @@ module.exports = {
       from: { path: "src/domain" },
       to: { path: "src/api" },
     },
+    {
+      from: { path: "src/domain/types" },
+      to: { path: "src/libs/constants" },
+    },
     {
       from: { path: "src/domain" },
       to: { path: "src/client" },

api/cdk/lib/apiStack.ts

@@ -1,10 +1,14 @@
-import { API_SERVICE_NAME } from "@businessnjgovnavigator/api/src/libs/constants";
+import {
+  API_SERVICE_NAME,
+  REMINDER_EMAIL_CONFIG_SET_NAME,
+  WELCOME_EMAIL_CONFIG_SET_NAME,
+} from "@businessnjgovnavigator/api/src/libs/constants";
 import { CfnOutput, Stack, StackProps } from "aws-cdk-lib";
 import * as apigateway from "aws-cdk-lib/aws-apigateway";
 import * as cognito from "aws-cdk-lib/aws-cognito";
 import { IFunction } from "aws-cdk-lib/aws-lambda";
 import { Construct } from "constructs";
-import { applyStandardTags, attachLambdaToResource } from "./stackUtils";
+import { applyStandardTags, attachLambdaToResource, createSesConfigSet } from "./stackUtils";
 
 interface LambdaConfig {
   lambda?: IFunction;
@@ -92,6 +96,9 @@ export class ApiStack extends Stack {
       value: this.restApi.restApiId,
       exportName: `${API_SERVICE_NAME}-${props.stage}-ApiGatewayId`,
     });
+
+    createSesConfigSet(this, WELCOME_EMAIL_CONFIG_SET_NAME);
+    createSesConfigSet(this, REMINDER_EMAIL_CONFIG_SET_NAME);
   }
 
   private addGatewayResponses() {

api/cdk/lib/iamStack.ts

@@ -93,7 +93,10 @@ export class IamStack extends Stack {
     const sendEmailPolicy = new iam.PolicyStatement({
       effect: iam.Effect.ALLOW,
       actions: ["ses:sendEmail", "ses:sendRawEmail"],
-      resources: [`arn:aws:ses:${this.region}:${this.account}:identity/business.nj.gov`],
+      resources: [
+        `arn:aws:ses:${this.region}:${this.account}:identity/business.nj.gov`,
+        `arn:aws:ses:${this.region}:${this.account}:configuration-set/*`,
+      ],
     });
 
     const kmsEncryptPolicy = new iam.PolicyStatement({

api/cdk/lib/stackUtils.ts

@@ -12,6 +12,7 @@ import { Role } from "aws-cdk-lib/aws-iam";
 import { IFunction, Runtime } from "aws-cdk-lib/aws-lambda";
 import { NodejsFunction, NodejsFunctionProps } from "aws-cdk-lib/aws-lambda-nodejs";
 import * as logs from "aws-cdk-lib/aws-logs";
+import { ConfigurationSet } from "aws-cdk-lib/aws-ses";
 import { Construct, IConstruct } from "constructs";
 import path from "node:path";
 
@@ -163,3 +164,9 @@ export const exportLambdaArn = (
     exportName: `${id}LambdaArn-${stage}`,
   });
 };
+
+export function createSesConfigSet(scope: Construct, name: string) {
+  return new ConfigurationSet(scope, name, {
+    configurationSetName: name,
+  });
+}

api/src/domain/types.ts

@@ -9,6 +9,7 @@ import {
   XrayRegistrationEntry,
   XrayRegistrationStatusResponse,
 } from "@businessnjgovnavigator/shared";
+import { REMINDER_EMAIL_CONFIG_SET_NAME, WELCOME_EMAIL_CONFIG_SET_NAME } from "@libs/constants";
 import { NameAvailability, NameAvailabilityResponse } from "@shared/businessNameSearch";
 import { BusinessUser, NewsletterResponse, UserTestingResponse } from "@shared/businessUser";
 import { TaxFilingCalendarEvent } from "@shared/calendarEvent";
@@ -50,6 +51,9 @@ import * as https from "node:https";
 export type MessageChannel = "email" | "sms" | "tts" | "whatsapp";
 export type MessageTemplateId = "welcome_version-B" | "test-reminder-v1";
 export type MessageTopic = "welcome" | "reminder";
+export type EmailType =
+  | typeof WELCOME_EMAIL_CONFIG_SET_NAME
+  | typeof REMINDER_EMAIL_CONFIG_SET_NAME;
 
 export interface MessageData {
   taskId: string;

api/src/functions/messagingService/app.ts

@@ -5,6 +5,7 @@ import { createDynamoDbClient } from "@db/config/dynamoDbConfig";
 import { DynamoMessagesDataClient } from "@db/DynamoMessagesDataClient";
 import { DynamoUserDataClient } from "@db/DynamoUserDataClient";
 import {
+  EmailType,
   MessageData,
   type MessageChannel,
   type MessageTemplateId,
@@ -21,6 +22,7 @@ import {
   STAGE,
   USERS_TABLE,
 } from "@functions/config";
+import { REMINDER_EMAIL_CONFIG_SET_NAME, WELCOME_EMAIL_CONFIG_SET_NAME } from "@libs/constants";
 import { LogWriter, LogWriterType } from "@libs/logWriter";
 import { getConfigValue, USER_MESSAGING_CONFIG_VARS } from "@libs/ssmUtils";
 import { v4 as uuidv4 } from "uuid";
@@ -159,7 +161,7 @@ export const handler = async (
 const buildWelcomeEmail = (props: { toEmail: string }): SendEmailCommand => {
   return buildSesEmailCommand({
     toEmail: props.toEmail,
-    emailType: "welcome-email",
+    emailType: WELCOME_EMAIL_CONFIG_SET_NAME,
     subject: "Welcome to Business.NJ.gov",
     htmlBody: welcomeEmailShortVersionTemplate,
     fallbackText: welcomeEmailShortVersionPlaintext,
@@ -169,7 +171,7 @@ const buildWelcomeEmail = (props: { toEmail: string }): SendEmailCommand => {
 const buildReminderEmail = (props: { toEmail: string }): SendEmailCommand => {
   return buildSesEmailCommand({
     toEmail: props.toEmail,
-    emailType: "test-reminder-email",
+    emailType: REMINDER_EMAIL_CONFIG_SET_NAME,
     subject: "Incomplete Tasks Reminder - Business.NJ.gov",
     htmlBody: testReminderHtmlTemplate,
   });
@@ -199,7 +201,7 @@ const buildMessageRecord = (props: {
 
 const buildSesEmailCommand = (props: {
   toEmail: string;
-  emailType: string;
+  emailType: EmailType;
   subject: string;
   fallbackText?: string;
   htmlBody: string;
@@ -234,6 +236,7 @@ const buildSesEmailCommand = (props: {
         Value: props.emailType,
       },
     ],
+    ConfigurationSetName: props.emailType,
   };
   return new SendEmailCommand(input);
 };

api/src/libs/constants.ts

@@ -1 +1,3 @@
 export const API_SERVICE_NAME = "businessnjgov-api-v2";
+export const WELCOME_EMAIL_CONFIG_SET_NAME = "welcome-email";
+export const REMINDER_EMAIL_CONFIG_SET_NAME = "reminder-email";