added endpoint for generating and getting discord invite for user (#1553)

* added enpoint for generating and getting discord invite for user

* changes in middleware and controller method

* changed discordNewComersChannelId constant

* tests for endpoint for getting  discord link generated for user

* tests for post API

* fix for failing tests

* fix for failing unit test

* types issue fixed

* model tests

* did suggested changes

* invite get model test changes

* removed the model test getInvite

* test description string change

* Update test/integration/discordactions.test.js

Co-authored-by: Satyam Bajpai <[email protected]>

* fix for failing tests

* fix for failing unit test

* made suggested changes

* updated one model test and added one model test for getInvite model

---------

Co-authored-by: Satyam Bajpai <[email protected]>
Co-authored-by: Prakash Choudhary <[email protected]>

Author: 3 people

config/development.js

@@ -10,6 +10,7 @@ module.exports = {
   port: port,
   enableFileLogs: false,
   enableConsoleLogs: true,
+  discordNewComersChannelId: "709080951824842783",
 
   services: {
     rdsApi: {

config/test.js

@@ -11,6 +11,7 @@ module.exports = {
   enableConsoleLogs: true,
   discordUnverifiedRoleId: "1234567890",
   discordDeveloperRoleId: "9876543210",
+  discordNewComersChannelId: "709080951824842783",
   discordMavenRoleId: "1212121212",
   githubOauth: {
     clientId: "clientId",

controllers/discordactions.js

@@ -403,6 +403,75 @@ const setRoleToUsersWith31DaysPlusOnboarding = async (req, res) => {
   }
 };
 
+const generateInviteForUser = async (req, res) => {
+  try {
+    const { userId } = req.query;
+    const userIdForInvite = userId || req.userData.id;
+
+    const modelResponse = await discordRolesModel.getUserDiscordInvite(userIdForInvite);
+
+    if (!modelResponse.notFound) {
+      return res.status(409).json({
+        message: "User invite is already present!",
+      });
+    }
+
+    const channelId = config.get("discordNewComersChannelId");
+    const authToken = jwt.sign({}, config.get("rdsServerlessBot.rdsServerLessPrivateKey"), {
+      algorithm: "RS256",
+      expiresIn: config.get("rdsServerlessBot.ttl"),
+    });
+
+    const inviteOptions = {
+      channelId: channelId,
+    };
+    const response = await fetch(`${DISCORD_BASE_URL}/invite`, {
+      method: "POST",
+      body: JSON.stringify(inviteOptions),
+      headers: { "Content-Type": "application/json", Authorization: `Bearer ${authToken}` },
+    });
+    const discordInviteResponse = await response.json();
+
+    const inviteCode = discordInviteResponse.data.code;
+    const inviteLink = `discord.gg/${inviteCode}`;
+
+    await discordRolesModel.addInviteToInviteModel({ userId: userIdForInvite, inviteLink });
+
+    return res.status(201).json({
+      message: "invite generated successfully",
+      inviteLink,
+    });
+  } catch (err) {
+    logger.error(`Error in generating invite for user: ${err}`);
+    return res.boom.badImplementation(INTERNAL_SERVER_ERROR);
+  }
+};
+
+const getUserDiscordInvite = async (req, res) => {
+  try {
+    const { userId } = req.query;
+    const isSuperUser = req.userData.roles.super_user;
+
+    if (userId && !isSuperUser) return res.boom.forbidden("User should be super user to get link for other users");
+
+    const userIdForInvite = userId || req.userData.id;
+
+    const invite = await discordRolesModel.getUserDiscordInvite(userIdForInvite);
+
+    if (invite.notFound) {
+      return res.boom.notFound("User invite doesn't exist");
+    }
+
+    return res.json({
+      message: "Invite returned successfully",
+      inviteLink: invite?.inviteLink,
+    });
+  } catch (err) {
+    logger.error(`Error in fetching user invite: ${err}`);
+    return res.boom.badImplementation(INTERNAL_SERVER_ERROR);
+  }
+};
+
 module.exports = {
   getGroupsRoleId,
   createGroupRole,
@@ -416,4 +485,6 @@ module.exports = {
   updateUsersNicknameStatus,
   syncDiscordGroupRolesInFirestore,
   setRoleToUsersWith31DaysPlusOnboarding,
+  getUserDiscordInvite,
+  generateInviteForUser,
 };

middlewares/checkCanGenerateDiscordLink.ts

@@ -0,0 +1,28 @@
+import { NextFunction } from "express";
+import { CustomRequest, CustomResponse } from "../types/global";
+
+const checkCanGenerateDiscordLink = async (req: CustomRequest, res: CustomResponse, next: NextFunction) => {
+  const { discordId, roles, id: userId, profileStatus } = req.userData;
+  const isSuperUser = roles.super_user;
+  const userIdInQuery = req.query.userId;
+
+  if (userIdInQuery && userIdInQuery !== userId && !isSuperUser) {
+    return res.boom.forbidden("User should be super user to generate link for other users");
+  }
+
+  if (discordId) {
+    return res.boom.forbidden("Only users who have never joined discord can generate invite link");
+  }
+
+  if (roles.archived) {
+    return res.boom.forbidden("Archived users cannot generate invite");
+  }
+
+  if (!roles.maven && !roles.designer && !roles.product_manager && profileStatus !== "VERIFIED") {
+    return res.boom.forbidden("Only selected roles can generate discord link directly");
+  }
+
+  return next();
+};
+
+module.exports = checkCanGenerateDiscordLink;

models/discordactions.js

@@ -2,6 +2,7 @@ const { generateDiscordProfileImageUrl } = require("../utils/discord-actions");
 const firestore = require("../utils/firestore");
 const discordRoleModel = firestore.collection("discord-roles");
 const memberRoleModel = firestore.collection("member-group-roles");
+const discordInvitesModel = firestore.collection("discord-invites");
 const admin = require("firebase-admin");
 const { findSubscribedGroupIds } = require("../utils/helper");
 const { retrieveUsers } = require("../services/dataAccessLayer");
@@ -830,6 +831,31 @@ const updateUsersWith31DaysPlusOnboarding = async () => {
   }
 };
 
+const addInviteToInviteModel = async (inviteObject) => {
+  try {
+    const invite = await discordInvitesModel.add(inviteObject);
+    return invite.id;
+  } catch (err) {
+    logger.error("Error in adding invite", err);
+    throw err;
+  }
+};
+
+const getUserDiscordInvite = async (userId) => {
+  try {
+    const invite = await discordInvitesModel.where("userId", "==", userId).get();
+    const [inviteDoc] = invite.docs;
+    if (inviteDoc) {
+      return { id: inviteDoc.id, ...inviteDoc.data(), notFound: false };
+    } else {
+      return { notFound: true };
+    }
+  } catch (err) {
+    logger.log("error in getting user invite", err);
+    throw err;
+  }
+};
+
 module.exports = {
   createNewRole,
   removeMemberGroup,
@@ -847,4 +873,6 @@ module.exports = {
   updateUsersNicknameStatus,
   updateIdle7dUsersOnDiscord,
   updateUsersWith31DaysPlusOnboarding,
+  getUserDiscordInvite,
+  addInviteToInviteModel,
 };

routes/discordactions.js

@@ -8,6 +8,8 @@ const {
   deleteRole,
   updateDiscordImageForVerification,
   setRoleIdleToIdleUsers,
+  getUserDiscordInvite,
+  generateInviteForUser,
   setRoleIdle7DToIdleUsers,
   updateDiscordNicknames,
   updateUsersNicknameStatus,
@@ -20,6 +22,7 @@ const {
   validateUpdateUsersNicknameStatusBody,
 } = require("../middlewares/validators/discordactions");
 const checkIsVerifiedDiscord = require("../middlewares/verifydiscord");
+const checkCanGenerateDiscordLink = require("../middlewares/checkCanGenerateDiscordLink");
 const { SUPERUSER } = require("../constants/roles");
 const authorizeRoles = require("../middlewares/authorizeRoles");
 const { verifyCronJob } = require("../middlewares/authorizeBot");
@@ -29,6 +32,8 @@ const router = express.Router();
 router.post("/groups", authenticate, checkIsVerifiedDiscord, validateGroupRoleBody, createGroupRole);
 router.get("/groups", authenticate, checkIsVerifiedDiscord, getAllGroupRoles);
 router.post("/roles", authenticate, checkIsVerifiedDiscord, validateMemberRoleBody, addGroupRoleToMember);
+router.get("/invite", authenticate, getUserDiscordInvite);
+router.post("/invite", authenticate, checkCanGenerateDiscordLink, generateInviteForUser);
 router.delete("/roles", authenticate, checkIsVerifiedDiscord, deleteRole);
 router.get("/roles", authenticate, checkIsVerifiedDiscord, getGroupsRoleId);
 router.patch(

test/fixtures/user/user.js

@@ -217,6 +217,7 @@ module.exports = () => {
         archived: false,
         member: true,
         in_discord: true,
+        designer: true,
       },
       twitter_id: "RitvikJamwal4u",
       linkedin_id: "ritvik-jamwal4u",
@@ -239,6 +240,7 @@ module.exports = () => {
         member: true,
         archived: false,
         in_discord: true,
+        product_manager: true,
       },
       picture: {
         publicId: "profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar",
@@ -261,6 +263,7 @@ module.exports = () => {
       },
       roles: {
         member: true,
+        maven: true,
       },
       picture: {
         publicId: "profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar",
@@ -411,5 +414,31 @@ module.exports = () => {
       updated_at: Date.now(),
       created_at: Date.now(),
     },
+    {
+      username: "Vinayak",
+      first_name: "Vinayak",
+      last_name: "Trivedi",
+      yoe: 2,
+      img: "./img.png",
+      linkedin_id: "_",
+      github_id: "xfasrfsd",
+      github_display_name: "vinayak-trivedi",
+      discordJoinedAt: "2023-04-06T01:47:34.488000+00:00",
+      phone: "1234567890",
+      email: "[email protected]",
+      status: "active",
+      tokens: {
+        githubAccessToken: "githubAccessToken",
+      },
+      roles: {
+        restricted: false,
+        app_owner: true,
+        archived: true,
+      },
+      picture: {
+        publicId: "profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar",
+        url: "https://res.cloudinary.com/realdevsquad/image/upload/v1667685133/profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar.jpg",
+      },
+    },
   ];
 };