Feature/one time user colors

controllers/userMigrations.js

@@ -0,0 +1,27 @@
+const userQuery = require("../models/userMigrations");
+const { SOMETHING_WENT_WRONG } = require("../constants/errorMessages");
+
+/**
+ * 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 usersDetails = await userQuery.addDefaultColors();
+
+    return res.json({
+      message: "User colors updated successfully!",
+      usersDetails,
+    });
+  } catch (error) {
+    logger.error(`Error adding default colors to users: ${error}`);
+    return res.boom.badImplementation(SOMETHING_WENT_WRONG);
+  }
+};
+
+module.exports = {
+  addDefaultColors,
+};

models/userMigrations.js

@@ -0,0 +1,63 @@
+const firestore = require("../utils/firestore");
+const userModel = firestore.collection("users");
+const { getRandomIndex } = require("../utils/helpers");
+const dataAccess = require("../services/dataAccessLayer");
+const MAX_TRANSACTION_WRITES = 500;
+const MAX_USERS_SIZE = 10_000;
+const USER_COLORS = 10;
+
+/**
+ * Returns the object with details about users to whom user color was added
+ *
+ * @param req {Object} - Express request object
+ * @param res {Object} - Express response object
+ */
+
+const addDefaultColors = async (batchSize = MAX_TRANSACTION_WRITES) => {
+  try {
+    const usersSnapshotArr = await dataAccess.retrieveUsers({ query: { size: MAX_USERS_SIZE } });
+    const usersArr = usersSnapshotArr.users;
+    // usersSnapshot.users.forEach((doc) => usersArr.push({ id: doc.id, ...doc }));
+
+    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) {
+        const userColorIndex = getRandomIndex(USER_COLORS);
+        colors.color_id = userColorIndex;
+        const docId = userModel.doc(user.id);
+        user.colors = colors;
+        batchArray[parseInt(batchIndex)].set(docId, user);
+        operationCounter++;
+        totalCount++;
+        users.push(user.username);
+        if (operationCounter === batchSize) {
+          batchArray.push(firestore.batch());
+          batchIndex++;
+          operationCounter = 0;
+        }
+      }
+    }
+    batchArray.forEach(async (batch) => await batch.commit());
+
+    return {
+      totalUsersFetched: usersArr.length,
+      totalUsersUpdated: totalCount,
+      totalUsersUnaffected: usersArr.length - totalCount,
+    };
+  } 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("/user-default-color", authenticate, authorizeRoles([SUPERUSER]), migrations.addDefaultColors);
+
+module.exports = router;

test/fixtures/user/user.js

@@ -170,6 +170,9 @@ module.exports = () => {
         archived: false,
         in_discord: 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,71 @@
+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 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(nonSuperUser);
+    superUserId = await addUser(superUser);
+    nonSuperUserId = userId;
+    superUserAuthToken = authService.generateAuthToken({ userId: superUserId });
+  });
+
+  afterEach(async function () {
+    await cleanDb();
+  });
+
+  describe("PATCH /migrations/user-default-color", 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/user-default-color`)
+        .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/user-default-color`)
+        .set("cookie", `${cookieName}=${superUserAuthToken}`)
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+
+          expect(res).to.have.status(200);
+          expect(res.body.usersDetails.totalUsersFetched).to.be.equal(colorBearingUsernames.length);
+          expect(res.body.usersDetails.totalUsersUpdated).to.be.equal(colorBearingUsernames.length);
+          expect(res.body.usersDetails.totalUsersUnaffected).to.be.equal(0);
+          return done();
+        });
+    });
+  });
+});

test/unit/models/userMigrations.test.js

@@ -0,0 +1,52 @@
+const chai = require("chai");
+const { expect } = chai;
+const firestore = require("../../../utils/firestore");
+const userModel = firestore.collection("users");
+const cleanDb = require("../../utils/cleanDb");
+const userMigrationModel = require("../../../models/userMigrations");
+const userData = require("../../fixtures/user/user")();
+const addUser = require("../../utils/addUser");
+
+describe("userColorMigrations", function () {
+  const MAX_TRANSACTION_WRITES = 500;
+
+  beforeEach(async function () {
+    await addUser(userData[0]);
+    await addUser(userData[1]);
+    await addUser(userData[2]);
+    await addUser(userData[3]);
+    await addUser(userData[4]);
+    await addUser(userData[6]);
+  });
+  afterEach(async function () {
+    await cleanDb();
+  });
+
+  it("should add color property to added users which dont have a color property", async function () {
+    const response = await userMigrationModel.addDefaultColors();
+
+    expect(response.totalUsersFetched).to.equal(6);
+    expect(response.totalUsersUpdated).to.equal(5);
+    expect(response.totalUsersUnaffected).to.equal(1);
+  });
+  it("should make sure that batch updates are working properly by passing smaller batch size", async function () {
+    const SMALL_BATCH_SIZE = 2;
+    const response = await userMigrationModel.addDefaultColors(SMALL_BATCH_SIZE);
+    expect(response.totalUsersFetched).to.equal(6);
+    expect(response.totalUsersUpdated).to.equal(5);
+    expect(response.totalUsersUnaffected).to.equal(1);
+  });
+  it("should not affect users already having color property", async function () {
+    // Manually add a color property to a user
+    const userId = await addUser(userData[0]);
+    await userModel.doc(userId).update({ colors: { color_id: 3 } });
+    const response = await userMigrationModel.addDefaultColors(MAX_TRANSACTION_WRITES);
+    expect(response.totalUsersFetched).to.equal(6);
+    expect(response.totalUsersUpdated).to.equal(4);
+    expect(response.totalUsersUnaffected).to.equal(2);
+
+    // Check that the user with a color property was unaffected
+    const updatedUser = await userModel.doc(userId).get();
+    expect(updatedUser.data().colors.color_id).to.equal(3);
+  });
+});

test/unit/utils/helpers.test.js

@@ -0,0 +1,20 @@
+const chai = require("chai");
+const { getRandomIndex } = require("../../../utils/helpers");
+const { expect } = chai;
+
+describe("helpers", function () {
+  describe("getRandom Index from function", function () {
+    it("should return a random number between 0 and 10 excluding 10 if no index is passed", function () {
+      const result = getRandomIndex();
+      expect(result).to.be.at.least(0);
+      expect(result).to.be.below(10);
+    });
+
+    it("expect a number between 0 and passed number", function () {
+      const delimiter = 100;
+      const result = getRandomIndex(delimiter);
+      expect(result).to.be.at.least(0);
+      expect(result).to.be.below(delimiter);
+    });
+  });
+});

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,
+};