Using roles url of discord to get roles details

Author: bksh05

src/typeDefinitions/role.types.d.ts

@@ -1,20 +1,12 @@
 export type GuildRole = {
   id: string;
   name: string;
+  color: string;
+  hoist: boolean;
+  icon?: string;
+  position?: integer;
+  managed?: boolean;
+  mentionable?: boolean;
 };
 
-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;
-  }>;
-};
+export type Role = Pick<GuildRole, "id" | "name">;

src/utils/guildRole.ts

@@ -11,7 +11,7 @@ import {
   guildRoleResponse,
   memberGroupRole,
 } from "../typeDefinitions/discordMessage.types";
-import { GuildDetails, GuildRole } from "../typeDefinitions/role.types";
+import { GuildRole, Role } from "../typeDefinitions/role.types";
 
 export async function createGuildRole(
   body: createNewRole,
@@ -87,11 +87,11 @@ export async function removeGuildRole(details: memberGroupRole, env: env) {
   }
 }
 
-export async function getGuildRoles(env: env): Promise<Array<GuildRole>> {
-  const guildDetailsUrl = `${DISCORD_BASE_URL}/guilds/${env.DISCORD_GUILD_ID}`;
+export async function getGuildRoles(env: env): Promise<Array<Role>> {
+  const guildRolesUrl = `${DISCORD_BASE_URL}/guilds/${env.DISCORD_GUILD_ID}/roles`;
 
   try {
-    const response = await fetch(guildDetailsUrl, {
+    const response = await fetch(guildRolesUrl, {
       method: "GET",
       headers: {
         "Content-Type": "application/json",
@@ -103,9 +103,9 @@ export async function getGuildRoles(env: env): Promise<Array<GuildRole>> {
       throw new Error(ROLE_FETCH_FAILED);
     }
 
-    const guildDetails: GuildDetails = await response.json();
+    const guildRoles: Array<GuildRole> = await response.json();
 
-    return guildDetails.roles.map((role) => ({
+    return guildRoles.map((role) => ({
       id: role.id,
       name: role.name,
     }));
@@ -117,7 +117,7 @@ export async function getGuildRoles(env: env): Promise<Array<GuildRole>> {
 export async function getGuildRoleByName(
   roleName: string,
   env: env
-): Promise<GuildRole | undefined> {
+): Promise<Role | undefined> {
   const roles = await getGuildRoles(env);
   return roles?.find((role) => role.name === roleName);
 }

tests/fixtures/fixture.ts

@@ -135,9 +135,3 @@ export const rolesMock = [
     mentionable: true,
   },
 ];
-
-export const guildDetailsMock = {
-  id: "123434232324242424",
-  name: "test server",
-  roles: rolesMock,
-};

tests/unit/handlers/guildRoleHandler.test.ts

@@ -2,7 +2,7 @@ import {
   getGuildRoleByRoleNameHandler,
   getGuildRolesHandler,
 } from "../../../src/controllers/guildRoleHandler";
-import { GuildRole } from "../../../src/typeDefinitions/role.types";
+import { Role } from "../../../src/typeDefinitions/role.types";
 import JSONResponse from "../../../src/utils/JsonResponse";
 import {
   generateDummyRequestObject,
@@ -84,16 +84,14 @@ describe("get roles", () => {
       mockRequest,
       guildEnv
     );
-    const jsonResponse: { roles: Array<GuildRole> } = await response.json();
+    const jsonResponse: { roles: Array<Role> } = await response.json();
     expect(response.status).toBe(200);
     expect(Array.isArray(jsonResponse.roles)).toBeTruthy();
     expect(jsonResponse.roles.length).toBe(0);
   });
 
   it("should return array of id and name of roles present in guild", async () => {
-    const expectedResponse = rolesMock;
-    getGuildRolesSpy.mockResolvedValueOnce(expectedResponse);
-
+    getGuildRolesSpy.mockResolvedValueOnce(rolesMock);
     const mockRequest = generateDummyRequestObject({
       url: "/roles",
       headers: { Authorization: "Bearer testtoken" },
@@ -103,15 +101,15 @@ describe("get roles", () => {
       mockRequest,
       guildEnv
     );
-    const jsonResponse: { roles: Array<GuildRole> } = await response.json();
+    const jsonResponse: { roles: Array<Role> } = await response.json();
     expect(response.status).toBe(200);
     expect(Array.isArray(jsonResponse.roles)).toBeTruthy();
-    expect(jsonResponse.roles).toEqual(expectedResponse);
+    expect(jsonResponse.roles).toEqual(rolesMock);
   });
 });
 
 describe("get role by role name", () => {
-  beforeEach(() => {
+  afterEach(() => {
     jest.resetAllMocks();
   });
 
@@ -199,9 +197,9 @@ describe("get role by role name", () => {
       mockRequest,
       guildEnv
     );
-    const jsonResponse: { roles: Array<GuildRole> } = await response.json();
+    const role: Role = await response.json();
     expect(response.status).toBe(500);
-    expect(jsonResponse).toEqual({
+    expect(role).toEqual({
       error: responseConstants.ROLE_FETCH_FAILED,
     });
   });
@@ -221,15 +219,16 @@ describe("get role by role name", () => {
       mockRequest,
       guildEnv
     );
-    const jsonResponse: { roles: Array<GuildRole> } = await response.json();
+    const role: Role = await response.json();
     expect(response.status).toBe(500);
-    expect(jsonResponse).toEqual({
+    expect(role).toEqual({
       error: responseConstants.INTERNAL_SERVER_ERROR,
     });
   });
 
   it("should return object of id and name corresponding to the role name recieved", async () => {
-    getGuildRoleByNameSpy.mockResolvedValueOnce(rolesMock[0]);
+    const resultMock = { id: rolesMock[0].id, name: rolesMock[0].name };
+    getGuildRoleByNameSpy.mockResolvedValueOnce(resultMock);
 
     const mockRequest = generateDummyRequestObject({
       url: "/roles",
@@ -243,8 +242,8 @@ describe("get role by role name", () => {
       mockRequest,
       guildEnv
     );
-    const jsonResponse: { roles: Array<GuildRole> } = await response.json();
+    const role: Role = await response.json();
     expect(response.status).toBe(200);
-    expect(jsonResponse).toEqual(rolesMock[0]);
+    expect(role).toEqual(resultMock);
   });
 });

tests/unit/utils/guildRole.test.ts

@@ -10,8 +10,8 @@ import {
 import {
   dummyAddRoleBody,
   dummyCreateBody,
-  guildDetailsMock,
   guildEnv,
+  rolesMock,
 } from "../../fixtures/fixture";
 
 describe("createGuildRole", () => {
@@ -162,10 +162,10 @@ describe("getGuildRoles", () => {
     jest
       .spyOn(global, "fetch")
       .mockImplementationOnce(async () =>
-        Promise.resolve(new JSONResponse(guildDetailsMock))
+        Promise.resolve(new JSONResponse(rolesMock))
       );
     const roles = await getGuildRoles(guildEnv);
-    const expectedRoles = guildDetailsMock.roles.map(({ id, name }) => ({
+    const expectedRoles = rolesMock.map(({ id, name }) => ({
       id,
       name,
     }));
@@ -200,7 +200,7 @@ describe("getGuildRolesByName", () => {
     jest
       .spyOn(global, "fetch")
       .mockImplementationOnce(async () =>
-        Promise.resolve(new JSONResponse(guildDetailsMock))
+        Promise.resolve(new JSONResponse(rolesMock))
       );
     const role = await getGuildRoleByName("@everyone", guildEnv);
     const expectedRoles = {
@@ -214,7 +214,7 @@ describe("getGuildRolesByName", () => {
     jest
       .spyOn(global, "fetch")
       .mockImplementationOnce(async () =>
-        Promise.resolve(new JSONResponse(guildDetailsMock))
+        Promise.resolve(new JSONResponse(rolesMock))
       );
     const role = await getGuildRoleByName("everyone", guildEnv);
     expect(role).toBeUndefined();