FEAT: ephemeral response message for /verify command (#51)

* FEAT: Epheremal text response add

* FEAT: retry command error message add

* FEAT: replaced discord dm with discord epheremal message function

* Fix: remove unused import

* Fix: typo epheremal to ephemeral fix

* TEST: tests add for discordEphemeralResponse .ts file

* REFACTOR: token update to dummy

* Fix: remove headers, second parameter for env and typo errors

* ENHANCE: responseJson interface update

* TEST ENHANCE: discordEphemeralResponse test suits update

* REFACTOR: add comments for better code quality

Author: samyakshah3008

src/constants/responses.ts

@@ -18,3 +18,6 @@ export const COMMAND_NOT_FOUND = "Command Not Found";
 
 export const INTERNAL_SERVER_ERROR =
   "Oops! We have encountered an internal Server Error";
+
+export const RETRY_COMMAND =
+  "Oops, we didn't catch that! Please use the command again.";

src/controllers/verifyCommand.ts

@@ -1,8 +1,8 @@
 import config from "../../config/config";
+import { RETRY_COMMAND } from "../constants/responses";
 import { env } from "../typeDefinitions/default.types";
-import { discordTextResponse } from "../utils/discordResponse";
+import { discordEphemeralResponse } from "../utils/discordEphemeralResponse";
 import { generateUniqueToken } from "../utils/generateUniqueToken";
-import { sendDiscordDm } from "../utils/sendDiscordDm";
 import { sendUserDiscordData } from "../utils/sendUserDiscordData";
 
 export async function verifyCommand(
@@ -22,12 +22,11 @@ export async function verifyCommand(
     discriminator,
     env
   );
-  if (response?.status === 201) {
+  if (response?.status === 201 || response?.status === 200) {
     const verificationSiteURL = config(env).VERIFICATION_SITE_URL;
     const message = `${verificationSiteURL}/discord?token=${token}`;
-    await sendDiscordDm(userId, env, message);
-    return discordTextResponse("Please check the DM");
+    return discordEphemeralResponse(message);
   } else {
-    return discordTextResponse("Error, please use the verify command again. ");
+    return discordEphemeralResponse(RETRY_COMMAND);
   }
 }

src/typeDefinitions/default.types.d.ts

@@ -20,5 +20,6 @@ export interface responseJson {
   type: number;
   data: {
     content: string;
+    flags?: number;
   };
 }

src/utils/discordEphemeralResponse.ts

@@ -0,0 +1,11 @@
+import { InteractionResponseType } from "discord-interactions";
+import JSONResponse from "./JsonResponse";
+export const discordEphemeralResponse = (reply: string): JSONResponse => {
+  return new JSONResponse({
+    type: InteractionResponseType.CHANNEL_MESSAGE_WITH_SOURCE,
+    data: {
+      content: reply,
+      flags: 64, // for ephemeral messages, flags value 64 will generate an ephemeral response. "1 << 6" is converted to integer.
+    },
+  });
+};

tests/unit/discordEphemeralResponse.test.ts

@@ -0,0 +1,43 @@
+import { InteractionResponseType } from "discord-interactions";
+import { responseJson } from "../../src/typeDefinitions/default.types";
+import JSONResponse from "../../src/utils/JsonResponse";
+import { discordEphemeralResponse } from "../../src/utils/discordEphemeralResponse";
+
+describe("Test discordEphemeralResponse function", () => {
+  it("should return a JSONResponse", () => {
+    const response = discordEphemeralResponse("Hello");
+    expect(response).toBeInstanceOf(JSONResponse);
+  });
+  it("Should have type as channelMessageWithSource", async () => {
+    const response: responseJson = await discordEphemeralResponse(
+      "Hello"
+    ).json();
+    expect(response?.type).toBe(
+      InteractionResponseType.CHANNEL_MESSAGE_WITH_SOURCE
+    );
+  });
+  it("Should contain a content property in data", async () => {
+    const response: responseJson = await discordEphemeralResponse(
+      "Hello"
+    ).json();
+    expect(response?.data).toHaveProperty("content");
+  });
+  it("Should have content as hello", async () => {
+    const response: responseJson = await discordEphemeralResponse(
+      "Hello"
+    ).json();
+    expect(response?.data.content).toBe("Hello");
+  });
+  it("Should contain a flag property in data", async () => {
+    const response: responseJson = await discordEphemeralResponse(
+      "Hello"
+    ).json();
+    expect(response?.data).toHaveProperty("flags");
+  });
+  it("Should have flag as 64", async () => {
+    const response: responseJson = await discordEphemeralResponse(
+      "Hello"
+    ).json();
+    expect(response?.data.flags).toBe(64);
+  });
+});