Fix nested top-level apps not being parsed properly (#136)

Author: rockbruno

Example/HelloWorld/BUILD

@@ -193,19 +193,21 @@ ios_application(
     families = ["iphone", "ipad"],
     infoplists = ["Resources/Info.plist"],
     minimum_os_version = IOS_MINIMUM_OS_VERSION,
+    watch_application = ":HelloWorldWatchApp",
     deps = [":HelloWorldLib"],
 )
 
 watchos_application(
     name = "HelloWorldWatchApp",
     bundle_id = "com.example.HelloWorld.Watch",
-    extensions = [":HelloWorldWatchExtension"],
+    extension = ":HelloWorldWatchExtension",
     infoplists = ["Resources/WatchApp-Info.plist"],
     minimum_os_version = WATCHOS_MINIMUM_OS_VERSION,
 )
 
 watchos_extension(
     name = "HelloWorldWatchExtension",
+    application_extension = True,
     bundle_id = "com.example.HelloWorld.Watch.extension",
     infoplists = ["Resources/WatchExt-Info.plist"],
     minimum_os_version = WATCHOS_MINIMUM_OS_VERSION,

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetGraphReport.swift

@@ -26,17 +26,23 @@ struct BazelTargetGraphReport: Codable, Equatable {
     struct TopLevelTarget: Codable, Equatable {
         let label: String
         let ruleType: String
-        let platform: String
-        let minimumOsVersion: String
-        let cpuArch: String
         let isTest: Bool
+        let configId: UInt32
     }
 
     struct DependencyTarget: Codable, Equatable {
         let label: String
-        let parents: [String]
+        let configId: UInt32
+    }
+
+    struct Configuration: Codable, Equatable {
+        let id: UInt32
+        let platform: String
+        let minimumOsVersion: String
+        let cpuArch: String
     }
 
     let topLevelTargets: [TopLevelTarget]
     let dependencyTargets: [DependencyTarget]
+    let configurations: [Configuration]
 }

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetQuerier.swift

@@ -94,9 +94,7 @@ final class BazelTargetQuerier {
         dependencyKindsFilter.append(contentsOf: testBundleRules)
 
         let topLevelKindsFilter = supportedTopLevelRuleTypes.map { $0.rawValue }
-
-        // Collect the top-level targets -> collect these targets' dependencies
-        let providedTargetsQuerySet = "set(\(userProvidedTargets.joined(separator: " ")))"
+        let topLevelDepsFilter = Self.queryDepsString(forTargets: userProvidedTargets)
 
         // Build exclusion clauses if filters are provided
         let topLevelExclusions = config.baseConfig.topLevelTargetsToExclude
@@ -110,7 +108,7 @@ final class BazelTargetQuerier {
             ? "" : " except set(\(dependencyExclusions.joined(separator: " ")))"
 
         let topLevelTargetsQuery = """
-            let topLevelTargets = kind("\(topLevelKindsFilter.joined(separator: "|"))", \(providedTargetsQuerySet))\(topLevelExceptClause) in \
+            let topLevelTargets = kind("\(topLevelKindsFilter.joined(separator: "|"))", \(topLevelDepsFilter))\(topLevelExceptClause) in \
               $topLevelTargets \
               union \
               (kind("\(dependencyKindsFilter.joined(separator: "|"))", deps($topLevelTargets))\(dependencyExceptClause))

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetQuerierParser.swift

@@ -45,6 +45,8 @@ enum BazelTargetStoreError: Error, LocalizedError {
     case unableToMapBazelLabelToParents(String)
     case unableToMapBazelLabelToTopLevelRuleType(String)
     case unableToMapBazelLabelToTopLevelConfig(String)
+    case unableToMapBazelLabelToParentConfig(String)
+    case unableToMapConfigToTopLevelLabels(UInt32)
     case noCachedAquery
 
     var errorDescription: String? {
@@ -57,6 +59,10 @@ enum BazelTargetStoreError: Error, LocalizedError {
             return "Unable to map '\(label)' to its top-level rule type"
         case .unableToMapBazelLabelToTopLevelConfig(let label):
             return "Unable to map '\(label)' to its top-level configuration"
+        case .unableToMapBazelLabelToParentConfig(let label):
+            return "Unable to map '\(label)' to its parent configuration"
+        case .unableToMapConfigToTopLevelLabels(let config):
+            return "Unable to map configuration '\(config)' to its top-level labels"
         case .noCachedAquery:
             return "No cached aquery result found in the store."
         }
@@ -126,14 +132,6 @@ final class BazelTargetStoreImpl: BazelTargetStore, @unchecked Sendable {
         return bspURIs
     }
 
-    /// Retrieves the list of top-level apps that a given Bazel target label belongs to.
-    func bazelLabelToParents(forBazelLabel label: String) throws -> [String] {
-        guard let parents = cqueryResult?.bazelLabelToParentsMap[label] else {
-            throw BazelTargetStoreError.unableToMapBazelLabelToParents(label)
-        }
-        return parents
-    }
-
     /// Retrieves the top-level rule type for a given Bazel **top-level** target label.
     func topLevelRuleType(forBazelLabel label: String) throws -> TopLevelRuleType {
         guard let ruleType = cqueryResult?.topLevelLabelToRuleMap[label] else {
@@ -150,20 +148,33 @@ final class BazelTargetStoreImpl: BazelTargetStore, @unchecked Sendable {
         return config
     }
 
+    /// Retrieves the configuration for a given Bazel target label.
+    func parentConfig(forBazelLabel label: String) throws -> UInt32 {
+        guard let config = cqueryResult?.bazelLabelToParentConfigMap[label] else {
+            throw BazelTargetStoreError.unableToMapBazelLabelToParentConfig(label)
+        }
+        return config
+    }
+
+    /// Retrieves the list of top-level labels for a given configuration.
+    func topLevelLabels(forConfig config: UInt32) throws -> [String] {
+        guard let labels = cqueryResult?.configurationToTopLevelLabelsMap[config] else {
+            throw BazelTargetStoreError.unableToMapConfigToTopLevelLabels(config)
+        }
+        return labels
+    }
+
     /// Provides the bazel label containing **platform information** for a given BSP URI.
     /// This is used to determine the correct set of compiler flags for the target / platform combo.
     func platformBuildLabelInfo(forBSPURI uri: URI) throws -> BazelTargetPlatformInfo {
         let bazelLabel = try bazelTargetLabel(forBSPURI: uri)
-        let parents = try bazelLabelToParents(forBazelLabel: bazelLabel)
+        let configId = try parentConfig(forBazelLabel: bazelLabel)
+        let parents = try topLevelLabels(forConfig: configId)
         // FIXME: When a target can compile to multiple platforms, the way Xcode handles it is by selecting
         // the one matching your selected simulator in the IDE. We don't have any sort of special IDE integration
         // at the moment, so for now we just select the first parent.
+        // We are also not processing the different variants at all (see FIXME in BazelTargetQuerierParser.swift).
         let parentToUse = parents[0]
-        if parents.count > 1 {
-            logger.warning(
-                "Target \(uri.description, privacy: .public) has multiple top-level parents; will pick the first one: \(parentToUse, privacy: .public)"
-            )
-        }
         let rule = try topLevelRuleType(forBazelLabel: parentToUse)
         let config = try topLevelConfigInfo(forBazelLabel: parentToUse)
         return BazelTargetPlatformInfo(
@@ -220,7 +231,7 @@ final class BazelTargetStoreImpl: BazelTargetStore, @unchecked Sendable {
 
         reportQueue.async { [weak self] in
             guard let self = self else { return }
-            let outputPath = self.initializedConfig.outputPath
+            let outputPath: String = self.initializedConfig.outputPath
             let fileName = "sourcekit-bazel-bsp-graph.json"
             self.writeReport(toPath: outputPath + "/" + fileName)
         }
@@ -253,29 +264,38 @@ extension BazelTargetStoreImpl {
     private func generateGraphReport() throws -> BazelTargetGraphReport {
         logger.info("Generating graph report")
         var reportTopLevel: [BazelTargetGraphReport.TopLevelTarget] = []
+        var reportConfigurations: [UInt32: BazelTargetGraphReport.Configuration] = [:]
         let topLevelTargets = cqueryResult?.topLevelTargets ?? []
         for (label, ruleType) in topLevelTargets {
             let topLevelConfig = try topLevelConfigInfo(forBazelLabel: label)
+            let configId = try parentConfig(forBazelLabel: label)
             reportTopLevel.append(
                 .init(
                     label: label,
                     ruleType: ruleType.rawValue,
+                    isTest: ruleType.testBundleRule != nil,
+                    configId: configId
+                )
+            )
+            reportConfigurations[configId] = .init(
+                .init(
+                    id: configId,
                     platform: topLevelConfig.platform,
                     minimumOsVersion: topLevelConfig.minimumOsVersion,
-                    cpuArch: topLevelConfig.cpuArch,
-                    isTest: ruleType.testBundleRule != nil
+                    cpuArch: topLevelConfig.cpuArch
                 )
             )
         }
         var reportDependencies: [BazelTargetGraphReport.DependencyTarget] = []
         let dependencyTargets = cqueryResult?.buildTargets.compactMap { $0.displayName } ?? []
         for label in dependencyTargets {
-            let parents = try bazelLabelToParents(forBazelLabel: label)
-            reportDependencies.append(.init(label: label, parents: parents))
+            let configId = try parentConfig(forBazelLabel: label)
+            reportDependencies.append(.init(label: label, configId: configId))
         }
         return BazelTargetGraphReport(
             topLevelTargets: reportTopLevel,
-            dependencyTargets: reportDependencies
+            dependencyTargets: reportDependencies,
+            configurations: reportConfigurations.values.sorted(by: { $0.id < $1.id })
         )
     }
 }

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetStore.swift

@@ -57,12 +57,6 @@ final class BuildTargetsHandler {
                     reply(.success(WorkspaceBuildTargetsResponse(targets: [])))
                 }
                 let result = try targetStore.fetchTargets()
-                logger.debug("Found \(result.count, privacy: .public) targets")
-                logger.logFullObjectInMultipleLogMessages(
-                    level: .debug,
-                    header: "Target list",
-                    result.map { $0.id.uri.stringValue }.joined(separator: ", "),
-                )
                 return result
             }
             connection?.finishTask(id: taskId, status: .ok)

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BuildTargetsHandler.swift

@@ -30,5 +30,6 @@ struct ProcessedCqueryResult {
     let bspURIsToSrcsMap: [URI: SourcesItem]
     let srcToBspURIsMap: [URI: [URI]]
     let topLevelLabelToRuleMap: [String: TopLevelRuleType]
-    let bazelLabelToParentsMap: [String: [String]]
+    let configurationToTopLevelLabelsMap: [UInt32: [String]]
+    let bazelLabelToParentConfigMap: [String: UInt32]
 }

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/ProcessedCqueryResult.swift

@@ -50,6 +50,8 @@ public enum TopLevelRuleType: String, CaseIterable, ExpressibleByArgument, Senda
     case visionosUiTest = "visionos_ui_test"
     case visionosBuildTest = "visionos_build_test"
 
+    /// The suffix that is added to the test rule name to get the bundle target name.
+    /// e.g. HelloWorldTests -> HelloWorldTests.__internal__.__test_bundle
     static var testBundleRuleSuffix: String {
         return ".__internal__.__test_bundle"
     }

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/TopLevelRuleType.swift

@@ -321,6 +321,12 @@ extension BazelTargetCompilerArgsExtractor {
                 continue
             }
 
+            // Indexing doesn't seem to like this attribute
+            if arg == "-Xfrontend" && arg == "-const-gather-protocols-file" {
+                index += 4
+                continue
+            }
+
             // Skip -emit-const-values-path for now, this causes permission issues in bazel-out
             if arg == "-emit-const-values-path" {
                 index += 2

Sources/SourceKitBazelBSP/RequestHandlers/SKOptions/BazelTargetCompilerArgsExtractor.swift

@@ -26,20 +26,12 @@ import Testing
 struct BazelProtobufBindingsTests {
     @Test("parses action graph from aquery protobuf output")
     func testBazelProtobuf_readBinaryData() throws {
-        guard let url = Bundle.module.url(forResource: "actions", withExtension: "pb") else {
-            Issue.record("actions.pb is not found in Resouces.")
-            return
-        }
-
-        guard let data = try? Data(contentsOf: url) else {
-            Issue.record("Fail to read actions.pb at url: \(url.path())")
-            return
-        }
-
-        guard let actionGraph = try? BazelProtobufBindings.parseActionGraph(data: data) else {
-            Issue.record("Fail to parse actions.pb")
-            return
-        }
+        let url = try #require(
+            Bundle.module.url(forResource: "actions", withExtension: "pb"),
+            "actions.pb is not found in Resources."
+        )
+        let data = try Data(contentsOf: url)
+        let actionGraph = try BazelProtobufBindings.parseActionGraph(data: data)
 
         let expected = [
             "//HelloWorld:HelloWorldLib",
@@ -55,23 +47,15 @@ struct BazelProtobufBindingsTests {
 
     @Test("testing compiler flags from action graph")
     func testBazelProtobuf_compilerArguments() throws {
-        guard let url = Bundle.module.url(forResource: "actions", withExtension: "pb") else {
-            Issue.record("actions.pb is not found in Resouces.")
-            return
-        }
-
-        guard let data = try? Data(contentsOf: url) else {
-            Issue.record("Fail to read actions.pb at url: \(url.path())")
-            return
-        }
-
-        guard let actionGraph = try? BazelProtobufBindings.parseActionGraph(data: data) else {
-            Issue.record("Fail to parse actions.pb")
-            return
-        }
+        let url = try #require(
+            Bundle.module.url(forResource: "actions", withExtension: "pb"),
+            "actions.pb is not found in Resources."
+        )
+        let data = try Data(contentsOf: url)
+        let actionGraph = try BazelProtobufBindings.parseActionGraph(data: data)
 
         // //HelloWorld:TodoModels -> targetID: 1
-        guard let action = actionGraph.actions.first(where: { $0.targetID == 1 }) else { return }
+        let action = try #require(actionGraph.actions.first(where: { $0.targetID == 1 }))
 
         let actual = action.arguments
         let expected = [