GitHub duplication Fixed and Migration

controllers/auth.js

@@ -27,6 +27,7 @@ const githubAuth = (req, res, next) => {
         tokens: {
           githubAccessToken: accessToken,
         },
+        github_user_id: user.id,
       };
 
       const { userId, incompleteUserDetails } = await users.addOrUpdate(userData);

controllers/users.js

@@ -1,3 +1,5 @@
+const axios = require("axios");
+const firestore = require("../utils/firestore");
 const chaincodeQuery = require("../models/chaincodes");
 const userQuery = require("../models/users");
 const profileDiffsQuery = require("../models/profileDiffs");
@@ -462,6 +464,46 @@ const filterUsers = async (req, res) => {
   }
 };
 
+// one time script function to perform the migration - adding github_user_id field to the document
+const migrate = async (req, res) => {
+  try {
+    // Fetch user data from GitHub API for each document in the users collection
+    // divided by 500 because firestore api guarantee that we can process in batch of 500.
+    const usersSnapshot = await firestore.collection("users").get();
+    const batchCount = Math.ceil(usersSnapshot.docs.length / 500);
+    // Create batch write operations for each batch of documents
+    for (let i = 0; i < batchCount; i++) {
+      const batchDocs = usersSnapshot.docs.slice(i * 500, (i + 1) * 500);
+      const batchWrite = firestore.batch();
+      const batchWrites = [];
+      for (const userDoc of batchDocs) {
+        const githubUsername = userDoc.data().github_id;
+        batchWrite.update(userDoc.ref, { github_user_id: null });
+        batchWrites.push(
+          axios
+            .get(`https://api.github.com/users/${githubUsername}`)
+            .then((response) => {
+              const githubUserId = response.data.id;
+              batchWrite.update(userDoc.ref, { github_user_id: `${githubUserId}` });
+            })
+            .catch((error) => {
+              logger.error(error);
+            })
+        );
+      }
+      await Promise.all(batchWrites);
+      await batchWrite.commit();
+    }
+
+    return res.send({
+      statusCode: 201,
+      message: "All Users github_user_id added successfully",
+    });
+  } catch (error) {
+    return res.status(500).send("Internal server error");
+  }
+};
+
 module.exports = {
   verifyUser,
   generateChaincode,
@@ -481,4 +523,5 @@ module.exports = {
   addDefaultArchivedRole,
   getUserSkills,
   filterUsers,
+  migrate,
 };

models/users.js

@@ -41,7 +41,7 @@ const addOrUpdate = async (userData, userId = null) => {
     }
 
     // userId is null, Add or Update user
-    const user = await userModel.where("github_id", "==", userData.github_id).limit(1).get();
+    const user = await userModel.where("github_user_id", "==", userData.github_user_id).limit(1).get();
     if (!user.empty) {
       await userModel.doc(user.docs[0].id).set(userData, { merge: true });
 
@@ -67,7 +67,6 @@ const addOrUpdate = async (userData, userId = null) => {
     throw err;
   }
 };
-
 const addJoinData = async (userData) => {
   try {
     await joinModel.add(userData);
@@ -80,7 +79,6 @@ const addJoinData = async (userData) => {
     throw err;
   }
 };
-
 const getJoinData = async (userId) => {
   try {
     const userData = [];

routes/users.js

@@ -29,4 +29,7 @@ router.patch("/rejectDiff", authenticate, authorizeRoles([SUPERUSER]), users.rej
 router.patch("/:userId", authenticate, authorizeRoles([SUPERUSER]), users.updateUser);
 router.get("/suggestedUsers/:skillId", authenticate, authorizeRoles([SUPERUSER]), users.getSuggestedUsers);
 
+// WARNING!! - One time Script/Route to do migration.
+router.post("/migrate", authenticate, authorizeRoles([SUPERUSER]), users.migrate);
+
 module.exports = router;

test/fixtures/user/migration.js

@@ -0,0 +1,38 @@
+const githubUserInfo = require("../auth/githubUserInfo")();
+
+/**
+ * User info for GitHub auth response
+ * Multiple responses can be added to the array if required
+ *
+ * @return {Object}
+ */
+module.exports = () => {
+  return [
+    {
+      username: "ankur",
+      first_name: "Ankur",
+      last_name: "Narkhede",
+      yoe: 0,
+      img: "./img.png",
+      linkedin_id: "ankurnarkhede",
+      github_id: githubUserInfo[0].username,
+      github_display_name: githubUserInfo[0].displayName,
+      isMember: true,
+      phone: "1234567890",
+      email: "[email protected]",
+      roles: {
+        member: true,
+      },
+      tokens: {
+        githubAccessToken: "githubAccessToken",
+      },
+      status: "active",
+      profileURL: "https://abcde.com",
+      picture: {
+        publicId: "profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar",
+        url: "https://res.cloudinary.com/realdevsquad/image/upload/v1667685133/profile/mtS4DhUvNYsKqI7oCWVB/aenklfhtjldc5ytei3ar.jpg",
+      },
+      incompleteUserDetails: false,
+    },
+  ];
+};

test/fixtures/user/user.js

@@ -16,6 +16,7 @@ module.exports = () => {
       yoe: 0,
       img: "./img.png",
       linkedin_id: "ankurnarkhede",
+      github_user_id: githubUserInfo[0].id,
       github_id: githubUserInfo[0].username,
       github_display_name: githubUserInfo[0].displayName,
       isMember: true,
@@ -41,6 +42,7 @@ module.exports = () => {
       last_name: "Bhandarkar",
       yoe: 0,
       img: "./img.png",
+      github_user_id: "23654780",
       github_id: "whydonti",
       linkedin_id: "nikhil-bhandarkar",
       twitter_id: "whatifi",
@@ -57,6 +59,7 @@ module.exports = () => {
       last_name: "Gajjewar",
       yoe: 0,
       img: "./img.png",
+      github_user_id: "23654788",
       github_id: "cartmanishere",
       linkedin_id: "pranav-gajjewar",
       twitter_id: "PGajjewar",
@@ -77,6 +80,7 @@ module.exports = () => {
       yoe: 3,
       img: "./img.png",
       linkedin_id: "sagarbajpai",
+      github_user_id: "23654790",
       github_id: "sagarbajpai",
       github_display_name: "Sagar Bajpai",
       phone: "1234567890",
@@ -101,6 +105,7 @@ module.exports = () => {
       yoe: 10,
       img: "./img.png",
       linkedin_id: "ankushdharkar",
+      github_user_id: "23654700",
       github_id: "ankushdharkar",
       github_display_name: "Ankush Dharkar",
       phone: "1234567890",
@@ -125,6 +130,7 @@ module.exports = () => {
       yoe: 0,
       img: "./img.png",
       linkedin_id: "ankitabannore",
+      github_user_id: "23654725",
       github_id: "Ankita2002-Fr",
       github_display_name: "Ankita Bannore",
       isMember: true,
@@ -149,6 +155,7 @@ module.exports = () => {
       last_name: "Chaudhari",
       yoe: 0,
       img: "./img.png",
+      github_user_id: "23654583",
       github_id: "mehulkchaudhari",
       linkedin_id: "mehulkchaudhari",
       twitter_id: "mehulkchaudhari",
@@ -174,6 +181,7 @@ module.exports = () => {
       yoe: 0,
       img: "./img.png",
       linkedin_id: "ankurnarkhede",
+      github_user_id: "23654236",
       github_id: "ankur1234",
       github_display_name: "ankur-xyz",
       phone: "1234567890",
@@ -182,6 +190,7 @@ module.exports = () => {
     {
       username: "ritvik",
       github_id: "RitvikJamwal75",
+      github_user_id: "23654123",
       first_name: "Ritvik",
       yoe: 1,
       picture: {

test/integration/contributions.test.js

@@ -23,17 +23,20 @@ describe("Contributions", function () {
       yoe: 0,
       img: "./img.png",
       github_id: "prakashchoudhary07",
+      github_user_id: "12345678",
       username: "prakash",
     };
     // Adding user
     await userModel.addOrUpdate(user);
     // Creating second user
     user.username = "userWithNoPrs";
     user.github_id = "userWithNoPrs";
+    user.github_user_id = "userWithNoPrs";
     await userModel.addOrUpdate(user);
     // Creating second user
     user.username = "userNoTask";
     user.github_id = "userNoTask";
+    user.github_user_id = "userNoTask";
     await userModel.addOrUpdate(user);
     //  Creating task for user
     const task = {

test/integration/tasks.test.js

@@ -224,6 +224,7 @@ describe("Tasks", function () {
       const { userId: assignedUser } = await userModel.addOrUpdate({
         github_id: "prakashchoudhary07",
         username: "user1",
+        github_user_id: "12345678",
       });
       const assignedTask = [
         {

test/integration/users.test.js

@@ -1,7 +1,6 @@
 const chai = require("chai");
 const { expect } = chai;
 const chaiHttp = require("chai-http");
-
 const firestore = require("../../utils/firestore");
 const app = require("../../server");
 const authService = require("../../services/authService");
@@ -13,7 +12,6 @@ const userData = require("../fixtures/user/user")();
 const profileDiffData = require("../fixtures/profileDiffs/profileDiffs")();
 const superUser = userData[4];
 const searchParamValues = require("../fixtures/user/search")();
-
 const config = require("config");
 const joinData = require("../fixtures/user/join");
 const {
@@ -25,7 +23,6 @@ const userStatusModel = require("../../models/userStatus");
 
 const cookieName = config.get("userToken.cookieName");
 chai.use(chaiHttp);
-
 describe("Users", function () {
   let jwt;
   let superUserId;
@@ -1040,4 +1037,61 @@ describe("Users", function () {
         });
     });
   });
+
+  describe("POST /users/migrate", function () {
+    beforeEach(async function () {
+      superUserId = await addUser(superUser);
+      superUserAuthToken = authService.generateAuthToken({ userId: superUserId });
+    });
+
+    afterEach(async function () {
+      await cleanDb();
+    });
+    it("Should return 401 when user is unauthorize", function (done) {
+      chai
+        .request(app)
+        .post("/users/migrate")
+        .end((err, res) => {
+          if (err) {
+            return done();
+          }
+          expect(res).to.have.status(401);
+          expect(res.body.message).to.equal("Unauthenticated User");
+          return done();
+        });
+    });
+    it("Should update the user", async function () {
+      const response1 = await chai
+        .request(app)
+        .post(`/users/migrate`)
+        .set("Cookie", `${cookieName}=${superUserAuthToken}`);
+      expect(response1).to.have.status(200);
+      expect(response1.body).to.eql({
+        statusCode: 201,
+        message: `All Users github_user_id added successfully`,
+      });
+      const response2 = await chai.request(app).get(`/users`).set("cookie", `${cookieName}=${superUserAuthToken}`);
+      expect(response2).to.have.status(200);
+      response2.body.users.forEach((document) => {
+        expect(document).to.have.property(`github_user_id`);
+      });
+    });
+    it("Should return unauthorized error when not logged in", function (done) {
+      chai
+        .request(app)
+        .post(`/users/migrate`)
+        .end((err, res) => {
+          if (err) {
+            return done(err);
+          }
+          expect(res).to.have.status(401);
+          expect(res.body).to.eql({
+            statusCode: 401,
+            error: "Unauthorized",
+            message: "Unauthenticated User",
+          });
+          return done();
+        });
+    });
+  });
 });

test/unit/models/users.test.js

@@ -87,5 +87,62 @@ describe("users", function () {
       expect(user.last_name).to.equal(userData.last_name);
       expect(userExists).to.equal(true);
     });
+
+    it("should add the github_user_id to the user collection", async function () {
+      const userData = userDataArray[0];
+      userData.github_user_id = "12345678";
+
+      const { isNewUser, userId } = await users.addOrUpdate(userData);
+
+      const data = (await userModel.doc(userId).get()).data();
+
+      expect(data.github_user_id).to.equal(userData.github_user_id);
+      expect(isNewUser).to.equal(true);
+    });
+
+    it("should update the github_id in the user collection", async function () {
+      const userData = userDataArray[0];
+      userData.github_user_id = "Yash Sinha";
+
+      // Add the user the first time
+      const { userId } = await users.addOrUpdate(userData);
+
+      // Update the user with same data and new github_user_id
+      userData.github_id = "Ankush Dharkar";
+      await users.addOrUpdate(userData, userId);
+
+      const data = (await userModel.doc(userId).get()).data();
+
+      expect(data.github_id).to.equal(userData.github_id);
+    });
+
+    it("verifies the error text message", async function () {
+      const userData = { ...userDataArray[0], github_id: 123 };
+
+      try {
+        await users.addOrUpdate(userData);
+      } catch (error) {
+        expect(error.message).to.equal("Validation error: github_id must be a string");
+      }
+    });
+
+    it("github_user_id field should have a maximum length of 8 characters", async function () {
+      const userData = { ...userDataArray[0], github_user_id: "a".repeat(9) };
+
+      try {
+        await users.addOrUpdate(userData);
+      } catch (error) {
+        expect(error.message).to.equal("Validation error: github_id exceeds maximum length of 8 characters");
+      }
+    });
+
+    it("should be stored correctly in the database", async function () {
+      const userData = { ...userDataArray[0], github_id: "my_github_id" };
+
+      const { userId } = await users.addOrUpdate(userData);
+      const data = (await userModel.doc(userId).get()).data();
+
+      expect(data.github_id).to.equal("my_github_id");
+    });
   });
 });