FEATURE: add timestamp to user model collection (#1346)

* FEATURE: add timestamp to user model

* TEST: add test for the changes in user model collection

* TEST(FIX): fix test and add new data for test

* FIX(DUMMY DATA): add new dummy data for test

* TEST(FIX): fix fixture data

Author: sahsisunny

controllers/auth.js

@@ -53,6 +53,9 @@ const githubAuthCallback = (req, res, next) => {
       userData = {
         github_id: user.username,
         github_display_name: user.displayName,
+        // github_account_created_at: user.created_at,
+        created_at: Date.now(),
+        updated_at: Date.now(),
       };
 
       const { userId, incompleteUserDetails } = await users.addOrUpdate(userData);

models/users.js

@@ -38,6 +38,7 @@ const addOrUpdate = async (userData, userId = null) => {
         await userModel.doc(userId).set({
           ...user.data(),
           ...userData,
+          updated_at: Date.now(),
         });
       }
 
@@ -53,6 +54,7 @@ const addOrUpdate = async (userData, userId = null) => {
         isNewUser: false,
         userId: user.docs[0].id,
         incompleteUserDetails: user.docs[0].data().incompleteUserDetails,
+        updated_at: Date.now(),
       };
     }
 
@@ -65,7 +67,7 @@ const addOrUpdate = async (userData, userId = null) => {
     userData.roles = { archived: false, in_discord: false };
     userData.incompleteUserDetails = true;
     const userInfo = await userModel.add(userData);
-    return { isNewUser: true, userId: userInfo.id, incompleteUserDetails: true };
+    return { isNewUser: true, userId: userInfo.id, incompleteUserDetails: true, updated_at: Date.now() };
   } catch (err) {
     logger.error("Error in adding or updating user", err);
     throw err;

services/discordService.js

@@ -34,6 +34,7 @@ const setInDiscordFalseScript = async () => {
         ...user.roles,
         in_discord: false,
       },
+      updated_at: Date.now(),
     };
     updateUsersPromises.push(userModel.doc(id).update(userData));
   });

test/fixtures/auth/githubUserInfo.js

@@ -67,5 +67,39 @@ module.exports = () => {
         },
       },
     },
+    {
+      login: "sahsisunny",
+      id: 70854507,
+      node_id: "MDQ6VXNlcjcwODU0NTA3",
+      avatar_url: "https://avatars.githubusercontent.com/u/70854507?v=4",
+      gravatar_id: "",
+      url: "https://api.github.com/users/sahsisunny",
+      html_url: "https://github.com/sahsisunny",
+      followers_url: "https://api.github.com/users/sahsisunny/followers",
+      following_url: "https://api.github.com/users/sahsisunny/following{/other_user}",
+      gists_url: "https://api.github.com/users/sahsisunny/gists{/gist_id}",
+      starred_url: "https://api.github.com/users/sahsisunny/starred{/owner}{/repo}",
+      subscriptions_url: "https://api.github.com/users/sahsisunny/subscriptions",
+      organizations_url: "https://api.github.com/users/sahsisunny/orgs",
+      repos_url: "https://api.github.com/users/sahsisunny/repos",
+      events_url: "https://api.github.com/users/sahsisunny/events{/privacy}",
+      received_events_url: "https://api.github.com/users/sahsisunny/received_events",
+      type: "User",
+      site_admin: false,
+      name: "Sunny Sahsi",
+      company: "@Real-Dev-Squad ",
+      blog: "https://sahsisunny.netlify.app/",
+      location: "India",
+      email: null,
+      hireable: true,
+      bio: null,
+      twitter_username: "sahsisunny",
+      public_repos: 38,
+      public_gists: 1,
+      followers: 11,
+      following: 4,
+      created_at: "2020-09-06T16:21:38Z",
+      updated_at: "2023-07-26T09:29:37Z",
+    },
   ];
 };

test/fixtures/user/user.js

@@ -329,5 +329,19 @@ module.exports = () => {
       twitter_id: "ramsingh123",
       linkedin_id: "ramsingh123",
     },
+    {
+      username: "sahsisunny",
+      first_name: "sunny",
+      last_name: "sahsi",
+      github_id: githubUserInfo[1].login,
+      github_display_name: githubUserInfo[1].name,
+      roles: {
+        member: true,
+        in_discord: true,
+      },
+      incompleteUserDetails: false,
+      updated_at: Date.now(),
+      created_at: Date.now(),
+    },
   ];
 };

test/integration/auth.test.js

@@ -40,7 +40,7 @@ describe("auth", function () {
     expect(res.headers.location).to.equal(githubOauthURL);
   });
 
-  it("should redirect the user to new sign up flow if they are have incomplte user details true", async function () {
+  it("should redirect the user to new sign up flow if they are have incomplete user details true", async function () {
     const redirectURL = "https://my.realdevsquad.com/new-signup";
     sinon.stub(passport, "authenticate").callsFake((strategy, options, callback) => {
       callback(null, "accessToken", githubUserInfo[0]);
@@ -55,6 +55,7 @@ describe("auth", function () {
     expect(res).to.have.status(302);
     expect(res.headers.location).to.equal(redirectURL);
   });
+
   // same data should be return from github and same data should be added there
   it("should redirect the request to the goto page on successful login, if user has incomplete user details false", async function () {
     await addUserToDBForTest(userData[0]);
@@ -90,7 +91,7 @@ describe("auth", function () {
     expect(res.headers.location).to.equal(rdsUrl);
   });
 
-  it("should redirect the realdevsquad.com if non RDS URL provided, any url that is other than *.realdevsqud.com is invalid", async function () {
+  it("should redirect the realdevsquad.com if non RDS URL provided, any url that is other than *.realdevsquad.com is invalid", async function () {
     await addUserToDBForTest(userData[0]);
     const invalidRedirectUrl = new URL("https://google.com").href;
     const rdsUiUrl = new URL(config.get("services.rdsUi.baseUrl")).href;

test/unit/models/users.test.js

@@ -92,7 +92,18 @@ describe("users", function () {
       expect(user.last_name).to.equal(userData.last_name);
       expect(userExists).to.equal(true);
     });
+
+    it("It should have created_At and updated_At fields", async function () {
+      const userData = userDataArray[14];
+      await users.addOrUpdate(userData);
+      const githubUsername = "sahsisunny";
+      const { user, userExists } = await users.fetchUser({ githubUsername });
+      expect(user).to.haveOwnProperty("created_at");
+      expect(user).to.haveOwnProperty("updated_at");
+      expect(userExists).to.equal(true);
+    });
   });
+
   describe("user image verification", function () {
     let userId, discordId, profileImageUrl, discordImageUrl;
     beforeEach(async function () {

test/unit/services/discordService.test.js

@@ -26,6 +26,7 @@ describe("Discord services", function () {
       const updatedUsers = await fetchAllUsers();
       updatedUsers.forEach((user) => {
         expect(user.roles.in_discord).to.be.equal(false);
+        expect(user.updated_at).to.be.a("number");
       });
     });
   });