Updated function definition and calling signature for addOrUpdate function for users collection

controllers/external-accounts.js

@@ -48,7 +48,7 @@ const getExternalAccountData = async (req, res) => {
 };
 const linkExternalAccount = async (req, res) => {
   try {
-    const { id: userId, roles } = req.userData;
+    const { id: userId } = req.userData;
 
     const externalAccountData = await externalAccountsModel.fetchExternalAccountData(req.query, req.params.token);
     if (!externalAccountData.id) {
@@ -62,7 +62,7 @@ const linkExternalAccount = async (req, res) => {
 
     await addOrUpdate(
       {
-        roles: { ...roles, in_discord: true },
+        "roles.in_discord": true,
         discordId: attributes.discordId,
         discordJoinedAt: attributes.discordJoinedAt,
       },
@@ -85,52 +85,33 @@ const linkExternalAccount = async (req, res) => {
 const syncExternalAccountData = async (req, res) => {
   try {
     const [discordUserData, rdsUserData] = await Promise.all([getDiscordMembers(), retrieveDiscordUsers()]);
-    const rdsUserDataMap = {};
     const updateUserDataPromises = [];
     const userUpdatedWithInDiscordFalse = [];
     const updateArchivedPromises = [];
 
-    rdsUserData.forEach((rdsUser) => {
-      rdsUserDataMap[rdsUser.discordId] = {
-        id: rdsUser.id,
-        roles: rdsUser.roles,
-      };
-    });
-
     for (const rdsUser of rdsUserData) {
       const discordUser = discordUserData.find((discordUser) => discordUser.user.id === rdsUser.discordId);
-
       let userData = {};
       if (rdsUser.roles?.in_discord && !discordUser) {
         userData = {
-          roles: {
-            ...rdsUser.roles,
-            in_discord: false,
-          },
+          "roles.in_discord": false,
         };
         userUpdatedWithInDiscordFalse.push(rdsUser);
       } else if (discordUser) {
         userData = {
           discordJoinedAt: discordUser.joined_at,
-          roles: {
-            ...rdsUser.roles,
-            in_discord: true,
-          },
+          "roles.in_discord": true,
         };
       }
       updateUserDataPromises.push(addOrUpdate(userData, rdsUser.id));
     }
 
     await Promise.all(updateUserDataPromises);
-
     const inDiscordUsers = await getUsersByRole("in_discord");
     inDiscordUsers.forEach((user) => {
       if (user.roles.archived === true) {
         const userData = {
-          roles: {
-            ...user.roles,
-            archived: false,
-          },
+          "roles.archived": false,
         };
         updateArchivedPromises.push(addOrUpdate(userData, user.id));
       }

controllers/staging.js

@@ -1,24 +1,16 @@
 const { addOrUpdate, getUsersByRole } = require("../models/users");
+const { flattenObject } = require("../utils/flattenObject");
 
 const updateRoles = async (req, res) => {
   try {
-    const userData = await req.userData;
     if (process.env.NODE_ENV === "production") {
       return res.status(403).json({
         message: "FORBIDDEN | To be used only in staging and development",
       });
     }
     const userId = req.userData.id;
-    await addOrUpdate(
-      {
-        roles: {
-          ...userData.roles,
-          ...req.body,
-        },
-        updated_at: Date.now(),
-      },
-      userId
-    );
+    const rolesToBeAdded = flattenObject({ roles: req.body });
+    await addOrUpdate(rolesToBeAdded, userId);
     return res.status(200).json({
       message: "Roles Updated successfully",
     });
@@ -42,28 +34,13 @@ const removePrivileges = async (req, res) => {
     const superUsers = await getUsersByRole("super_user");
 
     members.forEach((member) => {
-      updateUserPromises.push(
-        addOrUpdate(
-          {
-            roles: {
-              ...member.roles,
-              member: false,
-            },
-            updated_at: Date.now(),
-          },
-          member.id
-        )
-      );
+      updateUserPromises.push(addOrUpdate({ "roles.member": false }, member.id));
     });
     superUsers.forEach((superUser) => {
       updateUserPromises.push(
         addOrUpdate(
           {
-            roles: {
-              ...superUser.roles,
-              super_user: false,
-            },
-            updated_at: Date.now(),
+            "roles.super_user": false,
           },
           superUser.id
         )

controllers/users.js

@@ -29,6 +29,7 @@ const {
 const { addLog } = require("../models/logs");
 const { getUserStatus } = require("../models/userStatus");
 const config = require("config");
+const { flattenObject } = require("../utils/flattenObject");
 const discordDeveloperRoleId = config.get("discordDeveloperRoleId");
 
 const verifyUser = async (req, res) => {
@@ -420,7 +421,8 @@ const updateSelf = async (req, res) => {
       }
     }
 
-    const updatedUser = await userQuery.addOrUpdate(req.body, userId);
+    const updatePayload = flattenObject(req.body);
+    const updatedUser = await userQuery.addOrUpdate(updatePayload, userId);
 
     if (!updatedUser.isNewUser) {
       // Success criteria, user finished the sign-up process.
@@ -837,7 +839,8 @@ const updateRoles = async (req, res) => {
 
       const response = await getRoleToUpdate(result.user, dataToUpdate);
       if (response.updateRole) {
-        await userQuery.addOrUpdate(response.newUserRoles, result.user.id);
+        const rolesToBeUpdated = flattenObject(response.newUserRoles);
+        await userQuery.addOrUpdate(rolesToBeUpdated, result.user.id);
         if (dataToUpdate?.archived) {
           const body = {
             reason: reason || "",

models/users.js

@@ -39,14 +39,9 @@ const addOrUpdate = async (userData, userId = null) => {
       const isNewUser = !user.data();
       // user exists update user
       if (user.data()) {
-        await userModel.doc(userId).set(
-          {
-            ...user.data(),
-            ...userData,
-            updated_at: Date.now(),
-          },
-          { merge: true }
-        );
+        const userRef = userModel.doc(userId);
+        userData.updated_at = Date.now();
+        await userRef.update(userData);
       }
 
       return { isNewUser, userId };

test/integration/users.test.js

@@ -39,6 +39,7 @@ const cookieName = config.get("userToken.cookieName");
 const { userPhotoVerificationData } = require("../fixtures/user/photo-verification");
 const Sinon = require("sinon");
 const { INTERNAL_SERVER_ERROR, SOMETHING_WENT_WRONG } = require("../../constants/errorMessages");
+const { flattenObject } = require("../../utils/flattenObject");
 const photoVerificationModel = firestore.collection("photo-verification");
 
 chai.use(chaiHttp);
@@ -2111,9 +2112,10 @@ describe("Users", function () {
         archived: true,
         in_discord: false,
       };
-      await addOrUpdate({ ...userData[0], roles }, userId1);
-      await addOrUpdate({ ...userData[1], roles }, userId2);
-      await addOrUpdate({ ...userData[2], roles }, userId3);
+      const newRolesToBeAdded = flattenObject({ roles: roles });
+      await addOrUpdate(newRolesToBeAdded, userId1);
+      await addOrUpdate(newRolesToBeAdded, userId2);
+      await addOrUpdate(newRolesToBeAdded, userId3);
 
       const res = await chai
         .request(app)

test/unit/utils/flattenObject.test.ts

@@ -0,0 +1,43 @@
+const { expect } = require("chai");
+import { flattenObject } from "../../../utils/flattenObject";
+
+describe("flattenObject", function () {
+  it("flattenObject should flatten nested objects", () => {
+    const input = {
+      key1: "value1",
+      key2: {
+        key3: "value2",
+        key4: {
+          key5: "value3",
+        },
+      },
+    };
+    const expectedOutput = {
+      key1: "value1",
+      "key2.key3": "value2",
+      "key2.key4.key5": "value3",
+    };
+    const result = flattenObject(input);
+    expect(result).to.deep.equal(expectedOutput);
+  });
+
+  it("flattenObject should handle empty input", () => {
+    const input = {};
+    const expectedOutput = {};
+    const result = flattenObject(input);
+    expect(result).to.deep.equal(expectedOutput);
+  });
+
+  it("flattenObject should handle arrays", () => {
+    const input = {
+      key1: "value1",
+      key2: ["value2", "value3"],
+    };
+    const expectedOutput = {
+      key1: "value1",
+      key2: ["value2", "value3"],
+    };
+    const result = flattenObject(input);
+    expect(result).to.deep.equal(expectedOutput);
+  });
+});

test/utils/addUser.js

@@ -1,4 +1,5 @@
 const users = require("../../models/users");
+const { flattenObject } = require("../../utils/flattenObject");
 
 // Import fixtures
 const userData = require("../fixtures/user/user")();
@@ -23,10 +24,8 @@ module.exports = async (user) => {
   const { userId } = await users.addOrUpdate(userWithoutRoles);
 
   if (rolesToBeAdded) {
-    const persistedUser = (await users.fetchUser({ userId })).user;
-    const existingRoles = persistedUser.roles;
-    const rolesToBeUpdated = { ...existingRoles, ...rolesToBeAdded };
-    await users.addOrUpdate({ roles: rolesToBeUpdated }, userId);
+    const rolesToBeUpdated = flattenObject({ roles: rolesToBeAdded });
+    await users.addOrUpdate(rolesToBeUpdated, userId);
   }
   return userId;
 };

utils/flattenObject.ts

@@ -0,0 +1,27 @@
+/**
+ * Recursively flattens an object with nested objects and arrays into a single-depth object.
+ *
+ * @param {object} obj - The object to flatten.
+ * @param {string} [parentKey=""] - The parent key for nested objects.
+ * @return {object} The flattened object.
+ */
+
+export function flattenObject(obj, parentKey = "") {
+  return Object.keys(obj).reduce((acc, key) => {
+    const newKey = parentKey ? `${parentKey}.${key}` : key;
+    if (Array.isArray(obj[key])) {
+      acc[newKey] = obj[key].map((item, index) => {
+        if (typeof item === "object" && item !== null) {
+          return flattenObject(item, `${newKey}[${index}]`);
+        } else {
+          return item;
+        }
+      });
+    } else if (typeof obj[key] === "object" && obj[key] !== null) {
+      Object.assign(acc, flattenObject(obj[key], newKey));
+    } else {
+      acc[newKey] = obj[key];
+    }
+    return acc;
+  }, {});
+}