Write a JSON report after parsing targets (#133)

Author: rockbruno

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetGraphReport.swift

@@ -0,0 +1,42 @@
+// Copyright (c) 2025 Spotify AB.
+//
+// Licensed to the Apache Software Foundation (ASF) under one
+// or more contributor license agreements.  See the NOTICE file
+// distributed with this work for additional information
+// regarding copyright ownership.  The ASF licenses this file
+// to you under the Apache License, Version 2.0 (the
+// "License"); you may not use this file except in compliance
+// with the License.  You may obtain a copy of the License at
+//
+// http://www.apache.org/licenses/LICENSE-2.0
+//
+// Unless required by applicable law or agreed to in writing,
+// software distributed under the License is distributed on an
+// "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+// KIND, either express or implied.  See the License for the
+// specific language governing permissions and limitations
+// under the License.
+
+import Foundation
+
+/// A report containing all parsed targets from the build graph.
+/// Written as JSON after buildTargets completes.
+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
+    }
+
+    struct DependencyTarget: Codable, Equatable {
+        let label: String
+        let parents: [String]
+    }
+
+    let topLevelTargets: [TopLevelTarget]
+    let dependencyTargets: [DependencyTarget]
+}

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetQuerierParser.swift

@@ -165,6 +165,8 @@ final class BazelTargetQuerierParserImpl: BazelTargetQuerierParser {
             throw BazelTargetQuerierParserError.noTopLevelTargets(supportedTopLevelRuleTypes)
         }
 
