test: unit test for user util - getUsernamesFromPRs (#1123)

* feat: unit test for user util - getUsernamesFromPRs

* move constanst to fixtures

Author: khalatevarun

test/fixtures/pullrequests/pullrequests.js

@@ -0,0 +1,116 @@
+const filteredPRs = [
+  {
+    title: "Redesign the discord linking page",
+    username: "RitikJaiswal75",
+    state: "closed",
+    createdAt: "2023-05-19T06:35:41Z",
+    updatedAt: "2023-05-28T19:29:08Z",
+    repository: "website-my",
+    url: "https://github.com/Real-Dev-Squad/website-my/pull/407",
+    labels: ["UX", "UI"],
+    assignees: ["RitikJaiswal75"],
+  },
+  {
+    title: "Added a link on logo ",
+    username: "kushvahasumit",
+    state: "closed",
+    createdAt: "2023-04-29T18:01:24Z",
+    updatedAt: "2023-05-28T17:58:53Z",
+    repository: "website-www",
+    url: "https://github.com/Real-Dev-Squad/website-www/pull/465",
+    labels: [],
+    assignees: [],
+  },
+  {
+    title: "nuke: links to crypto site",
+    username: "vvaibhavdesai",
+    state: "closed",
+    createdAt: "2023-05-07T06:18:28Z",
+    updatedAt: "2023-05-28T15:37:54Z",
+    repository: "website-www",
+    url: "https://github.com/Real-Dev-Squad/website-www/pull/473",
+    labels: [],
+    assignees: [],
+  },
+  {
+    title: "[Ember-Migration] Embroider Setup",
+    username: "rohan09-raj",
+    state: "closed",
+    createdAt: "2023-05-27T15:55:18Z",
+    updatedAt: "2023-05-28T07:56:38Z",
+    repository: "website-www",
+    url: "https://github.com/Real-Dev-Squad/website-www/pull/490",
+    labels: ["ember-migration", "config"],
+    assignees: ["rohan09-raj"],
+  },
+  {
+    title: "Added task-dependency data model",
+    username: "vinit717",
+    state: "closed",
+    createdAt: "2023-05-24T00:50:02Z",
+    updatedAt: "2023-05-28T06:15:22Z",
+    repository: "website-data-models",
+    url: "https://github.com/Real-Dev-Squad/website-data-models/pull/46",
+    labels: ["documentation"],
+    assignees: ["vinit717"],
+  },
+  {
+    title: "[Live-Site] create a modal for joining the live session",
+    username: "SanketDhabarde",
+    state: "closed",
+    createdAt: "2023-05-10T10:01:21Z",
+    updatedAt: "2023-05-28T05:01:01Z",
+    repository: "website-www",
+    url: "https://github.com/Real-Dev-Squad/website-www/pull/477",
+    labels: ["live-site"],
+    assignees: ["SanketDhabarde"],
+  },
+  {
+    title: "Set github actions timeout to 5 mins",
+    username: "prakashchoudhary07",
+    state: "closed",
+    createdAt: "2023-05-26T11:36:07Z",
+    updatedAt: "2023-05-27T09:21:38Z",
+    repository: "website-backend",
+    url: "https://github.com/Real-Dev-Squad/website-backend/pull/1117",
+    labels: [],
+    assignees: [],
+  },
+  {
+    title: "create a social share image for realdevsquad.com/join",
+    username: "Pratiyushkumar",
+    state: "closed",
+    createdAt: "2023-05-26T15:22:52Z",
+    updatedAt: "2023-05-27T08:21:17Z",
+    repository: "website-www",
+    url: "https://github.com/Real-Dev-Squad/website-www/pull/487",
+    labels: [],
+    assignees: ["Pratiyushkumar"],
+  },
+  {
+    title: "Sync dev to main",
+    username: "RitikJaiswal75",
+    state: "closed",
+    createdAt: "2023-05-27T06:01:41Z",
+    updatedAt: "2023-05-27T07:59:45Z",
+    repository: "website-status",
+    url: "https://github.com/Real-Dev-Squad/website-status/pull/586",
+    labels: [],
+    assignees: [],
+  },
+  {
+    title: "Task details page",
+    username: "YashJain24-chief",
+    state: "closed",
+    createdAt: "2022-11-07T14:43:28Z",
+    updatedAt: "2023-05-27T07:35:50Z",
+    repository: "website-status",
+    url: "https://github.com/Real-Dev-Squad/website-status/pull/341",
+    labels: ["feature task"],
+    assignees: ["kotesh-arya"],
+  },
+];
+
+module.exports = {
+  filteredPRs,
+};

test/unit/utils/users.test.js

@@ -4,6 +4,7 @@ const { expect } = chai;
 const usersUtils = require("../../../utils/users");
 const cleanDb = require("../../utils/cleanDb");
 const addUser = require("../../utils/addUser");
+const { filteredPRs } = require("../../fixtures/pullrequests/pullrequests");
 const userData = require("../../fixtures/user/user")()[0];
 /**
  * Test the utils functions and validate the data returned
@@ -65,4 +66,31 @@ describe("users", function () {
       expect(participantUserId).to.include(userId);
     });
   });
+
+  describe("getUsernamesFromPRs", function () {
+    it("returns an array of unique usernames from the filtered PRs/Issues response", function () {
+      // Mock the allPRs data
+      const allPRs = filteredPRs;
+
+      // Execute the function and store the result
+      const usernames = usersUtils.getUsernamesFromPRs(allPRs);
+
+      // Assert that the returned value is an array
+      expect(usernames).to.be.an("array");
+
+      // Assert that the returned array contains the correct usernames
+      const expectedUsernames = [
+        "RitikJaiswal75",
+        "kushvahasumit",
+        "vvaibhavdesai",
+        "rohan09-raj",
+        "vinit717",
+        "SanketDhabarde",
+        "prakashchoudhary07",
+        "Pratiyushkumar",
+        "YashJain24-chief",
+      ];
+      expect(usernames).to.have.members(expectedUsernames);
+    });
+  });
 });

utils/users.js

@@ -122,11 +122,8 @@ function getPaginationLink(query, cursor, documentId) {
 }
 
 /**
- * Returns an array of unique users from the filtered PRs/Issues response
- *
+ * @desc Returns an array of unique users from the filtered PRs/Issues response
  * @param allPRs {Array} - list of all PRs/Issues from the respective github service
- * @param allUsers {Array} - list of total users from firebase
- *
  */
 function getUsernamesFromPRs(allPRs) {
   const uniqueUsernamesSet = new Set();