Merge pull request #15354 from github/calumgrant/shared-diagnostics

calumgrant · web-flow · commit 4660a25d44b7 · 2024-01-17T15:40:12.000Z
C++/Swift: Create shared library and share Diagnostics
diff --git a/shared/cpp/BUILD.bazel b/shared/cpp/BUILD.bazel
@@ -0,0 +1,11 @@
+cc_library(
+    name = "extractor_shared",
+    srcs = glob(["*.cpp"]),
+    hdrs = glob(["*.h"]),
+    visibility = ["//visibility:public"],
+    deps = [
+        "@absl//absl/strings",
+        "@fmt",
+        "@json",
+    ],
+)
diff --git a/shared/cpp/Diagnostics.cpp b/shared/cpp/Diagnostics.cpp
@@ -1,6 +1,8 @@
-#include "swift/logging/SwiftDiagnostics.h"
+#include "Diagnostics.h"
+
+#include <fmt/format.h>
+#include <fmt/chrono.h>
 
-#include <binlog/Entries.hpp>
 #include "absl/strings/str_join.h"
 #include "absl/strings/str_cat.h"
 
diff --git a/shared/cpp/Diagnostics.h b/shared/cpp/Diagnostics.h
@@ -0,0 +1,88 @@
+#pragma once
+
+#include <optional>
+#include <string_view>
+
+#include <nlohmann/json.hpp>
+
+namespace codeql {
+
+extern const std::string_view programName;
+extern const std::string_view extractorName;
+
+struct DiagnosticsLocation {
+  std::string_view file;
+  unsigned startLine;
+  unsigned startColumn;
+  unsigned endLine;
+  unsigned endColumn;
+
+  nlohmann::json json() const;
+  std::string str() const;
+};
+
+// Models a diagnostic source for Swift, holding static information that goes out into a diagnostic
+// These are internally stored into a map on id's. A specific error log can use binlog's category
+// as id, which will then be used to recover the diagnostic source while dumping.
+class Diagnostic {
+ public:
+  enum class Visibility : unsigned char {
+    none = 0b000,
+    statusPage = 0b001,
+    cliSummaryTable = 0b010,
+    telemetry = 0b100,
+    all = 0b111,
+  };
+
+  // Notice that Tool Status Page severity is not necessarily the same as log severity, as the
+  // scope is different: TSP's scope is the whole analysis, log's scope is a single run
+  enum class Severity {
+    note,
+    warning,
+    error,
+  };
+
+  std::string_view id;
+  std::string_view name;
+  std::string_view action;
+
+  Visibility visibility{Visibility::all};
+  Severity severity{Severity::error};
+
+  std::optional<DiagnosticsLocation> location{};
+
+  // create a JSON diagnostics for this source with the given `timestamp` and Markdown `message`
+  // A markdownMessage is emitted that includes both the message and the action to take. The id is
+  // used to construct the source id in the form `swift/<prog name>/<id>`
+  nlohmann::json json(const std::chrono::system_clock::time_point& timestamp,
+                      std::string_view message) const;
+
+  // returns <id> or <id>@<location> if a location is present
+  std::string abbreviation() const;
+
+  Diagnostic withLocation(std::string_view file,
+                          unsigned startLine = 0,
+                          unsigned startColumn = 0,
+                          unsigned endLine = 0,
+                          unsigned endColumn = 0) const {
+    auto ret = *this;
+    ret.location = DiagnosticsLocation{file, startLine, startColumn, endLine, endColumn};
+    return ret;
+  }
+
+ private:
+  bool has(Visibility v) const;
+};
+
+inline constexpr Diagnostic::Visibility operator|(Diagnostic::Visibility lhs,
+                                                  Diagnostic::Visibility rhs) {
+  return static_cast<Diagnostic::Visibility>(static_cast<unsigned char>(lhs) |
+                                             static_cast<unsigned char>(rhs));
+}
+
+inline constexpr Diagnostic::Visibility operator&(Diagnostic::Visibility lhs,
+                                                  Diagnostic::Visibility rhs) {
+  return static_cast<Diagnostic::Visibility>(static_cast<unsigned char>(lhs) &
+                                             static_cast<unsigned char>(rhs));
+}
+}
diff --git a/swift/logging/BUILD.bazel b/swift/logging/BUILD.bazel
@@ -8,5 +8,6 @@ cc_library(
         "@binlog",
         "@fmt",
         "@json",
+        "//shared/cpp:extractor_shared",
     ],
 )
