feat: image service integrated with feature flag

constants/imageVerificationTypes.ts

@@ -1,3 +1,3 @@
-const IMAGE_VERIFICATION_TYPES = ["profile", "discord"];
+const IMAGE_VERIFICATION_TYPES = ["profile", "discord", "both"];
 
 module.exports = { IMAGE_VERIFICATION_TYPES };

constants/users.ts

@@ -1,3 +1,9 @@
+const photoVerificationRequestStatus = {
+  PENDING: "PENDING",
+  APPROVED: "APPROVED",
+  REJECTED: "REJECTED",
+};
+
 const profileStatus = {
   PENDING: "PENDING",
   APPROVED: "APPROVED",
@@ -61,4 +67,5 @@ module.exports = {
   months,
   discordNicknameLength,
   SIMULTANEOUS_WORKER_CALLS,
+  photoVerificationRequestStatus
 };

controllers/discordactions.js

@@ -193,8 +193,8 @@
  */
 const updateDiscordImageForVerification = async (req, res) => {
   try {
-    const { id: userDiscordId } = req.params;
-    const discordAvatarUrl = await discordRolesModel.updateDiscordImageForVerification(userDiscordId);
+    const { discordId } = req.params;
+    const discordAvatarUrl = await discordRolesModel.updateDiscordImageForVerification(discordId);
     return res.json({
       message: "Discord avatar URL updated successfully!",
       discordAvatarUrl,
@@ -290,7 +290,7 @@
     const nickNameUpdatedUsers = [];
     let counter = 0;
     for (let i = 0; i < usersToBeEffected.length; i++) {
       const { discordId, username, first_name: firstName } = usersToBeEffected[i];
       try {
         if (counter % 10 === 0 && counter !== 0) {
           await new Promise((resolve) => setTimeout(resolve, 5500));
@@ -306,7 +306,7 @@
           if (message) {
             counter++;
             totalNicknamesUpdated.count++;
             nickNameUpdatedUsers.push(usersToBeEffected[i].id);
           }
         }
       } catch (error) {

controllers/users.js

@@ -443,9 +443,10 @@ const updateSelf = async (req, res) => {
  */
 const postUserPicture = async (req, res) => {
   const { file } = req;
+  const { dev } = req.query;
   const { id: userId, discordId } = req.userData;
   const { coordinates } = req.body;
-  let discordAvatarUrl = "";
+  let discordAvatarUrl;
   let imageData;
   let verificationResult;
   try {
@@ -456,17 +457,26 @@ const postUserPicture = async (req, res) => {
   }
   try {
     const coordinatesObject = coordinates && JSON.parse(coordinates);
-    imageData = await imageService.uploadProfilePicture({ file, userId, coordinates: coordinatesObject });
+    imageData = await imageService.uploadProfilePicture({ file, userId, coordinates: coordinatesObject }, dev);
   } catch (error) {
     logger.error(`Error while adding profile picture of user: ${error}`);
     return res.boom.badImplementation(INTERNAL_SERVER_ERROR);
   }
-  try {
-    verificationResult = await userQuery.addForVerification(userId, discordId, imageData.url, discordAvatarUrl);
-  } catch (error) {
-    logger.error(`Error while adding profile picture of user: ${error}`);
-    return res.boom.badImplementation(INTERNAL_SERVER_ERROR);
+  if (dev) {
+    try {
+      verificationResult = await userQuery.addForVerification(
+        userId,
+        discordId,
+        imageData.url,
+        discordAvatarUrl,
+        imageData.publicId
+      );
+    } catch (error) {
+      logger.error(`Error while adding profile picture of user: ${error}`);
+      return res.boom.badImplementation(INTERNAL_SERVER_ERROR);
+    }
   }
+
   return res.status(201).json({
     message: `Profile picture uploaded successfully! ${verificationResult.message}`,
     image: imageData,
@@ -482,11 +492,12 @@ const postUserPicture = async (req, res) => {
 
 const verifyUserImage = async (req, res) => {
   try {
-    const { type: imageType } = req.query;
-    const { id: userId } = req.params;
-    await userQuery.markAsVerified(userId, imageType);
-    return res.json({
-      message: `${imageType} image was verified successfully!`,
+    const { type: imageType, status } = req.query;
+    const { userId } = req.params;
+
+    const verificationResponse = await userQuery.changePhotoVerificationStatus(userId, imageType, status);
+    return res.status(200).json({
+      message: verificationResponse,
     });
   } catch (error) {
     logger.error(`Error while verifying image of user: ${error}`);
@@ -565,20 +576,45 @@ const markUnverified = async (req, res) => {
  * @param res {Object} - Express response object
  */
 
-const getUserImageForVerification = async (req, res) => {
+const getUserPhotoVerificationRequests = async (req, res) => {
   try {
-    const { id: userId } = req.params;
-    const userImageVerificationData = await userQuery.getUserImageForVerification(userId);
+    const { userId } = req.params;
+    const userData = req.userData;
+    if ((userData.id !== userId && !userData.roles[ROLES.SUPERUSER]) || !userId) {
+      return res.boom.unauthorized("You are not authorized to view this user's image verification data");
+    }
+    const userImageVerificationData = await userQuery.getUserPhotoVerificationRequests(userId);
     return res.json({
       message: "User image verification record fetched successfully!",
-      data: userImageVerificationData,
+      data: userImageVerificationData[0],
     });
   } catch (error) {
-    logger.error(`Error while verifying image of user: ${error}`);
+    logger.error(`Error while querying image of user: ${error}`);
     return res.boom.badImplementation(INTERNAL_SERVER_ERROR);
   }
 };
 
+/**
+ * Updates the user data
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+
+const getAllUsersPhotoVerificationRequests = async (req, res) => {
+  const { username } = req.query;
+  try {
+    const userImageVerificationData = await userQuery.getAllUsersPhotoVerificationRequests(username);
+    return res.json({
+      message: "User image verification record fetched successfully!",
+      data: userImageVerificationData,
+    });
+  } catch (error) {
+    logger.error(`Error while querying image of user: ${error}`);
+    return res.boom.badImplementation(`Error while querying image verification data for ${username}`);
+  }
+};
+
 /**
  * Updates the user data
  *
@@ -954,7 +990,8 @@ module.exports = {
   getUserSkills,
   filterUsers,
   verifyUserImage,
-  getUserImageForVerification,
+  getAllUsersPhotoVerificationRequests,
+  getUserPhotoVerificationRequests,
   nonVerifiedDiscordUsers,
   setInDiscordScript,
   markUnverified,

middlewares/authenticate.js

@@ -56,7 +56,6 @@ module.exports = async (req, res, next) => {
     // add user data to `req.userData` for further use
     const userData = await dataAccess.retrieveUsers({ id: userId });
     req.userData = userData.user;
-
     return checkRestricted(req, res, next);
   } catch (err) {
     logger.error(err);

middlewares/validators/user.js

@@ -5,6 +5,7 @@ const {
   USER_STATUS,
   USERS_PATCH_HANDLER_ACTIONS,
   USERS_PATCH_HANDLER_ERROR_MESSAGES,
+  photoVerificationRequestStatus,
 } = require("../../constants/users");
 const ROLES = require("../../constants/roles");
 const { IMAGE_VERIFICATION_TYPES } = require("../../constants/imageVerificationTypes");
@@ -251,11 +252,16 @@ async function validateUserQueryParams(req, res, next) {
  * @param next {Object} - Express middleware function
  */
 const validateImageVerificationQuery = async (req, res, next) => {
-  const { type: imageType } = req.query;
+  const { type: imageType, status } = req.query;
   try {
     if (!IMAGE_VERIFICATION_TYPES.includes(imageType)) {
       throw new Error("Invalid verification type was provided!");
     }
+
+    if (status !== photoVerificationRequestStatus.APPROVED && status !== photoVerificationRequestStatus.REJECTED) {
+      throw new Error("Invalid verification status was provided!");
+    }
+
     next();
   } catch (error) {
     logger.error(`Error validating createLevel payload : ${error}`);

models/discordactions.js

@@ -9,7 +9,7 @@
 const { BATCH_SIZE_IN_CLAUSE } = require("../constants/firebase");
 const { getAllUserStatus, getGroupRole, getUserStatus } = require("./userStatus");
 const { userState } = require("../constants/userStatus");
-const { ONE_DAY_IN_MS, SIMULTANEOUS_WORKER_CALLS } = require("../constants/users");
+const { ONE_DAY_IN_MS, SIMULTANEOUS_WORKER_CALLS, photoVerificationRequestStatus } = require("../constants/users");
 const userModel = firestore.collection("users");
 const photoVerificationModel = firestore.collection("photo-verification");
 const dataAccess = require("../services/dataAccessLayer");
@@ -215,9 +215,13 @@
 const updateDiscordImageForVerification = async (userDiscordId) => {
   try {
     const discordAvatarUrl = await generateDiscordProfileImageUrl(userDiscordId);
-    const verificationDataSnapshot = await photoVerificationModel.where("discordId", "==", userDiscordId).get();
+    const verificationDataSnapshot = await photoVerificationModel
+      .where("discordId", "==", userDiscordId)
+      .where("status", "==", photoVerificationRequestStatus.PENDING)
+      .get();
     const unverifiedUserDiscordImage = {
       discord: { url: discordAvatarUrl, approved: false, date: admin.firestore.Timestamp.fromDate(new Date()) },
+      profile: { approved: false, date: admin.firestore.Timestamp.fromDate(new Date()) },
     };
     if (verificationDataSnapshot.empty) {
       throw new Error("No user verification record found");
@@ -490,7 +494,7 @@
 
     for (let i = 0; i < nicknameUpdateBatches.length; i++) {
       const promises = [];
       const usersStatusDocsBatch = nicknameUpdateBatches[i];
       usersStatusDocsBatch.forEach((document) => {
         const doc = document.data();
         const userId = doc.userId;