Remove user.data() in firestore data set (#2282)

* Updated set

* Added Dev Feature Flag

* Added variable for dev flag

* Update dev feature flag to be used as boolean

* Tests working of addOrUpdate feature when dev feature flag is true

---------

Co-authored-by: Achintya Chatterjee <[email protected]>
Co-authored-by: Prakash Choudhary <[email protected]>

Author: 3 people

controllers/users.js

@@ -39,11 +39,12 @@ const discordDeveloperRoleId = config.get("discordDeveloperRoleId");
 
 const verifyUser = async (req, res) => {
   const userId = req.userData.id;
+  const devFeatureFlag = req.query.dev === "true";
   try {
     if (!req.userData?.profileURL) {
       return res.boom.serverUnavailable("ProfileURL is Missing");
     }
-    await userQuery.addOrUpdate({ profileStatus: "PENDING" }, userId);
+    await userQuery.addOrUpdate({ profileStatus: "PENDING" }, userId, devFeatureFlag);
   } catch (error) {
     logger.error(`Error while verifying user: ${error}`);
     return res.boom.serverUnavailable(SOMETHING_WENT_WRONG);
@@ -500,7 +501,7 @@ const updateSelf = async (req, res) => {
         const { roles } = discordMember;
         if (roles && roles.includes(discordDeveloperRoleId)) {
           if (req.body.disabledRoles && devFeatureFlag) {
-            const updatedUser = await userQuery.addOrUpdate({ disabled_roles: rolesToDisable }, userId);
+            const updatedUser = await userQuery.addOrUpdate({ disabled_roles: rolesToDisable }, userId, devFeatureFlag);
             if (updatedUser) {
               return res
                 .status(200)
@@ -514,7 +515,7 @@ const updateSelf = async (req, res) => {
       }
     }
 
-    const updatedUser = await userQuery.addOrUpdate(req.body, userId);
+    const updatedUser = await userQuery.addOrUpdate(req.body, userId, devFeatureFlag);
 
     if (!updatedUser.isNewUser) {
       // Success criteria, user finished the sign-up process.
@@ -711,9 +712,9 @@ const getUserImageForVerification = async (req, res) => {
 const updateUser = async (req, res) => {
   try {
     const { id: profileDiffId, message } = req.body;
-    const devFeatureFlag = req.query.dev;
+    const devFeatureFlag = req.query.dev === "true";
     let profileDiffData;
-    if (devFeatureFlag === "true") {
+    if (devFeatureFlag) {
       profileDiffData = await profileDiffsQuery.fetchProfileDiffUnobfuscated(profileDiffId);
     } else {
       profileDiffData = await profileDiffsQuery.fetchProfileDiff(profileDiffId);
@@ -728,7 +729,7 @@ const updateUser = async (req, res) => {
 
     await profileDiffsQuery.updateProfileDiff({ approval: profileDiffStatus.APPROVED }, profileDiffId);
 
-    await userQuery.addOrUpdate(profileDiff, userId);
+    await userQuery.addOrUpdate(profileDiff, userId, devFeatureFlag);
 
     const meta = {
       approvedBy: req.userData.id,
@@ -749,9 +750,9 @@ const updateUser = async (req, res) => {
 const generateChaincode = async (req, res) => {
   try {
     const { id } = req.userData;
-
+    const devFeatureFlag = req.query.dev === "true";
     const chaincode = await chaincodeQuery.storeChaincode(id);
-    await userQuery.addOrUpdate({ chaincode }, id);
+    await userQuery.addOrUpdate({ chaincode }, id, devFeatureFlag);
     return res.json({
       chaincode,
       message: "Chaincode returned successfully",
@@ -766,7 +767,8 @@ const profileURL = async (req, res) => {
   try {
     const userId = req.userData.id;
     const { profileURL } = req.body;
-    await userQuery.addOrUpdate({ profileURL }, userId);
+    const devFeatureFlag = req.query.dev === "true";
+    await userQuery.addOrUpdate({ profileURL }, userId, devFeatureFlag);
     return res.json({
       message: "updated profile URL!!",
     });
@@ -958,6 +960,7 @@ const setInDiscordScript = async (req, res) => {
 const updateRoles = async (req, res) => {
   try {
     const result = await dataAccess.retrieveUsers({ id: req.params.id });
+    const devFeatureFlag = req.query.dev === "true";
     if (result?.userExists) {
       const dataToUpdate = req.body;
       const roles = req?.userData?.roles;
@@ -966,7 +969,7 @@ const updateRoles = async (req, res) => {
 
       const response = await getRoleToUpdate(result.user, dataToUpdate);
       if (response.updateRole) {
-        await userQuery.addOrUpdate(response.newUserRoles, result.user.id);
+        await userQuery.addOrUpdate(response.newUserRoles, result.user.id, devFeatureFlag);
         if (dataToUpdate?.archived) {
           const body = {
             reason: reason || "",

models/users.js

@@ -84,7 +84,7 @@ const archiveUsers = async (usersData) => {
  * @param userId { String }: User Id String to be used to update the user
  * @return {Promise<{isNewUser: boolean, userId: string}|{isNewUser: boolean, userId: string}>}
  */
-const addOrUpdate = async (userData, userId = null) => {
+const addOrUpdate = async (userData, userId = null, devFeatureFlag) => {
   try {
     // userId exists Update user
     if (userId !== null) {
@@ -96,14 +96,24 @@ const addOrUpdate = async (userData, userId = null) => {
         if ("id" in userData) {
           delete userData.id;
         }
-        await userModel.doc(userId).set(
-          {
-            ...user.data(),
-            ...userData,
-            updated_at: Date.now(),
-          },
-          { merge: true }
-        );
+        if (devFeatureFlag) {
+          await userModel.doc(userId).set(
+            {
+              ...userData,
+              updated_at: Date.now(),
+            },
+            { merge: true }
+          );
+        } else {
+          await userModel.doc(userId).set(
+            {
+              ...user.data(),
+              ...userData,
+              updated_at: Date.now(),
+            },
+            { merge: true }
+          );
+        }
 
         const logData = {
           type: logType.USER_DETAILS_UPDATED,

test/unit/models/users.test.js

@@ -117,6 +117,31 @@ describe("users", function () {
     });
   });
 
+  describe("addOrUpdate-Dev Feature Flag", function () {
+    it("should update the user collection when userId is passed", async function () {
+      const userData1 = userDataArray[0];
+      const userData2 = userDataArray[1];
+      const updatedUserData = {};
+
+      Object.assign(updatedUserData, userData1, userData2);
+
+      // Add the user the first time
+      const { isNewUser, userId } = await users.addOrUpdate(userData1, null, true);
+
+      // Update the user with same data
+      const { isNewUser: updatedIsNewUserFlag } = await users.addOrUpdate(userData2, userId, true);
+
+      const data = (await userModel.doc(userId).get()).data();
+
+      Object.keys(updatedUserData).forEach((key) => {
+        expect(updatedUserData[key]).to.deep.equal(data[key]);
+      });
+
+      expect(isNewUser).to.equal(true);
+      expect(updatedIsNewUserFlag).to.equal(false);
+    });
+  });
+
   describe("fetch user details based on discord id", function () {
     let [userId0] = [];