Add successfully resolved external references to reference index (#582)

* Add successfully resolved external references to reference index

rdar://108974747

* Undo accidental whitespace change

Co-authored-by: Ethan Kusters <[email protected]>

Author: d-ronnqvist

Sources/SwiftDocC/Infrastructure/DocumentationContext.swift

@@ -2442,6 +2442,9 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
         for reference in knownIdentifiers {
             referenceIndex[reference.absoluteString] = reference
         }
+        for case .success(let reference) in externallyResolvedLinks.values {
+            referenceIndex[reference.absoluteString] = reference
+        }
         for reference in nodeAnchorSections.keys {
             referenceIndex[reference.absoluteString] = reference
         }

Sources/SwiftDocC/Model/Rendering/RenderContentCompiler.swift

@@ -207,10 +207,16 @@ struct RenderContentCompiler: MarkupVisitor {
 
     mutating func resolveTopicReference(_ destination: String) -> ResolvedTopicReference? {
         if let cached = context.referenceIndex[destination] {
+            if let node = context.topicGraph.nodeWithReference(cached), !context.topicGraph.isLinkable(node.reference) {
+                return nil
+            }
             collectedTopicReferences.append(cached)
             return cached
         }
 
+        // FIXME: Links from this build already exist in the reference index and don't need to be resolved again.
+        // https://github.com/apple/swift-docc/issues/581
+
         guard let validatedURL = ValidatedURL(parsingAuthoredLink: destination) else {
             return nil
         }

Tests/SwiftDocCTests/Infrastructure/ExternalReferenceResolverTests.swift

@@ -12,6 +12,7 @@ import XCTest
 @testable import SwiftDocC
 import Markdown
 import SymbolKit
+import SwiftDocCTestUtilities
 
 class ExternalReferenceResolverTests: XCTestCase {
     class TestExternalReferenceResolver: ExternalReferenceResolver, FallbackReferenceResolver {
@@ -399,6 +400,66 @@ Document @1:1-1:35
         ])
     }
 
+    func testExternalReferenceWithDifferentResolvedPath() throws {
+        let externalResolver = TestExternalReferenceResolver()
+        externalResolver.bundleIdentifier = "com.test.external"
+        // Return a different path for this resolved reference
+        externalResolver.expectedReferencePath = "/path/to/externally-resolved-symbol"
+        externalResolver.resolvedEntityTitle = "ClassName"
+        externalResolver.resolvedEntityKind = .class
+        
+        let tempFolder = try createTempFolder(content: [
+        Folder(name: "SingleArticleWithExternalLink.docc", content: [
+            TextFile(name: "article.md", utf8Content: """
+            # Article with external link
+            
+            @Metadata {
+              @TechnologyRoot
+            }
+            
+            Link to an external page: <doc://com.test.external/path/to/external/symbol>
+            """)
+            ])
+        ])
+        
+        let workspace = DocumentationWorkspace()
+        let context = try DocumentationContext(dataProvider: workspace)
+        context.externalReferenceResolvers = [externalResolver.bundleIdentifier: externalResolver]
+        let dataProvider = try LocalFileSystemDataProvider(rootURL: tempFolder)
+        try workspace.registerProvider(dataProvider)
+        let bundle = try XCTUnwrap(workspace.bundles.first?.value)
+        
+        let converter = DocumentationNodeConverter(bundle: bundle, context: context)
+        let node = try context.entity(with: ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/article", sourceLanguage: .swift))
+        
+        guard let fileURL = context.documentURL(for: node.reference) else {
+            XCTFail("Unable to find the file for \(node.reference.path)")
+            return
+        }
+        
+        let renderNode = try converter.convert(node, at: fileURL)
+        
+        XCTAssertEqual(externalResolver.resolvedExternalPaths, ["/path/to/external/symbol"], "The authored link was resolved")
+        
+        // Verify that the article contains the external reference
+        guard let symbolRenderReference = renderNode.references["doc://com.test.external/path/to/externally-resolved-symbol"] as? TopicRenderReference else {
+            XCTFail("The external reference should be resolved and included among the article's references.")
+            return
+        }
+        
+        XCTAssertEqual(symbolRenderReference.identifier.identifier, "doc://com.test.external/path/to/externally-resolved-symbol")
+        XCTAssertEqual(symbolRenderReference.title, "ClassName")
+        XCTAssertEqual(symbolRenderReference.url, "/example/path/to/externally-resolved-symbol") // External references in topic groups use relative URLs
+        XCTAssertEqual(symbolRenderReference.kind, .symbol)
+        
+        // Verify that the rendered abstract contains the resolved link
+        if case RenderInlineContent.reference(identifier: let identifier, isActive: true, overridingTitle: _, overridingTitleInlineContent: _)? = renderNode.abstract?.last {
+            XCTAssertEqual(identifier.identifier, "doc://com.test.external/path/to/externally-resolved-symbol")
+        } else {
+            XCTFail("Unexpected abstract content: \(renderNode.abstract ?? [])")
+        }
+    }
+    
     func testSampleCodeReferenceHasSampleCodeRole() throws {
         let externalResolver = TestExternalReferenceResolver()
         externalResolver.bundleIdentifier = "com.test.external"