+        logger.logFullObjectInMultipleLogMessages(level: .info, header: "Top-level targets", String(topLevelTargets.map { $0.0.rule.name }.joined(separator: ", ")))
+
         // Start by pre-processing all of the provided source files into a map for quick lookup.
         var srcToUriMap: [String: URI] = [:]
         for target in allSrcs {
@@ -320,7 +322,6 @@ final class BazelTargetQuerierParserImpl: BazelTargetQuerierParser {
         var bspURIsToBazelLabelsMap: [URI: String] = [:]
         var bspURIsToSrcsMap: [URI: SourcesItem] = [:]
         var srcToBspURIsMap: [URI: [URI]] = [:]
-        var availableBazelLabels: Set<String> = []
         var topLevelLabelToRuleMap: [String: TopLevelRuleType] = [:]
         for dependencyTargetInfo in buildTargets {
             let target = dependencyTargetInfo.value.0
@@ -332,7 +333,6 @@ final class BazelTargetQuerierParserImpl: BazelTargetQuerierParser {
             let uri = target.id.uri
             bspURIsToBazelLabelsMap[uri] = displayName
             bspURIsToSrcsMap[uri] = sourcesItem
-            availableBazelLabels.insert(displayName)
             for src in sourcesItem.sources {
                 srcToBspURIsMap[src.uri, default: []].append(uri)
             }
@@ -348,7 +348,6 @@ final class BazelTargetQuerierParserImpl: BazelTargetQuerierParser {
             bspURIsToBazelLabelsMap: bspURIsToBazelLabelsMap,
             bspURIsToSrcsMap: bspURIsToSrcsMap,
             srcToBspURIsMap: srcToBspURIsMap,
-            availableBazelLabels: availableBazelLabels,
             topLevelLabelToRuleMap: topLevelLabelToRuleMap,
             bazelLabelToParentsMap: bazelLabelToParentsMap
         )

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetStore.swift

@@ -77,6 +77,7 @@ final class BazelTargetStoreImpl: BazelTargetStore, @unchecked Sendable {
     private let supportedDependencyRuleTypes: [DependencyRuleType]
     private let compileMnemonicsToFilter: [String]
     private let topLevelMnemonicsToFilter: [String]
+    private let reportQueue = DispatchQueue(label: "com.spotify.sourcekit-bazel-bsp.bazel-target-store.report-queue")
 
     private var cachedTargets: [BuildTarget]? = nil
     private var aqueryResult: ProcessedAqueryResult? = nil
@@ -217,6 +218,13 @@ final class BazelTargetStoreImpl: BazelTargetStore, @unchecked Sendable {
         let result = cqueryResult.buildTargets
         cachedTargets = result
 
+        reportQueue.async { [weak self] in
+            guard let self = self else { return }
+            let outputPath = self.initializedConfig.outputPath
+            let fileName = "sourcekit-bazel-bsp-graph.json"
+            self.writeReport(toPath: outputPath + "/" + fileName)
+        }
+
         return result
     }
 
@@ -227,3 +235,47 @@ final class BazelTargetStoreImpl: BazelTargetStore, @unchecked Sendable {
         cqueryResult = nil
     }
 }
+
+extension BazelTargetStoreImpl {
+    private func writeReport(toPath path: String) {
+        let encoder = JSONEncoder()
+        encoder.outputFormatting = .prettyPrinted
+        do {
+            let report = try generateGraphReport()
+            let json = try encoder.encode(report)
+            try json.write(to: URL(fileURLWithPath: path), options: .atomic)
+            logger.info("Graph report written to \(path, privacy: .public)")
+        } catch {
+            logger.error("Failed to write graph report: \(error.localizedDescription, privacy: .public)")
+        }
+    }
+
+    private func generateGraphReport() throws -> BazelTargetGraphReport {
+        logger.info("Generating graph report")
+        var reportTopLevel: [BazelTargetGraphReport.TopLevelTarget] = []
+        let topLevelTargets = cqueryResult?.topLevelTargets ?? []
+        for (label, ruleType) in topLevelTargets {
+            let topLevelConfig = try topLevelConfigInfo(forBazelLabel: label)
+            reportTopLevel.append(
+                .init(
+                    label: label,
+                    ruleType: ruleType.rawValue,
+                    platform: topLevelConfig.platform,
+                    minimumOsVersion: topLevelConfig.minimumOsVersion,
+                    cpuArch: topLevelConfig.cpuArch,
+                    isTest: ruleType.testBundleRule != nil
+                )
+            )
+        }
+        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))
+        }
+        return BazelTargetGraphReport(
+            topLevelTargets: reportTopLevel,
+            dependencyTargets: reportDependencies
+        )
+    }
+}

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/ProcessedCqueryResult.swift

@@ -29,7 +29,6 @@ struct ProcessedCqueryResult {
     let bspURIsToBazelLabelsMap: [URI: String]
     let bspURIsToSrcsMap: [URI: SourcesItem]
     let srcToBspURIsMap: [URI: [URI]]
-    let availableBazelLabels: Set<String>
     let topLevelLabelToRuleMap: [String: TopLevelRuleType]
     let bazelLabelToParentsMap: [String: [String]]
 }

Tests/SourceKitBazelBSPTests/BazelTargetQuerierParserImplTests.swift

@@ -154,24 +154,6 @@ struct BazelTargetQuerierParserImplTests {
             #expect(result.topLevelTargets[index] == expected)
         }
 
-        // Available Bazel labels
-        #expect(
-            result.availableBazelLabels
-                == Set([
-                    "//HelloWorld:ExpandedTemplate",
-                    "//HelloWorld:GeneratedDummy",
-                    "//HelloWorld:HelloWorldLib",
-                    "//HelloWorld:HelloWorldTestsLib",
-                    "//HelloWorld:MacAppLib",
-                    "//HelloWorld:MacAppTestsLib",
-                    "//HelloWorld:MacCLIAppLib",
-                    "//HelloWorld:TodoModels",
-                    "//HelloWorld:TodoObjCSupport",
-                    "//HelloWorld:WatchAppLib",
-                    "//HelloWorld:WatchAppTestsLib",
-                ])
-        )
-
         // Top level label to rule map
         let expectedTopLevelLabelToRuleMap: [String: TopLevelRuleType] = [
             "//HelloWorld:HelloWorld": .iosApplication,

Tests/SourceKitBazelBSPTests/BazelTargetQuerierTests.swift

@@ -33,7 +33,6 @@ struct BazelTargetQuerierTests {
         bspURIsToBazelLabelsMap: [:],
         bspURIsToSrcsMap: [:],
         srcToBspURIsMap: [:],
-        availableBazelLabels: [],
         topLevelLabelToRuleMap: [:],
         bazelLabelToParentsMap: [:]
     )