APEX-1637 - Manual testing (#21)

* chore: update diagram

* chore: move test route logic to separate file

* feat: add manual testing endpoints

* fix: adding cron detail type in staging

* chore: use getFunctionProps in SchedulerStack

* feat: add manual testing for squadjoin

* fix: adding schedule detail in staging

* chore: separate function permissions and roles into multiple groups

* fix: binding db to functions

* chore: create lambda result utils

* fix: send back empty json if no body is provided

README.md

@@ -80,10 +80,43 @@ npx sst secrets set RANDOM_SLACK_CHANNEL_ID <your-test-channel>
 
 Fill `.env.local` file with the secrets.
 
+### Run all tests in watch mode
+
 ```bash
 pnpm test
 ```
 
+### Run unit tests
+
+```bash
+pnpm test:unit
+```
+
+### Run integration tests
+
+```bash
+pnpm test:integration
+```
+
+### Run all tests
+
+```bash
+pnpm test:ci
+```
+
+### Manual testing
+
+All urls are displayed in the console output.
+
+- Send out icebreaker question: open `<ApiEndpoint>/icebreaker`
+- Ask birthday from everyone: open `<ApiEndpoint>/botJoined`
+- Ask birthday from specific user: open `<ApiEndpoint>/userJoined?userId=<slack user id>`
+- Send out birthday fill reminder: open `<ApiEndpoint>/daily`
+  - Only sends it out to users who have not filled in their birthday yet.
+- Send out birthday present idea question: open `<ApiEndpoint>/daily`
+  - Sends it out related to users whose birthday is in exactly 2 months.
+- Send out birthday present idea + squadjoin question: open `<ApiEndpoint>/squadJoin?userId=<slack user id>`
+
 ## Generate a new migration
 
 ```bash

packages/core/db/queries/deleteUser.ts

@@ -0,0 +1,10 @@
+import { and, eq } from "drizzle-orm";
+
+import { db } from "@/db/index";
+import { users } from "@/db/schema";
+
+export const deleteUser = async (userId: string, teamId: string) => {
+  await db
+    .delete(users)
+    .where(and(eq(users.id, userId), eq(users.teamId, teamId)));
+};

packages/core/db/queries/getUser.ts

@@ -0,0 +1,9 @@
+import { eq } from "drizzle-orm";
+
+import { db } from "@/db/index";
+import { users } from "@/db/schema";
+
+export const getUser = async (userId: string) =>
+  db.query.users.findFirst({
+    where: eq(users.id, userId),
+  });

packages/functions/events/memberLeftChannel.ts

@@ -1,16 +1,11 @@
-import { and, eq } from "drizzle-orm";
-
-import { db } from "@/db/index";
-import { users } from "@/db/schema";
+import { deleteUser } from "@/db/queries/deleteUser";
 import { handleEvent } from "@/utils/eventBridge/handleEvent";
 
 export const handler = handleEvent(
   "memberLeftChannel",
   async ({ user, team }) => {
     try {
-      await db
-        .delete(users)
-        .where(and(eq(users.id, user), eq(users.teamId, team)));
+      await deleteUser(user, team);
     } catch (error) {
       console.error("Error processing memberLeftChannel event: ", error);
     }

packages/functions/lambdas/listen-for-test-payloads.ts

@@ -2,6 +2,7 @@ import type { APIGatewayProxyHandlerV2 } from "aws-lambda";
 
 import { db } from "@/db/index";
 import { testItems } from "@/db/schema";
+import { errorResult, okResult } from "@/utils/lambda/result";
 
 export const handler: APIGatewayProxyHandlerV2 = async (request) => {
   try {
@@ -20,15 +21,9 @@ export const handler: APIGatewayProxyHandlerV2 = async (request) => {
       payload: request.body,
     });
 
-    return {
-      statusCode: 200,
-      body: JSON.stringify({}),
-    };
+    return okResult();
   } catch (error) {
     console.error(`Error handling slack event: ${error}`);
-    return {
-      statusCode: 500,
-      body: JSON.stringify({}),
-    };
+    return errorResult(error);
   }
 };

packages/functions/lambdas/manualBotJoinedEvent.ts

@@ -0,0 +1,19 @@
+import type { APIGatewayProxyHandlerV2 } from "aws-lambda";
+import { Config } from "sst/node/config";
+
+import { publishEvent } from "@/utils/eventBridge/publishEvent";
+import { errorResult, okResult } from "@/utils/lambda/result";
+
+export const handler: APIGatewayProxyHandlerV2 = async () => {
+  try {
+    await publishEvent("botJoined", {
+      channel: Config.CORE_SLACK_CHANNEL_ID,
+    });
+
+    return okResult("Event sent");
+  } catch (error) {
+    console.error(`Error sending manual botJoined event: ${error}`);
+
+    return errorResult(error);
+  }
+};

packages/functions/lambdas/manualSquadJoinEvent.ts

@@ -0,0 +1,30 @@
+import type { APIGatewayProxyHandlerV2 } from "aws-lambda";
+
+import { getUser } from "@/db/queries/getUser";
+import { publishEvent } from "@/utils/eventBridge/publishEvent";
+import { errorResult, okResult } from "@/utils/lambda/result";
+
+export const handler: APIGatewayProxyHandlerV2 = async (request) => {
+  try {
+    if (!request.queryStringParameters?.userId) {
+      throw new Error("No userId");
+    }
+
+    const user = await getUser(request.queryStringParameters.userId);
+
+    if (!user) {
+      throw new Error("User not found");
+    }
+
+    await publishEvent("askPresentAndSquadJoinFromTeam", {
+      birthdayPerson: user.id,
+      team: user.teamId,
+    });
+
+    return okResult("Event sent");
+  } catch (error) {
+    console.error(`Error sending manual botJoined event: ${error}`);
+
+    return errorResult(error);
+  }
+};

packages/functions/lambdas/manualUserJoinedEvent.ts

@@ -0,0 +1,24 @@
+import type { APIGatewayProxyHandlerV2 } from "aws-lambda";
+import { Config } from "sst/node/config";
+
+import { publishEvent } from "@/utils/eventBridge/publishEvent";
+import { errorResult, okResult } from "@/utils/lambda/result";
+
+export const handler: APIGatewayProxyHandlerV2 = async (request) => {
+  try {
+    if (!request.queryStringParameters?.userId) {
+      throw new Error("No userId");
+    }
+
+    await publishEvent("memberJoinedChannel", {
+      channel: Config.CORE_SLACK_CHANNEL_ID,
+      user: request.queryStringParameters.userId,
+    });
+
+    return okResult("Event sent");
+  } catch (error) {
+    console.error(`Error sending manual userJoined event: ${error}`);
+
+    return errorResult(error);
+  }
+};

packages/functions/lambdas/migrateDb.ts

@@ -1,4 +1,5 @@
 import { migrate } from "@/db/index";
+import { errorResult, okResult } from "@/utils/lambda/result";
 
 export const handler = async () => {
   try {
@@ -8,17 +9,10 @@ export const handler = async () => {
 
     console.log("Migration complete!");
 
-    return {
-      statusCode: 200,
-      body: JSON.stringify({}),
-    };
+    return okResult();
   } catch (error) {
     console.error(`Error migrating db: ${error}`);
-    return {
-      statusCode: 500,
-      body: JSON.stringify({
-        error,
-      }),
-    };
+
+    return errorResult(error);
   }
 };

packages/functions/lambdas/slack-event.ts

@@ -5,6 +5,7 @@ import type {
 
 import { SlackCallbackRequestSchema } from "@/types/SlackEventRequest";
 import { publishEvent } from "@/utils/eventBridge/publishEvent";
+import { errorResult, okResult } from "@/utils/lambda/result";
 
 export const handler: APIGatewayProxyHandlerV2 = async (
   request: APIGatewayProxyEventV2,
@@ -19,12 +20,9 @@ export const handler: APIGatewayProxyHandlerV2 = async (
     );
 
     if (validatedBody.type === "url_verification") {
-      return {
-        statusCode: 200,
-        body: JSON.stringify({
-          urlVerificationChallenge: validatedBody.challenge,
-        }),
-      };
+      return okResult({
+        urlVerificationChallenge: validatedBody.challenge,
+      });
     }
 
     switch (validatedBody.event.type) {
@@ -40,15 +38,10 @@ export const handler: APIGatewayProxyHandlerV2 = async (
         break;
     }
 
-    return {
-      statusCode: 200,
-      body: JSON.stringify({}),
-    };
+    return okResult();
   } catch (error) {
     console.error(`Error handling slack event: ${error}`);
-    return {
-      statusCode: 500,
-      body: JSON.stringify({}),
-    };
+
+    return errorResult(error);
   }
 };

packages/functions/lambdas/slack-interaction.ts

@@ -16,6 +16,7 @@ import {
 } from "@/types/SlackInteractionRequest";
 import { publishEvent } from "@/utils/eventBridge/publishEvent";
 import { parseRequest } from "@/utils/lambda/parseRequest";
+import { errorResult, okResult } from "@/utils/lambda/result";
 
 export const handler: APIGatewayProxyHandlerV2 = async (request) => {
   try {
@@ -93,15 +94,10 @@ export const handler: APIGatewayProxyHandlerV2 = async (request) => {
       }
     }
 
-    return {
-      statusCode: 200,
-      body: JSON.stringify({}),
-    };
+    return okResult();
   } catch (error) {
     console.error(`Error handling slack interaction: ${error}`);
-    return {
-      statusCode: 500,
-      body: JSON.stringify({}),
-    };
+
+    return errorResult(error);
   }
 };

packages/functions/utils/lambda/cronHandler.ts

@@ -3,13 +3,15 @@ import type { APIGatewayProxyEventV2, EventBridgeEvent } from "aws-lambda";
 import type { BaseEvent } from "@/types/BaseEvent";
 import type { CronEventType } from "@/types/cron";
 
+import { errorResult, okResult } from "./result";
+
 type Event =
   | APIGatewayProxyEventV2
   | EventBridgeEvent<CronEventType, BaseEvent>;
 
 const isApiGatewayProxyEventV2 = (
   event: Event,
-): event is APIGatewayProxyEventV2 => "queryStringParameters" in event;
+): event is APIGatewayProxyEventV2 => "routeKey" in event;
 
 export const cronHandler =
   (handler: (eventId?: string) => Promise<unknown>) =>
@@ -20,7 +22,11 @@ export const cronHandler =
         : request.detail.eventId;
 
       await handler(eventId);
+
+      return okResult("Event sent");
     } catch (error) {
       console.error(error);
+
+      return errorResult(error);
     }
   };

packages/functions/utils/lambda/result.ts

@@ -0,0 +1,15 @@
+export const okResult = (body?: unknown) => ({
+  statusCode: 200,
+  body: JSON.stringify(body ?? {}, null, 2),
+});
+
+export const errorResult = (error: unknown) => ({
+  statusCode: 500,
+  body: JSON.stringify(
+    {
+      error,
+    },
+    null,
+    2,
+  ),
+});

stacks/CronStack.ts

@@ -3,25 +3,30 @@ import { Cron } from "sst/constructs";
 
 import { daily, iceBreaker } from "@/types/cron";
 
-import { getFunctionProps } from "./getFunctionProps";
+import { getFunctionProps } from "./utils/getFunctionProps";
+import { isStageTestable } from "./utils/isStageTestable";
 
 export function CronStack({ stack }: StackContext) {
   const functionProps = getFunctionProps();
 
+  const isTestable = isStageTestable(stack);
+
   new Cron(stack, "IceBreakerCron", {
     job: {
       function: {
         handler: "packages/functions/cron/iceBreakerQuestions.handler",
         ...functionProps,
       },
     },
-    cdk: {
-      rule: {
-        eventPattern: {
-          detailType: [iceBreaker],
-        },
-      },
-    },
+    cdk: isTestable
+      ? {
+          rule: {
+            eventPattern: {
+              detailType: [iceBreaker],
+            },
+          },
+        }
+      : undefined,
     // Every first Tuesday of the month at 11:00 UTC
     schedule: "cron(0 11 ? * 3#1 *)",
   });
@@ -33,13 +38,15 @@ export function CronStack({ stack }: StackContext) {
         ...functionProps,
       },
     },
-    cdk: {
-      rule: {
-        eventPattern: {
-          detailType: [daily],
-        },
-      },
-    },
+    cdk: isTestable
+      ? {
+          rule: {
+            eventPattern: {
+              detailType: [daily],
+            },
+          },
+        }
+      : undefined,
     // Every day at 11:00 UTC
     schedule: "cron(0 11 ? * * *)",
   });