chore: move SQS handlers to their own folders (#159)

Author: devksingh4

src/api/sqs/handlers.ts

@@ -0,0 +1,44 @@
+import { AvailableSQSFunctions } from "common/types/sqsMessage.js";
+import {
+  currentEnvironmentConfig,
+  runEnvironment,
+  SQSHandlerFunction,
+} from "../index.js";
+import { environmentConfig, genericConfig } from "common/config.js";
+import { getAuthorizedClients } from "../utils.js";
+import { getEntraIdToken, getUserProfile } from "api/functions/entraId.js";
+import { issueAppleWalletMembershipCard } from "api/functions/mobileWallet.js";
+import { generateMembershipEmailCommand } from "api/functions/ses.js";
+import { SESClient } from "@aws-sdk/client-ses";
+
+export const emailMembershipPassHandler: SQSHandlerFunction<
+  AvailableSQSFunctions.EmailMembershipPass
+> = async (payload, metadata, logger) => {
+  const email = payload.email;
+  const commonConfig = { region: genericConfig.AwsRegion };
+  const clients = await getAuthorizedClients(logger, commonConfig);
+  const entraIdToken = await getEntraIdToken(
+    clients,
+    currentEnvironmentConfig.AadValidClientId,
+  );
+  const userProfile = await getUserProfile(entraIdToken, email);
+  const pkpass = await issueAppleWalletMembershipCard(
+    clients,
+    environmentConfig[runEnvironment],
+    runEnvironment,
+    email,
+    metadata.initiator,
+    logger,
+    userProfile.displayName,
+  );
+  const emailCommand = generateMembershipEmailCommand(
+    email,
+    `membership@${environmentConfig[runEnvironment].EmailDomain}`,
+    pkpass as any,
+  );
+  if (runEnvironment === "dev" && email === "[email protected]") {
+    return;
+  }
+  const sesClient = new SESClient(commonConfig);
+  return await sesClient.send(emailCommand);
+};

src/api/sqs/handlers/emailMembershipPassHandler.ts

@@ -1,5 +1,5 @@
 import { AvailableSQSFunctions } from "common/types/sqsMessage.js";
-import { currentEnvironmentConfig, SQSHandlerFunction } from "./index.js";
+import { currentEnvironmentConfig, SQSHandlerFunction } from "../index.js";
 import { SendEmailCommand, SESClient } from "@aws-sdk/client-ses";
 import { genericConfig } from "common/config.js";
 import { createAuditLogEntry } from "api/functions/auditLog.js";

src/api/sqs/emailNotifications.ts renamed to src/api/sqs/handlers/emailNotifications.ts

@@ -0,0 +1,5 @@
+export { pingHandler } from "./ping.js";
+export { emailMembershipPassHandler } from "./emailMembershipPassHandler.js";
+export { provisionNewMemberHandler } from "./provisionNewMember.js";
+export { sendSaleEmailHandler } from "./sendSaleEmailHandler.js";
+export { emailNotificationsHandler } from "./emailNotifications.js";

src/api/sqs/handlers/index.ts

@@ -0,0 +1,8 @@
+import { AvailableSQSFunctions } from "common/types/sqsMessage.js";
+import { SQSHandlerFunction } from "../index.js";
+
+export const pingHandler: SQSHandlerFunction<
+  AvailableSQSFunctions.Ping
+> = async (_payload, _metadata, logger) => {
+  logger.info("Pong!");
+};

src/api/sqs/handlers/ping.ts

@@ -0,0 +1,50 @@
+import { AvailableSQSFunctions } from "common/types/sqsMessage.js";
+import { currentEnvironmentConfig, SQSHandlerFunction } from "../index.js";
+import {
+  getEntraIdToken,
+  getUserProfile,
+} from "../../../api/functions/entraId.js";
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { genericConfig } from "../../../common/config.js";
+
+import { setPaidMembership } from "api/functions/membership.js";
+import { createAuditLogEntry } from "api/functions/auditLog.js";
+import { Modules } from "common/modules.js";
+import { getAuthorizedClients } from "../utils.js";
+import { emailMembershipPassHandler } from "./emailMembershipPassHandler.js";
+
+export const provisionNewMemberHandler: SQSHandlerFunction<
+  AvailableSQSFunctions.ProvisionNewMember
+> = async (payload, metadata, logger) => {
+  const { email } = payload;
+  const commonConfig = { region: genericConfig.AwsRegion };
+  const clients = await getAuthorizedClients(logger, commonConfig);
+  const entraToken = await getEntraIdToken(
+    clients,
+    currentEnvironmentConfig.AadValidClientId,
+  );
+  logger.info("Got authorized clients and Entra ID token.");
+  const { updated } = await setPaidMembership({
+    netId: email.replace("@illinois.edu", ""),
+    dynamoClient: clients.dynamoClient,
+    entraToken,
+    paidMemberGroup: currentEnvironmentConfig.PaidMemberGroupId,
+  });
+  if (updated) {
+    const logPromise = createAuditLogEntry({
+      entry: {
+        module: Modules.PROVISION_NEW_MEMBER,
+        actor: metadata.initiator,
+        target: email,
+        message: "Marked target as a paid member.",
+      },
+    });
+    logger.info(
+      `${email} added as a paid member. Emailing their membership pass.`,
+    );
+    await emailMembershipPassHandler(payload, metadata, logger);
+    await logPromise;
+  } else {
+    logger.info(`${email} was already a paid member.`);
+  }
+};

src/api/sqs/handlers/provisionNewMember.ts

@@ -1,11 +1,11 @@
 import { AvailableSQSFunctions } from "common/types/sqsMessage.js";
-import { currentEnvironmentConfig, SQSHandlerFunction } from "./index.js";
+import { currentEnvironmentConfig, SQSHandlerFunction } from "../index.js";
 import { SESClient } from "@aws-sdk/client-ses";
 import QRCode from "qrcode";
 import { generateSalesEmail } from "api/functions/ses.js";
 import { genericConfig } from "common/config.js";
 
-export const sendSaleEmailhandler: SQSHandlerFunction<
+export const sendSaleEmailHandler: SQSHandlerFunction<
   AvailableSQSFunctions.SendSaleEmail
 > = async (payload, _metadata, logger) => {
   const { qrCodeContent } = payload;
@@ -15,7 +15,7 @@ export const sendSaleEmailhandler: SQSHandlerFunction<
     errorCorrectionLevel: "H",
   });
   logger.info("Constructing email...");
