Dev to Main Sync (RealDevSquad#141)

* 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

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

---------

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

Author: 5 people

src/constants/commands.ts

@@ -53,3 +53,16 @@ export const TASK = {
     },
   ],
 };
+
+export const OOO = {
+  name: "ooo",
+  description: "out-of-office data of the mentioned user",
+  options: [
+    {
+      name: "username",
+      description: "tag user for that",
+      type: 6,
+      required: true,
+    },
+  ],
+};

src/constants/responses.ts

@@ -53,3 +53,5 @@ export const INVALID_NICKNAME_ERROR =
 export const NO_TASKS_FOUND = `No tasks found for **{{username}}**.`;
 export const TASKS_FETCH_FAILED = "An error occurred while fetching tasks.";
 export const FAILED_TO_FETCH_TASKS = `Failed to fetch tasks for **{{assignee}}**.`;
+export const USER_NOT_FOUND = `User Not Found`;
+export const USER_STATUS_NOT_FOUND = "No Status Found";

src/controllers/baseHandler.ts

@@ -3,6 +3,7 @@ import { helloCommand } from "./helloCommand";
 import { verifyCommand } from "./verifyCommand";
 import { mentionEachUser } from "./mentionEachUser";
 import { taskCommand } from "./taskCommand";
+import { oooCommand } from "./oooCommand";
 
 import { getCommandName } from "../utils/getCommandName";
 import JSONResponse from "../utils/JsonResponse";
@@ -20,6 +21,7 @@ import {
   MENTION_EACH,
   VERIFY,
   TASK,
+  OOO,
 } from "../constants/commands";
 import { updateNickName } from "../utils/updateNickname";
 import { discordEphemeralResponse } from "../utils/discordEphemeralResponse";
@@ -116,6 +118,10 @@ export async function baseHandler(
       const data = message.data?.options as Array<messageRequestDataOptions>;
       return await taskCommand(data[0].value, env);
     }
+    case getCommandName(OOO): {
+      const data = message.data?.options as Array<messageRequestDataOptions>;
+      return await oooCommand(data[0].value);
+    }
     default: {
       return commandNotFound();
     }

src/controllers/oooCommand.ts

@@ -0,0 +1,21 @@
+import { discordTextResponse } from "../utils/discordResponse";
+import { formatOOOMessage } from "../utils/formatOOOMessage";
+import { getUserOOODetails } from "../utils/getUserOOODetails";
+import { UserStatus } from "../typeDefinitions/userStatus.type";
+import { USER_NOT_FOUND } from "../constants/responses";
+import { getUserDetails } from "../utils/getUserDetails";
+
+export async function oooCommand(discordId: string) {
+  try {
+    const userResponse = await getUserDetails(discordId);
+    if (!userResponse.user) {
+      return discordTextResponse(USER_NOT_FOUND);
+    }
+    const userId = userResponse?.user?.id as string;
+    const userStatusResponse = await getUserOOODetails(userId);
+    const responseuser = formatOOOMessage(userStatusResponse as UserStatus);
+    return discordTextResponse(responseuser);
+  } catch (error: any) {
+    return discordTextResponse(USER_NOT_FOUND);
+  }
+}

src/register.ts

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

src/typeDefinitions/userStatus.type.ts

@@ -0,0 +1,26 @@
+export interface UserStatus {
+  id: string;
+  userId: string;
+  data: {
+    userId: string;
+    currentStatus: {
+      from: TimeStamp;
+      until: TimeStamp;
+      state: "IDLE" | "OOO" | "ACTIVE";
+      updatedAt: TimeStamp;
+      message: string;
+    };
+    futureStatus?: {
+      from: TimeStamp;
+      until: TimeStamp;
+      state: "IDLE" | "OOO" | "ACTIVE";
+      updatedAt: TimeStamp;
+      message: string;
+    };
+    monthlyHours?: {
+      committed: number;
+      updatedAt: TimeStamp;
+    };
+  };
+  message: string;
+}

src/utils/formatOOOMessage.ts

@@ -0,0 +1,27 @@
+import { UserStatus } from "../typeDefinitions/userStatus.type";
+
+export function formatOOOMessage(userStatusData: UserStatus) {
+  let msg: string;
+  const currentStatusState = userStatusData.data.currentStatus.state;
+  const futureStatusState = userStatusData.data.futureStatus?.state;
+  if (currentStatusState === "OOO") {
+    const currentFromDate = new Date(
+      userStatusData.data.currentStatus.from
+    ).toDateString();
+    const currentToDate = new Date(
+      userStatusData.data.currentStatus.until
+    ).toDateString();
+    msg = `**Current**:\n${currentFromDate} - ${currentToDate}\n ${userStatusData.data.currentStatus.message}\n\n`;
+  } else if (futureStatusState === "OOO") {
+    const futureFromDate = new Date(
+      userStatusData.data.futureStatus?.from
+    ).toDateString();
+    const futureToDate = new Date(
+      userStatusData.data.futureStatus?.until
+    ).toDateString();
+    msg = `**Upcoming**:\n${futureFromDate} - ${futureToDate}\n${userStatusData.data.futureStatus?.message}\n`;
+  } else {
+    msg = `User is currently **${currentStatusState}**`;
+  }
+  return msg;
+}

