Merge pull request #3839 from Northeastern-Electric-Racing/slack-rr-integrations

Slack rr integrations

Author: chpy04

src/backend/index.ts

@@ -1,4 +1,4 @@
-import express from 'express';
+import express, { Router } from 'express';
 import cors from 'cors';
 import cookieParser from 'cookie-parser';
 import { getUserAndOrganization, prodHeaders, requireJwtDev, requireJwtProd } from './src/utils/auth.utils.js';
@@ -16,7 +16,8 @@ import wbsElementTemplatesRouter from './src/routes/wbs-element-templates.routes
 import carsRouter from './src/routes/cars.routes.js';
 import organizationRouter from './src/routes/organizations.routes.js';
 import recruitmentRouter from './src/routes/recruitment.routes.js';
-import { slackEvents } from './src/routes/slack.routes.js';
+import { getReceiver } from './src/integrations/slack.js';
+import './src/routes/slack.routes.js';
 import announcementsRouter from './src/routes/announcements.routes.js';
 import onboardingRouter from './src/routes/onboarding.routes.js';
 import popUpsRouter from './src/routes/pop-up.routes.js';
@@ -61,9 +62,15 @@ const options: cors.CorsOptions = {
   allowedHeaders
 };
 
-// so we can listen to slack messages
-// NOTE: must be done before using json
-app.use('/slack', slackEvents.requestListener());
+// Mount Slack Bolt receiver BEFORE other middleware to handle raw body parsing
+// Bolt's receiver handles its own body parsing and request verification
+// The receiver is configured to handle requests at /slack/events
+// Only mount if Slack is configured (when SLACK_BOT_TOKEN is set)
+const receiver = getReceiver();
+if (receiver) {
+  app.use(receiver.router as unknown as Router);
+}
+
 app.get('/health', (_req, res) => {
   res.status(200).json({ status: 'healthy' });
 });

src/backend/package.json

