Skip to content

use found disambiguation to calculate diagnostic range if present #1213

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 5 commits into from
May 9, 2025
Merged

use found disambiguation to calculate diagnostic range if present #1213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
3de0e13
use found disambiguation to calculate diagnostic range if present
QuietMisdreavus May 7, 2025
117350f
review: use all the non-overloadable symbol kinds
QuietMisdreavus May 8, 2025
ba5fff2
review: assert that solutions exist before iterating on them
QuietMisdreavus May 8, 2025
1176cef
review: remove redundant assertion condition
QuietMisdreavus May 8, 2025
a7b2a37
review: add tests for wrong suffix and wrong name
QuietMisdreavus May 8, 2025
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
20 changes: 17 additions & 3 deletions Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchy+Error.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -223,13 +223,27 @@ extension PathHierarchy.Error {

case .lookupCollision(partialResult: let partialResult, remaining: let remaining, collisions: let collisions):
let nextPathComponent = remaining.first!
let (pathPrefix, _, solutions) = makeCollisionSolutions(from: collisions, nextPathComponent: nextPathComponent, partialResultPrefix: partialResult.pathPrefix)

let (pathPrefix, foundDisambiguation, solutions) = makeCollisionSolutions(
Copy link
Contributor

@d-ronnqvist d-ronnqvist May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

question: Is .lookupCollision the only kind of value where this happened or should we add similar checks to the other types of errors as well?

Copy link
Contributor Author

@QuietMisdreavus QuietMisdreavus May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It looks like the rangeAdjustment feature is also used by the unknownDisambiguation and unknownName errors, which could also potentially be wrong. Would you like me to investigate these options in this PR, or land this as-is and investigate those later?

Copy link
Contributor

@d-ronnqvist d-ronnqvist May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Either way works. If it's easy to investigate and fix it might make sense to do it while all of this is fresh in the mind.

Copy link
Contributor Author

@QuietMisdreavus QuietMisdreavus May 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I added tests for those cases to see if they would also have problems, and it looks like they're fine. 🤷‍♀️ I'll leave the tests in for posterity, but i didn't need to change anything for the cases i tested.

from: collisions,
nextPathComponent: nextPathComponent,
partialResultPrefix: partialResult.pathPrefix)

let rangeAdjustment: SourceRange
if !foundDisambiguation.isEmpty {
rangeAdjustment = .makeRelativeRange(
startColumn: pathPrefix.count - foundDisambiguation.count,
length: foundDisambiguation.count)
} else {
rangeAdjustment = .makeRelativeRange(
startColumn: pathPrefix.count - nextPathComponent.full.count,
length: nextPathComponent.full.count)
}

return TopicReferenceResolutionErrorInfo("""
\(nextPathComponent.full.singleQuoted) is ambiguous at \(partialResult.node.pathWithoutDisambiguation().singleQuoted)
""",
solutions: solutions,
rangeAdjustment: .makeRelativeRange(startColumn: pathPrefix.count - nextPathComponent.full.count, length: nextPathComponent.full.count)
rangeAdjustment: rangeAdjustment
)
}
}
Expand Down
6 changes: 6 additions & 0 deletions Sources/SwiftDocC/Semantics/ReferenceResolver.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,6 +44,12 @@ func unresolvedReferenceProblem(source: URL?, range: SourceRange?, severity: Dia
let diagnosticRange: SourceRange?
if var rangeAdjustment = errorInfo.rangeAdjustment, let referenceSourceRange {
rangeAdjustment.offsetWithRange(referenceSourceRange)
assert(rangeAdjustment.lowerBound.column >= 0, """
Unresolved topic reference range adjustment created range with negative column.
Source: \(source?.absoluteString ?? "nil")
Range: \(rangeAdjustment.lowerBound.description):\(rangeAdjustment.upperBound.description)
Summary: \(errorInfo.message)
""")
diagnosticRange = rangeAdjustment
} else {
diagnosticRange = referenceSourceRange
Expand Down
160 changes: 159 additions & 1 deletion Tests/SwiftDocCTests/Infrastructure/DocumentationContext/DocumentationContextTests.swift
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5266,7 +5266,165 @@ let expected = """
}
}
}


func testContextDiagnosesInsufficientDisambiguationWithCorrectRange() throws {
// This test deliberately does not turn on the overloads feature
// to ensure the symbol link below does not accidentally resolve correctly.
for symbolKindID in SymbolGraph.Symbol.KindIdentifier.allCases where !symbolKindID.isOverloadableKind {
// Generate a 4 symbols with the same name for every non overloadable symbol kind
let symbols: [SymbolGraph.Symbol] = [
makeSymbol(id: "first-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "second-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "third-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "fourth-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
]

let catalog =
Folder(name: "unit-test.docc", content: [
JSONFile(name: "ModuleName.symbols.json", content: makeSymbolGraph(
moduleName: "ModuleName",
symbols: symbols
)),

TextFile(name: "ModuleName.md", utf8Content: """
# ``ModuleName``

This is a test file for ModuleName.

## Topics

- ``SymbolName-\(symbolKindID.identifier)``
""")
])

let (_, context) = try loadBundle(catalog: catalog)

let problems = context.problems.sorted(by: \.diagnostic.summary)
XCTAssertEqual(problems.count, 1)

let problem = try XCTUnwrap(problems.first)

XCTAssertEqual(problem.diagnostic.summary, "'SymbolName-\(symbolKindID.identifier)' is ambiguous at '/ModuleName'")

XCTAssertEqual(problem.possibleSolutions.count, 4)

for solution in problem.possibleSolutions {
XCTAssertEqual(solution.replacements.count, 1)
let replacement = try XCTUnwrap(solution.replacements.first)

XCTAssertEqual(replacement.range.lowerBound, .init(line: 7, column: 15, source: nil))
XCTAssertEqual(
replacement.range.upperBound,
.init(line: 7, column: 16 + symbolKindID.identifier.count, source: nil)
)
}
}
}

func testContextDiagnosesIncorrectDisambiguationWithCorrectRange() throws {
// This test deliberately does not turn on the overloads feature
// to ensure the symbol link below does not accidentally resolve correctly.
for symbolKindID in SymbolGraph.Symbol.KindIdentifier.allCases where !symbolKindID.isOverloadableKind {
// Generate a 4 symbols with the same name for every non overloadable symbol kind
let symbols: [SymbolGraph.Symbol] = [
makeSymbol(id: "first-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "second-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "third-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "fourth-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
]

let catalog =
Folder(name: "unit-test.docc", content: [
JSONFile(name: "ModuleName.symbols.json", content: makeSymbolGraph(
moduleName: "ModuleName",
symbols: symbols
)),

TextFile(name: "ModuleName.md", utf8Content: """
# ``ModuleName``

This is a test file for ModuleName.

## Topics

- ``SymbolName-abc123``
""")
])

let (_, context) = try loadBundle(catalog: catalog)

let problems = context.problems.sorted(by: \.diagnostic.summary)
XCTAssertEqual(problems.count, 1)

let problem = try XCTUnwrap(problems.first)

XCTAssertEqual(problem.diagnostic.summary, "'abc123' isn't a disambiguation for 'SymbolName' at '/ModuleName'")

XCTAssertEqual(problem.possibleSolutions.count, 4)

for solution in problem.possibleSolutions {
XCTAssertEqual(solution.replacements.count, 1)
let replacement = try XCTUnwrap(solution.replacements.first)

// "Replace '-abc123' with '-(hash)'" where 'abc123' is at 7:15-7:22
XCTAssertEqual(replacement.range.lowerBound, .init(line: 7, column: 15, source: nil))
XCTAssertEqual(replacement.range.upperBound, .init(line: 7, column: 22, source: nil))
}
}
}

func testContextDiagnosesIncorrectSymbolNameWithCorrectRange() throws {
// This test deliberately does not turn on the overloads feature
// to ensure the symbol link below does not accidentally resolve correctly.
for symbolKindID in SymbolGraph.Symbol.KindIdentifier.allCases where !symbolKindID.isOverloadableKind {
// Generate a 4 symbols with the same name for every non overloadable symbol kind
let symbols: [SymbolGraph.Symbol] = [
makeSymbol(id: "first-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "second-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "third-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
makeSymbol(id: "fourth-\(symbolKindID.identifier)-id", kind: symbolKindID, pathComponents: ["SymbolName"]),
]

let catalog =
Folder(name: "unit-test.docc", content: [
JSONFile(name: "ModuleName.symbols.json", content: makeSymbolGraph(
moduleName: "ModuleName",
symbols: symbols
)),

TextFile(name: "ModuleName.md", utf8Content: """
# ``ModuleName``

This is a test file for ModuleName.

## Topics

- ``Symbol``
""")
])

let (_, context) = try loadBundle(catalog: catalog)

let problems = context.problems.sorted(by: \.diagnostic.summary)
XCTAssertEqual(problems.count, 1)

let problem = try XCTUnwrap(problems.first)

XCTAssertEqual(problem.diagnostic.summary, "'Symbol' doesn't exist at '/ModuleName'")

XCTAssertEqual(problem.possibleSolutions.count, 1)
let solution = try XCTUnwrap(problem.possibleSolutions.first)

XCTAssertEqual(solution.summary, "Replace 'Symbol' with 'SymbolName'")

XCTAssertEqual(solution.replacements.count, 1)
let replacement = try XCTUnwrap(solution.replacements.first)

XCTAssertEqual(replacement.range.lowerBound, .init(line: 7, column: 5, source: nil))
XCTAssertEqual(replacement.range.upperBound, .init(line: 7, column: 11, source: nil))
}
}

func testResolveExternalLinkFromTechnologyRoot() throws {
enableFeatureFlag(\.isExperimentalLinkHierarchySerializationEnabled)

Expand Down