FEATURE : /notify command (RealDevSquad#138)

* FEATURE: add code chages for notify command

* REFACTOR: removed duplicate types and refactor

* REFACTOR: add new  types for user and refactor

* FIX: add new function to get dicord ID from response and fix response message

* REFACTOR: added choices for command type

* REFACTOR: create constants for message

* ENHANCEMENT: added util function doc comments

* ENHANCEMENT: added util function doc comments

* TEST: test and mock data added for utils functions

* TYPO: removed console from index file

* Update commands.ts

Author: sahsisunny

src/constants/commands.ts

@@ -79,3 +79,50 @@ export const USER = {
     },
   ],
 };
+
+export const NOTIFY = {
+  name: "notify",
+  description: "notify the user",
+  options: [
+    {
+      name: "type",
+      description: "type of notification",
+      type: 3,
+      required: true,
+      choices: [
+        {
+          name: "OVERDUE",
+          value: "OVERDUE",
+        },
+        {
+          name: "ONBOARDING",
+          value: "ONBOARDING",
+        },
+      ],
+    },
+    {
+      name: "sub-type",
+      description: "sub-type of notification",
+      type: 3,
+      required: false,
+      choices: [
+        {
+          name: "In 1 Day",
+          value: "1",
+        },
+        {
+          name: "In 2 Day",
+          value: "2",
+        },
+        {
+          name: "> 7 Days",
+          value: "7",
+        },
+        {
+          name: "> 31 Days",
+          value: "31",
+        },
+      ],
+    },
+  ],
+};

src/constants/responses.ts

@@ -55,3 +55,11 @@ 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";
+
+export const OVERDUE_DEFAULT_MESSAGE = "You have overdue tasks.";
+export const OVERDUE_CUSTOM_MESSAGE =
+  "Please be aware that you currently have tasks that are overdue or due within the next {{days}} day. If you require additional time to complete these tasks, kindly submit an extension request.";
+
+export const ONBOARDING_DEFAULT_MESSAGE = `You currently have an onboarding status. Please provide an update explaining any challenges you're facing in completing your tasks. If you're finished, consider assigning new tasks to Admin.`;
+
+export const ONBOARDING_CUSTOM_MESSAGE = `Please update your status explaining why you are unable to complete your onboarding tasks within {{days}} days.`;

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 { notifyCommand } from "./notifyCommand";
 import { oooCommand } from "./oooCommand";
 import { userCommand } from "./userCommand";
 
@@ -22,6 +23,7 @@ import {
   MENTION_EACH,
   VERIFY,
   TASK,
+  NOTIFY,
   OOO,
   USER,
 } from "../constants/commands";
