Remove error for mixed symbol graph formats. (#715)

rdar://114405721
rdar://115438349

Author: d-ronnqvist

Sources/SwiftDocC/Infrastructure/Symbol Graph/SymbolGraphLoader.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-2023 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
@@ -80,7 +80,6 @@ struct SymbolGraphLoader {
 
                 configureSymbolGraph?(&symbolGraph)
 
-                // `moduleNameFor(_:at:)` is static because it's pure function.
                 let (moduleName, isMainSymbolGraph) = Self.moduleNameFor(symbolGraph, at: symbolGraphURL)
                 // If the bundle provides availability defaults add symbol availability data.
                 self.addDefaultAvailability(to: &symbolGraph, moduleName: moduleName)
@@ -131,25 +130,6 @@ struct SymbolGraphLoader {
 
         // define an appropriate merging strategy based on the graph formats
         let foundGraphUsingExtensionSymbolFormat = loadedGraphs.values.map(\.usesExtensionSymbolFormat).contains(true)
-        let foundGraphNotUsingExtensionSymbolFormat = loadedGraphs.values.map(\.usesExtensionSymbolFormat).contains(false)
-        
-        guard !foundGraphUsingExtensionSymbolFormat || !foundGraphNotUsingExtensionSymbolFormat else {
-            let usingExtensionSymbolFormat = loadedGraphs.filter { (_, value) in
-                guard let usesExtensionSymbolFormat = value.usesExtensionSymbolFormat else {
-                    return false
-                }
-                return usesExtensionSymbolFormat
-            }.map(\.key)
-            
-            let notUsingExtensionSymbolFormat = loadedGraphs.filter { (_, value) in
-                guard let usesExtensionSymbolFormat = value.usesExtensionSymbolFormat else {
-                    return false
-                }
-                return !usesExtensionSymbolFormat
-            }.map(\.key)
-            
-            throw LoadingError.mixedGraphFormats(usingExtensionSymbolFormat, notUsingExtensionSymbolFormat)
-        }
 
         let usingExtensionSymbolFormat = foundGraphUsingExtensionSymbolFormat
 
@@ -170,24 +150,6 @@ struct SymbolGraphLoader {
         (self.unifiedGraphs, self.graphLocations) = graphLoader.finishLoading()
     }
 
-    private enum LoadingError: DescribedError {
-        case mixedGraphFormats([URL], [URL])
-        
-        var errorDescription: String {
-            switch self {
-            case let .mixedGraphFormats(usingExtensionSymbolFormat, notUsingExtensionSymbolFormat):
-                return """
-                Mixing symbol graph files with and without extension declarations is not supported.
-                
-                Symbol graph files with extension declarations:
-                \(usingExtensionSymbolFormat.map(\.absoluteString).joined(separator: "\n"))
-                Symbol graph files without extension declarations:
-                \(notUsingExtensionSymbolFormat.map(\.absoluteString).joined(separator: "\n"))
-                """
-            }
-        }
-    }
-    
     // Alias to declutter code
     typealias AvailabilityItem = SymbolGraph.Symbol.Availability.AvailabilityItem
 
@@ -209,7 +171,7 @@ struct SymbolGraphLoader {
         let (moduleName, isMainSymbolGraph) = Self.moduleNameFor(symbolGraph, at: url)
 
         if !isMainSymbolGraph && symbolGraph.module.bystanders == nil {
-            // If this is an extending another module, change the module name to match the exteneded module.
+            // If this is an extending another module, change the module name to match the extended module.
             // This makes the symbols in this graph have a path that starts with the extended module's name.
             symbolGraph.module.name = moduleName
         }

Tests/SwiftDocCTests/Infrastructure/SymbolGraph/SymbolGraphLoaderTests.swift

@@ -329,150 +329,6 @@ class SymbolGraphLoaderTests: XCTestCase {
         XCTAssertEqual(loader.decodingStrategy, .concurrentlyEachFileInBatches)
         #endif
     }
-
-    func testInputWithMixedGraphFormats() throws {
-        let tempURL = try createTemporaryDirectory()
-        
-        let mainGraph = (url: tempURL.appendingPathComponent("A.symbols.json"),
-                         content: makeSymbolGraphString(moduleName: "A"))
-        
-        let emptyExtensionGraph = (url: tempURL.appendingPathComponent("[email protected]"),
-                                   content: makeSymbolGraphString(moduleName: "A"))
-        
-        let extensionBlockFormatExtensionGraph = (url: tempURL.appendingPathComponent("[email protected]"),
-                                                  content: makeSymbolGraphString(moduleName: "A", symbols: """
-        {
-            "kind": {
-                "identifier": "swift.extension",
-                "displayName": "Extension"
-            },
-            "identifier": {
-                "precise": "s:e:s:EBFfunction",
-                "interfaceLanguage": "swift"
-            },
-            "pathComponents": [
-                "EBF"
-            ],
-            "names": {
-                "title": "EBF",
-            },
-            "swiftExtension": {
-                "extendedModule": "A",
-                "typeKind": "struct"
-            },
-            "accessLevel": "public"
-        },
-        {
-            "kind": {
-                "identifier": "swift.func",
-                "displayName": "Function"
-            },
-            "identifier": {
-                "precise": "s:EBFfunction",
-                "interfaceLanguage": "swift"
-            },
-            "pathComponents": [
-                "EBF",
-                "function"
-            ],
-            "names": {
-                "title": "function",
-            },
-            "swiftExtension": {
-                "extendedModule": "A",
-                "typeKind": "struct"
-            },
-            "accessLevel": "public"
-        }
-        """, relationships: """
-        {
-            "kind": "memberOf",
-            "source": "s:EBFfunction",
-            "target": "s:e:s:EBFfunction",
-            "targetFallback": "A.EBF"
-        },
-        {
-            "kind": "extensionTo",
-            "source": "s:e:s:EBFfunction",
-            "target": "s:EBF",
-            "targetFallback": "A.EBF"
-        }
-        """))
-        
-        let noExtensionBlockFormatExtensionGraph = (url: tempURL.appendingPathComponent("[email protected]"),
-                                                    content: makeSymbolGraphString(moduleName: "A", symbols: """
-        {
-            "kind": {
-                "identifier": "swift.func",
-                "displayName": "Function"
-            },
-            "identifier": {
-                "precise": "s:EBFfunction",
-                "interfaceLanguage": "swift"
-            },
-            "pathComponents": [
-                "EBF",
-                "function"
-            ],
-            "names": {
-                "title": "function",
-            },
-            "swiftExtension": {
-                "extendedModule": "A",
-                "typeKind": "struct"
-            },
-            "accessLevel": "public"
-        }
-        """, relationships: """
-        {
-            "kind": "memberOf",
-            "source": "s:EBFfunction",
-            "target": "s:EBF",
-            "targetFallback": "A.EBF"
-        }
-        """))
-        
-        let allGraphs = [mainGraph, emptyExtensionGraph, extensionBlockFormatExtensionGraph, noExtensionBlockFormatExtensionGraph]
-        
-        for graph in allGraphs {
-            try XCTUnwrap(graph.content.data(using: .utf8)).write(to: graph.url)
-        }
-        
-        let validUndetermined = [mainGraph, emptyExtensionGraph]
-        var loader = try makeSymbolGraphLoader(symbolGraphURLs: validUndetermined.map(\.url))
-        try loader.loadAll()
-        // by default, extension graphs should be associated with the extended graph
-        XCTAssertEqual(loader.unifiedGraphs.count, 2)
-        
-        let validEBF = [mainGraph, emptyExtensionGraph, extensionBlockFormatExtensionGraph]
-        loader = try makeSymbolGraphLoader(symbolGraphURLs: validEBF.map(\.url))
-        try loader.loadAll()
-        // found extension block symbols; extension graphs should be associated with the extending graph
-        XCTAssertEqual(loader.unifiedGraphs.count, 1)
-        
-        let validNEBF = [mainGraph, emptyExtensionGraph, noExtensionBlockFormatExtensionGraph]
-        loader = try makeSymbolGraphLoader(symbolGraphURLs: validNEBF.map(\.url))
-        try loader.loadAll()
-        // found no extension block symbols; extension graphs should be associated with the extended graph
-        XCTAssertEqual(loader.unifiedGraphs.count, 3)
-        
-        let invalid = allGraphs
-        loader = try makeSymbolGraphLoader(symbolGraphURLs: invalid.map(\.url))
-        // found non-empty extension graphs with and without extension block symbols -> should throw
-        XCTAssertThrowsError(try loader.loadAll(),
-                             "SymbolGraphLoader should throw when encountering a collection of symbol graph files, where some do and some don't use the extension block format") { error in
-            XCTAssertFalse(error.localizedDescription.contains(mainGraph.url.absoluteString))
-            XCTAssertFalse(error.localizedDescription.contains(emptyExtensionGraph.url.absoluteString))
-            XCTAssert(error.localizedDescription.contains("""
-            Symbol graph files with extension declarations:
-            \(extensionBlockFormatExtensionGraph.url.absoluteString)
-            """))
-            XCTAssert(error.localizedDescription.contains("""
-            Symbol graph files without extension declarations:
-            \(noExtensionBlockFormatExtensionGraph.url.absoluteString)
-            """))
-        }
-    }
 
     func testConfiguresSymbolGraphs() throws {
         let tempURL = try createTemporaryDirectory()