added users data in response, fixed test cases

Author: iamYashSinha

controllers/users.js

@@ -466,9 +466,11 @@ 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) => {
-  const authToken = `${config.get("githubOauth.clientId")}:${config.get("githubOauth.clientSecret")}`;
+  const authToken = `${config.get("githubOauth.patToken")}`;
   // converting the `authToken` string into Base64 format
-  const encodedToken = Buffer.from(`${authToken}`, "binary").toString("base64");
+  const encodedToken = Buffer.from(`${authToken}`).toString("base64");
+  const usernameNotFound = [];
+  let countUserNotFound = 0;
   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.
@@ -481,6 +483,7 @@ const migrate = async (req, res) => {
       const batchWrites = [];
       for (const userDoc of batchDocs) {
         const githubUsername = userDoc.data().github_id;
+        const userName = userDoc.data().github_display_name;
         batchWrite.update(userDoc.ref, { github_user_id: null });
         batchWrites.push(
           axios
@@ -496,7 +499,12 @@ const migrate = async (req, res) => {
             })
             .catch((error) => {
               if (error.response && error.response.status === 404) {
-                logger.error(`Error: github_user_id not found for ${githubUsername}`);
+                countUserNotFound++;
+                const userNotFound = {
+                  name: `${userName}`,
+                  username: `${githubUsername}`,
+                };
+                usernameNotFound.push(userNotFound);
               } else {
                 // Other error occurred
                 logger.error("An error occurred at axios.get:", error);
@@ -510,11 +518,14 @@ const migrate = async (req, res) => {
 
     return res.status(200).json({
       message: "All Users github_user_id added successfully",
+      data: {
+        invalidUsers: usernameNotFound,
+        totalCount: countUserNotFound,
+      },
     });
   } catch (error) {
-    return res.status(500).json({
-      message: "Internal Server Error",
-    });
+    logger.error(`Error while Updating all users: ${error}`);
+    return res.boom.badImplementation(INTERNAL_SERVER_ERROR);
   }
 };
 

test/integration/users.test.js

@@ -4,6 +4,7 @@ const chaiHttp = require("chai-http");
 const firestore = require("../../utils/firestore");
 const app = require("../../server");
 const authService = require("../../services/authService");
+const sinon = require("sinon");
 const addUser = require("../utils/addUser");
 const profileDiffs = require("../../models/profileDiffs");
 const cleanDb = require("../utils/cleanDb");
@@ -1053,19 +1054,30 @@ describe("Users", function () {
         });
     });
     it("Should update the user", async function () {
-      const response1 = await chai
+      const usersMigrateResponse = await chai
         .request(app)
         .post(`/users/migrate`)
         .set("Cookie", `${cookieName}=${superUserAuthToken}`);
-      expect(response1).to.have.status(200);
-      expect(response1.body).to.eql({
+      expect(usersMigrateResponse).to.have.status(200);
+      expect(usersMigrateResponse.body).to.eql({
         message: `All Users github_user_id added successfully`,
+        data: {
+          invalidUsers: [],
+          totalCount: 0,
+        },
       });
-      const response2 = await chai.request(app).get(`/users`).set("cookie", `${cookieName}=${superUserAuthToken}`);
-      expect(response2).to.have.status(200);
-      response2.body.users.forEach((document) => {
+      const stub = sinon.stub(chai.request(app), "get").resolves({
+        status: 200,
+        body: {
+          users: [{ github_user_id: "12345678" }, { github_user_id: "78945612" }],
+        },
+      });
+      const usersReponse = await chai.request(app).get(`/users`).set("cookie", `${cookieName}=${superUserAuthToken}`);
+      expect(usersReponse).to.have.status(200);
+      usersReponse.body.users.forEach((document) => {
         expect(document).to.have.property(`github_user_id`);
       });
+      stub.restore();
     });
     it("Should return unauthorized error when not logged in", function (done) {
       chai

test/unit/models/users.test.js

@@ -116,16 +116,6 @@ describe("users", function () {
       expect(data.github_id).to.equal(userData.github_id);
     });
 
-    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" };