[DAPS-1522] Version Router Logging Improvements (#1758)

Author: megatnt1122

core/database/CMakeLists.txt

@@ -28,6 +28,7 @@ if( ENABLE_FOXX_TESTS )
   add_test(NAME foxx_version COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_version:")
   add_test(NAME foxx_support COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_support:")
   add_test(NAME foxx_user_router COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_user_router:")
+  add_test(NAME foxx_version_router COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_version_router:")
   add_test(NAME foxx_tag_router COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_tag_router:")
   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:")
@@ -54,6 +55,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_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)
   set_tests_properties(foxx_task_router PROPERTIES FIXTURES_REQUIRED Foxx)

core/database/foxx/api/version_router.js.in

@@ -5,6 +5,8 @@ const router = createRouter();
 const joi = require('joi');
 const g_db = require('@arangodb').db;
 const g_lib = require('./support');
+const logger = require("./lib/logger");
+const basePath = "";
 
 module.exports = router;
 
@@ -14,6 +16,14 @@ module.exports = router;
 
 router.get('/version', function(req, res) {
         try {
+            logger.logRequestStarted({
+                client: "anonymous",
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/version",
+                status: "Started",
+                description: "Get version numbers",
+            });
             res.send({
                 "release_year": @DATAFED_RELEASE_YEAR@,
                 "release_month": @DATAFED_RELEASE_MONTH@,
@@ -27,7 +37,26 @@ router.get('/version', function(req, res) {
                 "component_minor": @DATAFED_FOXX_MINOR@,
                 "component_patch": @DATAFED_FOXX_PATCH@
             });
+            logger.logRequestSuccess({
+                client: "anonymous",
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/version",
+                status: "Success",
+                description: "Get version numbers",
+                extra: null
+            });
         } catch (e) {
+            logger.logRequestFailure({
+                client: "anonymous",
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/version",
+                status: "Failure",
+                description: "Get version numbers",
+                extra: null,
+                error: e
+            });
             g_lib.handleException(e, res);
         }
     })

core/database/foxx/tests/version_router.test.js

@@ -0,0 +1,53 @@
+"use strict";
+
+const { expect } = require("chai");
+const request = require("@arangodb/request");
+const { baseUrl } = module.context;
+const { db } = require("@arangodb");
+
+// (replace “myrouter” with the actual base path)
+const base_url = `${baseUrl}/`;
+
+after(function () {
+    // cleanup collections if needed
+    const collections = [
+        /* list collections to truncate */
+    ];
+    collections.forEach((name) => {
+        let col = db._collection(name);
+        if (col) col.truncate();
+    });
+});
+
+describe("unit_version_router: the Foxx microservice version/ endpoint", () => {
+    beforeEach(() => {
+        // ensure collections exist & trimmed/initialized
+        const collections = [
+            /* list collections */
+        ];
+        collections.forEach((name) => {
+            let col = db._collection(name);
+            if (col) {
+                col.truncate();
+            } else {
+                db._create(name);
+            }
+        });
+    });
+
+    it("should succeed when valid parameters given", () => {
+        // arrange: setup fixture data
+        // e.g., db.u.save({...}); db.mycoll.save({...});
+        // TODO: insert required documents
+
+        // arrange: build request string
+        const request_string = `${base_url}/version`;
+
+        // act
+        const response = request.get(request_string);
+
+        // assert
+        expect(response.status).to.equal(200);
+        // additional assertions on response body (if needed)
+    });
+});