Dev to main sync (RealDevSquad#143)

* Auto fetch task which are overdue

* added type definitions for taskoverdue, refactored the code and removed the use of any

* fixed return type of scheduled func

* added fixtures and tests for getDiscordIds func

* updated type def for user backend

* removed public key from .toml and removed kick command from baseHandler

* removed public key

* added error message in getDiscordIds.ts

* added fixture for taskOverdue, written test for taskOverDue, restructured the code of scheduleEventHandler, altered tests for getDiscordIds, refactored code for taskOverDueDiscordMembers, refactored code for getDiscordIds

* forgot to add updated typeDefinitions for taskOverdue

* extracted url to url.ts

* resolved comments by:bharti

* resolving comments

* keeping schedule event under comments

* error handling in scheduledEventHandler

* resolved comments by:bharti

* resolving comments by:dipayan

* replaced staging url with production

* inserted tracking channel id in url

* extracted super user discord id to constants

* BugFix: /listening (RealDevSquad#126)

* bug fix

* refactored te code

* major fixes

* resolved the comments

---------

Co-authored-by: Prakash Choudhary <[email protected]>

* FEATURE: Add /task command (RealDevSquad#127)

* FEATURE: add code changes for /task command

* feat(utils): add formatDate and formatTask utility

* feat(message): update response format

* FEATURE: add code changes for /task command

* FEAT: add TASK command to register

* Update src/utils/getNickName.ts

* REFACTOR: change var name and add try-catch to getNickName fun

* TEST: add tet for formatDate and formatStatusToTitleCase function

* REFACTOR: extract fetchTasks fun

* TEST: add test for fetchTasks

* TEST(FIX): fix formatDate test

* TEST: improve test coverage of fetchTasks function

* TEST: add test for formatTasks function

* TEST: fix failed test

* TEST: fix failed test

* remove console from getNickName.ts

* TEST: add test for fetchTask funtion

* REFACTOR: changes position of status var

* REFACTOR: add try catch to fetchTasks function

* FIX: lint

* Making Auto fetch Overdue task live (RealDevSquad#134)

* Refactor : Task command (RealDevSquad#137)

* REFACTOR: add function to get RDS user data and replace formatDate function

* TEST: add test for changes

* TEST: add more test

* REFACTOR: change date format

* REFACTOR: change type file extension

* FORMAT: fix prettier

* Discord bot command called user that takes a username as an option and provides user details in response

* Registered /user  command for a bot in a specific guild

* /OOO command to get user OOO  details (RealDevSquad#129)

* Added utility functions to get and return user details

* Test : For utility functions

* Refactor : time stamp conversion

---------

Co-authored-by: FMK2312 <[email protected]>
Co-authored-by: Sunny Sahsi <[email protected]>
Co-authored-by: Fakhruddin KW <[email protected]>
Co-authored-by: Vinit khandal <[email protected]>
Co-authored-by: SHREYA MISHRA <[email protected]>
Co-authored-by: Prakash Choudhary <[email protected]>
Co-authored-by: Vinit <[email protected]>
Co-authored-by: Dash Deipayan <[email protected]>

Author: 7 people

src/constants/commands.ts

@@ -66,3 +66,16 @@ export const OOO = {
     },
   ],
 };
+
+export const USER = {
+  name: "user",
+  description: "Replies with specific user details in the channel",
+  options: [
+    {
+      name: "username",
+      description: "Takes username and shows user details",
+      type: 6,
+      required: true,
+    },
+  ],
+};

src/controllers/baseHandler.ts

@@ -4,6 +4,7 @@ import { verifyCommand } from "./verifyCommand";
 import { mentionEachUser } from "./mentionEachUser";
 import { taskCommand } from "./taskCommand";
 import { oooCommand } from "./oooCommand";
+import { userCommand } from "./userCommand";
 
 import { getCommandName } from "../utils/getCommandName";
 import JSONResponse from "../utils/JsonResponse";
@@ -22,6 +23,7 @@ import {
   VERIFY,
   TASK,
   OOO,
+  USER,
 } from "../constants/commands";
 import { updateNickName } from "../utils/updateNickname";
 import { discordEphemeralResponse } from "../utils/discordEphemeralResponse";
@@ -122,6 +124,11 @@ export async function baseHandler(
       const data = message.data?.options as Array<messageRequestDataOptions>;
       return await oooCommand(data[0].value);
     }
+
+    case getCommandName(USER): {
+      const data = message.data?.options as Array<messageRequestDataOptions>;
+      return await userCommand(data[0].value, env);
+    }
     default: {
       return commandNotFound();
     }

src/controllers/userCommand.ts

@@ -0,0 +1,14 @@
+import { env } from "../typeDefinitions/default.types";
+import { discordTextResponse } from "../utils/discordResponse";
+import { getUserDetails } from "../utils/getUserDetails";
+import { formatUserDetails } from "../utils/formatUserDetails";
+
+export async function userCommand(discordId: string, env: env) {
+  try {
+    const userDetails = await getUserDetails(discordId);
+    const formattedUserDetails = formatUserDetails(userDetails);
+    return discordTextResponse(formattedUserDetails);
+  } catch (error) {
+    return discordTextResponse("Trouble in fetching user details.");
+  }
+}

src/register.ts

@@ -5,6 +5,7 @@ import {
   LISTENING,
   TASK,
   OOO,
+  USER,
 } from "./constants/commands";
 import { config } from "dotenv";
 import { DISCORD_BASE_URL } from "./constants/urls";
@@ -24,7 +25,7 @@ async function registerGuildCommands(
   discordApplicationId?: string,
   discordGuildId?: string
 ) {
-  const commands = [HELLO, VERIFY, MENTION_EACH, LISTENING, TASK, OOO];
+  const commands = [HELLO, VERIFY, MENTION_EACH, LISTENING, TASK, OOO, USER];
 
   try {
     if (!discordBotToken) throw new Error("Please provide a BOT TOKEN");

src/typeDefinitions/rdsUser.ts

@@ -29,6 +29,7 @@ export type UserType = {
   designation?: string;
   username: string;
   profileStatus?: string;
+  state?: string;
 };
 
 export type UserResponseType = {

src/utils/formatUserDetails.ts

@@ -0,0 +1,27 @@
+import { UserResponseType } from "../typeDefinitions/rdsUser";
+
+export function convertTimeStamp(userDetails: UserResponseType) {
+  const timestamp = userDetails.user?.discordJoinedAt ?? "";
+  const date = new Date(timestamp);
+
+  const day = String(date.getDate()).padStart(2, "0");
+  const month = String(date.getMonth() + 1).padStart(2, "0");
+  const year = date.getFullYear();
+
+  const hours = String(date.getHours()).padStart(2, "0");
+  const minutes = String(date.getMinutes()).padStart(2, "0");
+  const seconds = String(date.getSeconds()).padStart(2, "0");
+
+  const formattedDate = `${day}/${month}/${year} ${hours}:${minutes}:${seconds}`;
+  return formattedDate;
+}
+
+export function formatUserDetails(userDetails: UserResponseType) {
+  const convertedTimestamp = convertTimeStamp(userDetails);
+  return `
+          ## User Details
+          **Full Name :** ${userDetails.user?.first_name} ${userDetails.user?.last_name}
+          **RDS Discord Joined At :** ${convertedTimestamp}
+          **State :** ${userDetails.user?.state}
+          `;
+}

tests/unit/utils/formatUserDetails.test.ts

@@ -0,0 +1,24 @@
+import { UserResponseType } from "../../../src/typeDefinitions/rdsUser";
+import { formatUserDetails } from "../../../src/utils/formatUserDetails";
+import { userResponse } from "../../fixtures/user";
+import { convertTimeStamp } from "../../../src/utils/formatUserDetails";
+
+describe("formatUserDetails function", () => {
+  it("Should return a string", () => {
+    const userData: UserResponseType = userResponse;
+    const formattedUserDetails = formatUserDetails(userData);
+    expect(typeof formattedUserDetails).toBe("string");
+  });
+
+  it("should format user details correctly", () => {
+    const formattedDetails = formatUserDetails(userResponse).trim();
+    console.log(formattedDetails);
+    const expectedFormattedDetails = `
+          ## User Details
+          **Full Name :** Sunny Sahsi
+          **RDS Discord Joined At :** ${convertTimeStamp(userResponse)}
+          **State :** ACTIVE
+        `.trim();
+    expect(formattedDetails).toEqual(expectedFormattedDetails);
+  });
+});

tests/unit/utils/getUserDetails.test.ts

@@ -48,4 +48,15 @@ describe("Test getUserDetails function", () => {
       "https://api.realdevsquad.com/users?discordId=1234567890&dev=true"
     );
   });
+
+  it("Should include state property", async () => {
+    const mockResponse = userResponse;
+    jest
+      .spyOn(global, "fetch")
+      .mockImplementation(() =>
+        Promise.resolve(new JSONResponse(mockResponse))
+      );
+    const user = await getUserDetails(discordID);
+    expect(userResponse.user).toHaveProperty("state");
+  });
 });