Add a patch URL to change nickname (#44)

* add a patch url to change nickname

* add JWT Verification

* Update from develop and better coding practices

* add tests for nickname change

* improve test coverage

* remove console.log

* Change api name to a noun

* change api name to /guild/members

* Change response message of name changed

Author: RitikJaiswal75

src/constants/responses.ts

@@ -23,3 +23,5 @@ export const RETRY_COMMAND =
   "Oops, we didn't catch that! Please use the command again.";
 
 export const ROLE_ADDED = "Role added successfully";
+
+export const NAME_CHANGED = "User nickname changed successfully";

src/controllers/changeNickname.ts

@@ -0,0 +1,23 @@
+import { IRequest } from "itty-router";
+import { env } from "../typeDefinitions/default.types";
+import JSONResponse from "../utils/JsonResponse";
+import * as response from "../constants/responses";
+import { verifyAuthToken } from "../utils/verifyAuthToken";
+import { updateNickName } from "../utils/updateNickname";
+
+export async function changeNickname(request: IRequest, env: env) {
+  const authHeader = await request.headers.get("Authorization");
+
+  if (!authHeader) {
+    return new JSONResponse(response.BAD_SIGNATURE);
+  }
+
+  try {
+    await verifyAuthToken(authHeader, env);
+    const { discordId, userName } = await request.json();
+    const res = await updateNickName(discordId, userName, env);
+    return new JSONResponse(res);
+  } catch {
+    return new JSONResponse(response.BAD_SIGNATURE);
+  }
+}

src/index.ts

@@ -11,6 +11,7 @@ import {
   createGuildRoleHandler,
 } from "./controllers/guildRoleHandler";
 import { getMembersInServerHandler } from "./controllers/getMembersInServer";
+import { changeNickname } from "./controllers/changeNickname";
 
 const router = Router();
 
@@ -20,6 +21,8 @@ router.get("/", async () => {
   });
 });
 
+router.patch("/guild/member", changeNickname);
+
 router.put("/roles/create", createGuildRoleHandler);
 
 router.put("/roles/add", addGroupRoleHandler);

src/utils/updateNickname.ts

@@ -1,4 +1,4 @@
-import { INTERNAL_SERVER_ERROR } from "../constants/responses";
+import { INTERNAL_SERVER_ERROR, NAME_CHANGED } from "../constants/responses";
 import { DISCORD_BASE_URL } from "../constants/urls";
 import { env } from "../typeDefinitions/default.types";
 
@@ -19,13 +19,9 @@ export async function updateNickName(
       body: JSON.stringify(data),
     });
     if (nameChangeResponse.ok) {
-      return await nameChangeResponse.json();
-    } else {
-      console.log(nameChangeResponse.json());
-      return INTERNAL_SERVER_ERROR;
+      return NAME_CHANGED;
     }
   } catch (error) {
-    console.log(error);
     return INTERNAL_SERVER_ERROR;
   }
 }

tests/unit/utils/updateNickname.test.ts

@@ -0,0 +1,71 @@
+import {
+  INTERNAL_SERVER_ERROR,
+  NAME_CHANGED,
+} from "../../../src/constants/responses";
+import { DISCORD_BASE_URL } from "../../../src/constants/urls";
+import JSONResponse from "../../../src/utils/JsonResponse";
+import { updateNickName } from "../../../src/utils/updateNickname";
+
+describe("Update nickname", () => {
+  const mockEnv = {
+    BOT_PUBLIC_KEY: "xyz",
+    DISCORD_GUILD_ID: "123",
+    DISCORD_TOKEN: "abc",
+  };
+
+  const mockData = { discordId: "12345678910111213", nickname: "jhon" };
+
+  test("updatenickname fetch is called with expected parameters", async () => {
+    const data = { nick: mockData.nickname };
+
+    jest
+      .spyOn(global, "fetch")
+      .mockImplementation(() =>
+        Promise.resolve(new JSONResponse(NAME_CHANGED))
+      );
+
+    const response = await updateNickName(
+      mockData.discordId,
+      mockData.nickname,
+      mockEnv
+    );
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      `${DISCORD_BASE_URL}/guilds/${mockEnv.DISCORD_GUILD_ID}/members/${mockData.discordId}`,
+      {
+        method: "PATCH",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+        },
+        body: JSON.stringify(data),
+      }
+    );
+
+    expect(response).toEqual(NAME_CHANGED);
+  });
+
+  test("Return Internal server error for improper body", async () => {
+    jest
+      .spyOn(global, "fetch")
+      .mockRejectedValue(() =>
+        Promise.resolve(new JSONResponse({ INTERNAL_SERVER_ERROR }))
+      );
+
+    const response = await updateNickName(mockData.discordId, "", mockEnv);
+
+    expect(response).toEqual(INTERNAL_SERVER_ERROR);
+
+    expect(global.fetch).toHaveBeenCalledWith(
+      `${DISCORD_BASE_URL}/guilds/${mockEnv.DISCORD_GUILD_ID}/members/${mockData.discordId}`,
+      {
+        method: "PATCH",
+        headers: {
+          "Content-Type": "application/json",
+          Authorization: `Bot ${mockEnv.DISCORD_TOKEN}`,
+        },
+        body: JSON.stringify({ nick: "" }),
+      }
+    );
+  });
+});