-  const emailCommand = generateSalesEmail(payload, senderEmail, qrCode);
+  const emailCommand = generateSalesEmail(payload, senderEmail, qrCode as any);
   logger.info("Constructing email...");
   const sesClient = new SESClient({ region: genericConfig.AwsRegion });
   const response = await sesClient.send(emailCommand);

src/api/sqs/sales.ts renamed to src/api/sqs/handlers/sendSaleEmailHandler.ts

@@ -16,12 +16,12 @@ import {
   emailMembershipPassHandler,
   pingHandler,
   provisionNewMemberHandler,
-} from "./handlers.js";
+  sendSaleEmailHandler,
+  emailNotificationsHandler,
+} from "./handlers/index.js";
 import { ValidationError } from "../../common/errors/index.js";
 import { RunEnvironment } from "../../common/roles.js";
 import { environmentConfig } from "../../common/config.js";
-import { sendSaleEmailhandler } from "./sales.js";
-import { emailNotificationsHandler } from "./emailNotifications.js";
 
 export type SQSFunctionPayloadTypes = {
   [K in keyof typeof sqsPayloadSchemas]: SQSHandlerFunction<K>;
@@ -37,7 +37,7 @@ const handlers: SQSFunctionPayloadTypes = {
   [AvailableSQSFunctions.EmailMembershipPass]: emailMembershipPassHandler,
   [AvailableSQSFunctions.Ping]: pingHandler,
   [AvailableSQSFunctions.ProvisionNewMember]: provisionNewMemberHandler,
-  [AvailableSQSFunctions.SendSaleEmail]: sendSaleEmailhandler,
+  [AvailableSQSFunctions.SendSaleEmail]: sendSaleEmailHandler,
   [AvailableSQSFunctions.EmailNotifications]: emailNotificationsHandler,
 };
 export const runEnvironment = process.env.RunEnvironment as RunEnvironment;

src/api/sqs/index.ts

@@ -0,0 +1,34 @@
+import { DynamoDBClient } from "@aws-sdk/client-dynamodb";
+import { SecretsManagerClient } from "@aws-sdk/client-secrets-manager";
+import { getRoleCredentials } from "api/functions/sts.js";
+import { genericConfig, roleArns } from "common/config.js";
+import pino from "pino";
+
+export const getAuthorizedClients = async (
+  logger: pino.Logger,
+  commonConfig: { region: string },
+) => {
+  if (roleArns.Entra) {
+    logger.info(
+      `Attempting to assume Entra role ${roleArns.Entra} to get the Entra token...`,
+    );
+    const credentials = await getRoleCredentials(roleArns.Entra);
+    const clients = {
+      smClient: new SecretsManagerClient({
+        region: genericConfig.AwsRegion,
+        credentials,
+      }),
+      dynamoClient: new DynamoDBClient({
+        region: genericConfig.AwsRegion,
+        credentials,
+      }),
+    };
+    logger.info(`Assumed Entra role ${roleArns.Entra} to get the Entra token.`);
+    return clients;
+  }
+  logger.debug("Did not assume Entra role as no env variable was present");
+  return {
+    smClient: new SecretsManagerClient(commonConfig),
+    dynamoClient: new DynamoDBClient(commonConfig),
+  };
+};

src/api/sqs/utils.ts

@@ -7,16 +7,9 @@
     "skipLibCheck": true,
     "forceConsistentCasingInFileNames": true,
     "outDir": "../dist/tests",
-    "rootDir": ".",
-    "resolveJsonModule": true,
+    "rootDir": "../",
+    "resolveJsonModule": true
   },
