refactor: First pass of logging on version_router

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_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:")
@@ -53,6 +54,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_query_router PROPERTIES FIXTURES_REQUIRED Foxx)
   set_tests_properties(foxx_task_router PROPERTIES FIXTURES_REQUIRED Foxx)
   set_tests_properties(foxx_unit_user_token PROPERTIES FIXTURES_REQUIRED Foxx)

core/database/foxx/api/version_router.js

@@ -0,0 +1,66 @@
+'use strict';
+
+const createRouter = require('@arangodb/foxx/router');
+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;
+
+
+//==================== ACL API FUNCTIONS
+
+
+router.get('/version', function(req, res) {
+        let client = null;
+        try {
+            client = req.queryParams.client;
+            logger.logRequestStarted({
+                client: client,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/version",
+                status: "Started",
+                description: "Get version numbers",
+            });
+            res.send({
+                "release_year": 2025,
+                "release_month": 10,
+                "release_day": 7,
+                "release_hour": 14,
+                "release_minute": 1,
+                "api_major": 1,
+                "api_minor": 1,
+                "api_patch": 0,
+                "component_major": 1,
+                "component_minor": 1,
+                "component_patch": 0
+            });
+            logger.logRequestSuccess({
+                client: client,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "GET",
+                routePath: basePath + "/version",
+                status: "Success",
+                description: "Get version numbers",
+                extra: null
+            });
+        } catch (e) {
+            logger.logRequestFailure({
+                client: client,
+                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);
+        }
+    })
+    .summary('Get version numbers')
+    .description('Get version number of Foxx service, of foxx API and of release');

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

@@ -0,0 +1,49 @@
+"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)
+  });
+});