@@ -118,7 +120,11 @@ export async function baseHandler(
     }
     case getCommandName(TASK): {
       const data = message.data?.options as Array<messageRequestDataOptions>;
-      return await taskCommand(data[0].value, env);
+      return await taskCommand(data[0].value);
+    }
+    case getCommandName(NOTIFY): {
+      const data = message.data?.options as Array<messageRequestDataOptions>;
+      return await notifyCommand(data);
     }
     case getCommandName(OOO): {
       const data = message.data?.options as Array<messageRequestDataOptions>;

src/controllers/notifyCommand.ts

@@ -0,0 +1,66 @@
+import {
+  OVERDUE_DEFAULT_MESSAGE,
+  OVERDUE_CUSTOM_MESSAGE,
+  ONBOARDING_DEFAULT_MESSAGE,
+  ONBOARDING_CUSTOM_MESSAGE,
+} from "../constants/responses";
+import {
+  UserOverdueTaskResponseType,
+  UserResponseType,
+} from "../typeDefinitions/rdsUser";
+import { discordTextResponse } from "../utils/discordResponse";
+import { fetchRdsData } from "../utils/fetchRdsData";
+import { createTaggableDiscordIds } from "../utils/createTaggableDiscordIds";
+import { extractDiscordIds } from "../utils/extractDiscordIds";
+
+export async function notifyCommand(data: Array<{ value: string }>) {
+  const typeValue = data[0].value;
+  const daysValue = data[1]?.value;
+
+  try {
+    if (typeValue === "OVERDUE") {
+      const options = {
+        isOverdue: true,
+        days: daysValue,
+      };
+      const usersResponse = (await fetchRdsData(
+        options
+      )) as UserOverdueTaskResponseType;
+      const discordIDs = extractDiscordIds(usersResponse);
+      const formattedIds = createTaggableDiscordIds(discordIDs);
+
+      const message = `**Message:** ${
+        daysValue
+          ? OVERDUE_CUSTOM_MESSAGE.replace("{{days}}", daysValue)
+          : OVERDUE_DEFAULT_MESSAGE
+      }`;
+
+      const users = `**Developers:** ${formattedIds.join(", ")}`;
+      const responseMessage = `${message}\n${users}`;
+      return discordTextResponse(responseMessage);
+    } else if (typeValue === "ONBOARDING") {
+      const options = {
+        isOnboarding: true,
+        days: daysValue,
+      };
+      const users = (await fetchRdsData(options)) as UserResponseType;
+      const discordIDs = extractDiscordIds(users);
+      const formattedIds = createTaggableDiscordIds(discordIDs);
+
+      const message = `**Message:** ${
+        daysValue
+          ? ONBOARDING_CUSTOM_MESSAGE.replace("{{days}}", daysValue)
+          : ONBOARDING_DEFAULT_MESSAGE
+      }`;
+
+      const usersMessage = `**Developers:** ${formattedIds.join(", ")}`;
+      const responseMessage = `${message}\n${usersMessage}`;
+      return discordTextResponse(responseMessage);
+    }
+    const responseMessage = "Please provide a valid type";
+    return discordTextResponse(responseMessage);
+  } catch (error) {
+    console.error(error);
+    return discordTextResponse("Something went wrong");
+  }
+}

src/register.ts

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

src/typeDefinitions/rdsUser.ts

@@ -1,3 +1,4 @@
+import { task } from "./task.types";
 export type UserType = {
   id: string;
   profileURL?: string;
@@ -43,3 +44,16 @@ export type UserListResponseType = {
   count: number;
   users: string[];
 };
+
+export type UserOverdueTask = {
+  id: string;
+  discordId: string;
+  username: string;
+  tasks?: task[];
+};
+
+export type UserOverdueTaskResponseType = {
+  message: string;
+  count: number;
+  users: UserOverdueTask[];
+};

src/utils/createTaggableDiscordIds.ts

@@ -0,0 +1,9 @@
+/**
+ * Creates a taggable discord id from a list of discord ids
+ * @param discordIds - List of discord ids to be formatted eg: ["123", "456", "789"]
+ * @returns A list of taggable discord ids eg: ["<@123>", "<@456>", "<@789>"]
+ */
+export function createTaggableDiscordIds(discordIds: string[]) {
+  const formattedIds = discordIds.map((id) => `<@${id}>`);
+  return formattedIds;
+}

src/utils/extractDiscordIds.ts

@@ -0,0 +1,26 @@
+import {
+  UserOverdueTaskResponseType,
+  UserResponseType,
+  UserOverdueTask,
+  UserType,
+} from "../typeDefinitions/rdsUser";
+
+/**
+ * Extracts discord IDs from a UserResponseType or UserOverdueTaskResponseType which fetches data from the RDS API
+ * @param usersResponse - A UserResponseType or UserOverdueTaskResponseType
+ * @returns A list of discord IDs eg: ["123", "456", "789"]
+ */
+
+export function extractDiscordIds(
+  usersResponse: UserOverdueTaskResponseType | UserResponseType
+): string[] {
+  const userData = usersResponse?.users;
+  const discordIDs: string[] = [];
+  userData?.forEach((user: UserOverdueTask | UserType) => {
+    const discordId = user?.discordId;
+    if (discordId) {
+      discordIDs.push(discordId);
+    }
+  });
+  return discordIDs;
+}

src/utils/fetchRdsData.ts

@@ -0,0 +1,52 @@
+import { RDS_BASE_API_URL } from "../constants/urls";
+import {
+  UserResponseType,
+  UserOverdueTaskResponseType,
+} from "../typeDefinitions/rdsUser";
+
+/**
+ * Fetches user(s) from RDS API based on the options provided
+ * @param {Object} options - Options object
+ * @param {string} options.days - Number of days
+ * @param {boolean} options.isOnboarding - Whether to fetch onboarding users
+ * @param {boolean} options.isOverdue - Whether to fetch overdue task users
+ * @returns {Promise<UserResponseType | UserOverdueTaskResponseType>} - User(s) response
+ * @throws {Error} - Error object
+ */
+
+type OptionsType = {
+  days?: string;
+  isOnboarding?: boolean;
+  isOverdue?: boolean;
+};
+
+async function fetchRdsData(options = {}) {
+  try {
+    const { days, isOnboarding, isOverdue }: OptionsType = options;
+    let url = RDS_BASE_API_URL;
+
+    if (isOnboarding) {
+      url += days
+        ? `/users/search?state=ONBOARDING&time=${days}d`
+        : `/users/search?state=ONBOARDING`;
+    } else if (isOverdue) {
+      url += days
+        ? `/users?query=filterBy:overdue_tasks+days:${days}`
+        : `/users?query=filterBy:overdue_tasks`;
+    }
+    const response = await fetch(url);
+
+    if (isOnboarding) {
+      const responseData: UserResponseType = await response.json();
+      return responseData;
+    } else if (isOverdue) {
+      const responseData: UserOverdueTaskResponseType = await response.json();
+      return responseData;
+    }
+  } catch (error) {
+    console.error("An error occurred while fetching user(s):", error);
+    throw error;
+  }
+}
+
+export { fetchRdsData };