-  "include": [
-    "./e2e/**/*.ts",
-    "./live/**/*.ts",
-    "./unit/**/*.ts"
-  ],
-  "exclude": [
-    "../node_modules",
-    "../dist"
-  ]
+  "include": ["../src/", "./e2e/**/*.ts", "./live/**/*.ts", "./unit/**/*.ts"],
+  "exclude": ["../node_modules", "../dist"]
 }

tests/tsconfig.json

@@ -0,0 +1,10 @@
+import { expect, test, vi } from "vitest";
+import { pingHandler } from "../../../../src/api/sqs/handlers/ping.js";
+
+test("SQS Ping Handler test", () => {
+  const pinoMock = {
+    info: vi.fn(),
+  }
+  pingHandler({}, { reqId: "0", initiator: "1" }, pinoMock as any)
+  expect(pinoMock.info).toHaveBeenCalledExactlyOnceWith("Pong!");
+})

tests/unit/sqs/handlers/ping.test.ts

@@ -5817,6 +5817,11 @@ flatted@^3.3.3:
   resolved "https://registry.yarnpkg.com/flatted/-/flatted-3.3.3.tgz#67c8fad95454a7c7abebf74bb78ee74a44023358"
   integrity sha512-GX+ysw4PBCz0PzosHDepZGANEuFCMLrnRTiEy9McGjmkCQYwRq4A/X786G/fjM/+OjsWSU1ZrY5qyARZmO/uwg==
 
+follow-redirects@^1.15.6:
+  version "1.15.9"
+  resolved "https://registry.yarnpkg.com/follow-redirects/-/follow-redirects-1.15.9.tgz#a604fa10e443bf98ca94228d9eebcc2e8a2c8ee1"
+  integrity sha512-gew4GsXizNgdoRyqmyfMHyAmXsZDk6mHkSxZFCzW9gwlbtOW44CDtYavM+y+72qD/Vq2l550kMF52DT8fOLJqQ==
+
 for-each@^0.3.3:
   version "0.3.4"
   resolved "https://registry.yarnpkg.com/for-each/-/for-each-0.3.4.tgz#814517ffc303d1399b2564d8165318e735d0341c"
@@ -8222,6 +8227,11 @@ prop-types@^15.6.2, prop-types@^15.8.1:
     object-assign "^4.1.1"
     react-is "^16.13.1"
 
+proxy-from-env@^1.1.0:
+  version "1.1.0"
+  resolved "https://registry.yarnpkg.com/proxy-from-env/-/proxy-from-env-1.1.0.tgz#e102f16ca355424865755d2c9e8ea4f24d58c3e2"
+  integrity sha512-D+zkORCbA9f1tdWRK0RaCR3GPv50cMxcrz4X8k5LTSUD1Dkw47mKJEZQNunItRTkWwgtaUSo1RVFRIG9ZXiFYg==
+
 psl@^1.1.28:
   version "1.15.0"
   resolved "https://registry.yarnpkg.com/psl/-/psl-1.15.0.tgz#bdace31896f1d97cec6a79e8224898ce93d974c6"