Merge pull request #218 from rishirishhh/feat/remove-tagged-users

Author: iamitprakash

src/constants/commands.ts

@@ -34,6 +34,19 @@ export const MENTION_EACH = {
   ],
 };
 
+export const REMOVE = {
+  name: "remove",
+  description: "remove user/users from the server",
+  options: [
+    {
+      name: "role",
+      description: "remove developers with specific role",
+      type: 8, // User type
+      required: true,
+    },
+  ],
+};
+
 export const LISTENING = {
   name: "listening",
   description: "mark user as listening",

src/controllers/baseHandler.ts

@@ -27,6 +27,7 @@ import {
   NOTIFY_ONBOARDING,
   OOO,
   USER,
+  REMOVE,
 } from "../constants/commands";
 import { updateNickName } from "../utils/updateNickname";
 import { discordEphemeralResponse } from "../utils/discordEphemeralResponse";
@@ -40,6 +41,7 @@ import {
   RETRY_COMMAND,
 } from "../constants/responses";
 import { DevFlag } from "../typeDefinitions/filterUsersByRole";
+import { kickEachUser } from "./kickEachUser";
 
 export async function baseHandler(
   message: discordMessageRequest,
@@ -75,6 +77,15 @@ export async function baseHandler(
       return await mentionEachUser(transformedArgument, env, ctx);
     }
 
+    case getCommandName(REMOVE): {
+      const data = message.data?.options as Array<messageRequestDataOptions>;
+      const transformedArgument = {
+        roleToBeRemovedObj: data[0],
+        channelId: message.channel_id,
+      };
+      return await kickEachUser(transformedArgument, env, ctx);
+    }
+
     case getCommandName(LISTENING): {
       const data = message.data?.options;
       const setter = data ? data[0].value : false;

src/controllers/kickEachUser.ts

@@ -0,0 +1,44 @@
+import {
+  MentionEachUserOptions,
+  UserArray,
+} from "../typeDefinitions/filterUsersByRole";
+import { env } from "../typeDefinitions/default.types";
+import { getMembersInServer } from "../utils/getMembersInServer";
+import { filterUserByRoles } from "../utils/filterUsersByRole";
+import { discordTextResponse } from "../utils/discordResponse";
+import { removeUsers } from "../utils/removeUsers";
+
+export async function kickEachUser(
+  transformedArgument: {
+    roleToBeRemovedObj: MentionEachUserOptions;
+    channelId: number;
+  },
+  env: env,
+  ctx: ExecutionContext
+) {
+  const getMembersInServerResponse = await getMembersInServer(env);
+  const roleId = transformedArgument.roleToBeRemovedObj.value;
+
+  const usersWithMatchingRole = filterUserByRoles(
+    getMembersInServerResponse as UserArray[],
+    roleId
+  );
+
+  const usersText = usersWithMatchingRole
+    .map((user) => {
+      return user;
+    })
+    .join("\n");
+
+  if (usersWithMatchingRole.length === 0) {
+    return discordTextResponse(
+      `We couldn't find any user(s) assigned to <@&${roleId}> role.`
+    );
+  } else {
+    ctx.waitUntil(
+      removeUsers(env, usersWithMatchingRole, transformedArgument.channelId)
+    );
+    const responseText = `Following users will be removed shortly ..... :\n${usersText}`;
+    return discordTextResponse(responseText);
+  }
+}

src/register.ts

@@ -8,6 +8,7 @@ import {
   NOTIFY_ONBOARDING,
   OOO,
   USER,
+  REMOVE,
 } from "./constants/commands";
 import { config } from "dotenv";
 import { DISCORD_BASE_URL } from "./constants/urls";
@@ -37,6 +38,7 @@ async function registerGuildCommands(
     USER,
     NOTIFY_OVERDUE,
     NOTIFY_ONBOARDING,
+    REMOVE,
   ];
 
   try {

src/utils/removeUsers.ts

@@ -0,0 +1,76 @@
+import { env } from "../typeDefinitions/default.types";
+import { DISCORD_BASE_URL } from "../constants/urls";
+import {
+  parseRateLimitRemaining,
+  parseResetAfter,
+} from "./batchDiscordRequests";
+import {
+  discordMessageRequest,
+  discordMessageError,
+} from "../typeDefinitions/discordMessage.types";
+
+export async function removeUsers(
+  env: env,
+  usersWithMatchingRole: string[],
+  channelId: number
+) {
+  const batchSize = 4;
+  let waitTillNextAPICall = 0;
+
+  try {
+    const failedUsers: Array<string> = [];
+    for (let i = 0; i < usersWithMatchingRole.length; i += batchSize) {
+      const batchwiseUsers = usersWithMatchingRole.slice(i, i + batchSize);
+      const deleteRequests = batchwiseUsers.map((mention) => {
+        const userId = mention.replace(/<@!*/g, "").replace(/>/g, "");
+        const url = `${DISCORD_BASE_URL}/guilds/${env.DISCORD_GUILD_ID}/members/${userId}`;
+
+        return fetch(url, {
+          method: "DELETE",
+          headers: {
+            "Content-Type": "application/json",
+            Authorization: `Bot ${env.DISCORD_TOKEN}`,
+          },
+        }).then((response) => {
+          const rateLimitRemaining = parseRateLimitRemaining(response);
+          if (rateLimitRemaining === 0) {
+            waitTillNextAPICall = Math.max(
+              parseResetAfter(response),
+              waitTillNextAPICall
+            );
+          }
+          return response.json();
+        }) as Promise<discordMessageRequest | discordMessageError>;
+      });
+
+      const responses = await Promise.all(deleteRequests);
+      responses.forEach((response, i) => {
+        if (response && "message" in response) {
+          failedUsers.push(batchwiseUsers[i]);
+          console.error(`Failed to remove a user`);
+        }
+      });
+      await sleep(waitTillNextAPICall * 1000);
+      waitTillNextAPICall = 0;
+    }
+
+    if (failedUsers.length > 0) {
+      await fetch(`${DISCORD_BASE_URL}/channels/${channelId}/messages`, {
+        method: "POST",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bot ${env.DISCORD_TOKEN}`,
+        },
+        body: JSON.stringify({
+          content: `Failed to remove ${failedUsers}.`,
+        }),
+      });
+    }
+  } catch (error) {
+    console.error("Error occurred while removing users:", error);
+  }
+}
+
+function sleep(ms: number) {
+  return new Promise((resolve) => setTimeout(resolve, ms));
+}

tests/unit/handlers/kickEachUser.test.ts

@@ -0,0 +1,30 @@
+import { kickEachUser } from "../../../src/controllers/kickEachUser";
+import { transformedArgument, ctx } from "../../fixtures/fixture";
+
+describe("kickEachUser", () => {
+  it("should run when found no users with Matched Role", async () => {
+    const env = {
+      BOT_PUBLIC_KEY: "xyz",
+      DISCORD_GUILD_ID: "123",
+      DISCORD_TOKEN: "abc",
+    };
+
+    const { roleToBeTaggedObj } = transformedArgument; // Extracting roleToBeTaggedObj
+    const response = kickEachUser(
+      { roleToBeRemovedObj: roleToBeTaggedObj, channelId: 12345 },
+      env,
+      ctx
+    );
+
+    const roleID = roleToBeTaggedObj.value;
+
+    expect(response).toBeInstanceOf(Promise);
+
+    const textMessage: { data: { content: string } } = await response.then(
+      (res) => res.json()
+    );
+    expect(textMessage.data.content).toBe(
+      `We couldn't find any user(s) assigned to <@&${roleID}> role.`
+    );
+  });
+});

tests/unit/utils/removeUsers.test.ts

@@ -0,0 +1,94 @@
+import { DISCORD_BASE_URL } from "../../../src/constants/urls";
+import JSONResponse from "../../../src/utils/JsonResponse";
+import { removeUsers } from "../../../src/utils/removeUsers";
+
+describe("removeUsers", () => {
+  const mockEnv = {
+    BOT_PUBLIC_KEY: "xyz",
+    DISCORD_GUILD_ID: "123",
+    DISCORD_TOKEN: "abc",
+  };
+
+  beforeEach(() => {
+    jest.clearAllMocks();
+  });
+  afterEach(() => {
+    jest.clearAllMocks();
+    jest.resetAllMocks();
+  });
+
+  test("removes users successfully", async () => {
+    const usersWithMatchingRole = ["<@userId1>", "<@userId2>"];
+
+    jest
+      .spyOn(global, "fetch")
+      .mockImplementation(() =>
+        Promise.resolve(new Response(null, { status: 204 }))
+      );
+    await removeUsers(mockEnv, usersWithMatchingRole, 21121);
+
+    expect(fetch).toHaveBeenCalledTimes(2);
+    expect(fetch).toHaveBeenCalledWith(
+      `${DISCORD_BASE_URL}/guilds/${mockEnv.DISCORD_GUILD_ID}/members/userId1`,
+      {
+        method: "DELETE",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+        },
+      }
+    );
+    expect(fetch).toHaveBeenCalledWith(
+      `${DISCORD_BASE_URL}/guilds/${mockEnv.DISCORD_GUILD_ID}/members/userId2`,
+      {
+        method: "DELETE",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+        },
+      }
+    );
+  });
+  test("handles errors", async () => {
+    const usersWithMatchingRole = ["<@userId1>"];
+
+    // Mocking the fetch function to simulate a rejected promise with a 404 error response
+    jest
+      .spyOn(global, "fetch")
+      .mockImplementation(() =>
+        Promise.reject(new Response(null, { status: 404 }))
+      );
+
+    // Calling the function under test
+    await removeUsers(mockEnv, usersWithMatchingRole, 23231);
+
+    // Expectations
+    expect(fetch).toHaveBeenCalledWith(
+      `${DISCORD_BASE_URL}/guilds/${mockEnv.DISCORD_GUILD_ID}/members/userId1`,
+      {
+        method: "DELETE",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+        },
+      }
+    );
+  });
+
+  it("should send a message of failed api calls at the end", async () => {
+    let fetchCallCount = 0;
+    const usersWithMatchingRole = ["<@userId1>", "<@userId2>", "<@userId3>"];
+
+    jest.spyOn(global, "fetch").mockImplementation(async () => {
+      if (fetchCallCount < 3) {
+        fetchCallCount++;
+        return Promise.resolve(new JSONResponse({ message: "404: Not Found" }));
+      } else {
+        return Promise.resolve(new JSONResponse({ ok: true }));
+      }
+    });
+
+    await removeUsers(mockEnv, usersWithMatchingRole, 23231);
+    expect(fetch).toHaveBeenCalledTimes(4); // should send a message of failed api calls at the end
+  });
+});