[Feature] Add APIs for fetching role information

Author: bksh05

src/constants/responses.ts

@@ -27,3 +27,10 @@ export const ROLE_ADDED = "Role added successfully";
 export const NAME_CHANGED = "User nickname changed successfully";
 
 export const ROLE_REMOVED = "Role Removed successfully";
+
+export const ROLE_FETCH_FAILED_MESSAGE =
+  "Oops! We are experiencing an issue fetching roles.";
+
+export const ROLE_FETCH_FAILED_ERROR = {
+  error: ROLE_FETCH_FAILED_MESSAGE,
+};

src/controllers/guildRoleHandler.ts

@@ -6,6 +6,8 @@ import {
   addGroupRole,
   createGuildRole,
   removeGuildRole,
+  getGuildRoleByName,
+  getGuildRoles,
 } from "../utils/guildRole";
 import {
   createNewRole,
@@ -69,14 +71,52 @@ export async function removeGuildRoleHandler(request: IRequest, env: env) {
   }
 }
 export async function getGuildRolesHandler(request: IRequest, env: env) {
-  // To be implemented
-  return new JSONResponse(response.NOT_FOUND);
+  const authHeader = request.headers.get("Authorization");
+
+  if (!authHeader) {
+    return new JSONResponse(response.BAD_SIGNATURE, { status: 401 });
+  }
+  try {
+    await verifyAuthToken(authHeader, env);
+    const roles = await getGuildRoles(env);
+    return new JSONResponse({ roles });
+  } catch (err: any) {
+    if (err.message === response.ROLE_FETCH_FAILED_MESSAGE) {
+      return new JSONResponse(response.ROLE_FETCH_FAILED_ERROR, {
+        status: 500,
+      });
+    }
+    return new JSONResponse(response.INTERNAL_SERVER_ERROR, { status: 500 });
+  }
 }
 
 export async function getGuildRoleByRoleNameHandler(
   request: IRequest,
   env: env
 ) {
-  // To be implemented
-  return new JSONResponse(response.NOT_FOUND);
+  const authHeader = request.headers.get("Authorization");
+  const roleName = decodeURI(request.params?.roleName ?? "");
+
+  if (!authHeader) {
+    return new JSONResponse(response.BAD_SIGNATURE, { status: 401 });
+  }
+
+  if (!roleName) {
+    return new JSONResponse(response.NOT_FOUND, { status: 404 });
+  }
+  try {
+    await verifyAuthToken(authHeader, env);
+    const role = await getGuildRoleByName(roleName, env);
+    if (!role) {
+      return new JSONResponse(response.NOT_FOUND, { status: 404 });
+    }
+    return new JSONResponse(role);
+  } catch (err: any) {
+    if (err.message === response.ROLE_FETCH_FAILED_MESSAGE) {
+      return new JSONResponse(response.ROLE_FETCH_FAILED_ERROR, {
+        status: 500,
+      });
+    }
+    return new JSONResponse(response.INTERNAL_SERVER_ERROR, { status: 500 });
+  }
 }

src/index.ts

@@ -10,6 +10,7 @@ import {
   addGroupRoleHandler,
   createGuildRoleHandler,
   removeGuildRoleHandler,
+  getGuildRoleByRoleNameHandler,
   getGuildRolesHandler,
 } from "./controllers/guildRoleHandler";
 import { getMembersInServerHandler } from "./controllers/getMembersInServer";
@@ -31,8 +32,11 @@ router.put("/roles/create", createGuildRoleHandler);
 router.put("/roles/add", addGroupRoleHandler);
 
 router.delete("/roles", removeGuildRoleHandler);
+
 router.get("/roles", getGuildRolesHandler);
 
+router.get("/roles/:roleName", getGuildRoleByRoleNameHandler);
+
 router.get("/discord-members", getMembersInServerHandler);
 
 router.get("/member/:id", getGuildMemberDetailsHandler);

src/typeDefinitions/role.types.d.ts

@@ -2,3 +2,19 @@ export type GuildRole = {
   id: string;
   name: string;
 };
+
+export type GuildDetails = {
+  // This type defines the partial guild details response that we get from discord
+  id: string;
+  name: string;
+  roles: Array<{
+    id: string;
+    name: string;
+    permissions: string;
+    position: number;
+    color: number;
+    hoist: boolean;
+    managed: boolean;
+    mentionable: boolean;
+  }>;
+};

src/utils/guildRole.ts

@@ -2,6 +2,7 @@ import {
   INTERNAL_SERVER_ERROR,
   ROLE_ADDED,
   ROLE_REMOVED,
+  ROLE_FETCH_FAILED_MESSAGE,
 } from "../constants/responses";
 import { DISCORD_BASE_URL } from "../constants/urls";
 import { env } from "../typeDefinitions/default.types";
@@ -10,7 +11,7 @@ import {
   guildRoleResponse,
   memberGroupRole,
 } from "../typeDefinitions/discordMessage.types";
-import { GuildRole } from "../typeDefinitions/role.types";
+import { GuildDetails, GuildRole } from "../typeDefinitions/role.types";
 
 export async function createGuildRole(
   body: createNewRole,
@@ -86,17 +87,33 @@ export async function removeGuildRole(details: memberGroupRole, env: env) {
   }
 }
 
-
 export async function getGuildRoles(env: env): Promise<Array<GuildRole>> {
-  return [];
+  const guildDetailsUrl = `${DISCORD_BASE_URL}/guilds/${env.DISCORD_GUILD_ID}`;
+
+  const response = await fetch(guildDetailsUrl, {
+    method: "GET",
+    headers: {
+      "Content-Type": "application/json",
+      Authorization: `Bot ${env.DISCORD_TOKEN}`,
+    },
+  });
+
+  if (!response.ok) {
+    throw new Error(ROLE_FETCH_FAILED_MESSAGE);
+  }
+
+  const guildDetails: GuildDetails = await response.json();
+
+  return guildDetails.roles.map((role) => ({
+    id: role.id,
+    name: role.name,
+  }));
 }
 
 export async function getGuildRoleByName(
   roleName: string,
   env: env
-): Promise<GuildRole> {
-  return {
-    id: "dummy-id",
-    name: "dummy-name",
-  };
+): Promise<GuildRole | undefined> {
+  const roles = await getGuildRoles(env);
+  return roles.find((role) => role.name === roleName);
 }

tests/fixtures/fixture.ts

@@ -112,3 +112,30 @@ export const generateDummyRequestObject = ({
     headers: new Map(Object.entries(headers ?? {})),
   };
 };
+
+export const guildDetailsMock = {
+  id: "123434232324242424",
+  name: "test server",
+  roles: [
+    {
+      id: "1234567889",
+      name: "@everyone",
+      permissions: "",
+      position: 2,
+      color: 2,
+      hoist: true,
+      managed: true,
+      mentionable: true,
+    },
+    {
+      id: "12344567",
+      name: "bot one",
+      permissions: "",
+      position: 2,
+      color: 2,
+      hoist: true,
+      managed: true,
+      mentionable: true,
+    },
+  ],
+};