Dev to main sync (RealDevSquad#135)

* 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

---------

Co-authored-by: FMK2312 <[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]>

Author: 5 people

src/constants/commands.ts

@@ -40,3 +40,16 @@ export const LISTENING = {
     },
   ],
 };
+
+export const TASK = {
+  name: "task",
+  description: "display the task of the user",
+  options: [
+    {
+      name: "username",
+      description: "Nickname of the user",
+      type: 6,
+      required: true,
+    },
+  ],
+};

src/constants/responses.ts

@@ -47,3 +47,9 @@ export const LISTENING_SUCCESS_MESSAGE =
 export const REMOVED_LISTENING_MESSAGE = "Listening nickname removed.";
 export const ALREADY_LISTENING = "You are already set to listen.";
 export const NOTHING_CHANGED = "Your nickname remains unchanged.";
+
+export const INVALID_NICKNAME_ERROR =
+  "Please set your discord server nickname or contact the Moderators.";
+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}}**.`;

src/constants/urls.ts

@@ -12,3 +12,5 @@ export const STAGING_VERIFICATION_SITE_URL =
 
 export const RDS_TRACKING_CHANNEL_URL =
   "https://discord.com/api/v10/channels/1136650427878871090/messages";
+
+export const RDS_STATUS_SITE_URL = "https://status.realdevsquad.com";

src/controllers/baseHandler.ts

@@ -2,6 +2,7 @@ import { commandNotFound } from "./commandNotFound";
 import { helloCommand } from "./helloCommand";
 import { verifyCommand } from "./verifyCommand";
 import { mentionEachUser } from "./mentionEachUser";
+import { taskCommand } from "./taskCommand";
 
 import { getCommandName } from "../utils/getCommandName";
 import JSONResponse from "../utils/JsonResponse";
@@ -13,7 +14,13 @@ import {
   messageRequestDataOptions,
 } from "../typeDefinitions/discordMessage.types";
 
-import { HELLO, LISTENING, MENTION_EACH, VERIFY } from "../constants/commands";
+import {
+  HELLO,
+  LISTENING,
+  MENTION_EACH,
+  VERIFY,
+  TASK,
+} from "../constants/commands";
 import { updateNickName } from "../utils/updateNickname";
 import { discordEphemeralResponse } from "../utils/discordEphemeralResponse";
 import { removeListening } from "../utils/removeListening";
@@ -105,6 +112,10 @@ export async function baseHandler(
         return discordEphemeralResponse(RETRY_COMMAND);
       }
     }
+    case getCommandName(TASK): {
+      const data = message.data?.options as Array<messageRequestDataOptions>;
+      return await taskCommand(data[0].value, env);
+    }
     default: {
       return commandNotFound();
     }

src/controllers/taskCommand.ts

@@ -0,0 +1,42 @@
+import { task } from "../typeDefinitions/task.types";
+import { formatTask, generateTaskResponseMessage } from "../utils/formatTask";
+import { discordTextResponse } from "../utils/discordResponse";
+import { fetchTasks } from "../utils/fetchTasks";
+import { getUserDetails } from "../utils/getUserDetails";
+import {
+  INVALID_NICKNAME_ERROR,
+  NO_TASKS_FOUND,
+  TASKS_FETCH_FAILED,
+} from "../constants/responses";
+
+export async function taskCommand(userId: string) {
+  const status = "IN_PROGRESS";
+  try {
+    const userData = await getUserDetails(userId);
+    if (!userData.user) {
+      return discordTextResponse(INVALID_NICKNAME_ERROR);
+    }
+    const username = userData.user.username;
+    const tasksData = await fetchTasks(username, status);
+
+    if (!tasksData.tasks) {
+      const errorMessage = NO_TASKS_FOUND.replace("{{username}}", username);
+      return discordTextResponse(errorMessage);
+    }
+
+    const formattedTasks = tasksData.tasks.map((task: task) =>
+      formatTask(task)
+    );
+
+    const responseMessage = generateTaskResponseMessage(
+      username,
+      formattedTasks,
+      status
+    );
+
+    return discordTextResponse(responseMessage);
+  } catch (error) {
+    console.error(error);
+    return discordTextResponse(TASKS_FETCH_FAILED);
+  }
+}

src/index.ts

@@ -81,10 +81,7 @@ export default {
     return router.handle(request, env);
   },
 
-  //keeping these code under comment until we patch the pagination
-  //of overdue tasks API
-
-  // async scheduled(req: Request, env: env, ctx: ExecutionContext) {
-  //   ctx.waitUntil(send(env));
-  // },
+  async scheduled(req: Request, env: env, ctx: ExecutionContext) {
+    ctx.waitUntil(send(env));
+  },
 };

src/register.ts

@@ -1,4 +1,10 @@
-import { HELLO, LISTENING, MENTION_EACH, VERIFY } from "./constants/commands";
+import {
+  HELLO,
+  MENTION_EACH,
+  VERIFY,
+  LISTENING,
+  TASK,
+} from "./constants/commands";
 import { config } from "dotenv";
 import { DISCORD_BASE_URL } from "./constants/urls";
 import { registerCommands } from "./utils/registerCommands";
@@ -17,7 +23,7 @@ async function registerGuildCommands(
   discordApplicationId?: string,
   discordGuildId?: string
 ) {
-  const commands = [HELLO, VERIFY, MENTION_EACH, LISTENING];
+  const commands = [HELLO, VERIFY, MENTION_EACH, LISTENING, TASK];
 
   try {
     if (!discordBotToken) throw new Error("Please provide a BOT TOKEN");
@@ -28,7 +34,7 @@ async function registerGuildCommands(
     const registrationUrl = `${DISCORD_BASE_URL}/applications/${discordApplicationId}/guilds/${discordGuildId}/commands`;
     await registerCommands(registrationUrl, discordBotToken, commands);
   } catch (e) {
-    console.log(e);
+    console.error(e);
   }
 }
 

src/typeDefinitions/rdsUser.ts

@@ -0,0 +1,44 @@
+export type UserType = {
+  id: string;
+  profileURL?: string;
+  discordJoinedAt?: string;
+  roles: {
+    archived: boolean;
+    in_discord: boolean;
+    member?: boolean;
+  };
+  created_at?: number;
+  yoe?: number;
+  github_created_at?: number;
+  updated_at: number;
+  company?: string;
+  twitter_id?: string;
+  first_name: string;
+  incompleteUserDetails: boolean;
+  website?: string;
+  discordId?: string;
+  last_name: string;
+  linkedin_id?: string;
+  picture?: {
+    publicId: string;
+    url: string;
+  };
+  instagram_id?: string;
+  github_display_name?: string;
+  github_id?: string;
+  designation?: string;
+  username: string;
+  profileStatus?: string;
+};
+
+export type UserResponseType = {
+  message: string;
+  users?: UserType[];
+  user?: UserType;
+};
+
+export type UserListResponseType = {
+  message: string;
+  count: number;
+  users: string[];
+};

src/typeDefinitions/task.types.d.ts

@@ -0,0 +1,32 @@
+export type task = {
+  id: string;
+  title: string;
+  type: string;
+  endsOn: number;
+  status: string;
+  assignee?: string;
+  percentCompleted: number;
+  dependsOn: string[];
+  participants?: string[];
+  createdBy: string;
+  github?: {
+    issue: {
+      assignee?: string;
+      status: string;
+      id: number;
+      closedAt?: string;
+      assigneeRdsInfo?: {
+        firstName: string | null | undefined;
+        lastName: string | null | undefined;
+        username: string;
+      };
+    };
+  };
+};
+
+export type TasksResponseType = {
+  message?: string;
+  tasks: task[];
+  next?: string;
+  prev?: string;
+};

src/utils/fetchTasks.ts

@@ -0,0 +1,22 @@
+import { FAILED_TO_FETCH_TASKS } from "../constants/responses";
+import { RDS_BASE_API_URL } from "../constants/urls";
+import { TasksResponseType } from "../typeDefinitions/task.types";
+
+async function fetchTasks(assignee: string, status: string) {
+  try {
+    const url = `${RDS_BASE_API_URL}/tasks?status=${status}&assignee=${assignee}&dev=true`;
+    const response = await fetch(url);
+
+    if (!response.ok) {
+      throw new Error(FAILED_TO_FETCH_TASKS.replace("{{assignee}}", assignee));
+    }
+
+    const responseData: TasksResponseType = await response.json();
+    return responseData;
+  } catch (error) {
+    console.error("An error occurred while fetching tasks:", error);
+    throw error;
+  }
+}
+
+export { fetchTasks };