Merge branch 'devel' of github.com:ORNL/DataFed into devel

Author: JoshuaSBrown

core/server/DatabaseAPI.cpp

@@ -3656,91 +3656,105 @@ void DatabaseAPI::taskPurge(uint32_t a_age_sec, LogContext log_context) {
       }
   */
 
+/**
+ * @brief Converts client metrics into a structured JSON string.
+ *
+ * This method takes a timestamp, a total count, and a nested map of client
+ * metrics, and produces a JSON string with the following structure:
+ *
+ * - `timestamp`: the timestamp provided.
+ * - `total`: the total count provided.
+ * - `uids` (or clients): a JSON object where each key is a client ID and the
+ * value is an object containing:
+ *     - `tot`: subtotal for the client (from message type 0, if present)
+ *     - `msg`: an object mapping message types (as strings) to counts.
+ *
+ * @param a_timestamp The timestamp to include in the JSON payload.
+ * @param a_total The total count across all clients (sum of all subtotals).
+ * @param a_metrics A map where:
+ *   - The first key (`std::string`) is the client ID.
+ *   - The nested map (`std::map<uint16_t, uint32_t>`) maps:
+ *       - Key: message type (uint16_t), where `0` is reserved for subtotal.
+ *       - Value: count of messages for that type, at key `0` it is the
+ * subtotal.
+ *   - If a client has no metrics, the nested map will be empty.
+ *   - Message type `0` is used as a subtotal and is never a valid message type.
+ *
+ * @return A formatted JSON string representing the clients and their message
+ * counts.
+ *
+ * @note The JSON structure will always include the `"uids"` object, even if
+ * empty.
+ * @note Message type keys in `"msg"` are converted to strings to ensure valid
+ * JSON objects.
+ *
+ * In the below example total is equivalent to subtotal because there is only
+ * one client.
+ *
+ * @example
+ * Input:
+ * @code
+ * timestamp = 111
+ * total = 15
+ * metrics = {
+ *     {"client1", {{0, 15}, {1, 10}, {2, 5}}}
+ * }
+ * @endcode
+ *
+ * Output JSON:
+ * @code
+ * {
+ *   "timestamp": 111,
+ *   "total": 15,
+ *   "uids": {
+ *     "client1": {
+ *       "tot": 15,
+ *       "msg": {
+ *         "1": 10,
+ *         "2": 5
+ *       }
+ *     }
+ *   }
+ * }
+ * @endcode
+ */
 std::string DatabaseAPI::newJsonMetricParse(
     uint32_t a_timestamp, uint32_t a_total,
     const std::map<std::string, std::map<uint16_t, uint32_t>> &a_metrics) {
-  map<string, std::map<uint16_t, uint32_t>>::const_iterator u;
-  map<uint16_t, uint32_t>::const_iterator m;
+
   nlohmann::json payload;
-  payload["timestamp"] = to_string(a_timestamp);
-  payload["total"] = to_string(a_total);
-
-  nlohmann::json uids;
-  for (u = a_metrics.begin(); u != a_metrics.end(); ++u) {
-    nlohmann::json uid_body;
-    uid_body["tot"] = to_string(u->second.at(0));
-    nlohmann::json uid_msg;
-    for (m = u->second.begin(); m != u->second.end(); ++m) {
-      if (m->first != 0) {
-        uid_msg[to_string(m->first)] = to_string(m->second);
-      }
-    }
-    uid_body["msg"] = uid_msg;
+  payload["timestamp"] = a_timestamp;
+  payload["total"] = a_total;
 
-    uids[u->first] = uid_body;
-  }
+  nlohmann::json clients_json = nlohmann::json::object();
 
-  payload["uids"] = uids;
-  string body = payload.dump(-1, ' ', true);
-  return body;
-}
+  for (const auto &[client_id, client_metrics] : a_metrics) {
+    nlohmann::json client_json;
 
-// TODO: verify and remove
-std::string DatabaseAPI::oldJsonMetricParse(
-    uint32_t a_timestamp, uint32_t a_total,
-    const std::map<std::string, std::map<uint16_t, uint32_t>> &a_metrics) {
-  map<string, std::map<uint16_t, uint32_t>>::const_iterator u;
-  map<uint16_t, uint32_t>::const_iterator m;
-  string body = "{\"timestamp\":" + to_string(a_timestamp) +
-                ",\"total\":" + to_string(a_total) + ",\"uids\":{";
-  bool c = false, cc;
-
-  for (u = a_metrics.begin(); u != a_metrics.end(); ++u) {
-    if (c)
-      body += ",";
-    else
-      c = true;
-
-    body += "\"" + u->first + "\":{\"tot\":" + to_string(u->second.at(0)) +
-            ",\"msg\":{";
-
-    for (cc = false, m = u->second.begin(); m != u->second.end(); ++m) {
-      if (m->first != 0) {
-        if (cc)
-          body += ",";
-        else
-          cc = true;
-
-        body += "\"" + to_string(m->first) + "\":" + to_string(m->second);
-      }
+    // Use safe access for total
+    auto it = client_metrics.find(0);
+    client_json["tot"] = (it != client_metrics.end()) ? it->second : 0;
+
+    nlohmann::json msg_json;
+    for (const auto &[msg_id, msg_count] : client_metrics) {
+      if (msg_id != 0)
+        msg_json[std::to_string(msg_id)] = msg_count;
     }
-    body += "}}";
+
+    client_json["msg"] = msg_json;
+    clients_json[client_id] = client_json;
   }
 
-  body += "}}";
-  return body;
+  payload["uids"] = clients_json;
+  return payload.dump(-1, ' ', true);
 }
 
 void DatabaseAPI::metricsUpdateMsgCounts(
     uint32_t a_timestamp, uint32_t a_total,
     const std::map<std::string, std::map<uint16_t, uint32_t>> &a_metrics,
     LogContext log_context) {
 
-  string body;
-  string new_body = newJsonMetricParse(a_timestamp, a_total, a_metrics);
-  string old_body = oldJsonMetricParse(a_timestamp, a_total, a_metrics);
-
-  if (new_body == old_body) {
-    // on match use safer serialization
-    body = new_body;
-  } else {
-    body = old_body;
-    DL_WARNING(
-        log_context,
-        "Serialized metric bodies did not match, new serialization yielded:\n"
-            << new_body << "\n old serialization yielded:\n"
-            << old_body);
-  }
+  std::string body = newJsonMetricParse(a_timestamp, a_total, a_metrics);
 
   libjson::Value result;
 

core/server/DatabaseAPI.hpp

@@ -333,7 +333,7 @@ class DatabaseAPI {
       LogContext);
   void metricsPurge(uint32_t a_timestamp, LogContext);
 
-private:
+protected:
   long dbGet(const char *a_url_path,
              const std::vector<std::pair<std::string, std::string>> &a_params,
              libjson::Value &a_result, LogContext, bool a_log = true);

core/server/tests/unit/CMakeLists.txt

@@ -2,6 +2,7 @@
 foreach(PROG
     test_AuthMap
     test_AuthenticationManager
+    test_DatabaseAPI
 )
 
   file(GLOB ${PROG}_SOURCES ${PROG}*.cpp)