Skip to content

Commit 50e9c91

Browse files
d-ronnqvistd-ronnqvist
committed
Prefer bundleID over id for types that scoped inside bundle
1 parent 540e17b commit 50e9c91

File tree

94 files changed

+578
-582
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

94 files changed

+578
-582
lines changed

‎Sources/SwiftDocC/DocumentationService/Convert/ConvertService.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -267,7 +267,7 @@ public struct ConvertService: DocumentationService {
267267
.compactMap { (value, isDocumentationExtensionContent) -> (ResolvedTopicReference, RenderReferenceStore.TopicContent)? in
268268
let (topicReference, article) = value
269269

270-
guard let bundle = context.bundle, bundle.id == topicReference.id else { return nil }
270+
guard let bundle = context.bundle, bundle.id == topicReference.bundleID else { return nil }
271271
let renderer = DocumentationContentRenderer(documentationContext: context, bundle: bundle)
272272

273273
let documentationNodeKind: DocumentationNode.Kind = isDocumentationExtensionContent ? .unknownSymbol : .article

‎Sources/SwiftDocC/Indexing/Navigator/NavigatorIndex.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -438,7 +438,7 @@ extension ResolvedTopicReference {
438438
let normalizedPath = NodeURLGenerator.fileSafeReferencePath(self, lowercased: true)
439439

440440
return NavigatorIndex.Identifier(
441-
bundleIdentifier: id.rawValue.lowercased(),
441+
bundleIdentifier: bundleID.rawValue.lowercased(),
442442
path: "/" + normalizedPath,
443443
fragment: fragment,
444444
languageIdentifier: languageIdentifier

‎Sources/SwiftDocC/Infrastructure/DocumentationBundle.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -127,9 +127,9 @@ public struct DocumentationBundle {
127127
self.customHeader = customHeader
128128
self.customFooter = customFooter
129129
self.themeSettings = themeSettings
130-
self.rootReference = ResolvedTopicReference(id: info.id, path: "/", sourceLanguage: .swift)
131-
self.documentationRootReference = ResolvedTopicReference(id: info.id, path: NodeURLGenerator.Path.documentationFolder, sourceLanguage: .swift)
132-
self.tutorialTableOfContentsContainer = ResolvedTopicReference(id: info.id, path: NodeURLGenerator.Path.tutorialsFolder, sourceLanguage: .swift)
130+
self.rootReference = ResolvedTopicReference(bundleID: info.id, path: "/", sourceLanguage: .swift)
131+
self.documentationRootReference = ResolvedTopicReference(bundleID: info.id, path: NodeURLGenerator.Path.documentationFolder, sourceLanguage: .swift)
132+
self.tutorialTableOfContentsContainer = ResolvedTopicReference(bundleID: info.id, path: NodeURLGenerator.Path.tutorialsFolder, sourceLanguage: .swift)
133133
self.tutorialsContainerReference = tutorialTableOfContentsContainer.appendingPath(urlReadablePath(info.displayName))
134134
self.articlesDocumentationRootReference = documentationRootReference.appendingPath(urlReadablePath(info.displayName))
135135
}

‎Sources/SwiftDocC/Infrastructure/DocumentationContext.swift‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -913,7 +913,7 @@ public class DocumentationContext {
913913
let (url, analyzed) = analyzedDocument
914914

915915
let path = NodeURLGenerator.pathForSemantic(analyzed, source: url, bundle: bundle)
916-
let reference = ResolvedTopicReference(id: bundle.id, path: path, sourceLanguage: .swift)
916+
let reference = ResolvedTopicReference(bundleID: bundle.id, path: path, sourceLanguage: .swift)
917917

918918
// Since documentation extensions' filenames have no impact on the URL of pages, there is no need to enforce unique filenames for them.
919919
// At this point we consider all articles with an H1 containing link a "documentation extension."
@@ -1334,7 +1334,7 @@ public class DocumentationContext {
13341334

13351335
let symbolPath = NodeURLGenerator.Path.documentation(path: url.components.path).stringValue
13361336
let symbolReference = ResolvedTopicReference(
1337-
id: reference.id,
1337+
bundleID: reference.bundleID,
13381338
path: symbolPath,
13391339
fragment: nil,
13401340
sourceLanguages: reference.sourceLanguages
@@ -1946,7 +1946,7 @@ public class DocumentationContext {
19461946
let title = articleResult.source.deletingPathExtension().lastPathComponent
19471947
// Create a new root-looking reference
19481948
let reference = ResolvedTopicReference(
1949-
id: bundle.id,
1949+
bundleID: bundle.id,
19501950
path: NodeURLGenerator.Path.documentation(path: title).stringValue,
19511951
sourceLanguages: [DocumentationContext.defaultLanguage(in: nil /* article-only content has no source language information */)]
19521952
)
@@ -1985,7 +1985,7 @@ public class DocumentationContext {
19851985
let path = NodeURLGenerator.Path.documentation(path: title).stringValue
19861986
let sourceLanguage = DocumentationContext.defaultLanguage(in: [])
19871987

1988-
let reference = ResolvedTopicReference(id: bundle.id, path: path, sourceLanguages: [sourceLanguage])
1988+
let reference = ResolvedTopicReference(bundleID: bundle.id, path: path, sourceLanguages: [sourceLanguage])
19891989

19901990
let graphNode = TopicGraph.Node(reference: reference, kind: .module, source: .external, title: title)
19911991
topicGraph.addNode(graphNode)
@@ -2050,7 +2050,7 @@ public class DocumentationContext {
20502050
let defaultSourceLanguage = defaultLanguage(in: availableSourceLanguages)
20512051

20522052
let reference = ResolvedTopicReference(
2053-
id: bundle.id,
2053+
bundleID: bundle.id,
20542054
path: path,
20552055
sourceLanguages: availableSourceLanguages
20562056
// FIXME: Pages in article-only catalogs should not be inferred as "Swift" as a fallback
@@ -2685,12 +2685,12 @@ public class DocumentationContext {
26852685
*/
26862686
private func unregister(_ bundle: DocumentationBundle) {
26872687
let referencesToRemove = topicGraph.nodes.keys.filter {
2688-
$0.id == bundle.id
2688+
$0.bundleID == bundle.id
26892689
}
26902690

26912691
for reference in referencesToRemove {
2692-
topicGraph.edges[reference]?.removeAll(where: { $0.id == bundle.id })
2693-
topicGraph.reverseEdges[reference]?.removeAll(where: { $0.id == bundle.id })
2692+
topicGraph.edges[reference]?.removeAll(where: { $0.bundleID == bundle.id })
2693+
topicGraph.reverseEdges[reference]?.removeAll(where: { $0.bundleID == bundle.id })
26942694
topicGraph.nodes[reference] = nil
26952695
}
26962696
}
@@ -2736,7 +2736,7 @@ public class DocumentationContext {
27362736
}
27372737

27382738
private func externalEntity(with reference: ResolvedTopicReference) -> LinkResolver.ExternalEntity? {
2739-
return configuration.externalDocumentationConfiguration.sources[reference.id].map({ $0.entity(with: reference) })
2739+
return configuration.externalDocumentationConfiguration.sources[reference.bundleID].map({ $0.entity(with: reference) })
27402740
?? configuration.convertServiceConfiguration.fallbackResolver?.entityIfPreviouslyResolved(with: reference)
27412741
}
27422742

@@ -2902,7 +2902,7 @@ public class DocumentationContext {
29022902
/// - asset: The new asset for this name.
29032903
/// - parent: The topic where the asset is referenced.
29042904
public func updateAsset(named name: String, asset: DataAsset, in parent: ResolvedTopicReference) {
2905-
assetManagers[parent.id]?.update(name: name, asset: asset)
2905+
assetManagers[parent.bundleID]?.update(name: name, asset: asset)
29062906
}
29072907

29082908
/// Attempt to resolve an asset given its name and the topic it's referenced in.
@@ -2913,7 +2913,7 @@ public class DocumentationContext {
29132913
/// - type: A restriction for what type of asset to resolve.
29142914
/// - Returns: The data that's associated with an image asset if it was found, otherwise `nil`.
29152915
public func resolveAsset(named name: String, in parent: ResolvedTopicReference, withType type: AssetType? = nil) -> DataAsset? {
2916-
resolveAsset(named: name, bundleID: parent.id, withType: type)
2916+
resolveAsset(named: name, bundleID: parent.bundleID, withType: type)
29172917
}
29182918

29192919
func resolveAsset(named name: String, bundleID: DocumentationBundle.Identifier, withType expectedType: AssetType?) -> DataAsset? {
@@ -2957,7 +2957,7 @@ public class DocumentationContext {
29572957
///
29582958
/// - Returns: The best matching storage key if it was found, otherwise `nil`.
29592959
public func identifier(forAssetName name: String, in parent: ResolvedTopicReference) -> String? {
2960-
if let assetManager = assetManagers[parent.id] {
2960+
if let assetManager = assetManagers[parent.bundleID] {
29612961
if let localName = assetManager.bestKey(forAssetName: name) {
29622962
return localName
29632963
} else if let fallbackAssetManager = configuration.convertServiceConfiguration.fallbackResolver {

‎Sources/SwiftDocC/Infrastructure/DocumentationCurator.swift‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -94,7 +94,7 @@ struct DocumentationCurator {
9494
let sourceArticlePath = NodeURLGenerator.Path.article(bundleName: bundle.displayName, articleName: articleFilename).stringValue
9595

9696
let reference = ResolvedTopicReference(
97-
id: resolved.id,
97+
bundleID: resolved.bundleID,
9898
path: sourceArticlePath,
9999
sourceLanguages: resolved.sourceLanguages)
100100

‎Sources/SwiftDocC/Infrastructure/External Data/OutOfProcessReferenceResolver.swift‎

Lines changed: 11 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -53,11 +53,11 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
5353

5454
@available(*, deprecated, renamed: "id", message: "Use 'id' instead. This deprecated API will be removed after 6.2 is released")
5555
public var bundleIdentifier: String {
56-
id.rawValue
56+
bundleID.rawValue
5757
}
5858

5959
/// The bundle identifier for the reference resolver in the other process.
60-
public let id: DocumentationBundle.Identifier
60+
public let bundleID: DocumentationBundle.Identifier
6161

6262
/// Creates a new reference resolver that interacts with another executable.
6363
///
@@ -82,13 +82,13 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
8282
throw Error.invalidBundleIdentifierOutputFromExecutable(processLocation)
8383
}
8484

85-
self.id = .init(rawValue: decodedBundleIdentifier)
85+
self.bundleID = .init(rawValue: decodedBundleIdentifier)
8686
self.externalLinkResolvingClient = longRunningProcess
8787
}
8888

89-
@available(*, deprecated, renamed: "init(id:server:convertRequestIdentifier:)", message: "Use 'init(id:server:convertRequestIdentifier:)' instead. This deprecated API will be removed after 6.2 is released")
89+
@available(*, deprecated, renamed: "init(bundleID:server:convertRequestIdentifier:)", message: "Use 'init(bundleID:server:convertRequestIdentifier:)' instead. This deprecated API will be removed after 6.2 is released")
9090
public init(bundleIdentifier: String, server: DocumentationServer, convertRequestIdentifier: String?) throws {
91-
self.id = .init(rawValue: bundleIdentifier)
91+
self.bundleID = .init(rawValue: bundleIdentifier)
9292
self.externalLinkResolvingClient = LongRunningService(
9393
server: server, convertRequestIdentifier: convertRequestIdentifier)
9494
}
@@ -102,7 +102,7 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
102102
/// - server: The server to send link resolution requests to.
103103
/// - convertRequestIdentifier: The identifier that the resolver will use for convert requests that it sends to the server.
104104
public init(id: DocumentationBundle.Identifier, server: DocumentationServer, convertRequestIdentifier: String?) throws {
105-
self.id = id
105+
self.bundleID = id
106106
self.externalLinkResolvingClient = LongRunningService(
107107
server: server, convertRequestIdentifier: convertRequestIdentifier)
108108
}
@@ -115,7 +115,7 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
115115
return resolved
116116

117117
case let .unresolved(unresolvedReference):
118-
guard unresolvedReference.id == id else {
118+
guard unresolvedReference.bundleID == bundleID else {
119119
fatalError("""
120120
Attempted to resolve a local reference externally: \(unresolvedReference.description.singleQuoted).
121121
DocC should never pass a reference to an external resolver unless it matches that resolver's bundle identifier.
@@ -147,7 +147,7 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
147147
guard let resolvedInformation = try? resolveInformationForSymbolIdentifier(preciseIdentifier) else { return nil }
148148

149149
let reference = ResolvedTopicReference(
150-
id: "com.externally.resolved.symbol",
150+
bundleID: "com.externally.resolved.symbol",
151151
path: "/\(preciseIdentifier)",
152152
sourceLanguages: sourceLanguages(for: resolvedInformation)
153153
)
@@ -255,7 +255,7 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
255255

256256
private func resolvedReference(for resolvedInformation: ResolvedInformation) -> ResolvedTopicReference {
257257
return ResolvedTopicReference(
258-
id: id,
258+
bundleID: bundleID,
259259
path: resolvedInformation.url.path,
260260
fragment: resolvedInformation.url.fragment,
261261
sourceLanguages: sourceLanguages(for: resolvedInformation)
@@ -779,13 +779,13 @@ extension OutOfProcessReferenceResolver: ConvertServiceFallbackResolver {
779779
}
780780

781781
func resolveInformationForAsset(named assetName: String) throws -> DataAsset {
782-
let assetReference = AssetReference(assetName: assetName, bundleID: id)
782+
let assetReference = AssetReference(assetName: assetName, bundleID: bundleID)
783783
if let asset = assetCache[assetReference] {
784784
return asset
785785
}
786786

787787
let response = try externalLinkResolvingClient.sendAndWait(
788-
request: Request.asset(AssetReference(assetName: assetName, bundleID: id))
788+
request: Request.asset(AssetReference(assetName: assetName, bundleID: bundleID))
789789
) as Response
790790

791791
switch response {
@@ -798,8 +798,4 @@ extension OutOfProcessReferenceResolver: ConvertServiceFallbackResolver {
798798
throw Error.unexpectedResponse(response: response, requestDescription: "asset")
799799
}
800800
}
801-
802-
var bundleID: DocumentationBundle.Identifier {
803-
id
804-
}
805801
}

‎Sources/SwiftDocC/Infrastructure/Link Resolution/ExternalPathHierarchyResolver.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ final class ExternalPathHierarchyResolver {
9898
else {
9999
return nil
100100
}
101-
return ResolvedTopicReference(id: .init(rawValue: bundleID), path: url.path, fragment: url.fragment, sourceLanguage: .swift)
101+
return ResolvedTopicReference(bundleID: .init(rawValue: bundleID), path: url.path, fragment: url.fragment, sourceLanguage: .swift)
102102
}
103103
let dependencies = RenderReferenceDependencies(
104104
topicReferences: topicReferences,
@@ -126,7 +126,7 @@ final class ExternalPathHierarchyResolver {
126126
symbols.reserveCapacity(linkDestinationSummaries.count)
127127
for entity in linkDestinationSummaries {
128128
let reference = ResolvedTopicReference(
129-
id: .init(rawValue: entity.referenceURL.host!),
129+
bundleID: .init(rawValue: entity.referenceURL.host!),
130130
path: entity.referenceURL.path,
131131
fragment: entity.referenceURL.fragment,
132132
sourceLanguage: entity.language
@@ -150,7 +150,7 @@ final class ExternalPathHierarchyResolver {
150150
continue
151151
}
152152
let identifier = identifiers[index]
153-
self.resolvedReferences[identifier] = ResolvedTopicReference(id: fileRepresentation.bundleID, path: url.path, fragment: url.fragment, sourceLanguage: .swift)
153+
self.resolvedReferences[identifier] = ResolvedTopicReference(bundleID: fileRepresentation.bundleID, path: url.path, fragment: url.fragment, sourceLanguage: .swift)
154154
}
155155
}
156156
// Finally, the Identifier -> Symbol mapping can be constructed by iterating over the nodes and looking up the reference for each USR.

‎Sources/SwiftDocC/Infrastructure/Link Resolution/LinkResolver.swift‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -92,7 +92,7 @@ public class LinkResolver {
9292
}
9393

9494
// Check if this is a link to an external documentation source that should have previously been resolved in `DocumentationContext.preResolveExternalLinks(...)`
95-
if let bundleID = unresolvedReference.id,
95+
if let bundleID = unresolvedReference.bundleID,
9696
!context._registeredBundles.contains(where: { $0.id == bundleID || urlReadablePath($0.displayName) == bundleID.rawValue })
9797
{
9898
return .failure(unresolvedReference, TopicReferenceResolutionErrorInfo("No external resolver registered for '\(bundleID)'."))
@@ -169,7 +169,7 @@ private final class FallbackResolverBasedLinkResolver {
169169

170170
private func resolve(_ unresolvedReference: UnresolvedTopicReference, in parent: ResolvedTopicReference, fromSymbolLink isCurrentlyResolvingSymbolLink: Bool, context: DocumentationContext) -> TopicReferenceResolutionResult? {
171171
// Check if a fallback reference resolver should resolve this
172-
let referenceID = unresolvedReference.id ?? parent.id
172+
let referenceID = unresolvedReference.bundleID ?? parent.bundleID
173173
guard let fallbackResolver = context.configuration.convertServiceConfiguration.fallbackResolver,
174174
// This uses an underscored internal variant of `registeredBundles` to avoid deprecation warnings and remain compatible with legacy data providers.
175175
let knownBundleID = context._registeredBundles.first(where: { $0.id == referenceID || urlReadablePath($0.displayName) == referenceID.rawValue })?.id,
@@ -184,7 +184,7 @@ private final class FallbackResolverBasedLinkResolver {
184184
var allCandidateURLs = [URL]()
185185

186186
let alreadyResolved = ResolvedTopicReference(
187-
id: referenceID,
187+
bundleID: referenceID,
188188
path: unresolvedReference.path.prependingLeadingSlash,
189189
fragment: unresolvedReference.topicURL.components.fragment,
190190
sourceLanguages: parent.sourceLanguages

‎Sources/SwiftDocC/Infrastructure/Link Resolution/PathHierarchyBasedLinkResolver.swift‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ final class PathHierarchyBasedLinkResolver {
2828
func unregisterBundle(identifier: DocumentationBundle.Identifier) {
2929
var newMap = BidirectionalMap<ResolvedIdentifier, ResolvedTopicReference>()
3030
for (id, reference) in resolvedReferenceMap {
31-
if reference.id == identifier {
31+
if reference.bundleID == identifier {
3232
pathHierarchy.removeNodeWithID(id)
3333
} else {
3434
newMap[id] = reference
@@ -301,7 +301,7 @@ final class PathHierarchyBasedLinkResolver {
301301
}
302302

303303
return ResolvedTopicReference(
304-
id: bundle.documentationRootReference.id,
304+
bundleID: bundle.documentationRootReference.bundleID,
305305
path: NodeURLGenerator.Path.documentationFolder + path,
306306
sourceLanguages: symbol.sourceLanguages
307307
)

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

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -107,7 +107,7 @@ enum GeneratedDocumentationTopics {
107107

108108
// Create the collection topic reference
109109
let collectionReference = ResolvedTopicReference(
110-
id: bundle.id,
110+
bundleID: bundle.id,
111111
path: NodeURLGenerator.Path.documentationCuration(
112112
parentPath: parent.path,
113113
articleName: title

0 commit comments

Comments
 (0)