src/utils/getUserOOODetails.ts

@@ -0,0 +1,13 @@
+import { USER_STATUS_NOT_FOUND } from "../constants/responses";
+import { RDS_BASE_API_URL } from "../constants/urls";
+import { UserStatus } from "../typeDefinitions/userStatus.type";
+
+export const getUserOOODetails = async (id: string) => {
+  try {
+    const userStatus = await fetch(`${RDS_BASE_API_URL}/users/status/${id}`);
+    const userStatusData: UserStatus = await userStatus.json();
+    return userStatusData;
+  } catch (err) {
+    return USER_STATUS_NOT_FOUND;
+  }
+};

tests/fixtures/fixture.ts

@@ -7,6 +7,7 @@ import {
 import { InteractionType } from "discord-interactions";
 import { UserBackend } from "../../src/typeDefinitions/userBackend.types";
 import { TaskOverdueResponse } from "../../src/typeDefinitions/taskOverdue.types";
+import { UserStatus } from "../../src/typeDefinitions/userStatus.type";
 
 export const dummyHelloMessage: discordMessageRequest = {
   type: InteractionType.APPLICATION_COMMAND,
@@ -194,3 +195,50 @@ export const taskOverdueMock: TaskOverdueResponse = {
     },
   ],
 };
+
+export const userStatusMock: UserStatus = {
+  id: "someId",
+  userId: "someUserId",
+  data: {
+    userId: "someUserId",
+    currentStatus: {
+      state: "OOO",
+      updatedAt: 1691398400000,
+      from: 1691398400000,
+      until: 1691484800000,
+      message: "Out of office message for today",
+    },
+    monthlyHours: {
+      committed: 40,
+      updatedAt: 1690956800000,
+    },
+  },
+  message: "User Status found successfully.",
+};
+
+export const userFutureStatusMock: UserStatus = {
+  id: "someId",
+  userId: "someUserId",
+  data: {
+    userId: "someUserId",
+    currentStatus: {
+      state: "ACTIVE",
+      updatedAt: 1691398400000,
+      from: 1691398400000,
+      until: 1691484800000,
+      message: "Out of office message for today",
+    },
+    futureStatus: {
+      state: "OOO",
+      updatedAt: 1691030400000,
+      from: 1691030400000,
+      until: 1691116800000,
+      message: "Upcoming out of office message",
+    },
+    monthlyHours: {
+      committed: 40,
+      updatedAt: 1690956800000,
+    },
+  },
+  message: "User Status found successfully.",
+};

tests/unit/utils/formatOOOMessage.test.ts

@@ -0,0 +1,50 @@
+import { UserStatus } from "../../../src/typeDefinitions/userStatus.type";
+import { formatOOOMessage } from "../../../src/utils/formatOOOMessage";
+import { userStatusMock, userFutureStatusMock } from "../../fixtures/fixture";
+
+describe("formatOOOMessage", () => {
+  it("formats an OOO message correctly when current status is OOO", () => {
+    const currentStatus = userStatusMock.data.currentStatus;
+    const currentFromDate = new Date(currentStatus.from).toDateString();
+    const currentToDate = new Date(currentStatus.until).toDateString();
+
+    const expectedMessage = `**Current**:\n${currentFromDate} - ${currentToDate}\n${currentStatus.message}\n`;
+    const result = formatOOOMessage(userStatusMock);
+
+    expect(result.replace(/\s/g, "")).toEqual(
+      expectedMessage.replace(/\s/g, "")
+    );
+  });
+
+  it("formats an OOO message correctly when the future status is OOO", () => {
+    const futureStatus = userFutureStatusMock.data.futureStatus;
+
+    const futureFromDate = new Date(futureStatus?.from).toDateString();
+    const futureToDate = new Date(futureStatus?.until).toDateString();
+
+    const expectedMessage = `**Upcoming**:\n${futureFromDate} - ${futureToDate}\n${futureStatus?.message}\n`;
+    const result = formatOOOMessage(userFutureStatusMock);
+
+    expect(result).toEqual(expectedMessage);
+  });
+
+  it('returns "No data found!" when no OOO statuses are provided', () => {
+    const userStatusData: UserStatus = {
+      ...userStatusMock,
+      data: {
+        ...userStatusMock.data,
+        currentStatus: {
+          state: "ACTIVE",
+          updatedAt: 1691398400000,
+          from: 1691398400000,
+          until: 1691484800000,
+          message: "Active status message",
+        },
+      },
+    };
+
+    const expectedMessage = `User is currently **${userStatusData.data.currentStatus.state}**`;
+    const result = formatOOOMessage(userStatusData);
+    expect(result).toEqual(expectedMessage);
+  });
+});