Added a route to send Profile Blocked Messages (#198)

* Added a route to sent Profile Blocked Messages

* Modification to the message bot is sending

* Authentication Added

* Fixed Lint issues

* Code Cleaning

* Update variables.ts

* Code Cleaning

Author: lakshayman

config/config.ts

@@ -10,23 +10,32 @@ import {
   DEVELOPMENT_RDS_TRACKING_CHANNEL_URL,
   STAGING_RDS_TRACKING_CHANNEL_URL,
 } from "../src/constants/urls";
+import {
+  DISCORD_PROFILE_SERVICE_HELP_GROUP,
+  DISCORD_PROFILE_SERVICE_STAGING_HELP_GROUP,
+  DISCORD_PROFILE_SERVICE_DEVELOPMENT_HELP_GROUP,
+} from "../src/constants/variables";
 
 const config = (env: env) => {
   const environment: environment = {
     production: {
       RDS_BASE_API_URL: RDS_BASE_API_URL,
       VERIFICATION_SITE_URL: VERIFICATION_SITE_URL,
       TRACKING_CHANNEL_URL: RDS_TRACKING_CHANNEL_URL,
+      PROFILE_SERVICE_HELP_GROUP_ID: DISCORD_PROFILE_SERVICE_HELP_GROUP,
     },
     staging: {
       RDS_BASE_API_URL: RDS_BASE_STAGING_API_URL,
       VERIFICATION_SITE_URL: STAGING_VERIFICATION_SITE_URL,
       TRACKING_CHANNEL_URL: STAGING_RDS_TRACKING_CHANNEL_URL,
+      PROFILE_SERVICE_HELP_GROUP_ID: DISCORD_PROFILE_SERVICE_STAGING_HELP_GROUP,
     },
     default: {
       RDS_BASE_API_URL: RDS_BASE_DEVELOPMENT_API_URL,
       VERIFICATION_SITE_URL: DEVELOPMENT_VERIFICATION_SITE_URL,
       TRACKING_CHANNEL_URL: DEVELOPMENT_RDS_TRACKING_CHANNEL_URL,
+      PROFILE_SERVICE_HELP_GROUP_ID:
+        DISCORD_PROFILE_SERVICE_DEVELOPMENT_HELP_GROUP,
     },
   };
 

src/constants/variables.ts

@@ -1,2 +1,7 @@
 export const SUPER_USER_ONE = "154585730465660929";
 export const SUPER_USER_TWO = "1040700289348542566";
+
+export const DISCORD_PROFILE_SERVICE_HELP_GROUP = "1209244798557360138";
+export const DISCORD_PROFILE_SERVICE_STAGING_HELP_GROUP = "1209248671170953236";
+export const DISCORD_PROFILE_SERVICE_DEVELOPMENT_HELP_GROUP =
+  "1209237447083303014"; //Change this for your local environment

src/controllers/profileHandler.ts

@@ -0,0 +1,22 @@
+import { env } from "../typeDefinitions/default.types";
+import { sendProfileServiceBlockedMessage } from "../utils/sendProfileServiceBlockedMessage";
+import JSONResponse from "../utils/JsonResponse";
+import * as response from "../constants/responses";
+import { verifyAuthToken } from "../utils/verifyAuthToken";
+
+export const sendProfileBlockedMessage = async (request: any, env: env) => {
+  const authHeader = request.headers.get("Authorization");
+  if (!authHeader) {
+    return new JSONResponse(response.BAD_SIGNATURE);
+  }
+  try {
+    await verifyAuthToken(authHeader, env);
+    const messageRequest: { userId: string; reason: string } =
+      await request.json();
+    const { userId, reason } = messageRequest;
+    await sendProfileServiceBlockedMessage(userId, reason, env);
+    return new JSONResponse("Message sent in tracking channel on discord");
+  } catch (e) {
+    return new JSONResponse(response.BAD_SIGNATURE);
+  }
+};

src/index.ts

@@ -19,6 +19,7 @@ import { changeNickname } from "./controllers/changeNickname";
 import { getGuildMemberDetailsHandler } from "./controllers/getGuildMemberDetailsHandler";
 import { send } from "./handlers/scheduledEventHandler";
 import { generateInviteLink } from "./controllers/generateDiscordInvite";
+import { sendProfileBlockedMessage } from "./controllers/profileHandler";
 
 const router = Router();
 
@@ -54,6 +55,8 @@ router.put("/roles/add", addGroupRoleHandler);
 
 router.delete("/roles", removeGuildRoleHandler);
 
+router.post("/profile/blocked", sendProfileBlockedMessage);
+
 router.post("/", async (request, env) => {
   const message: discordMessageRequest = await request.json();
 
@@ -76,7 +79,7 @@ router.all("*", async () => {
 
 export default {
   async fetch(request: Request, env: env): Promise<Response> {
-    const apiUrls = ["/invite", "/roles"];
+    const apiUrls = ["/invite", "/roles", "/profile/blocked"];
     const url = new URL(request.url);
     if (request.method === "POST" && !apiUrls.includes(url.pathname)) {
       const isVerifiedRequest = await verifyBot(request, env);

src/typeDefinitions/default.types.d.ts

@@ -10,6 +10,7 @@ export interface variables {
   RDS_BASE_API_URL: string;
   VERIFICATION_SITE_URL: string;
   TRACKING_CHANNEL_URL: string;
+  PROFILE_SERVICE_HELP_GROUP_ID: string;
 }
 
 export interface discordCommand {

src/utils/sendProfileServiceBlockedMessage.ts

@@ -0,0 +1,40 @@
+import { env } from "../typeDefinitions/default.types";
+import config from "../../config/config";
+
+export const generateStringToBeSent = (
+  userId: string,
+  reason: string,
+  env: env
+) => {
+  const helpGroupRoleId = config(env).PROFILE_SERVICE_HELP_GROUP_ID;
+  return `Hello${userId ? ` <@${userId}>` : ""},\n${
+    userId ? "Your" : "Someone's"
+  } Profile Service is **BLOCKED** because of the below-mentioned reason.${
+    userId
+      ? ` Please visit the [MY SITE](https://my.realdevsquad.com/identity) to fix this.\nIf you have any issue related to profile service, you can tag <@&${helpGroupRoleId}> and ask for help.`
+      : ""
+  }\n\n**Reason:** \`${reason ? reason : "No reason provided"}\``;
+};
+
+export async function sendProfileServiceBlockedMessage(
+  userId: string,
+  reason: string,
+  env: env
+): Promise<void> {
+  const stringToBeSent = generateStringToBeSent(userId, reason, env);
+
+  const bodyObj = {
+    content: stringToBeSent,
+  };
+
+  const url = config(env).TRACKING_CHANNEL_URL;
+
+  await fetch(url, {
+    method: "POST",
+    body: JSON.stringify(bodyObj),
+    headers: {
+      "Content-Type": "application/json",
+      Authorization: `Bot ${env.DISCORD_TOKEN}`,
+    },
+  });
+}

tests/unit/utils/sendProfileServiceBlockedMessage.test.ts

@@ -0,0 +1,115 @@
+import config from "../../../config/config";
+import JSONResponse from "../../../src/utils/JsonResponse";
+import {
+  generateStringToBeSent,
+  sendProfileServiceBlockedMessage,
+} from "../../../src/utils/sendProfileServiceBlockedMessage";
+
+describe("Send Profile Service Blocked Message", () => {
+  const mockEnv = {
+    BOT_PUBLIC_KEY: "xyz",
+    DISCORD_GUILD_ID: "123",
+    DISCORD_TOKEN: "abc",
+  };
+
+  const mockData = {
+    discordId: "12345678910111213",
+    reason: "Unauthenticated access to profile service",
+  };
+
+  test("should send the message if both userId and reason provided", async () => {
+    const url = config(mockEnv).TRACKING_CHANNEL_URL;
+    const data = {
+      content: generateStringToBeSent(
+        mockData.discordId,
+        mockData.reason,
+        mockEnv
+      ),
+    };
+
+    jest
+      .spyOn(global, "fetch")
+      .mockImplementation(() => Promise.resolve(new JSONResponse("")));
+
+    await sendProfileServiceBlockedMessage(
+      mockData.discordId,
+      mockData.reason,
+      mockEnv
+    );
+
+    expect(global.fetch).toHaveBeenCalledWith(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+      },
+      body: JSON.stringify(data),
+    });
+  });
+
+  test("should send the message if userId not present", async () => {
+    const data = {
+      content: generateStringToBeSent("", mockData.reason, mockEnv),
+    };
+    const url = config(mockEnv).TRACKING_CHANNEL_URL;
+
+    jest
+      .spyOn(global, "fetch")
+      .mockImplementation(() => Promise.resolve(new JSONResponse("")));
+
+    await sendProfileServiceBlockedMessage("", mockData.reason, mockEnv);
+
+    expect(global.fetch).toHaveBeenCalledWith(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+      },
+      body: JSON.stringify(data),
+    });
+  });
+
+  test("should send the message if both are not present", async () => {
+    const data = {
+      content: generateStringToBeSent("", "", mockEnv),
+    };
+    const url = config(mockEnv).TRACKING_CHANNEL_URL;
+
+    jest
+      .spyOn(global, "fetch")
+      .mockImplementation(() => Promise.resolve(new JSONResponse("")));
+
+    await sendProfileServiceBlockedMessage("", "", mockEnv);
+
+    expect(global.fetch).toHaveBeenCalledWith(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+      },
+      body: JSON.stringify(data),
+    });
+  });
+
+  test("should send the message if reason is not present", async () => {
+    const data = {
+      content: generateStringToBeSent(mockData.discordId, "", mockEnv),
+    };
+    const url = config(mockEnv).TRACKING_CHANNEL_URL;
+
+    jest
+      .spyOn(global, "fetch")
+      .mockImplementation(() => Promise.resolve(new JSONResponse("")));
+
+    await sendProfileServiceBlockedMessage(mockData.discordId, "", mockEnv);
+
+    expect(global.fetch).toHaveBeenCalledWith(url, {
+      method: "POST",
+      headers: {
+        "Content-Type": "application/json",
+        Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+      },
+      body: JSON.stringify(data),
+    });
+  });
+});