To display specific message when used /mention-each command (Real-Dev-Squad#280)

* display a message everytime user runs mention-each command

* created a new feature flag

* removed unecessary lines

* changed the feature flag name and removed nesting

* changed flag name to dev_title

* made some test changes

* move some lines to fixtures from test

* removed unnecessary comments

Author: RishiChaubey31

src/constants/commands.ts

@@ -50,6 +50,12 @@ export const MENTION_EACH = {
       type: 5,
       require: false,
     },
+    {
+      name: "dev_title",
+      description: "want to see extra details?",
+      type: 5,
+      require: false,
+    },
   ],
 };
 

src/controllers/baseHandler.ts

@@ -75,6 +75,9 @@ export async function baseHandler(
         displayMessageObj: data.find((item) => item.name === "message"),
         channelId: message.channel_id,
         dev: data.find((item) => item.name === "dev") as unknown as DevFlag,
+        dev_title: data.find(
+          (item) => item.name === "dev_title"
+        ) as unknown as DevFlag,
       };
       return await mentionEachUser(transformedArgument, env, ctx);
     }

src/controllers/mentionEachUser.ts

@@ -16,6 +16,7 @@ export async function mentionEachUser(
     roleToBeTaggedObj: MentionEachUserOptions;
     displayMessageObj?: MentionEachUserOptions;
     channelId: number;
+    dev_title?: DevFlag;
     dev?: DevFlag;
   },
   env: env,
@@ -25,6 +26,7 @@ export async function mentionEachUser(
   const roleId = transformedArgument.roleToBeTaggedObj.value;
   const msgToBeSent = transformedArgument?.displayMessageObj?.value;
   const dev = transformedArgument?.dev?.value || false;
+  const devtitle = transformedArgument?.dev_title?.value || false;
   // optional chaining here only because display message obj is optional argument
   const usersWithMatchingRole = filterUserByRoles(
     getMembersInServerResponse as UserArray[],
@@ -36,6 +38,19 @@ export async function mentionEachUser(
     message: msgToBeSent,
     usersWithMatchingRole,
   };
+
+  if (transformedArgument.dev_title?.value === true) {
+    let responseMessage = "";
+    if (usersWithMatchingRole.length === 0) {
+      responseMessage = `Sorry, no user found with <@&${roleId}> role.`;
+    } else if (usersWithMatchingRole.length === 1) {
+      responseMessage = `The user with <@&${roleId}> role is ${payload.usersWithMatchingRole}.`;
+    } else {
+      responseMessage = `The users with <@&${roleId}> role are ${payload.usersWithMatchingRole}.`;
+    }
+    return discordTextResponse(responseMessage);
+  }
+
   if (!dev || usersWithMatchingRole.length === 0) {
     const responseData = checkDisplayType({
       usersWithMatchingRole,

tests/fixtures/fixture.ts

@@ -370,3 +370,16 @@ export const overdueTaskUsers = {
     },
   ],
 };
+export const testDataWithDevTitle = {
+  channelId: 123,
+  roleToBeTaggedObj: {
+    name: "role",
+    type: 4,
+    value: "860900892193456149",
+  },
+  dev_title: {
+    name: "dev_title",
+    type: 4,
+    value: true,
+  },
+};

tests/unit/handlers/mentionEachUser.test.ts

@@ -1,6 +1,7 @@
 import { mentionEachUser } from "../../../src/controllers/mentionEachUser";
 import { checkDisplayType } from "../../../src/utils/checkDisplayType";
 import { filterUserByRoles } from "../../../src/utils/filterUsersByRole";
+import { testDataWithDevTitle } from "../../../tests/fixtures/fixture";
 import {
   onlyRoleToBeTagged,
   transformedArgument,
@@ -14,7 +15,6 @@ describe("Test mention each function", () => {
       DISCORD_GUILD_ID: "123",
       DISCORD_TOKEN: "abc",
     };
-
     const response = mentionEachUser(transformedArgument, env, ctx);
     expect(response).toBeInstanceOf(Promise);
   });
@@ -52,7 +52,6 @@ describe("Test mention each function", () => {
       DISCORD_GUILD_ID: "123",
       DISCORD_TOKEN: "abc",
     };
-
     const response = mentionEachUser(onlyRoleToBeTagged, env, ctx);
     expect(response).toBeInstanceOf(Promise);
     const textMessage: { data: { content: string } } = await response.then(
@@ -107,15 +106,15 @@ describe("Test mention each function", () => {
     expect(response).toBe(expectedResponse);
   });
 
-  it("should return default string ", () => {
+  it("should return default string when no users found", () => {
     const usersWithMatchingRole = [] as string[];
     const msgToBeSent = "hello";
     const response = checkDisplayType({ usersWithMatchingRole, msgToBeSent });
     const expectedResponse = `Sorry no user found under this role.`;
     expect(response).toBe(expectedResponse);
   });
 
-  it("should return default string ", () => {
+  it("should return default string with undefined message", () => {
     const usersWithMatchingRole = [
       "<@282859044593598464>",
       "<@725745030706364447>",
@@ -126,4 +125,60 @@ describe("Test mention each function", () => {
     const expectedResponse = `${returnString} ${usersWithMatchingRole}`;
     expect(response).toBe(expectedResponse);
   });
+
+  // New tests for dev_title flag
+  it("should show appropriate message when no users found with dev_title flag", async () => {
+    const env = {
+      BOT_PUBLIC_KEY: "xyz",
+      DISCORD_GUILD_ID: "123",
+      DISCORD_TOKEN: "abc",
+    };
+    const roleId = "860900892193456149";
+    const response = mentionEachUser(
+      {
+        ...onlyRoleToBeTagged,
+        roleToBeTaggedObj: {
+          name: "role",
+          type: 4,
+          value: roleId,
+        },
+        dev_title: {
+          name: "dev_title",
+          type: 4,
+          value: true,
+        },
+      },
+      env,
+      ctx
+    );
+
+    expect(response).toBeInstanceOf(Promise);
+    const textMessage: { data: { content: string } } = await response.then(
+      (res) => res.json()
+    );
+    expect(textMessage.data.content).toBe(
+      `Sorry, no user found with <@&${roleId}> role.`
+    );
+  });
+
+  // Only showing the modified test case for clarity
+  it("should show appropriate message when single user found with dev_title flag", async () => {
+    const env = {
+      BOT_PUBLIC_KEY: "xyz",
+      DISCORD_GUILD_ID: "123",
+      DISCORD_TOKEN: "abc",
+    };
+
+    const response = mentionEachUser(testDataWithDevTitle, env, ctx);
+    expect(response).toBeInstanceOf(Promise);
+
+    const textMessage: { data: { content: string } } = await response.then(
+      (res) => res.json()
+    );
+
+    expect([
+      `The user with <@&${testDataWithDevTitle.roleToBeTaggedObj.value}> role is <@282859044593598464>.`,
+      `Sorry, no user found with <@&${testDataWithDevTitle.roleToBeTaggedObj.value}> role.`,
+    ]).toContain(textMessage.data.content);
+  });
 });