refactor: metrics_rotuer final pass (MORE TESTS REQUIRED)

megatnt1122 · megatnt1122 · commit cc720ceda133 · 2025-11-25T14:05:22.000-05:00
diff --git a/core/database/CMakeLists.txt b/core/database/CMakeLists.txt
@@ -33,6 +33,7 @@ if( ENABLE_FOXX_TESTS )
   add_test(NAME foxx_task_router COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_task_router:")
   add_test(NAME foxx_authz_router COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_authz_router:")
   add_test(NAME foxx_query_router COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_query_router:")
+  add_test(NAME foxx_metrics_router COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_metrics_router:")
   add_test(NAME foxx_unit_user_token COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_user_token:")
   add_test(NAME foxx_unit_user_model COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_user_model:")
   add_test(NAME foxx_unit_globus_collection_model COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_globus_collection_model:")
@@ -55,6 +56,7 @@ if( ENABLE_FOXX_TESTS )
   set_tests_properties(foxx_validation_repo PROPERTIES FIXTURES_REQUIRED Foxx)
   set_tests_properties(foxx_path PROPERTIES FIXTURES_REQUIRED Foxx)
   set_tests_properties(foxx_user_router PROPERTIES FIXTURES_REQUIRED "Foxx;FoxxDBFixtures")
+  set_tests_properties(foxx_metrics_router PROPERTIES FIXTURES_REQUIRED Foxx)
   set_tests_properties(foxx_version_router PROPERTIES FIXTURES_REQUIRED Foxx)
   set_tests_properties(foxx_tag_router PROPERTIES FIXTURES_REQUIRED Foxx)
   set_tests_properties(foxx_query_router PROPERTIES FIXTURES_REQUIRED Foxx)
diff --git a/core/database/foxx/api/metrics_router.js b/core/database/foxx/api/metrics_router.js
@@ -5,12 +5,23 @@ const router = createRouter();
 const g_db = require("@arangodb").db;
 const g_lib = require("./support");
 const joi = require("joi");
+const logger = require("./lib/logger");
 
 module.exports = router;
 
+const basePath = "metrics";
 router
     .post("/msg_count/update", function (req, res) {
+        const client = g_lib.getUserFromClientID(req.queryParams.client);
         try {
+            logger.logRequestStarted({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/msg_count/update",
+                status: "Started",
+                description: "Update message metrics",
+            });
             var i,
                 u,
                 ts = req.body.timestamp,
@@ -33,7 +44,26 @@ router
                 };
                 g_db.metrics.save(obj);
             }
+            logger.logRequestSuccess({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/msg_count/update",
+                status: "Success",
+                description: "Update message metrics",
+                extra: obj,
+            });
         } catch (e) {
+            logger.logRequestFailure({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/msg_count/update",
+                status: "Failure",
+                description: "Update message metrics",
+                extra: obj,
+                error: e,
+            });
             g_lib.handleException(e, res);
         }
     })
@@ -43,7 +73,16 @@ router
 
 router
     .get("/msg_count", function (req, res) {
+        const client = g_lib.getUserFromClientID(req.queryParams.client);
         try {
+            logger.logRequestStarted({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/msg_count",
+                status: "Started",
+                description: "Update message metrics",
+            });
             var par = {
                     now: Date.now() / 1000,
                     since: 60 * (req.queryParams.since ? req.queryParams.since : 60),
@@ -71,7 +110,26 @@ router
             }
 
             res.send(result);
+            logger.logRequestSuccess({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/msg_count",
+                status: "Success",
+                description: "Update message metrics",
+                extra: result,
+            });
         } catch (e) {
+            logger.logRequestFailure({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/msg_count",
+                status: "Failure",
+                description: "Update message metrics",
+                extra: result,
+                error: e,
+            });
             g_lib.handleException(e, res);
         }
     })
@@ -87,7 +145,19 @@ router
 
 router
     .get("/users/active", function (req, res) {
+        const client = req.queryParams.client
+            ? g_lib.getUserFromClientID(req.queryParams.client)
+            : null;
         try {
+            logger.logRequestStarted({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/users/active",
+                status: "Started",
+                description: "Get recently active users from metrics",
+            });
+
             var cnt = {},
                 u,
                 r,
@@ -111,7 +181,27 @@ router
             }
 
             res.json(cnt);
+            logger.logRequestSuccess({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/users/active",
+                status: "Success",
+                description: "Get recently active users from metrics",
+                extra: cnt,
+            });
         } catch (e) {
+            logger.logRequestFailure({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/users/active",
+                status: "Failure",
+                description: "Get recently active users from metrics",
+                extra: cnt,
+                error: e,
+            });
+
             g_lib.handleException(e, res);
         }
     })
@@ -125,7 +215,17 @@ router
 
 router
     .post("/purge", function (req, res) {
+        const client = g_lib.getUserFromClientID(req.queryParams.client);
         try {
+            logger.logRequestStarted({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/purge",
+                status: "Started",
+                description: "Purge older metrics",
+            });
+
             g_db.metrics.save({
                 timestamp: Math.floor(Date.now() / 1000),
                 type: "purge",
@@ -135,7 +235,26 @@ router
             g_db._query("for i in metrics filter i.timestamp < @ts remove i in metrics", {
                 ts: req.queryParams.timestamp,
             });
+            logger.logRequestSuccess({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/purge",
+                status: "Success",
+                description: "Purge older metrics",
+                extra: "undefined",
+            });
         } catch (e) {
+            logger.logRequestFailure({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/purge",
+                status: "Failure",
+                description: "Purge older metrics",
+                extra: "undefined",
+                error: e,
+            });
             g_lib.handleException(e, res);
         }
     })
diff --git a/core/database/foxx/tests/metrics_router.test.js b/core/database/foxx/tests/metrics_router.test.js
@@ -0,0 +1,96 @@
+"use strict";
+
+const g_lib = require("../api/support");
+const { expect } = require("chai");
+const request = require("@arangodb/request");
+const { baseUrl } = module.context;
+const { db } = require("@arangodb");
+
+const metrics_base_url = `${baseUrl}/metrics`;
+
+describe("unit_metrics_router: /users/active endpoint", () => {
+    after(function () {
+        const collections = ["metrics"];
+        collections.forEach((name) => {
+            let col = db._collection(name);
+            if (col) col.truncate();
+        });
+    });
+    beforeEach(() => {
+        const collections = ["metrics"];
+        collections.forEach((name) => {
+            let col = db._collection(name);
+            if (col) {
+                col.truncate();
+            } else {
+                db._create(name);
+            }
+        });
+    });
+
+    it("should return active users within the default 15 minutes", () => {
+        const now = Math.floor(Date.now() / 1000);
+
+        db.metrics.save([
+            {
+                _key: "m1",
+                type: "msgcnt_user",
+                uid: "u/fakeUser",
+                total: 5,
+                timestamp: now - 60 * 5, // 5 minutes ago
+            },
+            {
+                _key: "m2",
+                type: "msgcnt_user",
+                uid: "u/otherUser",
+                total: 10,
+                timestamp: now - 60 * 20, // 20 minutes ago
+            },
+        ]);
+
+        const request_string = `${metrics_base_url}/users/active`;
+        const response = request.get(request_string);
+
+        expect(response.status).to.equal(200);
+
+        const body = JSON.parse(response.body);
+
+        // u/fakeUser should appear, u/otherUser should not
+        expect(body).to.have.property("u/fakeUser");
+        expect(body["u/fakeUser"]).to.equal(5);
+        expect(body).to.not.have.property("u/otherUser");
+    });
+
+    it("should respect the 'since' query parameter", () => {
+        const now = Math.floor(Date.now() / 1000);
+
+        db.metrics.save([
+            {
+                _key: "m3",
+                type: "msgcnt_user",
+                uid: "u/fakeUser",
+                total: 7,
+                timestamp: now - 60 * 30, // 30 minutes ago
+            },
+        ]);
+
+        // since=45 → include 30-min-old record
+        let response = request.get(`${metrics_base_url}/users/active?since=45`);
+        expect(response.status).to.equal(200);
+        let body = JSON.parse(response.body);
+        expect(body).to.have.property("u/fakeUser");
+
+        // since=15 → exclude 30-min-old record
+        response = request.get(`${metrics_base_url}/users/active?since=15`);
+        expect(response.status).to.equal(200);
+        body = JSON.parse(response.body);
+        expect(body).to.not.have.property("u/fakeUser");
+    });
+
+    it("should return an empty object if no users are active", () => {
+        const response = request.get(`${metrics_base_url}/users/active`);
+        expect(response.status).to.equal(200);
+        const body = JSON.parse(response.body);
+        expect(body).to.deep.equal({});
+    });
+});
