Updated: archived users data structure and test cases

Author: gauravsinhaweb

controllers/members.js

@@ -85,14 +85,10 @@ const archiveMembers = async (req, res) => {
     const { username } = req.params;
     const user = await dataAccess.retrieveUsers({ username });
     const superUserId = req.userData.id;
-    const body = req.body;
-    const meta = {
-      userId: user?.user?.id,
-      superUserId: superUserId,
-      username: username,
-    };
-    const isReasonNullOrUndefined = !body?.reason;
-    const isReasonEmptyOrWhitespace = /^\s*$/.test(body?.reason);
+    const { reason } = req.body;
+    const roles = req?.userData?.roles;
+    const isReasonNullOrUndefined = !reason;
+    const isReasonEmptyOrWhitespace = /^\s*$/.test(reason);
     if (isReasonNullOrUndefined || isReasonEmptyOrWhitespace) {
       return res.boom.badRequest("Reason is required");
     }
@@ -101,7 +97,19 @@ const archiveMembers = async (req, res) => {
       if (successObject.isArchived) {
         return res.boom.badRequest("User is already archived");
       }
-      addLog("archive-details", meta, { body: body?.reason });
+      const body = {
+        reason: reason,
+        archived_user: {
+          user_id: user.user.id,
+          username: user.user.username,
+        },
+        archived_by: {
+          user_id: superUserId,
+          roles: roles,
+        },
+      };
+
+      addLog("archived-details", {}, body);
       return res.status(204).send();
     }
     return res.boom.notFound("User doesn't exist");

models/logs.js

@@ -53,7 +53,7 @@ const fetchLogs = async (query, param) => {
     if (userId) {
       const logsSnapshot = await logsModel
         .where("type", "==", param)
-        .where("meta.userId", "==", userId)
+        .where("body.archived_user.user_id", "==", userId)
         .orderBy("timestamp", "desc")
         .get();
       const logs = [];

test/fixtures/logs/archievedUsers.js

@@ -1,43 +1,61 @@
 const archivedUserDetailsModal = [
   {
-    type: "archive-details",
-    meta: {
-      userId: "TEST_USER_ID_1",
-      superUserId: "TEST_SUPER_USER_ID",
-      username: "TEST_USERNAME_1",
-    },
+    type: "archived-details",
+    meta: {},
     body: {
-      reason: "TEST_REASON_1",
+      reason: "test reason",
+      archived_user: { user_id: "R5kljdsleH4Gr2t7tvr0Z", username: "testUser1" },
+      archived_by: {
+        user_id: "ReMyuklislajwooncVL",
+        roles: {
+          in_discord: true,
+          super_user: false,
+          member: true,
+          archived: false,
+        },
+      },
     },
     timestamp: {
       _seconds: 1657193216,
       _nanoseconds: 912000000,
     },
   },
   {
-    type: "archive-details",
-    meta: {
-      userId: "TEST_USER_ID_2",
-      superUserId: "TEST_SUPER_USER_ID",
-      username: "TEST_USERNAME_2",
-    },
+    type: "archived-details",
+    meta: {},
     body: {
-      reason: "TEST_REASON_2",
+      reason: "test reason",
+      archived_user: { user_id: "R5kljdsleH4Gr2t7tvr0Z", username: "testUser1" },
+      archived_by: {
+        user_id: "ReMyuklislajwooncVL",
+        roles: {
+          in_discord: true,
+          super_user: false,
+          member: true,
+          archived: false,
+        },
+      },
     },
     timestamp: {
       _seconds: 1657193216,
       _nanoseconds: 912000000,
     },
   },
   {
-    type: "archive-details",
-    meta: {
-      userId: "TEST_USER_ID_1",
-      superUserId: "TEST_SUPER_USER_ID",
-      username: "TEST_USERNAME_1",
-    },
+    type: "archived-details",
+    meta: {},
     body: {
-      reason: "TEST_REASON_1",
+      reason: "test reason",
+      archived_user: { user_id: "Efskee4Gr2t7tvr0Z", username: "testUser2" },
+      archived_by: {
+        user_id: "ReMyuklislajwooncVL",
+        roles: {
+          in_discord: true,
+          super_user: false,
+          member: true,
+          archived: false,
+        },
+      },
     },
     timestamp: {
       _seconds: 1657193216,

test/unit/models/logs.test.js

@@ -49,7 +49,7 @@ describe("Logs", function () {
     });
   });
 
-  describe("GET /logs/archive-details", function () {
+  describe("GET /logs/archived-details", function () {
     let addLogsStub;
     let jwt;
     beforeEach(async function () {
@@ -61,15 +61,13 @@ describe("Logs", function () {
       Sinon.restore();
     });
 
-    it("Should return an object with status 500 and an error message", async function () {
+    it("Should return an Internal server error message", async function () {
       addLogsStub = Sinon.stub(logsQuery, "fetchLogs");
       addLogsStub.throws(new Error(INTERNAL_SERVER_ERROR));
 
       addUser(userToBeMadeMember).then(() => {
-        const res = chai.request(app).get("/logs/archive-details").set("cookie", `${cookieName}=${jwt}`).send();
+        const res = chai.request(app).get("/logs/archived-details").set("cookie", `${cookieName}=${jwt}`).send();
 
-        // expect(res).to.have.status(500);
-        // expect(res.body).to.have.property("message").that.is.a("string");
         expect(res.body.message).to.equal(INTERNAL_SERVER_ERROR);
       });
     });
@@ -92,13 +90,13 @@ describe("Logs", function () {
       expect(data[0]).to.have.property("timestamp").that.is.an("object");
       expect(data[0].timestamp).to.have.property("_seconds").that.is.a("number");
       expect(data[0].timestamp).to.have.property("_nanoseconds").that.is.a("number");
-      expect(data[0].meta).to.have.property("username").that.is.a("string");
+      expect(data[0].body.archived_user).to.have.property("username").that.is.a("string");
       expect(data[0].body).to.have.property("reason").that.is.a("string");
     });
-    it("Should fetch all archived logs for given username", async function () {
+    it("Should fetch all archived logs for given user_id", async function () {
       const { type, meta, body } = logsData.archivedUserDetailsModal[0];
       const query = {
-        userId: meta.userId,
+        userId: body.archived_user.user_id,
       };
       await logsQuery.addLog(type, meta, body);
       const data = await logsQuery.fetchLogs(query, type);
@@ -107,7 +105,6 @@ describe("Logs", function () {
       expect(data[0]).to.have.property("timestamp").that.is.an("object");
       expect(data[0].timestamp).to.have.property("_seconds").that.is.a("number");
       expect(data[0].timestamp).to.have.property("_nanoseconds").that.is.a("number");
-      expect(data[0].meta).to.have.property("username").that.is.a("string");
       expect(data[0].body).to.have.property("reason").that.is.a("string");
     });
     it("Should throw response status 404, if username is incorrect in the query", async function () {
@@ -117,7 +114,7 @@ describe("Logs", function () {
       };
       await logsQuery.addLog(type, meta, body);
       const data = await logsQuery.fetchLogs(query, type);
-      const response = await chai.request(app).get(`/logs/${type}/${meta.username}`);
+      const response = await chai.request(app).get(`/logs/${type}/${query}`);
 
       expect(data).to.be.an("array").with.lengthOf(0);
       expect(response).to.have.status(404);