Fix: Disable discord-actions/invite routes (#2435)

* feat: Add short-circuit middleware to disable invite routes temporarily

* fix: Temporarily skip tests for invite routes in Discord actions

* fix: Correct wording in server unavailable message for disabled route

Author: prakashchoudhary07

middlewares/shortCircuit.ts

@@ -0,0 +1,8 @@
+import { NextFunction } from "express";
+import { CustomRequest, CustomResponse } from "../types/global";
+
+export const disableRoute = (_req: CustomRequest, res: CustomResponse, _next: NextFunction) => {
+  return res.boom.serverUnavailable(
+    "This route has been temporarily disabled. If you need assistance, please reach out to the team."
+  );
+};

routes/discordactions.js

@@ -31,14 +31,24 @@ const ROLES = require("../constants/roles");
 const { Services } = require("../constants/bot");
 const { verifyCronJob } = require("../middlewares/authorizeBot");
 const { authorizeAndAuthenticate } = require("../middlewares/authorizeUsersAndService");
+const { disableRoute } = require("../middlewares/shortCircuit");
 const router = express.Router();
 
 router.post("/groups", authenticate, checkIsVerifiedDiscord, validateGroupRoleBody, createGroupRole);
 router.get("/groups", authenticate, checkIsVerifiedDiscord, validateLazyLoadingParams, getPaginatedAllGroupRoles);
 router.delete("/groups/:groupId", authenticate, checkIsVerifiedDiscord, authorizeRoles([SUPERUSER]), deleteGroupRole);
 router.post("/roles", authenticate, checkIsVerifiedDiscord, validateMemberRoleBody, addGroupRoleToMember);
-router.get("/invite", authenticate, getUserDiscordInvite);
-router.post("/invite", authenticate, checkCanGenerateDiscordLink, generateInviteForUser);
+/**
+ * Short-circuit the GET method for this endpoint
+ * Refer https://github.com/Real-Dev-Squad/todo-action-items/issues/269 for more details.
+ */
+router.get("/invite", disableRoute, authenticate, getUserDiscordInvite);
+/**
+ * Short-circuit this POST method for this endpoint
+ * Refer https://github.com/Real-Dev-Squad/todo-action-items/issues/269 for more details.
+ */
+router.post("/invite", disableRoute, authenticate, checkCanGenerateDiscordLink, generateInviteForUser);
+
 router.delete("/roles", authenticate, checkIsVerifiedDiscord, deleteRole);
 router.get("/roles", authenticate, checkIsVerifiedDiscord, getGroupsRoleId);
 router.patch(

test/integration/discordactions.test.js

@@ -952,7 +952,8 @@ describe("Discord actions", function () {
     });
   });
 
-  describe("GET /discord-actions/invite", function () {
+  // eslint-disable-next-line mocha/no-skipped-tests
+  describe.skip("GET /discord-actions/invite", function () {
     it("should return the invite for the user if no userId is provided in the params and the invite exists", async function () {
       await addInviteToInviteModel({ userId: superUserId, inviteLink: "discord.gg/apQYT7HB" });
 
@@ -994,7 +995,8 @@ describe("Discord actions", function () {
   });
 
   // <------ Will revisit this later https://github.com/Real-Dev-Squad/website-backend/issues/2078 --->
-  describe("POST /discord-actions/invite", function () {
+  // eslint-disable-next-line mocha/no-skipped-tests
+  describe.skip("POST /discord-actions/invite", function () {
     afterEach(function () {
       sinon.restore();
     });