Remove the cache based link resolver (#624)

* Remove the cache based link resolver

* Change link resolver property to implicitly unwrapped optional

* Remove should-use checks in new tests

Author: d-ronnqvist

Sources/SwiftDocC/DocumentationService/Convert/Symbol Link Resolution/DocCSymbolRepresentable.swift

@@ -155,18 +155,10 @@ public extension Collection where Element: DocCSymbolRepresentable {
             // Disambiguate by kind
             return map { currentSymbol in
                 let kindCount = filter { $0.kindIdentifier == currentSymbol.kindIdentifier }.count
-                
-                if LinkResolutionMigrationConfiguration.shouldUseHierarchyBasedLinkResolver {
-                    return (
-                        shouldAddIdHash: kindCount > 1,
-                        shouldAddKind: kindCount == 1
-                    )
-                } else {
-                    return (
-                        shouldAddIdHash: kindCount > 1,
-                        shouldAddKind: true
-                    )
-                }
+                return (
+                    shouldAddIdHash: kindCount > 1,
+                    shouldAddKind: kindCount == 1
+                )
             }
         }
     }

Sources/SwiftDocC/Infrastructure/DocumentationContext.swift

@@ -398,8 +398,6 @@ public struct DocumentationConverter: DocumentationConverterProtocol {
         benchmark(add: Benchmark.ExternalTopicsHash(context: context))
         // Log the peak memory.
         benchmark(add: Benchmark.PeakMemory())
-
-        context.linkResolutionMismatches.reportGatheredMismatchesIfEnabled()
 
         return (analysisProblems: context.problems, conversionProblems: conversionProblems)
     }

Sources/SwiftDocC/Infrastructure/DocumentationConverter.swift

@@ -115,10 +115,7 @@ struct DocumentationCurator {
         context.topicGraph.addNode(curatedNode)
 
         // Move the article from the article cache to the documentation
-        
-        if let hierarchyBasedLinkResolver = context.hierarchyBasedLinkResolver {
-            hierarchyBasedLinkResolver.addArticle(filename: articleFilename, reference: reference, anchorSections: documentationNode.anchorSections)
-        }
+        context.hierarchyBasedLinkResolver.addArticle(filename: articleFilename, reference: reference, anchorSections: documentationNode.anchorSections)
 
         context.documentationCache[reference] = documentationNode
         for anchor in documentationNode.anchorSections {

Sources/SwiftDocC/Infrastructure/DocumentationCurator.swift

@@ -1192,7 +1192,7 @@ private extension PathHierarchy.Node {
             return context.nodeWithSymbolIdentifier(symbol.identifier.precise)!.name.description
         }
         // This only gets called for PathHierarchy error messages, so hierarchyBasedLinkResolver is never nil.
-        let reference = context.hierarchyBasedLinkResolver!.resolvedReferenceMap[identifier]!
+        let reference = context.hierarchyBasedLinkResolver.resolvedReferenceMap[identifier]!
         if reference.fragment != nil {
             return context.nodeAnchorSections[reference]!.title
         } else {

Sources/SwiftDocC/Infrastructure/Link Resolution/DocumentationCacheBasedLinkResolver.swift

@@ -141,9 +141,7 @@ enum GeneratedDocumentationTopics {
                     let inheritedSection = AutomaticTaskGroupSection(title: defaultImplementationGroupTitle, references: [collectionReference], renderPositionPreference: .bottom)
                     symbol.automaticTaskGroupsVariants[trait]?.append(inheritedSection)
                 }
-                if let hierarchyBasedLinkResolver = context.hierarchyBasedLinkResolver {
-                    hierarchyBasedLinkResolver.addTaskGroup(named: title, reference: collectionReference, to: parent)
-                }
+                context.hierarchyBasedLinkResolver.addTaskGroup(named: title, reference: collectionReference, to: parent)
             }
         } else {
             fatalError("createCollectionNode() should be used only to add nodes under symbols.")

Sources/SwiftDocC/Infrastructure/Link Resolution/LinkResolutionMigration.swift

@@ -16,11 +16,6 @@ func unresolvedReferenceProblem(reference: TopicReference, source: URL?, range:
         [DiagnosticNote(source: $0, range: SourceLocation(line: 1, column: 1, source: $0)..<SourceLocation(line: 1, column: 1, source: $0), message: "This article was found but is not available for linking because it's uncurated")]
     } ?? []
 
-    guard LinkResolutionMigrationConfiguration.shouldUseHierarchyBasedLinkResolver else {
-        let diagnostic = Diagnostic(source: source, severity: severity, range: range, identifier: "org.swift.docc.unresolvedTopicReference", summary: "Topic reference \(reference.description.singleQuoted) couldn't be resolved. \(errorInfo.message)", notes: notes)
-        return Problem(diagnostic: diagnostic, possibleSolutions: [])
-    }
-    
     let referenceSourceRange: SourceRange? = range.map { range in
         // FIXME: Finding the range for the link's destination is better suited for Swift-Markdown
         // https://github.com/apple/swift-markdown/issues/109

Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy.swift

@@ -89,21 +89,13 @@ class DiagnosticTests: XCTestCase {
         // Resolve references
         _ = resolver.visitMarkup(markup)
 
-        if LinkResolutionMigrationConfiguration.shouldUseHierarchyBasedLinkResolver {
-            XCTAssertEqual(resolver.problems.first?.diagnostic.range, SourceLocation(line: 1, column: 10, source: nil)..<SourceLocation(line: 1, column: 19, source: nil))
-        } else {
-            XCTAssertEqual(resolver.problems.first?.diagnostic.range, SourceLocation(line: 1, column: 8, source: nil)..<SourceLocation(line: 1, column: 21, source: nil))
-        }
+        XCTAssertEqual(resolver.problems.first?.diagnostic.range, SourceLocation(line: 1, column: 10, source: nil)..<SourceLocation(line: 1, column: 19, source: nil))
         let offset = SymbolGraph.LineList.SourceRange(start: .init(line: 10, character: 10), end: .init(line: 10, character: 20))
 
         var problem = try XCTUnwrap(resolver.problems.first)
         problem.offsetWithRange(offset)
 
-        if LinkResolutionMigrationConfiguration.shouldUseHierarchyBasedLinkResolver {
-            XCTAssertEqual(problem.diagnostic.range, SourceLocation(line: 11, column: 20, source: nil)..<SourceLocation(line: 11, column: 29, source: nil))
-        } else {
-            XCTAssertEqual(problem.diagnostic.range, SourceLocation(line: 11, column: 18, source: nil)..<SourceLocation(line: 11, column: 31, source: nil))
-        }
+        XCTAssertEqual(problem.diagnostic.range, SourceLocation(line: 11, column: 20, source: nil)..<SourceLocation(line: 11, column: 29, source: nil))
     }
 
     func testFormattedDescription() {