made changes in the code as per reviews

Author: rishirishhh

src/constants/commands.ts

@@ -34,15 +34,15 @@ export const MENTION_EACH = {
   ],
 };
 
-export const KICK = {
-  name: "kick",
-  description: "Kick a user from the server",
+export const REMOVE = {
+  name: "remove",
+  description: "remove user/users from the server",
   options: [
     {
       name: "role",
-      description: "The role to kick",
+      description: "remove developers with specific role",
       type: 8, // User type
-      required: false,
+      required: true,
     },
   ],
 };

src/controllers/baseHandler.ts

@@ -27,7 +27,7 @@ import {
   NOTIFY_ONBOARDING,
   OOO,
   USER,
-  KICK,
+  REMOVE,
 } from "../constants/commands";
 import { updateNickName } from "../utils/updateNickname";
 import { discordEphemeralResponse } from "../utils/discordEphemeralResponse";
@@ -79,7 +79,7 @@ export async function baseHandler(
       return await mentionEachUser(transformedArgument, env, ctx);
     }
 
-    case getCommandName(KICK): {
+    case getCommandName(REMOVE): {
       const data = message.data?.options as Array<messageRequestDataOptions>;
       const transformedArgument = {
         roleToBeRemovedObj: data[0],

src/controllers/kickEachUser.ts

@@ -23,12 +23,19 @@ export async function kickEachUser(
     roleId
   );
 
+  const usersText = usersWithMatchingRole
+    .map((user) => {
+      return user;
+    })
+    .join("\n");
+
   if (usersWithMatchingRole.length === 0) {
-    return discordTextResponse(`Found no users with the matched role.`);
-  } else {
-    ctx.waitUntil(removeUsers(env, usersWithMatchingRole));
     return discordTextResponse(
-      `Found ${usersWithMatchingRole.length} users with the matched role, removing them shortly...`
+      `We couldn't find any user(s) assigned to <@&${roleId}> role.`
     );
+  } else {
+    ctx.waitUntil(removeUsers(env, usersWithMatchingRole));
+    const responseText = `Following users are removed:\n${usersText}`;
+    return discordTextResponse(responseText);
   }
 }

src/register.ts

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

src/utils/removeUsers.ts

@@ -1,27 +1,58 @@
 import { env } from "../typeDefinitions/default.types";
 import { DISCORD_BASE_URL } from "../constants/urls";
+import {
+  parseRateLimitRemaining,
+  parseResetAfter,
+} from "./batchDiscordRequests";
 
-export const removeUsers = async (
-  env: env,
-  usersWithMatchingRole: string[]
-) => {
-  const baseUrl = `${DISCORD_BASE_URL}/guilds/${env.DISCORD_GUILD_ID}/members`;
-  // Method : DELETE /guilds/{guild.id}/members/{user.id}
-
-  for (const mention of usersWithMatchingRole) {
-    // Remove <@ and > symbols from the mention
-    const userId = mention.replace(/<@!*/g, "").replace(/>/g, "");
-    const url = `${baseUrl}/${userId}`;
-
-    const headers = {
-      "Content-Type": "application/json",
-      Authorization: `Bot ${env.DISCORD_TOKEN}`,
-    };
-
-    try {
-      await fetch(url, { method: "DELETE", headers });
-    } catch (error) {
-      console.error(`Error removing user with ID ${userId}:`, error);
+export async function removeUsers(env: env, usersWithMatchingRole: string[]) {
+  const batchSize = 4;
+  let waitTillNextAPICall = 0;
+
+  try {
+    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(async (response) => {
+          const rateLimitRemaining = parseRateLimitRemaining(response);
+
+          if (rateLimitRemaining === 0) {
+            waitTillNextAPICall = Math.max(
+              parseResetAfter(response),
+              waitTillNextAPICall
+            );
+          }
+
+          // Check if response status is 204 (No Content) indicating success
+          if (response.status === 204) {
+            return { success: true };
+          } else {
+            throw new Error(`Failed to remove user ${userId}.`);
+          }
+        });
+      });
+
+      // Wait for all delete requests in the batch to complete
+      await Promise.all(deleteRequests);
+
+      // Wait until the next API call is allowed based on rate limits
+      await sleep(waitTillNextAPICall * 1000);
+      waitTillNextAPICall = 0;
     }
+  } 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

@@ -16,13 +16,15 @@ describe("kickEachUser", () => {
       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(
-      "Found no users with the matched role."
+      `We couldn't find any user(s) assigned to <@&${roleID}> role.`
     );
   });
 });