diff --git a/swift/logging/SwiftDiagnostics.h b/swift/logging/SwiftDiagnostics.h
@@ -1,102 +1,9 @@
 #pragma once
 
-#include <binlog/binlog.hpp>
-#include <string>
-#include <vector>
-#include <unordered_map>
-#include <optional>
-#include <cassert>
-#include <fstream>
-#include <filesystem>
-#include <sstream>
-#include <mutex>
-#include <fmt/format.h>
-#include <fmt/chrono.h>
-#include <nlohmann/json.hpp>
-
-#include "swift/logging/Formatters.h"
+#include "shared/cpp/Diagnostics.h"
 
 namespace codeql {
 
-extern const std::string_view programName;
-extern const std::string_view extractorName;
-
-struct DiagnosticsLocation {
-  std::string_view file;
-  unsigned startLine;
-  unsigned startColumn;
-  unsigned endLine;
-  unsigned endColumn;
-
-  nlohmann::json json() const;
-  std::string str() const;
-};
-
-// Models a diagnostic source for Swift, holding static information that goes out into a diagnostic
-// These are internally stored into a map on id's. A specific error log can use binlog's category
-// as id, which will then be used to recover the diagnostic source while dumping.
-class Diagnostic {
- public:
-  enum class Visibility : unsigned char {
-    none = 0b000,
-    statusPage = 0b001,
-    cliSummaryTable = 0b010,
-    telemetry = 0b100,
-    all = 0b111,
-  };
-
-  // Notice that Tool Status Page severity is not necessarily the same as log severity, as the
-  // scope is different: TSP's scope is the whole analysis, log's scope is a single run
-  enum class Severity {
-    note,
-    warning,
-    error,
-  };
-
-  std::string_view id;
-  std::string_view name;
-  std::string_view action;
-
-  Visibility visibility{Visibility::all};
-  Severity severity{Severity::error};
-
-  std::optional<DiagnosticsLocation> location{};
-
-  // create a JSON diagnostics for this source with the given `timestamp` and Markdown `message`
-  // A markdownMessage is emitted that includes both the message and the action to take. The id is
-  // used to construct the source id in the form `swift/<prog name>/<id>`
-  nlohmann::json json(const std::chrono::system_clock::time_point& timestamp,
-                      std::string_view message) const;
-
-  // returns <id> or <id>@<location> if a location is present
-  std::string abbreviation() const;
-
-  Diagnostic withLocation(std::string_view file,
-                          unsigned startLine = 0,
-                          unsigned startColumn = 0,
-                          unsigned endLine = 0,
-                          unsigned endColumn = 0) const {
-    auto ret = *this;
-    ret.location = DiagnosticsLocation{file, startLine, startColumn, endLine, endColumn};
-    return ret;
-  }
-
- private:
-  bool has(Visibility v) const;
-};
-
-inline constexpr Diagnostic::Visibility operator|(Diagnostic::Visibility lhs,
-                                                  Diagnostic::Visibility rhs) {
-  return static_cast<Diagnostic::Visibility>(static_cast<unsigned char>(lhs) |
-                                             static_cast<unsigned char>(rhs));
-}
-
-inline constexpr Diagnostic::Visibility operator&(Diagnostic::Visibility lhs,
-                                                  Diagnostic::Visibility rhs) {
-  return static_cast<Diagnostic::Visibility>(static_cast<unsigned char>(lhs) &
-                                             static_cast<unsigned char>(rhs));
-}
-
 constexpr Diagnostic internalError{
     .id = "internal-error",
     .name = "Internal error",
@@ -108,4 +15,5 @@ constexpr Diagnostic internalError{
         "\n"
         "[1]: https://github.com/github/codeql/issues/new?labels=bug&template=ql---general.md",
     .severity = Diagnostic::Severity::warning};
+
 }  // namespace codeql
diff --git a/swift/logging/SwiftLogging.h b/swift/logging/SwiftLogging.h
@@ -6,6 +6,11 @@
 #include <regex>
 #include <vector>
 
+#include <fmt/format.h>
+#include <fmt/chrono.h>
+
+#include "swift/logging/Formatters.h"
+
 #include <binlog/binlog.hpp>
 #include <binlog/TextOutputStream.hpp>
 #include <binlog/EventFilter.hpp>

Original file line number	Diff line number	Diff line change
`@@ -8,5 +8,6 @@ cc_library(`
`8`	`8`	`"@binlog",`
`9`	`9`	`"@fmt",`
`10`	`10`	`"@json",`
	`11`	`+ "//shared/cpp:extractor_shared",`
`11`	`12`	`],`
`12`	`13`	`)`