Standardize Logs Collection for Consistent Querying (#2226)

* chore: fix log type into lower case

* chore: revert changes for make the logs working

* chore: add logs migration route

* chore: add migration model function

* chore: add tests for migration api

* chore: update route name

* chore: update route name

Author: vinit717

controllers/logs.js

@@ -72,7 +72,19 @@ const fetchAllLogs = async (req, res) => {
   }
 };
 
+const updateLogs = async (req, res) => {
+  try {
+    const response = await logsQuery.updateLogs();
+    return res.json({
+      response,
+    });
+  } catch (error) {
+    return res.boom.serverUnavailable(SOMETHING_WENT_WRONG);
+  }
+};
+
 module.exports = {
   fetchLogs,
   fetchAllLogs,
+  updateLogs,
 };

models/logs.js

@@ -250,10 +250,72 @@ const fetchAllLogs = async (query) => {
   }
 };
 
+const updateLogs = async () => {
+  const batchSize = 500;
+  let lastDoc = null;
+  let isCompleted = false;
+
+  const summary = {
+    totalLogsProcessed: 0,
+    totalLogsUpdated: 0,
+    totalOperationsFailed: 0,
+    failedLogDetails: [],
+  };
+
+  try {
+    while (!isCompleted) {
+      let query = logsModel.orderBy("timestamp").limit(batchSize);
+      if (lastDoc) {
+        query = query.startAfter(lastDoc);
+      }
+      const snapshot = await query.get();
+
+      if (snapshot.empty) {
+        isCompleted = true;
+        continue;
+      }
+
+      const batch = firestore.batch();
+      snapshot.forEach((doc) => {
+        const data = doc.data();
+        if (data.meta && data.meta.createdBy) {
+          const updatedMeta = {
+            ...data.meta,
+            userId: data.meta.createdBy,
+          };
+          delete updatedMeta.createdBy;
+
+          batch.update(doc.ref, { meta: updatedMeta });
+          summary.totalLogsUpdated++;
+        }
+        summary.totalLogsProcessed++;
+      });
+
+      try {
+        await batch.commit();
+      } catch (err) {
+        logger.error("Batch update failed for logs collection:", err);
+        summary.totalOperationsFailed += snapshot.docs.length;
+        summary.failedLogDetails.push(...snapshot.docs.map((doc) => doc.id));
+      }
+
+      lastDoc = snapshot.docs[snapshot.docs.length - 1];
+      isCompleted = snapshot.docs.length < batchSize;
+    }
+
+    logger.info("Migration completed:", summary);
+    return summary;
+  } catch (error) {
+    logger.error("Error during logs migration:", error);
+    throw error;
+  }
+};
+
 module.exports = {
   addLog,
   fetchLogs,
   fetchCacheLogs,
   fetchLastAddedCacheLog,
   fetchAllLogs,
+  updateLogs,
 };

routes/logs.js

@@ -7,5 +7,6 @@ const { SUPERUSER } = require("../constants/roles");
 
 router.get("/:type", authenticate, authorizeRoles([SUPERUSER]), logs.fetchLogs);
 router.get("/", authenticate, authorizeRoles([SUPERUSER]), logs.fetchAllLogs);
+router.post("/migrate", authenticate, authorizeRoles([SUPERUSER]), logs.updateLogs);
 
 module.exports = router;

test/integration/logs.test.js

@@ -203,6 +203,36 @@ describe("/logs", function () {
     });
   });
 
+  describe("Update logs", function () {
+    it("should run the migration and update logs successfully", async function () {
+      const res = await chai.request(app).post("/logs/migrate").set("cookie", `${cookieName}=${superUserToken}`).send();
+
+      expect(res).to.have.status(200);
+      expect(res.body).to.be.an("object");
+      expect(res.body.response).to.have.property("totalLogsProcessed").that.is.a("number");
+      expect(res.body.response).to.have.property("totalLogsUpdated").that.is.a("number");
+      expect(res.body.response).to.have.property("totalOperationsFailed").that.is.a("number");
+      expect(res.body.response).to.have.property("failedLogDetails").that.is.an("array");
+
+      expect(res.body.response.totalLogsProcessed).to.be.at.least(0);
+      expect(res.body.response.totalLogsUpdated).to.be.lessThanOrEqual(res.body.response.totalLogsProcessed);
+
+      expect(res.body.response).to.have.all.keys(
+        "totalLogsProcessed",
+        "totalLogsUpdated",
+        "totalOperationsFailed",
+        "failedLogDetails"
+      );
+    });
+
+    it("should return error if unauthorized user tries to run migration", async function () {
+      const res = await chai.request(app).post("/logs/migrate").set("cookie", `${cookieName}=invalidToken`).send();
+
+      expect(res).to.have.status(401);
+      expect(res.body).to.have.property("error").that.is.a("string");
+    });
+  });
+
   describe("Add logs when user doc is update", function () {
     let jwt;
     let userId;