Skip to content

Fix regression with duplicated generated implementation sections #321

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jun 24, 2022
Merged

Fix regression with duplicated generated implementation sections #321

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
67e522d
Fix regression with duplicated generated implementation sections
ethan-kusters Jun 24, 2022
976c858
Address PR feedback: child symbol is non-optional
ethan-kusters Jun 24, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion Sources/SwiftDocC/Infrastructure/DocumentationContext.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1264,7 +1264,6 @@ public class DocumentationContext: DocumentationContextDataProviderDelegate {
for (_, relationships) in combinedRelationships {
try GeneratedDocumentationTopics.createInheritedSymbolsAPICollections(
relationships: relationships,
parentOfFunction: { try? symbolsURLHierarchy.parent(of: $0) },
context: self,
bundle: bundle
)
Expand Down
46 changes: 33 additions & 13 deletions Sources/SwiftDocC/Infrastructure/Symbol Graph/GeneratedDocumentationTopics.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,15 +40,35 @@ enum GeneratedDocumentationTopics {
/// - reference: The parent type reference.
/// - originDisplayName: The origin display name as provided by the symbol graph.
/// - extendedModuleName: Extended module name.
mutating func add(_ childReference: ResolvedTopicReference, to reference: ResolvedTopicReference, originDisplayName: String, originParentSymbol: ResolvedTopicReference?, extendedModuleName: String) throws {
mutating func add(_ childReference: ResolvedTopicReference, to reference: ResolvedTopicReference, childSymbol: SymbolGraph.Symbol, originDisplayName: String, originSymbol: SymbolGraph.Symbol?, extendedModuleName: String) throws {
let fromType: String
let typeSimpleName: String
if let originParentSymbol = originParentSymbol, !originParentSymbol.pathComponents.isEmpty {
// If we have a resolved symbol for the parent of `sourceOrigin`, use that for the names
fromType = originParentSymbol.pathComponents.joined(separator: ".")
typeSimpleName = originParentSymbol.pathComponents.last!
if let originSymbol = originSymbol, originSymbol.pathComponents.count > 1 {
// If we have a resolved symbol for the source origin, use its path components to
// find the name of the parent by dropping the last path component.
let parentSymbolPathComponents = originSymbol.pathComponents.dropLast()
fromType = parentSymbolPathComponents.joined(separator: ".")
typeSimpleName = parentSymbolPathComponents.last!
} else if let childSymbolName = childSymbol.pathComponents.last,
originDisplayName.count > (childSymbolName.count + 1)
{
// In the case where we don't have a resolved symbol for the source origin,
// this allows us to still accurately handle cases like this:
//
// "displayName": "SuperFancyProtocol..<..(_:_:)"
//
// Where there's no way for us to determine which of the periods is the one
// splitting the name of the parent type and the symbol name. Using the count
// of the symbol name (+1 for the period splitting the names)
// from the source is a reliable way to support this.

let parentSymbolName = originDisplayName.dropLast(childSymbolName.count + 1)
fromType = String(parentSymbolName)
typeSimpleName = String(parentSymbolName.split(separator: ".").last ?? parentSymbolName)
} else {
// If we don't have a resolved `sourceOrigin` parent, fall back to parsing its display name
// This should never happen but is a last safeguard for the case where
// the child symbol is unexpectedly short. In this case, we can attempt to just parse
// the parent symbol name out of the origin display name.

// Detect the path components of the providing the default implementation.
let typeComponents = originDisplayName.split(separator: ".")
Expand Down Expand Up @@ -209,7 +229,7 @@ enum GeneratedDocumentationTopics {
/// - 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>, parentOfFunction: (ResolvedTopicReference) -> 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.
Expand All @@ -223,14 +243,14 @@ enum GeneratedDocumentationTopics {
let parent = context.symbolIndex[relationship.target],
// Resolve the child
let child = context.symbolIndex[relationship.source],
// Get the child symbol
let childSymbol = child.symbol,
// Get the swift extension data
let extends = child.symbol?.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] as? SymbolGraph.Symbol.Swift.Extension {
var originParentSymbol: ResolvedTopicReference? = nil
if let originSymbol = context.symbolIndex[origin.identifier] {
originParentSymbol = parentOfFunction(originSymbol.reference)
}
let extends = childSymbol.mixins[SymbolGraph.Symbol.Swift.Extension.mixinKey] as? SymbolGraph.Symbol.Swift.Extension {
let originSymbol = context.symbolIndex[origin.identifier]?.symbol

// Add the inherited symbol to the index.
try inheritanceIndex.add(child.reference, to: parent.reference, originDisplayName: origin.displayName, originParentSymbol: originParentSymbol, extendedModuleName: extends.extendedModule)
try inheritanceIndex.add(child.reference, to: parent.reference, childSymbol: childSymbol, originDisplayName: origin.displayName, originSymbol: originSymbol, extendedModuleName: extends.extendedModule)
}
}

Expand Down
115 changes: 115 additions & 0 deletions Tests/SwiftDocCTests/Rendering/RenderNodeTranslatorTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,7 @@
import Foundation
import XCTest
@testable import SwiftDocC
import SwiftDocCTestUtilities
import Markdown

class RenderNodeTranslatorTests: XCTestCase {
Expand Down Expand Up @@ -650,6 +651,120 @@ class RenderNodeTranslatorTests: XCTestCase {

}

func testAutomaticImplementationsWithExtraDotsFromExternalModule() throws {
let inheritedDefaultImplementationsFromExternalModuleSGF = Bundle.module.url(
forResource: "InheritedDefaultImplementationsFromExternalModule.symbols",
withExtension: "json",
subdirectory: "Test Resources"
)!

let testBundle = try Folder(
name: "unit-test.docc",
content: [
InfoPlist(displayName: "TestBundle", identifier: "com.test.example"),
CopyOfFile(original: inheritedDefaultImplementationsFromExternalModuleSGF),
]
).write(inside: createTemporaryDirectory())

try assertDefaultImplementationCollectionTitles(
in: try loadRenderNode(at: "/documentation/SecondTarget/FancyProtocolConformer", in: testBundle),
[
"FancyProtocol Implementations",
]
)

try assertDefaultImplementationCollectionTitles(
in: try loadRenderNode(at: "/documentation/SecondTarget/OtherFancyProtocolConformer", in: testBundle),
[
"OtherFancyProtocol Implementations",
]
)

try assertDefaultImplementationCollectionTitles(
in: try loadRenderNode(at: "/documentation/SecondTarget/FooConformer", in: testBundle),
[
"Foo Implementations",
]
)
}

func testAutomaticImplementationsFromCurrentModuleWithMixOfDocCoverage() throws {
let inheritedDefaultImplementationsSGF = Bundle.module.url(
forResource: "InheritedDefaultImplementations.symbols",
withExtension: "json",
subdirectory: "Test Resources"
)!
let inheritedDefaultImplementationsAtSwiftSGF = Bundle.module.url(
forResource: "[email protected]",
withExtension: "json",
subdirectory: "Test Resources"
)!

let testBundle = try Folder(
name: "unit-test.docc",
content: [
InfoPlist(displayName: "TestBundle", identifier: "com.test.example"),
CopyOfFile(original: inheritedDefaultImplementationsSGF),
CopyOfFile(original: inheritedDefaultImplementationsAtSwiftSGF),
]
).write(inside: createTemporaryDirectory())

try assertDefaultImplementationCollectionTitles(
in: try loadRenderNode(at: "/documentation/FirstTarget/Bar", in: testBundle),
[
"Foo Implementations",
]
)

try assertDefaultImplementationCollectionTitles(
in: try loadRenderNode(at: "/documentation/FirstTarget/OtherStruct", in: testBundle),
[
"Comparable Implementations",
"Equatable Implementations",
]
)

try assertDefaultImplementationCollectionTitles(
in: try loadRenderNode(at: "/documentation/FirstTarget/SomeStruct", in: testBundle),
[
"Comparable Implementations",
"Equatable Implementations",
"FancyProtocol Implementations",
"OtherFancyProtocol Implementations",
]
)
}

func assertDefaultImplementationCollectionTitles(
in renderNode: RenderNode,
_ expectedTitles: [String],
file: StaticString = #file,
line: UInt = #line
) throws {
let defaultImplementationSection = try XCTUnwrap(
renderNode.topicSections.first(where: { $0.title == "Default Implementations" }),
"Expected to find default implementations topic section.",
file: file,
line: line
)

let references = defaultImplementationSection.identifiers.compactMap { identifier in
renderNode.references[identifier] as? TopicRenderReference
}

XCTAssertEqual(references.map(\.title), expectedTitles, file: file, line: line)
}

func loadRenderNode(at path: String, in bundleURL: URL) throws -> RenderNode {
let (_, bundle, context) = try loadBundle(from: bundleURL)

let reference = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: path, sourceLanguage: .swift)
var translator = RenderNodeTranslator(context: context, bundle: bundle, identifier: reference, source: nil)
let node = try context.entity(with: reference)
let symbol = try XCTUnwrap(node.semantic as? Symbol)
return try XCTUnwrap(translator.visitSymbol(symbol) as? RenderNode)
}

func testAutomaticTaskGroupTopicsAreSorted() throws {
let (bundle, context) = try testBundleAndContext(named: "DefaultImplementations")
let structReference = ResolvedTopicReference(bundleIdentifier: bundle.identifier, path: "/documentation/DefaultImplementations/Foo", sourceLanguage: .swift)
Expand Down
Loading