Feature/one time user colors

constants/cardColorArray.js

@@ -0,0 +1,12 @@
+module.exports = [
+  { color_primary: "#DB1212", color_secondary: "#F88181" },
+  { color_primary: "#E9C46A", color_secondary: "#FFE094" },
+  { color_primary: "#F4A261", color_secondary: "#FFBF8C" },
+  { color_primary: "#2A9D8F", color_secondary: "#42E0CD" },
+  { color_primary: "#165692", color_secondary: "#3D8BD3" },
+  { color_primary: "#264653", color_secondary: "#387892" },
+  { color_primary: "#B93160", color_secondary: "#D75281" },
+  { color_primary: "#A5C9CA", color_secondary: "#E7F6F2" },
+  { color_primary: "#6E85B7", color_secondary: "#B2C8DF" },
+  { color_primary: "#FBA1A1", color_secondary: "#FBC5C5" },
+];

controllers/migrations.js

@@ -0,0 +1,27 @@
+const userQuery = require("../models/users");
+const logger = require("../utils/logger");
+
+/**
+ * Returns the lists of usernames where default colors were added
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+
+const addDefaultColors = async (req, res) => {
+  try {
+    const addedDefaultColorsData = await userQuery.addDefaultColors();
+
+    return res.json({
+      message: "User colors updated successfully!",
+      ...addedDefaultColorsData,
+    });
+  } catch (error) {
+    logger.error(`Error adding default colors to users: ${error}`);
+    return res.boom.badImplementation("Something went wrong. Please contact admin");
+  }
+};
+
+module.exports = {
+  addDefaultColors,
+};

models/users.js

@@ -7,7 +7,8 @@ const walletConstants = require("../constants/wallets");
 const firestore = require("../utils/firestore");
 const { fetchWallet, createWallet } = require("../models/wallets");
 const userModel = firestore.collection("users");
-
+const cardColorArray = require("../constants/cardColorArray");
+const { addColorsProperty } = require("../utils/users");
 /**
  * Adds or updates the user data
  *
@@ -188,6 +189,39 @@ const fetchUserImage = async (users) => {
   return images;
 };
 
+/**
+ * Adds default archived role
+ * @return {Promise<usersMigrated|Object>}
+ */
+
+const addDefaultColors = async () => {
+  try {
+    const usersSnapshot = await userModel.get();
+    const migratedUsers = [];
+    const updateUserPromises = [];
+    const usersArr = [];
+
+    usersSnapshot.forEach((doc) => usersArr.push({ id: doc.id, ...doc.data() }));
+
+    for (const user of usersArr) {
+      const colors = user.colors ? user.colors : {};
+      if (user.colors === undefined) {
+        const userColorIndex = addColorsProperty(cardColorArray);
+
+        colors.primary_color = cardColorArray[parseInt(userColorIndex)].color_primary;
+        colors.secondary_color = cardColorArray[parseInt(userColorIndex)].color_secondary;
+        updateUserPromises.push(userModel.doc(user.id).set({ ...user, colors }));
+        migratedUsers.push(user.username);
+      }
+    }
+    await Promise.all(updateUserPromises);
+    return { count: migratedUsers.length, users: migratedUsers };
+  } catch (err) {
+    logger.error("Error adding default colors to users", err);
+    throw err;
+  }
+};
+
 module.exports = {
   addOrUpdate,
   fetchUsers,
@@ -196,4 +230,5 @@ module.exports = {
   initializeUser,
   updateUserPicture,
   fetchUserImage,
+  addDefaultColors,
 };

routes/index.js

@@ -17,5 +17,6 @@ app.use("/trade", require("./trading.js"));
 app.use("/users", require("./users.js"));
 app.use("/profileDiffs", require("./profileDiffs.js"));
 app.use("/wallet", require("./wallets.js"));
+app.use("/migrations", require("./migrations.js"));
 
 module.exports = app;

routes/migrations.js

@@ -0,0 +1,10 @@
+const express = require("express");
+const router = express.Router();
+const authenticate = require("../middlewares/authenticate");
+const authorizeRoles = require("../middlewares/authorizeRoles");
+const { SUPERUSER } = require("../constants/roles");
+const migrations = require("../controllers/migrations");
+
+router.patch("/addDefaultColorProperty", authenticate, authorizeRoles([SUPERUSER]), migrations.addDefaultColors);
+
+module.exports = router;

test/fixtures/user/user.js

@@ -115,6 +115,10 @@ module.exports = () => {
         app_owner: true,
         archived: true,
       },
+      colors: {
+        primary_color: "#DB1212",
+        secondary_color: "#F88181",
+      },
     },
     {
       username: "mehul",

test/integration/users.test.js

@@ -11,6 +11,9 @@ const cleanDb = require("../utils/cleanDb");
 const userData = require("../fixtures/user/user")();
 const profileDiffData = require("../fixtures/profileDiffs/profileDiffs")();
 const superUser = userData[4];
+const nonSuperUser = userData[0];
+const userWithColorProperty = [userData[5].username];
+const colorBearingUsernames = [superUser.username, nonSuperUser.username];
 
 const config = require("config");
 const cookieName = config.get("userToken.cookieName");
@@ -22,11 +25,12 @@ describe("Users", function () {
   let superUserId;
   let superUserAuthToken;
   let userId = "";
-
+  let nonSuperUserId = "";
   beforeEach(async function () {
     userId = await addUser();
     jwt = authService.generateAuthToken({ userId });
     superUserId = await addUser(superUser);
+    nonSuperUserId = await addUser(nonSuperUser);
     superUserAuthToken = authService.generateAuthToken({ userId: superUserId });
   });
 
@@ -565,4 +569,48 @@ describe("Users", function () {
         });
     });
   });
+
+  describe("PATCH /users/addDefaultColorProperty", function () {
+    it("Should return 401 if user is not a super user", function (done) {
+      const nonSuperUserJwt = authService.generateAuthToken({ userId: nonSuperUserId });
+      chai
+        .request(app)
+        .patch(`/users/addDefaultColorProperty`)
+        .set("cookie", `${cookieName}=${nonSuperUserJwt}`)
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+          expect(res).to.have.status(401);
+          expect(res.body).to.be.a("object");
+          expect(res.body.message).to.equal("You are not authorized for this action.");
+          return done();
+        });
+    });
+    it("Should add default color property to all users,using authorized user (super_user)", function (done) {
+      chai
+        .request(app)
+        .patch(`/users/addDefaultColorProperty`)
+        .set("cookie", `${cookieName}=${superUserAuthToken}`)
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+          expect(res).to.have.status(200);
+          expect(res.body.count).to.be.equal(colorBearingUsernames.length);
+          const migratedUsernames = res.body.users;
+
+          expect(migratedUsernames).to.include(
+            colorBearingUsernames[0],
+            "Should add default color property to user without color property"
+          );
+
+          expect(migratedUsernames).to.not.include.any.members(
+            userWithColorProperty,
+            "Should not modify color property of user with color object"
+          );
+          return done();
+        });
+    });
+  });
 });

utils/users.js

@@ -81,9 +81,19 @@ const getParticipantUserIds = async (participantArray) => {
   }
 };
 
+/**
+ * Returns a random object from the array of colors to user
+ * @param cardColorArray {array} : color containing array
+ * @returns userColorIndex number : index between the range 0 to cardColorArray.length
+ */
+const addColorsProperty = (cardColorArray) => {
+  return Math.floor(Math.random() * (cardColorArray.length - 0) + 0);
+};
+
 module.exports = {
   getUserId,
   getUsername,
   getParticipantUserIds,
   getParticipantUsernames,
+  addColorsProperty,
 };