Merge branch 'refactor-DAPS-1522-Version-Router-Logging-Improvements' of github.com:ORNL/DataFed into refactor-DAPS-1522-Version-Router-Logging-Improvements

megatnt1122 · megatnt1122 · commit 68f2ca12a297 · 2025-11-13T14:37:57.000-05:00
diff --git a/CMakeLists.txt b/CMakeLists.txt
@@ -241,8 +241,8 @@ if( INSTALL_FOXX )
                                 RESULT_VARIABLE _res)
                 if (NOT \${_res} EQUAL \"0\")
                     message( FATAL_ERROR \"out: \${_out} install_foxx failed: \${_err}\")
-		else()
-                    message( \"\${_out} install_foxx failed: \${_err}\")
+                else()
+                    message( \"\${_out} install_foxx completed: \${_err}\")
                 endif()"
          )
 endif()
diff --git a/core/database/CMakeLists.txt b/core/database/CMakeLists.txt
@@ -29,6 +29,7 @@ if( ENABLE_FOXX_TESTS )
   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:")
   add_test(NAME foxx_query_router COMMAND "${CMAKE_CURRENT_SOURCE_DIR}/tests/test_foxx.sh" -t "unit_query_router:")
@@ -55,6 +56,7 @@ if( ENABLE_FOXX_TESTS )
   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)
   set_tests_properties(foxx_unit_user_token PROPERTIES FIXTURES_REQUIRED Foxx)
diff --git a/core/database/foxx/api/tag_router.js b/core/database/foxx/api/tag_router.js
@@ -7,32 +7,48 @@ const joi = require("joi");
 
 const g_db = require("@arangodb").db;
 const g_lib = require("./support");
+const logger = require("./lib/logger");
 
+const basePath = "tag";
 module.exports = router;
 
 //==================== TAG API FUNCTIONS
 
 router
     .post("/search", function (req, res) {
+        let client = null;
+        let result = null;
+        let tot = null;
         try {
+            client = req.queryParams.client
+                ? g_lib.getUserFromClientID(req.queryParams.client)
+                : null;
+            logger.logRequestStarted({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "POST",
+                routePath: basePath + "/search",
+                status: "Started",
+                description: `Search for tags by name (${req.queryParams?.name?.trim()})`,
+            });
             var name = req.queryParams.name.trim();
             if (name.length < 3)
                 throw [error.ERR_INVALID_PARAM, "Input is too short for tag search."];
 
-            var off = req.queryParams.offset ? req.queryParams.offset : 0,
-                cnt = req.queryParams.count ? req.queryParams.count : 50,
-                result = g_db._query(
-                    "for t in tagview search analyzer(t._key in tokens(@name,'tag_name'), 'tag_name') let s = BM25(t) sort s desc limit @off,@cnt return {name: t._key, count: t.count}",
-                    {
-                        name: name,
-                        off: off,
-                        cnt: cnt,
-                    },
-                    {
-                        fullCount: true,
-                    },
-                ),
-                tot = result.getExtra().stats.fullCount;
+            var off = req.queryParams.offset ? req.queryParams.offset : 0;
+            var cnt = req.queryParams.count ? req.queryParams.count : 50;
+            result = g_db._query(
+                "for t in tagview search analyzer(t._key in tokens(@name,'tag_name'), 'tag_name') let s = BM25(t) sort s desc limit @off,@cnt return {name: t._key, count: t.count}",
+                {
+                    name: name,
+                    off: off,
+                    cnt: cnt,
+                },
+                {
+                    fullCount: true,
+                },
+            );
+            tot = result.getExtra().stats.fullCount;
 
             result = result.toArray();
             result.push({
@@ -44,7 +60,34 @@ router
             });
 
             res.send(result);
+            logger.logRequestSuccess({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "POST",
+                routePath: basePath + "/search",
+                status: "Success",
+                description: `Search for tags by name(${req.queryParams?.name?.trim()})`,
+                extra: {
+                    requestedName: name,
+                    returnedCount: result?.length - 1, // subtract the paging object
+                    total_found: tot,
+                },
+            });
         } catch (e) {
+            logger.logRequestFailure({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "POST",
+                routePath: basePath + "/search",
+                status: "Failure",
+                description: `Search for tags by name(${req.queryParams?.name?.trim()})`,
+                extra: {
+                    requestedName: name,
+                    returnedCount: result?.length - 1, // subtract the paging object
+                    total_found: tot,
+                },
+                error: e,
+            });
             g_lib.handleException(e, res);
         }
     })
@@ -56,7 +99,21 @@ router
 
 router
     .post("/list/by_count", function (req, res) {
+        let client = null;
+        let tot = null;
         try {
+            client = req.queryParams.client
+                ? g_lib.getUserFromClientID(req.queryParams.client)
+                : null;
+            logger.logRequestStarted({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "POST",
+                routePath: basePath + "/list/by_count",
+                status: "Started",
+                description: "List tags by count",
+            });
+
             g_db._executeTransaction({
                 collections: {
                     read: ["tag"],
@@ -76,7 +133,7 @@ router
                         },
                     );
 
-                    var tot = result.getExtra().stats.fullCount;
+                    tot = result.getExtra().stats.fullCount;
                     result = result.toArray();
                     result.push({
                         paging: {
@@ -87,9 +144,29 @@ router
                     });
 
                     res.send(result);
+                    logger.logRequestSuccess({
+                        client: client?._id,
+                        correlationId: req.headers["x-correlation-id"],
+                        httpVerb: "POST",
+                        routePath: basePath + "/list/by_count",
+                        status: "Success",
+                        description: "List tags by count",
+                        extra: { total_tags: tot },
+                    });
                 },
             });
         } catch (e) {
+            logger.logRequestFailure({
+                client: client?._id,
+                correlationId: req.headers["x-correlation-id"],
+                httpVerb: "POST",
+                routePath: basePath + "/list/by_count",
+                status: "Failure",
+                description: "List tags by count",
+                extra: { total_tags: tot },
+                error: e,
+            });
+
             g_lib.handleException(e, res);
         }
     })
diff --git a/core/database/foxx/tests/tag_router.test.js b/core/database/foxx/tests/tag_router.test.js
@@ -0,0 +1,63 @@
+"use strict";
+// NOTE: completion of tests requires successful run of user_fixture.js script
+
+// Need to pull enum from support
+const g_lib = require("../api/support");
+
+// Integration test of API
+const { expect } = require("chai");
+const request = require("@arangodb/request");
+const { baseUrl } = module.context;
+const { db } = require("@arangodb");
+
+const tag_base_url = `${baseUrl}/tag`;
+
+describe("unit_tag_router: the Foxx microservice topic_router /search endpoint", () => {
+    after(function () {
+        const collections = ["tag"];
+        collections.forEach((name) => {
+            let col = db._collection(name);
+            if (col) col.truncate();
+        });
+    });
+
+    beforeEach(() => {
+        const collections = ["tag"];
+        collections.forEach((name) => {
+            let col = db._collection(name);
+            if (col) {
+                col.truncate(); // truncate after ensuring collection exists
+            } else {
+                db._create(name); // create if it doesn’t exist
+            }
+        });
+    });
+
+    it("should successfully run the search route", () => {
+        db.tag.save({
+            name: "testName",
+        });
+
+        // arrangesudo journalctl -u arangodb3.service -f
+        // TODO: make encoded query params less hard coded
+        const request_string = `${tag_base_url}/search?name=testName`;
+        // act
+        const response = request.post(request_string);
+        // assert
+        expect(response.status).to.equal(200);
+    });
+
+    it("should successfully run the list by count route", () => {
+        db.tag.save({
+            name: "testName",
+        });
+
+        // arrangesudo journalctl -u arangodb3.service -f
+        // TODO: make encoded query params less hard coded
+        const request_string = `${tag_base_url}/list/by_count`;
+        // act
+        const response = request.post(request_string);
+        // assert
+        expect(response.status).to.equal(200);
+    });
+});
diff --git a/scripts/install_foxx.sh b/scripts/install_foxx.sh
@@ -161,13 +161,38 @@ fi
 
 url="${local_DATABASE_API_SCHEME}://${local_DATAFED_DATABASE_HOST}:${local_DATABASE_PORT}/_api/database/user"
 # Do not output to /dev/null we need the output
-code=$(LD_LIBRARY_PATH="${DATAFED_DEPENDENCIES_INSTALL_PATH}:$LD_LIBRARY_PATH" curl ${local_CURL_SSL_ARG} -s -o /dev/null -w "%{http_code}" --user "$basic_auth" "$url")
 
-if [[ "$code" != "200" ]]; then
-  echo "ERROR - Attempting to connect to database at $url"
-  echo "        HTTP code is: $code"
-  exit 1
-fi
+max_retries=3
+retry_delay=5
+
+for attempt in $(seq 1 $max_retries); do
+  set +e
+  code=$(LD_LIBRARY_PATH="${DATAFED_DEPENDENCIES_INSTALL_PATH}:$LD_LIBRARY_PATH" \
+    curl ${local_CURL_SSL_ARG} -s -o /dev/null -w "%{http_code}" \
+    --user "$basic_auth" "$url")
+  error_code=$?
+  set -e
+
+  if [[ "$error_code" -eq 0 && "$code" -eq 200 ]]; then
+    echo "INFO - Attempting to connect to database at $url"
+    echo "       HTTP code is: $code"
+    echo "       Succeeded"
+    break
+  fi
+
+  if [[ "$attempt" -lt "$max_retries" ]]; then
+    echo "WARNING - Attempting to connect to database at $url"
+    echo "          HTTP code is: $code"
+    echo "          Failed"
+    echo "          Retrying in ${retry_delay}s..."
+    sleep "$retry_delay"
+  else
+    echo "ERROR - Attempting to connect to database at $url"
+    echo "        HTTP code is: $code"
+    echo "        Failed after $max_retries"
+    exit 1
+  fi
+done
 
 url2="${local_DATABASE_API_SCHEME}://${local_DATAFED_DATABASE_HOST}:${local_DATABASE_PORT}/_api/database"
 # We are now going to initialize the DataFed database in Arango, but only if sdms database does
diff --git a/web/datafed-ws.js b/web/datafed-ws.js
@@ -592,12 +592,22 @@ the registration page.
 
                                     a_resp.redirect("/ui/register");
                                 } else {
+                                    if (reply.user.length > 1) {
+                                        logger.warn(
+                                            "ui/authn",
+                                            getCurrentLineNumber(),
+                                            "More than one user was returned from DataFed, this can happen if a user has registered two or more separate accounts with DataFed and has since linked their identities from a third party identity manager. DataFed will select the first identity when logging in.",
+                                        );
+                                    }
+                                    let username = reply.user[0]?.uid?.replace(/^u\//, "");
                                     logger.info(
                                         "/ui/authn",
                                         getCurrentLineNumber(),
                                         "User: " +
                                             uid +
-                                            " verified, acc:" +
+                                            " verified, mapped to: " +
+                                            username +
+                                            " acc:" +
                                             xfr_token.access_token +
                                             ", ref: " +
                                             xfr_token.refresh_token +
@@ -606,7 +616,7 @@ the registration page.
                                     );
 
                                     // Store only data needed for active session
-                                    a_req.session.uid = uid;
+                                    a_req.session.uid = username;
                                     a_req.session.reg = true;
 
                                     let redirect_path = "/ui/main";
