Allow the build test suffix to be further customized (#57)

* Allow the build test suffix to be further customized

* Allow the placeholder to be modified too

* Fix typo, use same Bazel version

* Make it optional to not break some environments

* Fix warnings

* Fix broken bzl file

Author: rockbruno

.bazelversion

@@ -1 +1 @@
-7.4.1
+8.3.1

Example/.bsp/config.json

@@ -29,6 +29,10 @@
 		"--index-flag",
 		"config=index_build",
 		"--files-to-watch",
-		"HelloWorld/**/*.swift,HelloWorld/**/*.m,HelloWorld/**/*.h"
+		"HelloWorld/**/*.swift,HelloWorld/**/*.m,HelloWorld/**/*.h",
+		"--build-test-suffix",
+		"_(PLAT)_skbsp",
+		"--build-test-platform-placeholder",
+		"(PLAT)"
 	]
 }

MODULE.bazel.lock

@@ -31,7 +31,7 @@
 
 - Make sure your Bazel project is using compatible versions of all iOS-related Bazel rulesets (available on each release's description) and is configured to generate Swift/Obj-C indexing data and debug symbols, either by default or under a specific config.
   - Detailed information around configuring Bazel flags is currently WIP, but you can currently check out the [example project](./Example) for an example.
-- Make sure all libraries that you'd like to use the BSP for have accompanying `(platform)_build_test` rules that directly targets them and have the `(lib_name)_{ios,watchos,tvos,macos,visionos}_skbsp` naming scheme.
+- Make sure all libraries that you'd like to use the BSP for have accompanying `(platform)_build_test` rules that directly targets them and have a predictable suffix that includes the platform name. Example naming scheme: `(lib_name)_{ios,watchos,tvos,macos,visionos}_skbsp`
   - This is because Bazel is currently missing a couple of important features we need in order to make this work in a clean way. This requirement is thus only temporary and you can expect it to be removed in the future as we evolve the tool and those missing features are introduced.
   - Keep in mind that our current focus are iOS targets, so as of writing your mileage may vary when it comes to other Apple platforms.
 - Download and install [the official Swift extension](https://marketplace.visualstudio.com/items?itemName=swiftlang.swift-vscode) for Cursor / VSCode.

README.md

@@ -129,8 +129,11 @@ final class BazelTargetStoreImpl: BazelTargetStore {
         // at the moment, so for now we just select the first parent.
         let parentToUse = parents[0]
         let rule = try topLevelRuleType(forBazelLabel: parentToUse)
+        let baseSuffix = initializedConfig.baseConfig.buildTestSuffix
+        let platformPlaceholder = initializedConfig.baseConfig.buildTestPlatformPlaceholder
+        let platformBuildSuffix = baseSuffix.replacingOccurrences(of: platformPlaceholder, with: rule.platform)
         return (
-            "\(bazelLabel)_\(rule.platform)\(initializedConfig.baseConfig.buildTestSuffix)",
+            "\(bazelLabel)\(platformBuildSuffix)",
             rule
         )
     }

Sources/SourceKitBazelBSP/RequestHandlers/BuildTargets/BazelTargetStore.swift

@@ -29,6 +29,7 @@ package struct BaseServerConfig: Equatable {
     let targets: [String]
     let indexFlags: [String]
     let buildTestSuffix: String
+    let buildTestPlatformPlaceholder: String
     let filesToWatch: String?
     let useSeparateOutputBaseForAquery: Bool
 
@@ -37,13 +38,15 @@ package struct BaseServerConfig: Equatable {
         targets: [String],
         indexFlags: [String],
         buildTestSuffix: String,
+        buildTestPlatformPlaceholder: String,
         filesToWatch: String?,
         useSeparateOutputBaseForAquery: Bool = false
     ) {
         self.bazelWrapper = bazelWrapper
         self.targets = targets
         self.indexFlags = indexFlags
         self.buildTestSuffix = buildTestSuffix
+        self.buildTestPlatformPlaceholder = buildTestPlatformPlaceholder
         self.filesToWatch = filesToWatch
         self.useSeparateOutputBaseForAquery = useSeparateOutputBaseForAquery
     }

Sources/SourceKitBazelBSP/Server/BaseServerConfig.swift

@@ -25,6 +25,8 @@ import SourceKitBazelBSP
 private let logger = makeFileLevelBSPLogger()
 
 struct Serve: ParsableCommand {
+    private static let defaultBuildTestPlatformPlaceholder = "(PLAT)"
+
     @Option(help: "The name of the Bazel CLI to invoke (e.g. 'bazelisk')")
     var bazelWrapper: String = "bazel"
 
@@ -44,9 +46,15 @@ struct Serve: ParsableCommand {
 
     @Option(
         help:
-            "The expected suffix for build_test targets."
+            "The expected suffix format for build_test targets. Use the value of `--build-test-platform-placeholder` as a platform placeholder.",
+    )
+    var buildTestSuffix: String = "_\(Self.defaultBuildTestPlatformPlaceholder)_skbsp"
+
+    @Option(
+        help:
+            "The expected platform placeholder for build_test targets.",
     )
-    var buildTestSuffix: String = "_skbsp"
+    var buildTestPlatformPlaceholder: String = Self.defaultBuildTestPlatformPlaceholder
 
     // FIXME: This should be enabled by default, but I ran into some weird race condition issues with rules_swift I'm not sure about.
     @Flag(
@@ -61,33 +69,33 @@ struct Serve: ParsableCommand {
     func run() throws {
         logger.info("`serve` invoked, initializing BSP server...")
 
-        // If the user provided no specific targets, try to discover them
-        // in the workspace.
         let targets: [String]
-        do {
-            targets = try {
-                if !target.isEmpty {
-                    return target
-                }
-                logger.warning(
-                    "No targets specified (--target)! Will now try to discover them. This can cause the BSP to perform poorly if we find too many targets. Prefer using --target explicitly if possible."
-                )
-                return try BazelTargetDiscoverer.discoverTargets(
+        if !target.isEmpty {
+            targets = target
+        } else {
+            // If the user provided no specific targets, try to discover them
+            // in the workspace.
+            logger.warning(
+                "No targets specified (--target)! Will now try to discover them. This can cause the BSP to perform poorly if we find too many targets. Prefer using --target explicitly if possible."
+            )
+            do {
+                targets = try BazelTargetDiscoverer.discoverTargets(
                     bazelWrapper: bazelWrapper
                 )
-            }()
-        } catch {
-            logger.error(
-                "Server startup failed due to target discovery error. Please check your Bazel configuration and try specifying targets explicitly with --target. \(error)"
-            )
-            throw error
+            } catch {
+                logger.error(
+                    "Failed to initialize server: Could not discover targets. Please check your Bazel configuration or try specifying targets explicitly with `--target` instead. Failure: \(error)"
+                )
+                throw error
+            }
         }
 
         let config = BaseServerConfig(
             bazelWrapper: bazelWrapper,
             targets: targets,
             indexFlags: indexFlag.map { "--" + $0 },
             buildTestSuffix: buildTestSuffix,
+            buildTestPlatformPlaceholder: buildTestPlatformPlaceholder,
             filesToWatch: filesToWatch,
             useSeparateOutputBaseForAquery: separateAqueryOutput
         )

Sources/sourcekit-bazel-bsp/Commands/Serve.swift

@@ -40,7 +40,8 @@ struct BazelTargetCompilerArgsExtractorTests {
                 bazelWrapper: "bazel",
                 targets: ["//HelloWorld"],
                 indexFlags: [],
-                buildTestSuffix: "_skbsp",
+                buildTestSuffix: "_(PLAT)_skbsp",
+                buildTestPlatformPlaceholder: "(PLAT)",
                 filesToWatch: nil
             ),
             rootUri: mockRootUri,

Tests/SourceKitBazelBSPTests/BazelTargetCompilerArgsExtractorTests.swift

@@ -32,7 +32,8 @@ struct BazelTargetParserTests {
             bazelWrapper: "bazel",
             targets: ["//HelloWorld:HelloWorld"],
             indexFlags: [],
-            buildTestSuffix: "_skbsp",
+            buildTestSuffix: "_(PLAT)_skbsp",
+            buildTestPlatformPlaceholder: "(PLAT)",
             filesToWatch: nil
         )
 

Tests/SourceKitBazelBSPTests/BazelTargetParserTests.swift

@@ -34,7 +34,8 @@ struct BazelTargetQuerierTests {
             bazelWrapper: "bazelisk",
             targets: ["//HelloWorld"],
             indexFlags: ["--config=test"],
-            buildTestSuffix: "_skbsp",
+            buildTestSuffix: "_(PLAT)_skbsp",
+            buildTestPlatformPlaceholder: "(PLAT)",
             filesToWatch: nil
         )
 
@@ -67,7 +68,8 @@ struct BazelTargetQuerierTests {
             bazelWrapper: "bazelisk",
             targets: ["//HelloWorld", "//Tests"],
             indexFlags: ["--config=test"],
-            buildTestSuffix: "_skbsp",
+            buildTestSuffix: "_(PLAT)_skbsp",
+            buildTestPlatformPlaceholder: "(PLAT)",
             filesToWatch: nil
         )
 
@@ -100,7 +102,8 @@ struct BazelTargetQuerierTests {
             bazelWrapper: "bazel",
             targets: ["//HelloWorld"],
             indexFlags: [],
-            buildTestSuffix: "_skbsp",
+            buildTestSuffix: "_(PLAT)_skbsp",
+            buildTestPlatformPlaceholder: "(PLAT)",
             filesToWatch: nil
         )
 
@@ -154,7 +157,8 @@ struct BazelTargetQuerierTests {
             bazelWrapper: "bazel",
             targets: ["//HelloWorld:HelloWorld"],
             indexFlags: [],
-            buildTestSuffix: "_skbsp",
+            buildTestSuffix: "_(PLAT)_skbsp",
+            buildTestPlatformPlaceholder: "(PLAT)",
             filesToWatch: nil
         )