fix: eslint issue

Author: surajmaity1

config/custom-environment-variables.js

@@ -88,6 +88,10 @@ module.exports = {
       __name: "USER_TOKEN_REFRESH_TTL",
       __format: "number",
     },
+    impersonationTtl: {
+      __name: "USER_TOKEN_IMPERSONATION_TTL",
+      __format: "number",
+    },
     publicKey: "PUBLIC_KEY",
     privateKey: "PRIVATE_KEY",
   },

config/default.js

@@ -86,6 +86,7 @@ module.exports = {
     cookieV2Name: `rds-session-v2-${NODE_ENV}`,
     ttl: 30 * 24 * 60 * 60, // in seconds
     refreshTtl: 180 * 24 * 60 * 60, // in seconds
+    impersonationTtl: 15 * 60, // in seconds
     publicKey: "<publicKey>",
     privateKey: "<privateKey>",
   },

constants/requests.ts

@@ -68,3 +68,9 @@ export const INVALID_REQUEST_TYPE = "Invalid request type";
 export const INVALID_REQUEST_DEADLINE = "New deadline of the request must be greater than old deadline";
 export const REQUEST_UPDATED_SUCCESSFULLY = "Request updated successfully";
 export const UNAUTHORIZED_TO_UPDATE_REQUEST = "Unauthorized to update request";
+
+export const FEATURE_NOT_IMPLEMENTED = "Feature not implemented";
+
+export const IMPERSONATION_NOT_COMPLETED = "Please complete impersonation before creating a new request";
+export const IMPERSONATION_ALREADY_ATTEMPTED = "No active request is available for impersonation";
+export const IMPERSONATION_REQUEST_NOT_APPROVED = "Awaiting approval for impersonation request";

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,7 @@ describe("Discord actions", function () {
     });
   });
 
-  describe("GET /discord-actions/invite", function () {
+  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 +994,7 @@ describe("Discord actions", function () {
   });
 
   // <------ Will revisit this later https://github.com/Real-Dev-Squad/website-backend/issues/2078 --->
-  describe("POST /discord-actions/invite", function () {
+  describe.skip("POST /discord-actions/invite", function () {
     afterEach(function () {
       sinon.restore();
     });

types/impersonationRequest.d.ts

@@ -0,0 +1,81 @@
+import { Request, Response } from "express";
+import { REQUEST_STATE } from "../constants/requests";
+import { Boom } from "express-boom";
+import {RequestQuery } from "./requests";
+import { userData } from "./global";
+import { Timestamp } from "firebase-admin/firestore";
+
+export type ImpersonationRequest = {
+    id: string;
+    status: REQUEST_STATE;
+    isImpersonationFinished: boolean;
+    createdBy: string;
+    createdFor: string;
+    userId: string;
+    reason: string;
+    message?: string;
+    impersonatedUserId: string;
+    createdAt: Timestamp;
+    updatedAt: Timestamp;
+    startedAt?: Timestamp;
+    endedAt?: Timestamp;
+}
+
+export type CreateImpersonationRequestBody = {
+   impersonatedUserId: string;
+   reason: string;
+};
+
+export type CreateImpersonationRequestModelBody = {
+    status: REQUEST_STATE;
+    isImpersonationFinished: boolean;
+    createdBy: string;
+    createdFor: string;
+    userId: string;
+    reason: string;
+    impersonatedUserId: string;
+}
+
+export type UpdateImpersonationRequestDataBody = {
+    startedAt?: Timestamp;
+    endedAt: Timestamp;
+    isImpersonationFinished?: boolean;
+}
+
+export type UpdateImpersonationRequestStatusBody = {
+    status: REQUEST_STATE.APPROVED | REQUEST_STATE.REJECTED;
+    message?: string;
+}
+
+export type ImpersonationRequestQuery = RequestQuery & {
+    dev?: string;
+};
+
+export type ImpersonationRequestResponse = Response & {
+    boom: Boom;
+};
+
+export type RequestParams = {
+    id: string;
+}
+
+export type CreateImpersonationRequest = Request & {
+   userData: userData;
+   body: CreateImpersonationRequestBody;
+   query: ImpersonationRequestQuery;
+};
+
+export type UpdateImpersonationRequestStatus = Request & {
+    userData: userData;
+    body: UpdateImpersonationRequestStatusBody;
+    query: ImpersonationRequestQuery;
+    params: RequestParams;
+}
+
+export type PaginatedImpersonationRequests = {
+    allRequests: ImpersonationRequest[];
+    next: string;
+    prev: string;
+    page: number;
+    count: number;
+}