Feature/one time user colors

controllers/userMigrations.js

@@ -0,0 +1,57 @@
+const firestore = require("../utils/firestore");
+const userQuery = require("../models/userMigrations");
+const logger = require("../utils/logger");
+const { getRandomIndex } = require("../utils/helpers");
+const USER_COLORS = 10;
+const MAX_TRANSACTION_WRITES = 499;
+
+/**
+ * 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 { usersArr, userModel } = await userQuery.addDefaultColors();
+
+    const batchArray = [];
+    const users = [];
+    batchArray.push(firestore.batch());
+    let operationCounter = 0;
+    let batchIndex = 0;
+    let totalCount = 0;
+
+    for (const user of usersArr) {
+      const colors = user.colors ?? {};
+      if (user.colors === undefined) {
+        const userColorIndex = getRandomIndex(USER_COLORS);
+        colors.color_id = userColorIndex;
+        const docId = userModel.doc(user.id);
+        batchArray[parseInt(batchIndex)].set(docId, { ...user, colors });
+        operationCounter++;
+        totalCount++;
+        users.push(user.username);
+        if (operationCounter === MAX_TRANSACTION_WRITES) {
+          batchArray.push(firestore.batch());
+          batchIndex++;
+          operationCounter = 0;
+        }
+      }
+    }
+    batchArray.forEach(async (batch) => await batch.commit());
+
+    return res.json({
+      message: "User colors updated successfully!",
+      usersDetails: { count: totalCount, users },
+    });
+  } 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/userMigrations.js

@@ -0,0 +1,25 @@
+const firestore = require("../utils/firestore");
+const userModel = firestore.collection("users");
+
+/**
+ * Adds default colors property
+ * @return {Promise<usersMigrated|Object>}
+ */
+
+const addDefaultColors = async () => {
+  try {
+    const usersSnapshot = await userModel.get();
+    const usersArr = [];
+
+    usersSnapshot.forEach((doc) => usersArr.push({ id: doc.id, ...doc.data() }));
+
+    return { usersArr, userModel };
+  } catch (err) {
+    logger.error("Error adding default colors to users", err);
+    throw err;
+  }
+};
+
+module.exports = {
+  addDefaultColors,
+};

routes/index.js

@@ -19,6 +19,7 @@ app.use("/users/status", require("./userStatus.js"));
 app.use("/users", require("./users.js"));
 app.use("/profileDiffs", require("./profileDiffs.js"));
 app.use("/wallet", require("./wallets.js"));
+app.use("/migrations", require("./userMigrations.js"));
 app.use("/extension-requests", require("./extensionRequests"));
 app.use("/tags", require("./tags.js"));
 app.use("/levels", require("./levels.js"));

routes/userMigrations.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/userMigrations");
+
+router.patch("/addDefaultColorProperty", authenticate, authorizeRoles([SUPERUSER]), migrations.addDefaultColors);
+
+module.exports = router;

test/fixtures/user/user.js

@@ -144,6 +144,9 @@ module.exports = () => {
         app_owner: true,
         archived: true,
       },
+      colors: {
+        color_id: 2,
+      },
       picture: {
         publicId: "profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar",
         url: "https://res.cloudinary.com/realdevsquad/image/upload/v1667685133/profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar.jpg",

test/integration/userMigrations.test.js

@@ -0,0 +1,80 @@
+const chai = require("chai");
+const { expect } = chai;
+const chaiHttp = require("chai-http");
+
+const app = require("../../server");
+const authService = require("../../services/authService");
+const addUser = require("../utils/addUser");
+const cleanDb = require("../utils/cleanDb");
+// Import fixtures
+const userData = require("../fixtures/user/user")();
+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");
+
+chai.use(chaiHttp);
+
+describe("userColorMigrations", function () {
+  let superUserId;
+  let superUserAuthToken;
+  let userId = "";
+  let nonSuperUserId = "";
+  beforeEach(async function () {
+    userId = await addUser();
+    superUserId = await addUser(superUser);
+    nonSuperUserId = userId;
+    superUserAuthToken = authService.generateAuthToken({ userId: superUserId });
+  });
+
+  afterEach(async function () {
+    await cleanDb();
+  });
+
+  describe("PATCH /migrations/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(`/migrations/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(`/migrations/addDefaultColorProperty`)
+        .set("cookie", `${cookieName}=${superUserAuthToken}`)
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+
+          expect(res).to.have.status(200);
+          expect(res.body.usersDetails.count).to.be.equal(colorBearingUsernames.length);
+          const migratedUsernames = res.body.usersDetails.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();
+        });
+    });
+  });
+});

test/integration/users.test.js

@@ -49,6 +49,7 @@ describe("Users", function () {
     userId = await addUser();
     jwt = authService.generateAuthToken({ userId });
     superUserId = await addUser(superUser);
+
     superUserAuthToken = authService.generateAuthToken({ userId: superUserId });
 
     const userDocRef = photoVerificationModel.doc();

utils/helpers.js

@@ -0,0 +1,12 @@
+/**
+ * Returns a random object from the array of colors to user
+ * @param array {array} : array containing objects
+ * @returns random Index number : index between the range 0 to array.length
+ */
+const getRandomIndex = (arrayLength = 10) => {
+  return Math.floor(Math.random() * arrayLength);
+};
+
+module.exports = {
+  getRandomIndex,
+};