Merge pull request #2269 from Real-Dev-Squad/fetch-logs

Added queries to search the logs

Author: lakshayman

controllers/logs.js

@@ -67,6 +67,9 @@ const fetchAllLogs = async (req, res) => {
       prev: prevUrl,
     });
   } catch (err) {
+    if (err.statusCode) {
+      return res.status(err.statusCode).json({ error: err.message });
+    }
     logger.error(ERROR_WHILE_FETCHING_LOGS, err);
     return res.boom.badImplementation(ERROR_WHILE_FETCHING_LOGS);
   }

models/logs.js

@@ -4,7 +4,7 @@ const logsModel = firestore.collection("logs");
 const admin = require("firebase-admin");
 const { logType, ERROR_WHILE_FETCHING_LOGS } = require("../constants/logs");
 const { INTERNAL_SERVER_ERROR } = require("../constants/errorMessages");
-const { getFullName } = require("../utils/users");
+const { getFullName, getUserId } = require("../utils/users");
 const {
   getUsersListFromLogs,
   formatLogsForFeed,
@@ -164,18 +164,48 @@ const fetchLastAddedCacheLog = async (id) => {
 };
 
 const fetchAllLogs = async (query) => {
-  let { type, prev, next, page, size = SIZE, format } = query;
+  let { type, prev, next, page, size = SIZE, format, userId, username, startDate, endDate, dev } = query;
+
   size = parseInt(size);
   page = parseInt(page);
 
   try {
     let requestQuery = logsModel;
+    const isDev = dev === "true";
+
+    if (isDev && username) {
+      userId = await getUserId(username);
+      requestQuery = requestQuery.where("meta.userId", "==", userId);
+    }
 
     if (type) {
       const logType = type.split(",");
       if (logType.length >= 1) requestQuery = requestQuery.where("type", "in", logType);
     }
 
+    if (isDev && (startDate || endDate)) {
+      startDate = startDate ? parseInt(startDate) : null;
+      endDate = endDate ? parseInt(endDate) : null;
+
+      if (startDate && endDate && startDate > endDate) {
+        const error = new Error("Start date cannot be greater than end date.");
+        error.statusCode = 400;
+        throw error;
+      }
+
+      const buildTimestamp = (date) => ({
+        _seconds: Math.floor(date / 1000),
+        _nanoseconds: 0,
+      });
+
+      if (startDate) {
+        requestQuery = requestQuery.where("timestamp", ">=", buildTimestamp(startDate));
+      }
+      if (endDate) {
+        requestQuery = requestQuery.where("timestamp", "<=", buildTimestamp(endDate));
+      }
+    }
+
     requestQuery = requestQuery.orderBy("timestamp", "desc");
     let requestQueryDoc = requestQuery;
 
@@ -205,12 +235,14 @@ const fetchAllLogs = async (query) => {
       const last = snapshot.docs[snapshot.docs.length - 1];
       nextDoc = await requestQuery.startAfter(last).limit(1).get();
     }
+
     const allLogs = [];
     if (!snapshot.empty) {
       snapshot.forEach((doc) => {
         allLogs.push({ ...doc.data() });
       });
     }
+
     if (allLogs.length === 0) {
       return {
         allLogs: [],
@@ -219,17 +251,23 @@ const fetchAllLogs = async (query) => {
         page: page ? page + 1 : null,
       };
     }
+
     if (format === "feed") {
-      let logsData = [];
       const userList = await getUsersListFromLogs(allLogs);
       const taskIdList = await getTasksFromLogs(allLogs);
       const usersMap = mapify(userList, "id");
       const tasksMap = mapify(taskIdList, "id");
-      logsData = allLogs.map((data) => {
+
+      const logsData = allLogs.map((data) => {
         const formattedLogs = formatLogsForFeed(data, usersMap, tasksMap);
         if (!Object.keys(formattedLogs).length) return null;
-        return { ...formattedLogs, type: data.type, timestamp: convertTimestamp(data.timestamp) };
+        return {
+          ...formattedLogs,
+          type: data.type,
+          timestamp: convertTimestamp(data.timestamp),
+        };
       });
+
       return {
         allLogs: logsData.filter((log) => log),
         prev: prevDoc.empty ? null : prevDoc.docs[0].id,

test/integration/logs.test.js

@@ -201,6 +201,67 @@ describe("/logs", function () {
           return done();
         });
     });
+
+    it("should return logs filtered by username, startDate, and endDate when dev flag is enabled", function (done) {
+      const username = "joygupta";
+      const startDate = 1729841400000;
+      const endDate = 1729841500000;
+      chai
+        .request(app)
+        .get(`/logs?username=${username}&startDate=${startDate}&endDate=${endDate}&dev=true`)
+        .set("cookie", `${cookieName}=${superUserToken}`)
+        .end(function (err, res) {
+          if (err) {
+            return done(err);
+          }
+          expect(res).to.have.status(200);
+          expect(res.body.message).to.equal("All Logs fetched successfully");
+
+          expect(res.body.data).to.be.an("array");
+          res.body.data.forEach((log) => {
+            expect(log).to.have.property("meta");
+            expect(log).to.have.property("body");
+            expect(log.meta).to.have.property("userId");
+            const timestamp = log.timestamp._seconds * 1000;
+            expect(timestamp).to.be.at.least(startDate);
+            expect(timestamp).to.be.at.most(endDate);
+          });
+
+          return done();
+        });
+    });
+
+    it("should return an error if startDate is greater than endDate", function (done) {
+      const username = "joygupta";
+      const startDate = 1729841500000;
+      const endDate = 1729841400000;
+
+      chai
+        .request(app)
+        .get(`/logs?username=${username}&startDate=${startDate}&endDate=${endDate}&dev=true`)
+        .set("cookie", `${cookieName}=${superUserToken}`)
+        .end(function (_err, res) {
+          expect(res).to.have.status(400);
+          expect(res.body.error).to.equal("Start date cannot be greater than end date.");
+          return done();
+        });
+    });
+
+    it("should return an empty array if no logs match username and date range", function (done) {
+      const username = "nonexistentUser";
+      const startDate = 1729841400000;
+      const endDate = 1729841500000;
+
+      chai
+        .request(app)
+        .get(`/logs?username=${username}&startDate=${startDate}&endDate=${endDate}&dev=true`)
+        .set("cookie", `${cookieName}=${superUserToken}`)
+        .end(function (_err, res) {
+          expect(res).to.have.status(200);
+          expect(res.body.message).to.equal("All Logs fetched successfully");
+          return done();
+        });
+    });
   });
 
   describe("Update logs", function () {