Further reduce the severity to a debug-only assertion.

Author: d-ronnqvist

Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphRelationshipsBuilder.swift

@@ -12,46 +12,37 @@ import SymbolKit
 
 /// A set of functions that add relationship information to a topic graph.
 struct SymbolGraphRelationshipsBuilder {
-    /// A namespace for creation of symbol-graph-builder related problems.
-    private enum NodeProblem {
-        /// Returns a problem about a source symbol of a given relationship not being found locally.
-        static func sourceNotFound(_ relationship: SymbolGraph.Relationship) -> Problem {
-            return Problem(
-                diagnostic: Diagnostic(
-                    source: nil, severity: .warning, range: nil,identifier: "org.swift.docc.SymbolNodeNotFound",
-                    summary: "Source symbol \(relationship.source.singleQuoted) not found locally, from \(relationship.kind.rawValue.singleQuoted) relationship to \(relationship.target.singleQuoted)",
-                    explanation: """
-                    The "source" of a symbol graph relationship should always refer to a symbol in the same symbol graph file.
-                    If it doesn't, then the tool that created the symbol graph file should move the relationship to the symbol graph file that defines the "source" symbol \
-                    or remove the relationship if none of the created symbol graph file defines the "source" symbol.
-                    
-                    The "target" may refer to a symbol in another module.
-                    For example, if local symbol conforms to a protocol from another module, \
-                    there will be a "{ source: local-symbol-ID, kind: conformsTo, target: protocol-in-other-module-ID }" relationship.
-                    
-                    A symbol graph relationship with a non-local "source" symbol is a bug in the tool that created the symbol graph file.
-                    """
-                ),
-                possibleSolutions: []
-            )
+    /// A namespace for debug assert messages for data-correctness issues in the symbol graph data.
+    private enum AssertionMessages {
+        static func sourceNotFound(_ relationship: SymbolGraph.Relationship) -> String {
+            """
+            Source symbol \(relationship.source.singleQuoted) not found locally, from \(relationship.kind.rawValue.singleQuoted) relationship to \(relationship.target.singleQuoted).
+            
+            The "source" of a symbol graph relationship should always refer to a symbol in the same symbol graph file.
+            If it doesn't, then the tool that created the symbol graph file should move the relationship to the symbol graph file that defines the "source" symbol \
+            or remove the relationship if none of the created symbol graph file defines the "source" symbol.
+            
+            The "target" may refer to a symbol in another module.
+            For example, if local symbol conforms to a protocol from another module, \
+            there will be a "{ source: local-symbol-ID, kind: conformsTo, target: protocol-in-other-module-ID }" relationship.
+            
+            A symbol graph relationship with a non-local "source" symbol is a bug in the tool that created the symbol graph file.
+            """
         }
-        /// Returns a problem about a target symbol of an overload group not being found locally.
-        static func overloadGroupNotFound(_ relationship: SymbolGraph.Relationship) -> Problem {
-            return Problem(
-                diagnostic: Diagnostic(
-                    source: nil, severity: .error, range: nil,identifier: "org.swift.docc.SymbolNodeNotFound",
-                    summary: "Overload group \(relationship.source.singleQuoted) not found locally, from \(relationship.kind.rawValue.singleQuoted) relationship of \(relationship.source.singleQuoted)",
-                    explanation: """
-                    Both the "source" and "target" of an \(relationship.kind.rawValue.singleQuoted) symbol graph relationships with should always refer to symbols in the same symbol graph file.
-                    A \(relationship.kind.rawValue.singleQuoted) symbol graph relationship with a non-local "target" symbol is a bug in the tool that created the symbol graph file.
-                    """
-                ),
-                possibleSolutions: []
-            )
+        
+        static func overloadGroupNotFound(_ relationship: SymbolGraph.Relationship) -> String {
+            """
+            Overload group \(relationship.source.singleQuoted) not found locally, from \(relationship.kind.rawValue.singleQuoted) relationship of \(relationship.source.singleQuoted).
+            
+            Both the "source" and "target" of an \(relationship.kind.rawValue.singleQuoted) symbol graph relationships with should always refer to symbols in the same symbol graph file.
+            A \(relationship.kind.rawValue.singleQuoted) symbol graph relationship with a non-local "target" symbol is a bug in the tool that created the symbol graph file.
+            """
         }
-        /// Returns a problem about a node with the given reference not being found.
-        static func invalidReference(_ reference: String) -> Problem {
-            return Problem(diagnostic: Diagnostic(source: nil, severity: .error, range: nil, identifier: "org.swift.docc.InvalidSymbolIdentifier", summary: "Relationship symbol path \(reference.singleQuoted) isn't valid"), possibleSolutions: [])
+        
+        static func invalidSymbolReference(_ reference: SymbolReference) -> String {
+            return """
+            Failed to create an unresolved reference for \(reference.path.singleQuoted). It contains characters that are not allowed in the "path" of a RFC 3986 URL.
+            """
         }
     }
 
@@ -78,7 +69,7 @@ struct SymbolGraphRelationshipsBuilder {
               let implementorSymbol = implementorNode.semantic as? Symbol
         else {
             // The source node for implementation relationship not found.
-            engine.emit(NodeProblem.sourceNotFound(edge))
+            assertionFailure(AssertionMessages.sourceNotFound(edge))
             return
         }
 
@@ -94,7 +85,7 @@ struct SymbolGraphRelationshipsBuilder {
             let symbolReference = SymbolReference(edge.target, interfaceLanguage: language, symbol: localCache[edge.target]?.symbol)
             guard let unresolved = UnresolvedTopicReference(symbolReference: symbolReference, bundle: bundle) else {
                 // The symbol reference format is invalid.
-                engine.emit(NodeProblem.invalidReference(symbolReference.path))
+                assertionFailure(AssertionMessages.invalidSymbolReference(symbolReference))
                 return
             }
 
@@ -128,7 +119,7 @@ struct SymbolGraphRelationshipsBuilder {
             // Make the implementation a child of the requirement
             guard let childReference = localCache.reference(symbolID: edge.source) else {
                 // The child wasn't found, invalid reference in relationship.
-                engine.emit(SymbolGraphRelationshipsBuilder.NodeProblem.sourceNotFound(edge))
+                assertionFailure(SymbolGraphRelationshipsBuilder.AssertionMessages.sourceNotFound(edge))
                 return
             }
 
@@ -163,7 +154,7 @@ struct SymbolGraphRelationshipsBuilder {
               let conformingSymbol = conformingNode.semantic as? Symbol
         else {
             // The source node for conformance relationship not found.
-            engine.emit(NodeProblem.sourceNotFound(edge))
+            assertionFailure(AssertionMessages.sourceNotFound(edge))
             return
         }
 
@@ -184,7 +175,7 @@ struct SymbolGraphRelationshipsBuilder {
             let symbolReference = SymbolReference(edge.target, interfaceLanguage: language, symbol: localCache[edge.target]?.symbol)
             guard let unresolved = UnresolvedTopicReference(symbolReference: symbolReference, bundle: bundle) else {
                 // The symbol reference format is invalid.
-                engine.emit(NodeProblem.invalidReference(symbolReference.path))
+                assertionFailure(AssertionMessages.invalidSymbolReference(symbolReference))
                 return
             }
             conformanceNodeReference = .unresolved(unresolved)
@@ -252,7 +243,7 @@ struct SymbolGraphRelationshipsBuilder {
               let childSymbol = childNode.semantic as? Symbol
         else {
             // The source node for inheritance relationship not found.
-            engine.emit(NodeProblem.sourceNotFound(edge))
+            assertionFailure(AssertionMessages.sourceNotFound(edge))
             return
         }
 
@@ -271,7 +262,7 @@ struct SymbolGraphRelationshipsBuilder {
             let symbolReference = SymbolReference(edge.target, interfaceLanguage: language, symbol: nil)
             guard let unresolved = UnresolvedTopicReference(symbolReference: symbolReference, bundle: bundle) else {
                 // The symbol reference format is invalid.
-                engine.emit(NodeProblem.invalidReference(symbolReference.path))
+                assertionFailure(AssertionMessages.invalidSymbolReference(symbolReference))
                 return
             }
             parentNodeReference = .unresolved(unresolved)
@@ -352,7 +343,7 @@ struct SymbolGraphRelationshipsBuilder {
               let requiredSymbol = requiredNode.semantic as? Symbol
         else {
             // The source node for requirement relationship not found.
-            engine.emit(NodeProblem.sourceNotFound(edge))
+            assertionFailure(AssertionMessages.sourceNotFound(edge))
             return
         }
         requiredSymbol.isRequired = required
@@ -469,11 +460,11 @@ struct SymbolGraphRelationshipsBuilder {
         engine: DiagnosticEngine
     ) {
         guard let overloadNode = localCache[edge.source] else {
-            engine.emit(NodeProblem.sourceNotFound(edge))
+            assertionFailure(AssertionMessages.sourceNotFound(edge))
             return
         }
         guard let overloadGroupNode = localCache[edge.target] else {
-            engine.emit(NodeProblem.overloadGroupNotFound(edge))
+            assertionFailure(AssertionMessages.overloadGroupNotFound(edge))
             return
         }