feat(core): escape double colons in type URI bench arguments

Author: GuillaumeLagrange

core/include/codspeed.h

@@ -42,5 +42,6 @@ void generate_codspeed_walltime_report(
     const std::vector<RawWalltimeBenchmark> &walltime_data_list);
 
 std::string extract_lambda_namespace(const std::string &pretty_func);
+std::string sanitize_bench_args(std::string &text);
 
 #endif // CODSPEED_H

core/src/codspeed.cpp

@@ -4,6 +4,35 @@
 #include <string>
 #include <vector>
 
+// Remove any `::` between brackets at the end to not mess with the URI
+// parsing
+// FIXME: Remove this bandaid when we migrate to structured benchmark metadata
+std::string sanitize_bench_args(std::string &text) {
+  std::string search = "::";
+  std::string replace = "\\:\\:";
+
+  if (text.back() == ']') {
+    size_t pos_open = text.rfind('[');
+    if (pos_open != std::string::npos) {
+      // Extract the substring between '[' and ']'
+      size_t pos_close = text.size() - 1;
+      std::string substring =
+          text.substr(pos_open + 1, pos_close - pos_open - 1);
+
+      // Perform the search and replace within the substring
+      size_t pos = substring.find(search);
+      while (pos != std::string::npos) {
+        substring.replace(pos, search.length(), replace);
+        pos = substring.find(search, pos + replace.length());
+      }
+
+      // Replace the original substring with the modified one
+      text.replace(pos_open + 1, pos_close - pos_open - 1, substring);
+    }
+  }
+  return text;
+}
+
 std::string join(const std::vector<std::string> &elements,
                  const std::string &delimiter) {
   std::string result;
@@ -40,6 +69,8 @@ void CodSpeed::pop_group() {
 void CodSpeed::start_benchmark(const std::string &name) {
   std::string uri = name;
 
+  uri = sanitize_bench_args(uri);
+
   // Sanity check URI and add a placeholder if format is wrong
   if (name.find("::") == std::string::npos) {
     std::string uri = "unknown_file::" + name;

core/src/walltime.cpp

@@ -87,6 +87,18 @@ void compute_iqr_and_outliers(const std::vector<double> &times_ns, double mean,
                     });
 }
 
+std::string escapeBackslashes(const std::string &input) {
+  std::string output;
+  for (char c : input) {
+    if (c == '\\') {
+      output += "\\\\";
+    } else {
+      output += c;
+    }
+  }
+  return output;
+}
+
 void write_codspeed_benchmarks_to_json(
     const std::vector<CodspeedWalltimeBenchmark> &benchmarks) {
   std::ostringstream oss;
@@ -113,8 +125,8 @@ void write_codspeed_benchmarks_to_json(
     const auto &metadata = benchmark.metadata;
 
     oss << "    {\n";
-    oss << "      \"name\": \"" << metadata.name << "\",\n";
-    oss << "      \"uri\": \"" << metadata.uri << "\",\n";
+    oss << "      \"name\": \"" << escapeBackslashes(metadata.name) << "\",\n";
+    oss << "      \"uri\": \"" << escapeBackslashes(metadata.uri) << "\",\n";
     // TODO: Manage config fields from actual configuration
     oss << "      \"config\": {\n";
     oss << "        \"warmup_time_ns\": null,\n";

google_benchmark/src/benchmark.cc

@@ -357,6 +357,8 @@ RawWalltimeBenchmark generate_raw_walltime_data(const RunResults& run_results) {
 
   for (const auto& run : run_results.non_aggregates) {
     walltime_data.uri = run.benchmark_name();
+    walltime_data.uri = sanitize_bench_args(walltime_data.uri);
+
     size_t pos = walltime_data.uri.rfind("::");
 
     if (pos != std::string::npos) {