Ensure that bundle identifiers are valid URL host components

Sources/SwiftDocC/DocumentationService/Convert/ConvertService.swift

@@ -128,7 +128,7 @@ public struct ConvertService: DocumentationService {
 
             if let linkResolvingServer {
                 let resolver = try OutOfProcessReferenceResolver(
-                    bundleIdentifier: request.bundleInfo.identifier,
+                    id: request.bundleInfo.id,
                     server: linkResolvingServer,
                     convertRequestIdentifier: messageIdentifier
                 )

Sources/SwiftDocC/Infrastructure/DocumentationBundle.swift

@@ -55,7 +55,7 @@ public struct DocumentationBundle {
      An identifier string that specifies the app type of the bundle. The string should be in reverse DNS format using only the Roman alphabet in upper and lower case (A–Z, a–z), the dot (“.”), and the hyphen (“-”).
      */
     public var identifier: String {
-        info.identifier
+        info.id.rawValue
     }
 
     /**
@@ -126,9 +126,9 @@ public struct DocumentationBundle {
         self.customHeader = customHeader
         self.customFooter = customFooter
         self.themeSettings = themeSettings
-        self.rootReference = ResolvedTopicReference(bundleIdentifier: info.identifier, path: "/", sourceLanguage: .swift)
-        self.documentationRootReference = ResolvedTopicReference(bundleIdentifier: info.identifier, path: NodeURLGenerator.Path.documentationFolder, sourceLanguage: .swift)
-        self.tutorialTableOfContentsContainer = ResolvedTopicReference(bundleIdentifier: info.identifier, path: NodeURLGenerator.Path.tutorialsFolder, sourceLanguage: .swift)
+        self.rootReference = ResolvedTopicReference(bundleIdentifier: info.id.rawValue, path: "/", sourceLanguage: .swift)
+        self.documentationRootReference = ResolvedTopicReference(bundleIdentifier: info.id.rawValue, path: NodeURLGenerator.Path.documentationFolder, sourceLanguage: .swift)
+        self.tutorialTableOfContentsContainer = ResolvedTopicReference(bundleIdentifier: info.id.rawValue, path: NodeURLGenerator.Path.tutorialsFolder, sourceLanguage: .swift)
         self.tutorialsContainerReference = tutorialTableOfContentsContainer.appendingPath(urlReadablePath(info.displayName))
         self.articlesDocumentationRootReference = documentationRootReference.appendingPath(urlReadablePath(info.displayName))
     }

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

@@ -51,8 +51,13 @@ import SymbolKit
 public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalExternalSymbolResolver {
     private let externalLinkResolvingClient: ExternalLinkResolving
 
+    @available(*, deprecated, renamed: "id", message: "Use 'id' instead. This deprecated API will be removed after 6.2 is released")
+    public var bundleIdentifier: String {
+        id.rawValue
+    }
+
     /// The bundle identifier for the reference resolver in the other process.
-    public let bundleIdentifier: String
+    public let id: DocumentationBundle.Identifier
 
     /// Creates a new reference resolver that interacts with another executable.
     ///
@@ -77,20 +82,27 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
             throw Error.invalidBundleIdentifierOutputFromExecutable(processLocation)
         }
 
-        self.bundleIdentifier = decodedBundleIdentifier
+        self.id = .init(rawValue: decodedBundleIdentifier)
         self.externalLinkResolvingClient = longRunningProcess
     }
 
+    @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")
+    public init(bundleIdentifier: String, server: DocumentationServer, convertRequestIdentifier: String?) throws {
+        self.id = .init(rawValue: bundleIdentifier)
+        self.externalLinkResolvingClient = LongRunningService(
+            server: server, convertRequestIdentifier: convertRequestIdentifier)
+    }
+
     /// Creates a new reference resolver that interacts with a documentation service.
     ///
     /// The documentation service is expected to be able to handle messages of kind "resolve-reference".
     ///
     /// - Parameters:
-    ///   - bundleIdentifier: The bundle identifier the server can resolve references for.
+    ///   - id: The bundle identifier the server can resolve references for.
     ///   - server: The server to send link resolution requests to.
     ///   - convertRequestIdentifier: The identifier that the resolver will use for convert requests that it sends to the server.
-    public init(bundleIdentifier: String, server: DocumentationServer, convertRequestIdentifier: String?) throws {
-        self.bundleIdentifier = bundleIdentifier
+    public init(id: DocumentationBundle.Identifier, server: DocumentationServer, convertRequestIdentifier: String?) throws {
+        self.id = id
         self.externalLinkResolvingClient = LongRunningService(
             server: server, convertRequestIdentifier: convertRequestIdentifier)
     }
@@ -103,7 +115,7 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
             return resolved
 
         case let .unresolved(unresolvedReference):
-            guard unresolvedReference.bundleIdentifier == bundleIdentifier else {
+            guard unresolvedReference.bundleIdentifier == id.rawValue else {
                 fatalError("""
                     Attempted to resolve a local reference externally: \(unresolvedReference.description.singleQuoted).
                     DocC should never pass a reference to an external resolver unless it matches that resolver's bundle identifier.
@@ -243,7 +255,7 @@ public class OutOfProcessReferenceResolver: ExternalDocumentationSource, GlobalE
 
     private func resolvedReference(for resolvedInformation: ResolvedInformation) -> ResolvedTopicReference {
         return ResolvedTopicReference(
-            bundleIdentifier: bundleIdentifier,
+            bundleIdentifier: id.rawValue,
             path: resolvedInformation.url.path,
             fragment: resolvedInformation.url.fragment,
             sourceLanguages: sourceLanguages(for: resolvedInformation)
@@ -767,13 +779,13 @@ extension OutOfProcessReferenceResolver: ConvertServiceFallbackResolver {
     }
 
     func resolveInformationForAsset(named assetName: String) throws -> DataAsset {
-        let assetReference = AssetReference(assetName: assetName, bundleIdentifier: bundleIdentifier)
+        let assetReference = AssetReference(assetName: assetName, bundleIdentifier: id.rawValue)
         if let asset = assetCache[assetReference] {
             return asset
         }
 
         let response = try externalLinkResolvingClient.sendAndWait(
-            request: Request.asset(AssetReference(assetName: assetName, bundleIdentifier: bundleIdentifier))
+            request: Request.asset(AssetReference(assetName: assetName, bundleIdentifier: id.rawValue))
         ) as Response
 
         switch response {

Sources/SwiftDocCUtilities/Action/Actions/Convert/ConvertAction.swift

@@ -160,7 +160,7 @@ public struct ConvertAction: AsyncAction {
         }
 
         if let outOfProcessResolver {
-            configuration.externalDocumentationConfiguration.sources[outOfProcessResolver.bundleIdentifier] = outOfProcessResolver
+            configuration.externalDocumentationConfiguration.sources[outOfProcessResolver.id.rawValue] = outOfProcessResolver
             configuration.externalDocumentationConfiguration.globalSymbolResolver = outOfProcessResolver
         }
         configuration.externalDocumentationConfiguration.dependencyArchives = dependencies

Tests/SwiftDocCTests/DocumentationService/ConvertService/ConvertServiceTests.swift

@@ -17,7 +17,7 @@ import SwiftDocCTestUtilities
 class ConvertServiceTests: XCTestCase {
     private let testBundleInfo = DocumentationBundle.Info(
         displayName: "TestBundle",
-        identifier: "identifier"
+        id: "identifier"
     )
 
     func testConvertSinglePage() throws {
@@ -1730,7 +1730,7 @@ class ConvertServiceTests: XCTestCase {
         let request = ConvertRequest(
             bundleInfo: DocumentationBundle.Info(
                 displayName: "TestBundle",
-                identifier: "com.test.bundle"
+                id: "com.test.bundle"
             ),
             externalIDsToConvert: ["s:5MyKit0A5ClassC10myFunctionyyF"],
             documentPathsToConvert: [],
@@ -2019,7 +2019,7 @@ class ConvertServiceTests: XCTestCase {
         let request = ConvertRequest(
             bundleInfo: DocumentationBundle.Info(
                 displayName: "TestBundle",
-                identifier: "org.swift.example"
+                id: "org.swift.example"
             ),
             externalIDsToConvert: ["s:32MyKit3FooV"],
             documentPathsToConvert: [],
@@ -2128,7 +2128,7 @@ class ConvertServiceTests: XCTestCase {
         let request = ConvertRequest(
             bundleInfo: DocumentationBundle.Info(
                 displayName: "TestBundleDisplayName",
-                identifier: "com.test.bundle"
+                id: "com.test.bundle"
             ),
             externalIDsToConvert: ["s:21SmallTestingFramework40EnumerationWithSingleUnresolvableDocLinkO"],
             documentPathsToConvert: [],
@@ -2166,7 +2166,7 @@ class ConvertServiceTests: XCTestCase {
         let request = ConvertRequest(
             bundleInfo: DocumentationBundle.Info(
                 displayName: "TestBundleDisplayName",
-                identifier: "com.test.bundle"
+                id: "com.test.bundle"
             ),
             externalIDsToConvert: ["s:21SmallTestingFramework15TestEnumerationO06NesteddE0O0D6StructV06deeplyfD31FunctionWithUnresolvableDocLinkyyF"],
             documentPathsToConvert: [],
@@ -2205,7 +2205,7 @@ class ConvertServiceTests: XCTestCase {
         let request = ConvertRequest(
             bundleInfo: DocumentationBundle.Info(
                 displayName: "TestBundleDisplayName",
-                identifier: "com.test.bundle"
+                id: "com.test.bundle"
             ),
             externalIDsToConvert: ["s:21SmallTestingFramework43EnumerationWithSingleUnresolvableSymbolLinkO"],
             documentPathsToConvert: [],
@@ -2331,7 +2331,7 @@ class ConvertServiceTests: XCTestCase {
         let bundleURL = tempURL.appendingPathComponent("unit-test.docc")
 
         let requestWithDifferentBundleID = ConvertRequest(
-            bundleInfo: DocumentationBundle.Info(displayName: "DisplayName", identifier: "com.example.something-else"),
+            bundleInfo: DocumentationBundle.Info(displayName: "DisplayName", id: "com.example.something-else"),
             externalIDsToConvert: [],
             bundleLocation: bundleURL,
             symbolGraphs: [],
@@ -2341,7 +2341,7 @@ class ConvertServiceTests: XCTestCase {
         XCTAssertEqual(try linkResolutionRequestsForConvertRequest(requestWithDifferentBundleID), [], "Shouldn't make any link resolution requests because the bundle IDs are different.")
 
         let requestWithSameBundleID = ConvertRequest(
-            bundleInfo: DocumentationBundle.Info(displayName: "DisplayName", identifier: "com.example.something"),
+            bundleInfo: DocumentationBundle.Info(displayName: "DisplayName", id: "com.example.something"),
             externalIDsToConvert: [],
             bundleLocation: bundleURL,
             symbolGraphs: [],

Tests/SwiftDocCTests/DocumentationService/DocumentationServer+DefaultTests.swift

@@ -68,7 +68,7 @@ class DocumentationServer_DefaultTests: XCTestCase {
         let request = ConvertRequest(
             bundleInfo: DocumentationBundle.Info(
                 displayName: "TestBundle",
-                identifier: "identifier"
+                id: "identifier"
             ),
             externalIDsToConvert: ["s:5MyKit0A5ClassC10myFunctionyyF"],
             symbolGraphs: [symbolGraph],

Tests/SwiftDocCTests/Infrastructure/DocumentationBundleInfoTests.swift

@@ -22,7 +22,7 @@ class DocumentationBundleInfoTests: XCTestCase {
         let info = try DocumentationBundle.Info(from: infoPlistData)
 
         XCTAssertEqual(info.displayName, "Test Bundle")
-        XCTAssertEqual(info.identifier, "org.swift.docc.example")
+        XCTAssertEqual(info.id.rawValue, "org.swift.docc.example")
         XCTAssertEqual(info.defaultCodeListingLanguage, "swift")
     }
 
@@ -82,7 +82,7 @@ class DocumentationBundleInfoTests: XCTestCase {
             ),
             DocumentationBundle.Info(
                 displayName: "Info Plist Display Name",
-                identifier: "com.info.Plist"
+                id: "com.info.Plist"
             )
         )
 
@@ -93,7 +93,7 @@ class DocumentationBundleInfoTests: XCTestCase {
             ),
             DocumentationBundle.Info(
                 displayName: "Fallback Display Name",
-                identifier: "com.fallback.Identifier"
+                id: "com.fallback.Identifier"
             )
         )
 
@@ -104,7 +104,7 @@ class DocumentationBundleInfoTests: XCTestCase {
             ),
             DocumentationBundle.Info(
                 displayName: "Fallback Display Name",
-                identifier: "com.info.Plist"
+                id: "com.info.Plist"
             )
         )
 
@@ -128,7 +128,7 @@ class DocumentationBundleInfoTests: XCTestCase {
             ),
             DocumentationBundle.Info(
                 displayName: "Info Plist Display Name",
-                identifier: "com.info.Plist"
+                id: "com.info.Plist"
             )
         )
     }
@@ -237,7 +237,7 @@ class DocumentationBundleInfoTests: XCTestCase {
             info,
             DocumentationBundle.Info(
                 displayName: "Display Name",
-                identifier: "swift.org.Identifier",
+                id: "swift.org.Identifier",
                 defaultCodeListingLanguage: "swift",
                 defaultModuleKind: "Executable",
                 defaultAvailability: DefaultAvailability(
@@ -257,7 +257,7 @@ class DocumentationBundleInfoTests: XCTestCase {
     func testFallbackToInfoInBundleDiscoveryOptions() throws {
         let info = DocumentationBundle.Info(
             displayName: "Display Name",
-            identifier: "swift.org.Identifier",
+            id: "swift.org.Identifier",
             defaultCodeListingLanguage: "swift",
             defaultModuleKind: "Executable",
             defaultAvailability: DefaultAvailability(
@@ -341,7 +341,7 @@ class DocumentationBundleInfoTests: XCTestCase {
             ),
             DocumentationBundle.Info(
                 displayName: "Derived Display Name",
-                identifier: "Derived Display Name"
+                id: "Derived Display Name"
             )
         )
     }
@@ -366,7 +366,7 @@ class DocumentationBundleInfoTests: XCTestCase {
             ),
             DocumentationBundle.Info(
                 displayName: "Derived Display Name",
-                identifier: "org.swift.docc.example"
+                id: "org.swift.docc.example"
             )
         )
     }
@@ -390,7 +390,7 @@ class DocumentationBundleInfoTests: XCTestCase {
             ),
             DocumentationBundle.Info(
                 displayName: "Example",
-                identifier: "Example"
+                id: "Example"
             )
         )
     }

Tests/SwiftDocCTests/Infrastructure/DocumentationWorkspaceTests.swift

@@ -151,7 +151,7 @@ class DocumentationWorkspaceTests: XCTestCase {
             return DocumentationBundle(
                 info: DocumentationBundle.Info(
                     displayName: "Test" + suffix,
-                    identifier: "com.example.test" + suffix
+                    id: DocumentationBundle.Identifier(rawValue: "com.example.test" + suffix)
                 ),
                 symbolGraphURLs: [testSymbolGraphFile],
                 markupURLs: [testMarkupFile],

Tests/SwiftDocCTests/Infrastructure/SymbolDisambiguationTests.swift

@@ -324,7 +324,7 @@ class SymbolDisambiguationTests: XCTestCase {
         let bundle = DocumentationBundle(
             info: DocumentationBundle.Info(
                 displayName: "SymbolDisambiguationTests",
-                identifier: "com.test.SymbolDisambiguationTests"),
+                id: "com.test.SymbolDisambiguationTests"),
             symbolGraphURLs: [swiftSymbolGraphURL, objcSymbolGraphURL],
             markupURLs: [],
             miscResourceURLs: []

Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift

@@ -1791,7 +1791,7 @@ class SymbolGraphLoaderTests: XCTestCase {
         let bundle = DocumentationBundle(
             info: DocumentationBundle.Info(
                 displayName: "Test",
-                identifier: "com.example.test"
+                id: "com.example.test"
             ),
             baseURL: URL(string: "https://example.com/example")!,
             symbolGraphURLs: symbolGraphURLs,

Tests/SwiftDocCTests/Rendering/DefaultCodeListingSyntaxTests.swift

@@ -42,7 +42,7 @@ class DefaultCodeBlockSyntaxTests: XCTestCase {
         testBundleWithoutLanguageDefault = DocumentationBundle(
             info: DocumentationBundle.Info(
                 displayName: testBundleWithLanguageDefault.displayName,
-                identifier: testBundleWithLanguageDefault.identifier,
+                id: DocumentationBundle.Identifier(rawValue: testBundleWithLanguageDefault.identifier),
                 defaultCodeListingLanguage: nil
             ),
             baseURL: testBundleWithLanguageDefault.baseURL,

Tests/SwiftDocCTests/XCTestCase+LoadingTestData.swift

@@ -142,7 +142,7 @@ extension XCTestCase {
         let bundle = DocumentationBundle(
             info: DocumentationBundle.Info(
                 displayName: "Test",
-                identifier: "com.example.test"
+                id: "com.example.test"
             ),
             baseURL: URL(string: "https://example.com/example")!,
             symbolGraphURLs: [],