Merge pull request #80458 from AnthonyLatsis/hildoceras

DiagnosticEngine: Always favor the category of a wrapped diagnostic

Author: AnthonyLatsis

include/swift/AST/DiagnosticEngine.h

@@ -599,6 +599,9 @@ namespace swift {
     void setDecl(const class Decl *decl) { Decl = decl; }
     void setBehaviorLimit(DiagnosticBehavior limit){ BehaviorLimit = limit; }
 
+    /// Returns the wrapped diagnostic, if any.
+    std::optional<const DiagnosticInfo *> getWrappedDiagnostic() const;
+
     /// Returns true if this object represents a particular diagnostic.
     ///
     /// \code

lib/AST/DiagnosticEngine.cpp

@@ -166,6 +166,16 @@ DiagnosticState::DiagnosticState() {
 Diagnostic::Diagnostic(DiagID ID)
     : Diagnostic(ID, storedDiagnosticInfos[(unsigned)ID].groupID) {}
 
+std::optional<const DiagnosticInfo *> Diagnostic::getWrappedDiagnostic() const {
+  for (const auto &arg : getArgs()) {
+    if (arg.getKind() == DiagnosticArgumentKind::Diagnostic) {
+      return arg.getAsDiagnostic();
+    }
+  }
+
+  return std::nullopt;
+}
+
 static CharSourceRange toCharSourceRange(SourceManager &SM, SourceRange SR) {
   return CharSourceRange(SM, SR.Start, Lexer::getLocForEndOfToken(SM, SR.End));
 }
@@ -498,13 +508,14 @@ InFlightDiagnostic::wrapIn(const Diagnostic &wrapper) {
   Engine->WrappedDiagnosticArgs.emplace_back(wrapped.FormatArgs);
   wrapped.FormatArgs = Engine->WrappedDiagnosticArgs.back();
 
-  // Overwrite the ID and argument with those from the wrapper.
+  // Overwrite the ID and arguments with those from the wrapper.
   Engine->getActiveDiagnostic().ID = wrapper.ID;
   Engine->getActiveDiagnostic().Args = wrapper.Args;
   // Intentionally keeping the original GroupID here
 
   // Set the argument to the diagnostic being wrapped.
-  assert(wrapper.getArgs().front().getKind() == DiagnosticArgumentKind::Diagnostic);
+  ASSERT(wrapper.getArgs().front().getKind() ==
+         DiagnosticArgumentKind::Diagnostic);
   Engine->getActiveDiagnostic().Args.front() = &wrapped;
 
   return *this;
@@ -1377,7 +1388,9 @@ DiagnosticEngine::diagnosticInfoForDiagnostic(const Diagnostic &diagnostic,
 
   auto groupID = diagnostic.getGroupID();
   StringRef Category;
-  if (isAPIDigesterBreakageDiagnostic(diagnostic.getID()))
+  if (auto wrapped = diagnostic.getWrappedDiagnostic())
+    Category = wrapped.value()->Category;
+  else if (isAPIDigesterBreakageDiagnostic(diagnostic.getID()))
     Category = "api-digester-breaking-change";
   else if (isNoUsageDiagnostic(diagnostic.getID()))
     Category = "no-usage";
@@ -1621,16 +1634,15 @@ DiagnosticEngine::getFormatStringForDiagnostic(const Diagnostic &diagnostic,
   case PrintDiagnosticNamesMode::Group:
     break;
   case PrintDiagnosticNamesMode::Identifier: {
-    // If this diagnostic is a wrapper for another diagnostic, use the ID of
-    // the wrapped diagnostic.
-    for (const auto &arg : diagnostic.getArgs()) {
-      if (arg.getKind() == DiagnosticArgumentKind::Diagnostic) {
-        diagID = arg.getAsDiagnostic()->ID;
-        break;
-      }
+    auto userFacingID = diagID;
+    // If this diagnostic wraps another one, use the ID of the wrapped
+    // diagnostic.
+    if (auto wrapped = diagnostic.getWrappedDiagnostic()) {
+      userFacingID = wrapped.value()->ID;
     }
 
-    message = formatMessageWithName(message, diagnosticIDStringFor(diagID));
+    message =
+        formatMessageWithName(message, diagnosticIDStringFor(userFacingID));
     break;
   }
   }

unittests/AST/DiagnosticInfoTests.cpp

@@ -13,6 +13,8 @@
 #include "swift/AST/DiagnosticEngine.h"
 #include "swift/AST/DiagnosticGroups.h"
 #include "swift/AST/DiagnosticsFrontend.h"
+#include "swift/AST/DiagnosticsModuleDiffer.h"
+#include "swift/AST/DiagnosticsSema.h"
 #include "swift/Basic/SourceManager.h"
 #include "gtest/gtest.h"
 
@@ -142,7 +144,7 @@ TEST(DiagnosticInfo, PrintDiagnosticNamesMode_Group) {
       },
       [](DiagnosticEngine &, const DiagnosticInfo &info) {
         EXPECT_FALSE(info.FormatString.ends_with(" [DeprecatedDeclaration]"));
-        EXPECT_TRUE(info.Category == "DeprecatedDeclaration");
+        EXPECT_EQ(info.Category, "DeprecatedDeclaration");
       },
       /*expectedNumCallbackCalls=*/1);
 }
@@ -162,9 +164,64 @@ TEST(DiagnosticInfo, PrintDiagnosticNamesMode_Group_WrappedDiag) {
       [](DiagnosticEngine &, const DiagnosticInfo &info) {
         EXPECT_EQ(info.ID, diag::error_in_a_future_swift_lang_mode.ID);
         EXPECT_FALSE(info.FormatString.ends_with(" [DeprecatedDeclaration]"));
-        EXPECT_TRUE(info.Category == "DeprecatedDeclaration");
+        EXPECT_EQ(info.Category, "DeprecatedDeclaration");
       },
       /*expectedNumCallbackCalls=*/1);
 }
 
+// Test that the category is appropriately set in these cases, and that the
+// category of a wrapped diagnostic is favored.
+TEST(DiagnosticInfo, CategoryDeprecation) {
+  testCase(
+      [](DiagnosticEngine &diags) {
+        diags.setLanguageVersion(version::Version({5}));
+
+        const auto diag = diag::iuo_deprecated_here;
+        EXPECT_TRUE(diags.isDeprecationDiagnostic(diag.ID));
+
+        diags.diagnose(SourceLoc(), diag);
+        diags.diagnose(SourceLoc(), diag).warnUntilSwiftVersion(6);
+        diags.diagnose(SourceLoc(), diag).warnUntilSwiftVersion(99);
+      },
+      [](DiagnosticEngine &, const DiagnosticInfo &info) {
+        EXPECT_EQ(info.Category, "deprecation");
+      },
+      /*expectedNumCallbackCalls=*/3);
+}
+TEST(DiagnosticInfo, CategoryNoUsage) {
+  testCase(
+      [](DiagnosticEngine &diags) {
+        diags.setLanguageVersion(version::Version({5}));
+
+        const auto diag = diag::expression_unused_function;
+        EXPECT_TRUE(diags.isNoUsageDiagnostic(diag.ID));
+
+        diags.diagnose(SourceLoc(), diag);
+        diags.diagnose(SourceLoc(), diag).warnUntilSwiftVersion(6);
+        diags.diagnose(SourceLoc(), diag).warnUntilSwiftVersion(99);
+      },
+      [](DiagnosticEngine &, const DiagnosticInfo &info) {
+        EXPECT_EQ(info.Category, "no-usage");
+      },
+      /*expectedNumCallbackCalls=*/3);
+}
+TEST(DiagnosticInfo, CategoryAPIDigesterBreakage) {
+  testCase(
+      [](DiagnosticEngine &diags) {
+        diags.setLanguageVersion(version::Version({5}));
+
+        const auto diag = diag::enum_case_added;
+        EXPECT_TRUE(diags.isAPIDigesterBreakageDiagnostic(diag.ID));
+
+        diags.diagnose(SourceLoc(), diag, StringRef());
+        diags.diagnose(SourceLoc(), diag, StringRef()).warnUntilSwiftVersion(6);
+        diags.diagnose(SourceLoc(), diag, StringRef())
+            .warnUntilSwiftVersion(99);
+      },
+      [](DiagnosticEngine &, const DiagnosticInfo &info) {
+        EXPECT_EQ(info.Category, "api-digester-breaking-change");
+      },
+      /*expectedNumCallbackCalls=*/3);
+}
+
 } // end anonymous namespace