@@ -11,8 +11,7 @@
   },
   "dependencies": {
     "@prisma/client": "^6.2.1",
-    "@slack/events-api": "^3.0.1",
-    "@slack/web-api": "^7.8.0",
+    "@slack/bolt": "^3.22.0",
     "@types/concat-stream": "^2.0.0",
     "@types/cookie-parser": "^1.4.3",
     "@types/cors": "^2.8.12",

src/backend/src/controllers/slack.controllers.ts

@@ -1,6 +1,6 @@
-import { getWorkspaceId } from '../integrations/slack.js';
+import { getWorkspaceId, replyToMessageInThread } from '../integrations/slack.js';
 import OrganizationsService from '../services/organizations.services.js';
-import SlackServices from '../services/slack.services.js';
+import SlackServices, { SlackBlockActionBody, SaboSubmissionActionValue } from '../services/slack.services.js';
 
 export default class SlackController {
   static async processMessageEvent(event: any) {
@@ -15,4 +15,71 @@ export default class SlackController {
       console.log(error);
     }
   }
+
+  /**
+   * Handles the Slack block action for SABO submission confirmation.
+   * Performs action-specific validation and extracts relevant fields from the Slack action body.
+   * If validation fails, replies to the user in Slack with an error message.
+   *
+   * @param body The validated Slack block action body (general structure validated in routes)
+   */
+  static async handleSaboSubmittedAction(body: SlackBlockActionBody) {
+    const { user, container, actions } = body;
+    const channelId = container.channel_id;
+    const threadTs = container.thread_ts || container.message_ts;
+    const [firstAction] = actions;
+
+    try {
+      // Action-specific validation: verify action_id
+      if (firstAction.action_id !== 'sabo_submitted_confirmation') {
+        console.error('Unexpected action_id:', firstAction.action_id);
+        await replyToMessageInThread(
+          channelId,
+          threadTs,
+          `❌ An error occurred: Unexpected action type "${firstAction.action_id}". Please contact the software team.`
+        );
+        return;
+      }
+
+      // Action-specific validation: verify value format
+      let actionValue: SaboSubmissionActionValue;
+      try {
+        actionValue = JSON.parse(firstAction.value);
+      } catch (parseError) {
+        const parseErrorMsg = parseError instanceof Error ? parseError.message : 'Unknown parse error';
+        await replyToMessageInThread(
+          channelId,
+          threadTs,
+          `❌ An error occurred: Invalid action data format.\n\n*Error:* ${parseErrorMsg}\n*Value:* \`${firstAction.value}\`\n\nPlease contact the software team.`
+        );
+        return;
+      }
+
+      // Validate that reimbursementRequestId exists in the parsed value
+      if (!actionValue.reimbursementRequestId || typeof actionValue.reimbursementRequestId !== 'string') {
+        const actionValueStr = JSON.stringify(actionValue, null, 2);
+        await replyToMessageInThread(
+          channelId,
+          threadTs,
+          `❌ An error occurred: Missing or invalid reimbursement request ID.\n\n*Parsed value:*\n\`\`\`${actionValueStr}\`\`\`\n\nPlease contact the software team.`
+        );
+        return;
+      }
+
+      // Extract validated fields
+      const userSlackId = user.id;
+      const { reimbursementRequestId } = actionValue;
+
+      // Pass the extracted fields to the service layer for business logic
+      await SlackServices.handleSaboSubmittedAction(userSlackId, reimbursementRequestId);
+    } catch (error: unknown) {
+      const errorMessage = error instanceof Error ? error.message : 'Unknown error';
+      await replyToMessageInThread(
+        channelId,
+        threadTs,
+        `❌ An unexpected error occurred while processing your request.\n\n*Error message:* ${errorMessage}\n\nPlease contact the software team and provide them with this information.`
+      );
+      throw error;
+    }
+  }
 }

src/backend/src/integrations/slack.ts

@@ -1,7 +1,52 @@
-import { ChatPostMessageResponse, WebClient } from '@slack/web-api';
+import bolt from '@slack/bolt';
+import type { App, ExpressReceiver } from '@slack/bolt';
 import { HttpException } from '../utils/errors.utils.js';
 
-const slack = new WebClient(process.env.SLACK_BOT_TOKEN);
+const { App: AppClass, ExpressReceiver: ExpressReceiverClass } = bolt;
+
+let receiver: ExpressReceiver | null = null;
+let slackApp: App | null = null;
+let slack: any = null; // Type will be inferred from slackApp.client (WebClient from Bolt)
+
+/**
+ * Initializes the Slack Bolt app, receiver, and client if not already initialized
+ * Only initializes if SLACK_BOT_TOKEN is present
+ */
+const initializeSlack = () => {
+  const { SLACK_BOT_TOKEN, SLACK_SIGNING_SECRET } = process.env;
+
+  // Don't initialize if no token is configured (e.g., in tests)
+  if (!SLACK_BOT_TOKEN) {
+    return;
+  }
+
+  // Don't re-initialize if already initialized
+  if (slackApp) {
+    return;
+  }
+
+  // Initialize the receiver, app, and client
+  receiver = new ExpressReceiverClass({
+    signingSecret: SLACK_SIGNING_SECRET || '',
+    endpoints: '/slack/events'
+  });
+
+  slackApp = new AppClass({
+    token: SLACK_BOT_TOKEN,
+    receiver
+  });
+
+  slack = slackApp.client;
+};
+
+/**
+ * Get the Slack WebClient (initializes Slack if needed)
+ * @returns the Slack WebClient or null if no token is configured
+ */
+const getSlackClient = () => {
+  initializeSlack();
+  return slack;
+};
 
 /**
  * Send a slack message
@@ -12,14 +57,13 @@ const slack = new WebClient(process.env.SLACK_BOT_TOKEN);
  * @returns the channel id and timestamp of the created slack message
  */
 export const sendMessage = async (slackId: string, message: string, link?: string, linkButtonText?: string) => {
-  const { SLACK_BOT_TOKEN } = process.env;
-  if (!SLACK_BOT_TOKEN) return;
+  const client = getSlackClient();
+  if (!client) return;
 
   const block = generateSlackTextBlock(message, link, linkButtonText);
 
   try {
-    const response: ChatPostMessageResponse = await slack.chat.postMessage({
-      token: SLACK_BOT_TOKEN,
+    const response = await client.chat.postMessage({
       channel: slackId,
       text: message,
       blocks: [block],
@@ -48,14 +92,13 @@ export const replyToMessageInThread = async (
   link?: string,
   linkButtonText?: string
 ) => {
-  const { SLACK_BOT_TOKEN } = process.env;
-  if (!SLACK_BOT_TOKEN) return;
+  const client = getSlackClient();
+  if (!client) return;
 
   const block = generateSlackTextBlock(message, link, linkButtonText);
 
   try {
-    await slack.chat.postMessage({
-      token: SLACK_BOT_TOKEN,
+    await client.chat.postMessage({
       channel: slackId,
       thread_ts: parentTimestamp,
       text: message,
@@ -82,14 +125,13 @@ export const editMessage = async (
   link?: string,
   linkButtonText?: string
 ) => {
-  const { SLACK_BOT_TOKEN } = process.env;
-  if (!SLACK_BOT_TOKEN) return;
+  const client = getSlackClient();
+  if (!client) return;
 
   const block = generateSlackTextBlock(message, link, linkButtonText);
 
   try {
-    await slack.chat.update({
-      token: SLACK_BOT_TOKEN,
+    await client.chat.update({
       channel: slackId,
       ts: timestamp,
       text: message,
@@ -108,12 +150,11 @@ export const editMessage = async (
  * @param emoji - the emoji to react with
  */
 export const reactToMessage = async (slackId: string, parentTimestamp: string, emoji: string) => {
-  const { SLACK_BOT_TOKEN } = process.env;
-  if (!SLACK_BOT_TOKEN) return;
+  const client = getSlackClient();
+  if (!client) return;
 
   try {
-    await slack.reactions.add({
-      token: SLACK_BOT_TOKEN,
+    await client.reactions.add({
       channel: slackId,
       timestamp: parentTimestamp,
       name: emoji
@@ -165,12 +206,15 @@ const generateSlackTextBlock = (message: string, link?: string, linkButtonText?:
  * @returns an array of strings of all the slack ids of the users in the given channel
  */
 export const getUsersInChannel = async (channelId: string) => {
+  const client = getSlackClient();
+  if (!client) return [];
+
   let members: string[] = [];
   let cursor: string | undefined;
 
   try {
     do {
-      const response = await slack.conversations.members({
+      const response = await client.conversations.members({
         channel: channelId,
         cursor,
         limit: 200
@@ -196,8 +240,11 @@ export const getUsersInChannel = async (channelId: string) => {
  * @returns the name of the channel or undefined if it cannot be found
  */
 export const getChannelName = async (channelId: string) => {
+  const client = getSlackClient();
+  if (!client) return undefined;
+
   try {
-    const channelRes = await slack.conversations.info({ channel: channelId });
+    const channelRes = await client.conversations.info({ channel: channelId });
     return channelRes.channel?.name;
   } catch (error) {
     return undefined;
@@ -210,8 +257,11 @@ export const getChannelName = async (channelId: string) => {
  * @returns the name of the user (real name if no display name), undefined if cannot be found
  */
 export const getUserName = async (userId: string) => {
+  const client = getSlackClient();
+  if (!client) return undefined;
+
   try {
-    const userRes = await slack.users.info({ user: userId });
+    const userRes = await client.users.info({ user: userId });
     return userRes.user?.profile?.display_name || userRes.user?.real_name;
   } catch (error) {
     return undefined;
@@ -223,8 +273,13 @@ export const getUserName = async (userId: string) => {
  * @returns the id of the workspace
  */
 export const getWorkspaceId = async () => {
+  const client = getSlackClient();
+  if (!client) {
+    throw new HttpException(500, 'Slack client not configured');
+  }
+
   try {
-    const response = await slack.auth.test();
+    const response = await client.auth.test();
     if (response.ok) {
       return response.team_id;
     }
@@ -234,4 +289,57 @@ export const getWorkspaceId = async () => {
   }
 };
 
-export default slack;
+/**
+ * Sends a slack ephemeral message to a user
+ * @param channelId - the channel id of the channel to send to
+ * @param threadTs - the timestamp of the thread to send to
+ * @param userId - the id of the user to send to
+ * @param text - the text of the message to send (should always be populated in case blocks can't be rendered, but if blocks render text will not)
+ * @param blocks - the blocks of the message to send
+ */
+export async function sendEphemeralMessage(
+  channelId: string,
+  threadTs: string,
+  userId: string,
+  text: string,
+  blocks: any[]
+) {
+  const client = getSlackClient();
+  if (!client) return;
+
+  try {
+    await client.chat.postEphemeral({
+      channel: channelId,
+      user: userId,
+      thread_ts: threadTs,
+      text,
+      blocks
+    });
+  } catch (err: unknown) {
+    if (err instanceof Error) {
+      throw new HttpException(500, `Failed to send slack notifications: ${err.message}`);
+    }
+  }
+}
+
+/**
+ * Get the Slack Bolt app instance (initializes Slack if needed)
+ * @returns the Slack Bolt App or null if no token is configured
+ */
+export const getSlackApp = (): App | null => {
+  initializeSlack();
+  return slackApp;
+};
+
+/**
+ * Get the Express receiver instance (initializes Slack if needed)
+ * @returns the ExpressReceiver or null if no token is configured
+ */
+export const getReceiver = (): ExpressReceiver | null => {
+  initializeSlack();
+  return receiver;
+};
+
+// Export the getters for any direct usage if needed
+export { getSlackClient };
+export default getSlackClient;