Capture logs when user document is updated (#2182)

* feat: add logs when user doc is updated

* chore: remove query from api

* chore: fix addlog when user doc is updated

* chore: fix circular dependency

* chore: fix failing test

* chore: remove extra changes

* chore: add integration test

* chore: add test for log service

Author: vinit717

constants/logs.ts

@@ -13,6 +13,7 @@ export const logType = {
   EXTENSION_REQUESTS: "extensionRequests",
   TASK: "task",
   TASK_REQUESTS: "taskRequests",
+  USER_DETAILS_UPDATED: "USER_DETAILS_UPDATED", 
   ...REQUEST_LOG_TYPE,
 };
 

models/users.js

@@ -24,6 +24,8 @@ const admin = require("firebase-admin");
 const { INTERNAL_SERVER_ERROR } = require("../constants/errorMessages");
 const { AUTHORITIES } = require("../constants/authorities");
 const { formatUsername } = require("../utils/username");
+const { logType } = require("../constants/logs");
+const { addLog } = require("../services/logService");
 
 /**
  * Adds or updates the user data
@@ -48,6 +50,13 @@ const addOrUpdate = async (userData, userId = null) => {
           },
           { merge: true }
         );
+
+        const logData = {
+          type: logType.USER_DETAILS_UPDATED,
+          meta: { userId: userId },
+          body: userData,
+        };
+        await addLog(logData.type, logData.meta, logData.body);
       }
 
       return { isNewUser, userId };
@@ -63,6 +72,14 @@ const addOrUpdate = async (userData, userId = null) => {
     }
     if (user && !user.empty && user.docs !== null) {
       await userModel.doc(user.docs[0].id).set({ ...userData, updated_at: Date.now() }, { merge: true });
+
+      const logData = {
+        type: logType.USER_DETAILS_UPDATED,
+        meta: { userId: user.docs[0].id },
+        body: userData,
+      };
+      await addLog(logData.type, logData.meta, logData.body);
+
       const data = user.docs[0].data();
       return {
         isNewUser: false,

services/logService.ts

@@ -0,0 +1,35 @@
+import firestore from "../utils/firestore";
+const logsModel = firestore.collection("logs");
+import admin from "firebase-admin";
+const { INTERNAL_SERVER_ERROR } = require("../constants/errorMessages");
+
+interface LogMeta {
+  userId?: string;
+  [key: string]: number | string | object;
+}
+
+interface LogBody {
+  [key: string]: number | string | object;
+}
+
+/**
+ * Adds log
+ *
+ * @param type { string }: Type of the log
+ * @param meta { LogMeta }: Meta data of the log
+ * @param body { LogBody }: Body of the log
+ */
+export const addLog = async (type: string, meta: LogMeta, body: LogBody): Promise<FirebaseFirestore.DocumentReference<FirebaseFirestore.DocumentData>> => {
+  try {
+    const log = {
+      type,
+      timestamp: admin.firestore.Timestamp.fromDate(new Date()),
+      meta,
+      body,
+    };
+    return await logsModel.add(log);
+  } catch (err) {
+    logger.error("Error in adding log", err);
+    throw new Error(INTERNAL_SERVER_ERROR);
+  }
+};

test/integration/logs.test.js

@@ -108,7 +108,7 @@ describe("/logs", function () {
           }
           expect(res).to.have.status(200);
           expect(res.body.message).to.equal("All Logs fetched successfully");
-          expect(res.body.data).to.lengthOf(7);
+          expect(res.body.data).to.lengthOf(9);
           return done();
         });
     });
@@ -202,6 +202,37 @@ describe("/logs", function () {
         });
     });
   });
+
+  describe("Add logs when user doc is update", function () {
+    let jwt;
+    let userId;
+
+    beforeEach(async function () {
+      userId = await addUser();
+      jwt = authService.generateAuthToken({ userId });
+    });
+
+    it("Should update the users and capture the logs", async function () {
+      const res = await chai.request(app).patch("/users/self").set("cookie", `${cookieName}=${jwt}`).send({
+        first_name: "Test first_name",
+      });
+
+      expect(res).to.have.status(204);
+
+      const logRes = await chai
+        .request(app)
+        .get("/logs/USER_DETAILS_UPDATED")
+        .set("cookie", `${cookieName}=${superUserToken}`);
+
+      expect(logRes).to.have.status(200);
+      expect(logRes.body.message).to.equal("Logs fetched successfully");
+
+      const log = logRes.body.logs[0];
+      expect(log).to.have.property("meta");
+      expect(log).to.have.property("body");
+      expect(log.type).to.equal("USER_DETAILS_UPDATED");
+    });
+  });
 });
 
 async function addLogs() {

test/unit/services/logService.test.ts

@@ -0,0 +1,47 @@
+import { expect } from "chai";
+const Sinon = require("sinon");
+const cleanDb = require("../../utils/cleanDb");
+const { addLog } = require("../../../services/logService");
+const { INTERNAL_SERVER_ERROR } = require("../../../constants/errorMessages");
+
+describe("Logs services", function () {
+    beforeEach(function () {
+      Sinon.restore();
+    });
+
+    afterEach(async function () {
+      await cleanDb();
+    });
+
+    it("should successfully add a log", async function () {
+      const type = "TEST_LOG";
+      const meta = {
+        userId: "test-user-123",
+        action: "test-action"
+      };
+      const body = {
+        details: "test details",
+        status: "success"
+      };
+
+      const result = await addLog(type, meta, body);
+
+      expect(result).to.have.property('id');
+      expect(typeof result.id).to.equal('string');
+      expect(result.id).to.not.be.empty;
+    });
+
+    it("should handle errors when adding log fails", async function () {
+      
+      const type = "TEST_LOG";
+      const meta = { userId: "test-user-123" };
+      const body = { details: "test details" };
+
+      try {
+        await addLog(type, meta, body);
+        expect.fail(INTERNAL_SERVER_ERROR);
+      } catch (error) {
+        expect(error.message).to.equal(INTERNAL_SERVER_ERROR);
+      }
+    });
+});