feat(slackbot): do some backend work for the Slack app

In this commit:
* add some skelton library code for data persistence via Prisma ORM and Postgres
* add some word-based triggers for some automated responses a la Slackbot
* copious amounts of Block Kit Builder usage for building views

Pardon the mega commit dump!

Author: ajhalili2006

packages/slackbot/app.ts

@@ -1,5 +1,6 @@
 import { App, LogLevel } from '@slack/bolt';
 import registerListeners from './listeners';
+import { prisma } from './lib/db';
 
 /** Initialization */
 const app = new App({
@@ -16,12 +17,16 @@ registerListeners(app);
 (async () => {
   try {
     await app.start(process.env.PORT || 33123);
-    console.log('⚡️ Bolt app is running! ⚡️');
+    await prisma.$connect()
+    console.log("Now connected to database for data presistence")
+    console.log('⚡️ Recap Time Bot is up at port', process.env.PORT);
     app.client.users.setPresence({
       presence: 'auto',
       token: process.env.SLACK_BOT_TOKEN,
     })
   } catch (error) {
     console.error('Unable to start App', error);
+    await prisma.$disconnect()
+    process.exit(1)
   }
 })();

packages/slackbot/lib/blocks/homepage_nonstaff.ts

@@ -1,9 +1,12 @@
+import { HomeView } from '@slack/bolt';
+
 export default function homepageNonStaffView(
   uid: string,
   username?: string | null,
-) {
+): HomeView {
   return {
     type: 'home' as const,
+    callback_id: 'home_community-unverified',
     blocks: [
       {
         type: 'header',

packages/slackbot/lib/blocks/request_permissions.ts

@@ -1,119 +1,141 @@
-import { ModalView, View } from "@slack/bolt";
+import { ModalView } from "@slack/bolt";
 
-const requestPermissionsPrompt: View = {
-  type: 'modal',
+const requestPermissionsPrompt: ModalView = {
+  callback_id: "requestPermSubmission",
+  type: "modal",
   title: {
-    type: 'plain_text',
-    text: 'Request permissions',
+    type: "plain_text",
+    text: "Request permissions",
     emoji: true,
   },
   submit: {
-    type: 'plain_text',
-    text: 'Submit request',
+    type: "plain_text",
+    text: "Submit request",
+
     emoji: true,
   },
   close: {
-    type: 'plain_text',
-    text: 'Cancel',
+    type: "plain_text",
+    text: "Cancel",
     emoji: true,
   },
   blocks: [
     {
-      type: 'input',
-      block_id: 'role',
+      type: "input",
+      block_id: "role",
       element: {
-        type: 'static_select',
+        type: "static_select",
         placeholder: {
-          type: 'plain_text',
-          text: 'Select role here',
+          type: "plain_text",
+          text: "Select role here",
           emoji: true,
         },
         options: [
           {
             text: {
-              type: 'plain_text',
-              text: 'Squad member',
+              type: "plain_text",
+              text: "Squad member",
               emoji: true,
             },
-            value: 'crew.recaptime.dev',
+            value: "crew.recaptime.dev",
           },
           {
             text: {
-              type: 'plain_text',
-              text: 'Hack Clubber from HQ or HCB',
+              type: "plain_text",
+              text: "Hack Clubber from HQ or HCB",
               emoji: true,
             },
-            value: 'hackclub.com/team',
+            value: "hackclub.com/team",
           },
           {
             text: {
-              type: 'plain_text',
-              text: 'Community maintainers + mods (including community mods/Hack Club Slack FD)',
+              type: "plain_text",
+              text: "Community maintainers + mods (including community mods/Hack Club Slack FD)",
               emoji: true,
             },
-            value: 'crew.recaptime.dev/community-maintainers',
+            value: "crew.recaptime.dev/community-maintainers",
           },
           {
             text: {
-              type: 'plain_text',
-              text: 'None of the above',
+              type: "plain_text",
+              text: "None of the above",
               emoji: true,
             },
-            value: 'regular-user',
+            value: "regular-user",
           },
         ],
-        action_id: 'selector',
+        action_id: "selector",
       },
       label: {
-        type: 'plain_text',
-        text: 'Are you RecapTime.dev staff or community maintainer?',
+        type: "plain_text",
+        text: "Are you RecapTime.dev staff or community maintainer?",
         emoji: true,
       },
+      optional: false,
     },
     {
-      type: 'context',
+      type: "context",
       elements: [
         {
-          type: 'mrkdwn',
-          text: "To unlock the rest of @recaptimebot's features, you must be a Recap Time Squad member (part of @recaptimesquad user group), Hack Club Staff (@staff) or HCB Staff (@hcbops, @hcbteam or @hcb-engineers), a community maintainer from one of our projects (or from a open-source project we recongized), or a community moderator on one of our community spaces (this includes the Fire Department (@fire-fighters) at Hack Club Slack).",
+          type: "mrkdwn",
+          text: "To unlock more of Recap Time Bot features, you must be a <https://crew.recaptime.dev|current squad member> or <https://wiki.recaptime.dev/handbook/access-permission-levels#eligibility|part of eligible groups>.",
         },
       ],
     },
     {
-      type: 'input',
-      block_id: 'codeforge_profile',
+      type: "input",
+      block_id: "codeforge_profile",
       element: {
-        type: 'plain_text_input',
-        action_id: 'username',
+        type: "plain_text_input",
+        action_id: "username",
       },
       label: {
-        type: 'plain_text',
-        text: 'Your GitHub, GitLab SaaS or sourcehut username',
+        type: "plain_text",
+        text: "Your GitHub, GitLab SaaS or sourcehut username",
         emoji: true,
       },
+      hint: {
+        type: "plain_text",
+        text: "https://code-forge.tld/username",
+      },
+      optional: false,
     },
     {
-      type: 'context',
+      type: "context",
       elements: [
         {
-          type: 'mrkdwn',
-          text: "If you don't use GitHub but using either the GitLab SaaS instance (`gitlab.com`) or sourcehut (`sr.ht`), please fill this in.",
+          type: "mrkdwn",
+          text: "If you self-host GitLab, sourcehut or other open-source git hosting service, please paste the full profile URL here.",
         },
       ],
     },
     {
-      type: 'input',
-      block_id: 'reason',
+      type: "input",
+      block_id: "reason",
       element: {
-        type: 'plain_text_input',
+        type: "plain_text_input",
         multiline: true,
-        action_id: 'content',
+        action_id: "content",
       },
       label: {
-        type: 'plain_text',
-        text: 'Request reason',
+        type: "plain_text",
+        text: "Request reason",
         emoji: true,
       },
+      hint: {
+        text: "Your reason here",
+        type: "plain_text",
+      },
+      optional: false,
+    },
+    {
+      type: "context",
+      elements: [
+        {
+          type: "mrkdwn",
+          text: "We use this information to help use review your request and grant you access faster.",
+        },
+      ],
     },
   ],
 };

packages/slackbot/lib/db.ts

@@ -1,3 +1,76 @@
-import { PrismaClient } from '@prisma/client';
+// eslint-disable-next-line import/no-relative-packages
+import { PrismaClient } from "../prisma/lib";
+import { UserInfo, UserRole } from "./types";
 
-const prisma = new PrismaClient();
+export const prisma = new PrismaClient();
+
+type UserLookupResult = {
+  result: UserInfo | null
+  error?: object | string | unknown
+}
+
+export async function lookupUser(id: string): Promise<UserLookupResult> {
+  try {
+    const data = await prisma.slackUser.findUnique({
+      where: {
+        user_id: id,
+      },
+    });
+
+    if (data == null) {
+      return {
+        result: null,
+        error: {
+          code: "USER_NOT_FOUND",
+          message: "Slack user not found",
+        },
+      };
+    }
+    return {
+      result: {
+        user_id: data.user_id,
+        roles: data.roles as UserRole[],
+        is_staff: data.is_staff || false,
+        created_on: data.created_on,
+        updated_at: data.updated_at,
+      },
+      error: undefined,
+    };
+  } catch (error) {
+    console.log(error);
+    return {
+      result: null,
+      error,
+    };
+  }
+}
+
+export async function linkUserToTeam(user_id: string, team: string) {
+  try {
+    const { roles: existingRoles } = await prisma.slackUser.findUnique({
+      select: {
+        roles: true,
+      },
+      where: {
+        user_id,
+      },
+    }) || { roles: [] };
+
+    const updatedRoles = [...new Set([...existingRoles, ...team])];
+
+    const result = await prisma.slackUser.update({
+      where: { user_id },
+      data: { roles: updatedRoles },
+    });
+    return {
+      result,
+      error: null,
+    };
+  } catch (error) {
+    console.log(error);
+    return {
+      result: null,
+      error,
+    };
+  }
+}

packages/slackbot/lib/types.ts

@@ -0,0 +1,33 @@
+// Acceptable user roles
+export type UserRole = "community" | "crew.recaptime.dev" | "hackclub.com/team"
+
+/**
+ * Slack user information
+ */
+export interface UserInfo {
+  // Slack user ID
+  user_id: string
+
+  roles?: UserRole[]
+
+  // Whether if a user is a Recap Time Squad squad member or Hack Club HQ or HCB staff.
+  is_staff: boolean
+
+  // Whether the user is banned from using the bot
+  banned?: boolean
+  ban_reason?: string
+
+  // eslint-disable-next-line no-use-before-define
+  permission_requests?: BotPermissionRequest[]
+
+  created_on: Date
+  updated_at: Date
+}
+
+export interface BotPermissionRequest {
+  id: string,
+  user: UserInfo, // This references UserInfo, which is now defined before this type
+  user_id: UserInfo["user_id"],
+  created_on: Date,
+  updated_on: Date
+}

packages/slackbot/listeners/actions/index.ts

@@ -1,10 +1,11 @@
 import { App } from '@slack/bolt';
 import sampleActionCallback from './sample-action';
-import requestAccessCallback from './request-access';
+import { requestAccessCallback, requestPermSubmissionHandler } from './request-access';
 
 const register = (app: App) => {
   app.action('sample_action_id', sampleActionCallback);
   app.action('requestAccessPrompt', requestAccessCallback);
+  app.action('requestPermSubmission', requestPermSubmissionHandler);
 };
 
 export default { register };

packages/slackbot/listeners/actions/request-access.ts

@@ -1,14 +1,14 @@
 import { AllMiddlewareArgs, BlockAction, SlackActionMiddlewareArgs } from '@slack/bolt';
 import requestPermissionsPrompt from '../../lib/blocks/request_permissions';
 
-const requestAccessCallback = async ({ ack, client, body }:
+export const requestAccessCallback = async ({ ack, client, body }:
   AllMiddlewareArgs & SlackActionMiddlewareArgs<BlockAction>) => {
   try {
     await ack();
-    await client.views.update({
+    await client.views.open({
       trigger_id: body.trigger_id,
       view: requestPermissionsPrompt,
-    });
+    })
   } catch {
     await client.views.update({
       trigger_id: body.trigger_id,
@@ -39,4 +39,11 @@ const requestAccessCallback = async ({ ack, client, body }:
   }
 };
 
-export default requestAccessCallback;
+export const requestPermSubmissionHandler = async({ ack, client, body }:
+  AllMiddlewareArgs & SlackActionMiddlewareArgs<BlockAction>) => {
+    try {
+      const { state, user } = body;
+    } catch (error) {
+      console.error(error);
+    }
+}

packages/slackbot/listeners/commands/index.ts

@@ -5,6 +5,7 @@ import botCommandHandler from './rtdevbot';
 const register = (app: App) => {
   app.command('/sample-command', sampleCommandCallback);
   app.command('/rtdevbot', botCommandHandler);
+  app.command('/rtdevbot-dev', botCommandHandler);
 };
 
 export default { register };