Minimally integrate the symbol path tree.

Author: d-ronnqvist

Sources/SwiftDocC/Infrastructure/DocumentationContext.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2022 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -196,10 +196,9 @@ enum GeneratedDocumentationTopics {
     /// ```
     /// - Parameters:
     ///   - relationships: A set of relationships to inspect.
-    ///   - symbolsURLHierarchy: A symbol graph hierarchy as created during symbol registration.
     ///   - context: A documentation context to update.
     ///   - bundle: The current documentation bundle.
-    static func createInheritedSymbolsAPICollections(relationships: Set<SymbolGraph.Relationship>, symbolsURLHierarchy: inout BidirectionalTree<ResolvedTopicReference>, context: DocumentationContext, bundle: DocumentationBundle) throws {
+    static func createInheritedSymbolsAPICollections(relationships: Set<SymbolGraph.Relationship>, context: DocumentationContext, bundle: DocumentationBundle) throws {
         var inheritanceIndex = InheritedSymbols()
 
         // Walk the symbol graph relationships and look for parent <-> child links that stem in a different module.
@@ -220,7 +219,7 @@ enum GeneratedDocumentationTopics {
             }
         }
 
-        // Create the API Collection nodes and the neccessary topic graph curation.
+        // Create the API Collection nodes and the necessary topic graph curation.
         for (typeReference, collections) in inheritanceIndex.implementingTypes where !collections.inheritedFromTypeName.isEmpty {
             for (_, collection) in collections.inheritedFromTypeName where !collection.identifiers.isEmpty {
                 // Create a collection for the given provider type's inherited symbols

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

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2022 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -342,8 +342,10 @@ class ConvertServiceTests: XCTestCase {
             )
         }
 
+        // ???: Is this valid?
+        // myFunction() is an instance method and this tries to configure it to be disambiguated as a type method
         request.knownDisambiguatedSymbolPathComponents = [
-            "s:5MyKit0A5ClassC10myFunctionyyF": ["MyClass-swift.class", "myFunction()-swift.type.method"],
+            "s:5MyKit0A5ClassC10myFunctionyyF": ["MyClass-swift.class", "myFunction()-swift.method"],
         ]
 
         try processAndAssert(request: request) { message in
@@ -355,20 +357,28 @@ class ConvertServiceTests: XCTestCase {
 
             XCTAssertEqual(
                 renderNode.identifier.path,
-                "/documentation/MyKit/MyClass-swift.class/myFunction()-swift.type.method"
+                "/documentation/MyKit/MyClass-swift.class/myFunction()-swift.method"
             )
 
             XCTAssertEqual(
                 renderNode.abstract?.first,
-                .codeVoice(code: "myFunction()")
+                .reference(
+                    identifier: .init("""
+                        doc://identifier/documentation/MyKit/MyClass-swift.class/myFunction()-swift.method
+                        """
+                    ),
+                    isActive: true,
+                    overridingTitle: nil,
+                    overridingTitleInlineContent: nil
+                )
             )
         }
 
         let symbolGraphWithAdjustedLink = Data(
             try XCTUnwrap(
                 String(data: symbolGraph, encoding: .utf8)
             )
-            .replacingOccurrences(of: "``myFunction()``", with: "``myFunction()-swift.type.method``")
+            .replacingOccurrences(of: "``myFunction()``", with: "``myFunction()-swift.method``")
             .utf8
         )
 
@@ -383,14 +393,14 @@ class ConvertServiceTests: XCTestCase {
 
             XCTAssertEqual(
                 renderNode.identifier.path,
-                "/documentation/MyKit/MyClass-swift.class/myFunction()-swift.type.method"
+                "/documentation/MyKit/MyClass-swift.class/myFunction()-swift.method"
             )
 
             XCTAssertEqual(
                 renderNode.abstract?.first,
                 .reference(
                     identifier: .init("""
-                        doc://identifier/documentation/MyKit/MyClass-swift.class/myFunction()-swift.type.method
+                        doc://identifier/documentation/MyKit/MyClass-swift.class/myFunction()-swift.method
                         """
                     ),
                     isActive: true,

Sources/SwiftDocC/Infrastructure/SymbolPathTree.swift

@@ -1,7 +1,7 @@
 /*
  This source file is part of the Swift.org open source project
 
- Copyright (c) 2021 Apple Inc. and the Swift project authors
+ Copyright (c) 2021-2022 Apple Inc. and the Swift project authors
  Licensed under Apache License v2.0 with Runtime Library Exception
 
  See https://swift.org/LICENSE.txt for license information
@@ -366,7 +366,7 @@ Root
 
             let renderIndex = try RenderIndex.fromURL(targetURL.appendingPathComponent("index.json"))
             XCTAssertEqual(renderIndex.interfaceLanguages.keys.count, 1)
-            XCTAssertEqual(renderIndex.interfaceLanguages["swift"]?.count, 27)
+            XCTAssertEqual(renderIndex.interfaceLanguages["swift"]?.count, 29)
 
             XCTAssertEqual(renderIndex.interfaceLanguages["swift"]?.first?.title, "Functions")
             XCTAssertEqual(renderIndex.interfaceLanguages["swift"]?.first?.path, nil)
@@ -620,7 +620,10 @@ Root
             XCTAssertNil(navigatorIndex.path(for: 0)) // Root should have not path persisted.
             XCTAssertEqual(navigatorIndex.path(for: 1), "/documentation/fillintroduced")
             XCTAssertEqual(navigatorIndex.path(for: 4), "/tutorials/testoverview")
-            XCTAssertEqual(navigatorIndex.path(for: 10), "/documentation/fillintroduced/maccatalystonlydeprecated()")
+            XCTAssertEqual(navigatorIndex.path(for: 9), "/documentation/fillintroduced/maccatalystonlydeprecated()")
+            XCTAssertEqual(navigatorIndex.path(for: 10), "/documentation/fillintroduced/maccatalystonlyintroduced()")
+            XCTAssertEqual(navigatorIndex.path(for: 21), "/documentation/mykit/globalfunction(_:considering:)")
+            XCTAssertEqual(navigatorIndex.path(for: 23), "/documentation/sidekit/uncuratedclass/angle")
 
             assertUniqueIDs(node: navigatorIndex.navigatorTree.root)
             results.insert(navigatorIndex.navigatorTree.root.dumpTree())
@@ -643,7 +646,7 @@ Root
         XCTAssertEqual(Set(navigatorIndex.languages), Set(["Swift"]))
 
         // Get the Swift language group.
-        XCTAssertEqual(navigatorIndex.navigatorTree.numericIdentifierToNode[1]?.children.count, 5)
+        XCTAssertEqual(navigatorIndex.navigatorTree.numericIdentifierToNode[1]?.children.count, 4)
 
         assertUniqueIDs(node: navigatorIndex.navigatorTree.root)
         assertEqualDumps(navigatorIndex.navigatorTree.root.dumpTree(), try testTree(named: "testNavigatorIndexGenerationWithLanguageGrouping"))

Sources/SwiftDocC/Utility/DataStructures/BidirectionalTree.swift

@@ -167,15 +167,31 @@ class AutomaticCurationTests: XCTestCase {
 
                 graph.symbols[duplicateSymbol.identifier.precise] = duplicateSymbol
 
-                // Duplicate all the edges to and from the symbbol
+                // Duplicate all the edges and nodes to and from the symbol
                 for relationship in graph.relationships where relationship.source == sideClassIdentifier {
                     var newRelationship = relationship
                     newRelationship.source = duplicateSymbol.identifier.precise
+                    
+                    // Duplicate the target symbol to avoid symbols being members of more than one other symbol.
+                    let newTarget = relationship.target + suffix
+                    newRelationship.target = newTarget
+                    if let targetSymbol = graph.symbols[relationship.target] {
+                        graph.symbols[newTarget] = targetSymbol
+                    }
+                    
                     graph.relationships.append(newRelationship)
                 }
                 for relationship in graph.relationships where relationship.target == sideClassIdentifier {
                     var newRelationship = relationship
                     newRelationship.target = duplicateSymbol.identifier.precise
+                    
+                    // Duplicate the source symbol to avoid symbols being members of more than one other symbol.
+                    let newSource = relationship.source + suffix
+                    newRelationship.source = newSource
+                    if let targetSymbol = graph.symbols[relationship.target] {
+                        graph.symbols[newSource] = targetSymbol
+                    }
+                    
                     graph.relationships.append(newRelationship)
                 }