Merge pull request #12 from kc-vl/bzlmod-reponame-fixes

tgodzik · web-flow · commit f0be4c652780 · 2025-06-16T15:52:08.000+02:00
fix: support both rules_scala and io_bazel_rules_scala repo names
diff --git a/.bazelrc b/.bazelrc
diff --git a/MODULE.bazel b/MODULE.bazel
@@ -196,13 +196,13 @@ bazel_binaries = use_extension(
 # test project are too old for bazel 7
 # bazel_binaries.download(version_file = "//:.bazelversion")
 bazel_binaries.download(version = "8.2.1")
-bazel_binaries.download(version = "7.4.0")
+bazel_binaries.download(version = "7.6.1")
 bazel_binaries.download(version = "6.4.0")
 use_repo(
     bazel_binaries,
     "bazel_binaries",
     "bazel_binaries_bazelisk",
     "build_bazel_bazel_6_4_0",
-    "build_bazel_bazel_7_4_0",
+    "build_bazel_bazel_7_6_1",
     "build_bazel_bazel_8_2_1",
 )
diff --git a/MODULE.bazel.lock b/MODULE.bazel.lock
diff --git a/server/aspects/rules/scala/scala_info.bzl.template b/server/aspects/rules/scala/scala_info.bzl.template
@@ -53,7 +53,7 @@ def extract_scala_info(target, ctx, output_groups, **kwargs):
     if not kind.startswith("scala_") and not kind.startswith("thrift_"):
         return None, None
 
-    SCALA_TOOLCHAIN = "@io_bazel_rules_scala//scala:toolchain_type"
+    SCALA_TOOLCHAIN = "@${rulesetName}//scala:toolchain_type"
 
     scala_info = {}
 
diff --git a/server/e2e/BUILD b/server/e2e/BUILD
@@ -150,6 +150,12 @@ bazel_integration_test_all_versions(
     test_runner = "//server/e2e/src/main/kotlin/org/jetbrains/bsp/bazel:NestedModulesTest",
 )
 
+bazel_integration_test_all_versions(
+    name = "rules_scala_bzlmod_test",
+    bzlmod_project_path = "test-projects/bzlmod/rules_scala",
+    test_runner = "//server/e2e/src/main/kotlin/org/jetbrains/bsp/bazel:RulesScalaBzlmodTest",
+)
+
 test_suite(
     name = "all_tests",
     tags = integration_test_utils.DEFAULT_INTEGRATION_TEST_TAGS,
@@ -170,6 +176,7 @@ test_suite(
         ":partial_sync_test",
         ":python_project_test",
         ":remote_jdk_test",
+        ":rules_scala_bzlmod_test",
         ":rust_project_test",
         ":sample_repo_test",
         ":server_downloads_bazelisk_test",
diff --git a/server/e2e/src/main/kotlin/org/jetbrains/bsp/bazel/BUILD b/server/e2e/src/main/kotlin/org/jetbrains/bsp/bazel/BUILD
@@ -266,3 +266,20 @@ kt_jvm_binary(
         "@maven//:io_kotest_kotest_common_jvm",
     ],
 )
+
+kt_jvm_binary(
+    name = "RulesScalaBzlmodTest",
+    srcs = ["RulesScalaBzlmodTest.kt"],
+    main_class = "org.jetbrains.bsp.bazel.RulesScalaBzlmodTest",
+    resources = ["//server/e2e/src/main/resources:bsp-e2e-resources"],
+    visibility = ["//server/e2e:__subpackages__"],
+    deps = [
+        "//server/commons",
+        "//server/e2e/src/main/kotlin/org/jetbrains/bsp/bazel/base",
+        "@maven//:ch_epfl_scala_bsp4j",
+        "@maven//:io_kotest_kotest_assertions_api_jvm",
+        "@maven//:io_kotest_kotest_assertions_core_jvm",
+        "@maven//:io_kotest_kotest_assertions_shared_jvm",
+        "@maven//:io_kotest_kotest_common_jvm",
+    ],
+)
diff --git a/server/e2e/src/main/kotlin/org/jetbrains/bsp/bazel/RulesScalaBzlmodTest.kt b/server/e2e/src/main/kotlin/org/jetbrains/bsp/bazel/RulesScalaBzlmodTest.kt
@@ -0,0 +1,75 @@
+package org.jetbrains.bsp.bazel
+
+import ch.epfl.scala.bsp4j.SourcesParams
+import ch.epfl.scala.bsp4j.WorkspaceBuildTargetsResult
+import io.kotest.matchers.collections.shouldContainExactlyInAnyOrder
+import io.kotest.matchers.shouldBe
+import kotlinx.coroutines.future.await
+import org.jetbrains.bazel.label.Label
+import org.jetbrains.bsp.bazel.base.BazelBspTestBaseScenario
+import org.jetbrains.bsp.bazel.base.BazelBspTestScenarioStep
+import org.jetbrains.bsp.bazel.install.Install
+import kotlin.io.path.Path
+import kotlin.io.path.relativeTo
+import kotlin.time.Duration.Companion.seconds
+
+object RulesScalaBzlmodTest : BazelBspTestBaseScenario() {
+  private val testClient = createBazelClient()
+
+  @JvmStatic
+  fun main(args: Array<String>) = executeScenario()
+
+  override fun installServer() {
+    Install.main(
+      arrayOf(
+        "-d",
+        workspaceDir,
+        "-b",
+        bazelBinary,
+        "-t",
+        "@//...",
+      ),
+    )
+  }
+
+  override fun scenarioSteps(): List<BazelBspTestScenarioStep> =
+    listOf(
+      compareWorkspaceTargetsResults(),
+    )
+
+  override fun expectedWorkspaceBuildTargetsResult(): WorkspaceBuildTargetsResult {
+    error("not needed")
+  }
+
+  private fun compareWorkspaceTargetsResults(): BazelBspTestScenarioStep =
+    BazelBspTestScenarioStep(
+      "compare workspace targets results",
+    ) {
+      testClient.test(60.seconds) { session, _ ->
+        val targetsResult = session.server.workspaceBuildTargets().await()
+
+        targetsResult.targets.size shouldBe 2
+        targetsResult.targets.map { Label.parse(it.id.uri) } shouldContainExactlyInAnyOrder
+          listOf(
+            Label.parse("@//:lib"),
+            Label.parse("@//:bin"),
+          )
+
+        val sourcesResult =
+          session.server
+            .buildTargetSources(
+              SourcesParams(targetsResult.targets.map { it.id }),
+            ).await()
+
+        sourcesResult.items.size shouldBe 2
+
+        sourcesResult.items
+          .flatMap {
+            it.sources
+          }.map { Path(it.uri.removePrefix("file:")).relativeTo(Path(workspaceDir)).toString() } shouldContainExactlyInAnyOrder
+          listOf(
+            "Main.scala",
+          )
+      }
+    }
+}
diff --git a/server/e2e/test-projects/bzlmod/rules_scala/.bazelrc b/server/e2e/test-projects/bzlmod/rules_scala/.bazelrc
@@ -0,0 +1,3 @@
+common --enable_bzlmod
+common --incompatible_use_plus_in_repo_names
+build --java_runtime_version=remotejdk_11
diff --git a/server/e2e/test-projects/bzlmod/rules_scala/BUILD.bazel b/server/e2e/test-projects/bzlmod/rules_scala/BUILD.bazel
@@ -0,0 +1,14 @@
+load("@rules_scala//scala:scala.bzl", "scala_library", "scala_binary")
+
+scala_library(
+    name = "lib",
+    srcs = [
+        "Main.scala",
+    ],
+)
+
+scala_binary(
+    name = "bin",
+    main_class = "main.Main",
+    deps = [":lib"],
+)
diff --git a/server/e2e/test-projects/bzlmod/rules_scala/MODULE.bazel b/server/e2e/test-projects/bzlmod/rules_scala/MODULE.bazel
@@ -0,0 +1,19 @@
+module(name = "rules_scala_full_bzlmod")
+
+bazel_dep(name = "rules_scala", version = "7.0.0")
+bazel_dep(name = "rules_python", version = "0.40.0")
+
+scala_config = use_extension(
+    "@rules_scala//scala/extensions:config.bzl",
+    "scala_config",
+)
+
+scala_config.settings(scala_version = "2.13.16")
+
+scala_deps = use_extension(
+    "@rules_scala//scala/extensions:deps.bzl",
+    "scala_deps",
+)
+scala_deps.settings(fetch_sources = False)
+scala_deps.scala()
+scala_deps.scalatest()
diff --git a/server/e2e/test-projects/bzlmod/rules_scala/Main.scala b/server/e2e/test-projects/bzlmod/rules_scala/Main.scala
@@ -0,0 +1,7 @@
+package main
+
+object Main {
+  def main(args: Array[String]): Unit = {
+    println("Hello, rules_scala bzlmod!")
+  }
+}
diff --git a/server/install/src/test/kotlin/org/jetbrains/bsp/bazel/install/EnvironmentCreatorTest.kt b/server/install/src/test/kotlin/org/jetbrains/bsp/bazel/install/EnvironmentCreatorTest.kt
@@ -44,7 +44,7 @@ class EnvironmentCreatorTest {
       dotBazelBsp.resolve("aspects/rules/jvm/jvm_info.bzl.template").exists() shouldBeEqual true
       dotBazelBsp.resolve("aspects/rules/kt/kt_info.bzl.template").exists() shouldBeEqual true
       dotBazelBsp.resolve("aspects/rules/python/python_info.bzl.template").exists() shouldBeEqual true
-      dotBazelBsp.resolve("aspects/rules/scala/scala_info.bzl").exists() shouldBeEqual true
+      dotBazelBsp.resolve("aspects/rules/scala/scala_info.bzl.template").exists() shouldBeEqual true
       dotBazelBsp.resolve("aspects/rules/cpp/cpp_info.bzl").exists() shouldBeEqual true
     }
   }
diff --git a/server/rules/bazel_integration_test/defs.bzl b/server/rules/bazel_integration_test/defs.bzl
@@ -20,7 +20,7 @@ def bazel_integration_test_all_versions(name, test_runner, project_path = None,
         )
 
     if bzlmod_project_path != None:
-        bzlmod_bazel_versions = ["7.4.0", "8.2.1"]
+        bzlmod_bazel_versions = ["7.6.1", "8.2.1"]
         bazel_versions += bzlmod_bazel_versions
 
         bazel_integration_tests(
diff --git a/server/server/src/main/kotlin/org/jetbrains/bsp/bazel/server/bsp/managers/BazelBspLanguageExtensionsGenerator.kt b/server/server/src/main/kotlin/org/jetbrains/bsp/bazel/server/bsp/managers/BazelBspLanguageExtensionsGenerator.kt
@@ -17,7 +17,7 @@ enum class Language(
 ) {
   Java("//aspects:rules/java/java_info.bzl", listOf("rules_java"), listOf("extract_java_toolchain", "extract_java_runtime"), true, true),
   Python("//aspects:rules/python/python_info.bzl", listOf("rules_python"), listOf("extract_python_info"), true, true),
-  Scala("//aspects:rules/scala/scala_info.bzl", listOf("io_bazel_rules_scala", "rules_scala"), listOf("extract_scala_info"), false, false),
+  Scala("//aspects:rules/scala/scala_info.bzl", listOf("io_bazel_rules_scala", "rules_scala"), listOf("extract_scala_info"), true, false),
   Cpp("//aspects:rules/cpp/cpp_info.bzl", listOf("rules_cc"), listOf("extract_cpp_info", "extract_c_toolchain_info"), false, false),
   Kotlin("//aspects:rules/kt/kt_info.bzl", listOf("io_bazel_rules_kotlin", "rules_kotlin"), listOf("extract_kotlin_info"), true, false),
   Jvm(
diff --git a/server/server/src/main/kotlin/org/jetbrains/bsp/bazel/server/bsp/managers/BazelExternalRulesetsQuery.kt b/server/server/src/main/kotlin/org/jetbrains/bsp/bazel/server/bsp/managers/BazelExternalRulesetsQuery.kt
@@ -8,6 +8,8 @@ import org.jetbrains.bazel.label.Label
 import org.jetbrains.bsp.bazel.bazelrunner.BazelProcessResult
 import org.jetbrains.bsp.bazel.bazelrunner.BazelRunner
 import org.jetbrains.bsp.bazel.logger.BspClientLogger
+import org.jetbrains.bsp.bazel.server.bzlmod.BzlmodRepoMapping
+import org.jetbrains.bsp.bazel.server.bzlmod.RepoMapping
 import org.jetbrains.bsp.bazel.server.bzlmod.rootRulesToNeededTransitiveRules
 import org.jetbrains.bsp.bazel.workspacecontext.EnabledRulesSpec
 import org.w3c.dom.Document
@@ -34,12 +36,18 @@ class BazelExternalRulesetsQueryImpl(
   private val isWorkspaceEnabled: Boolean,
   private val enabledRules: EnabledRulesSpec,
   private val bspClientLogger: BspClientLogger,
+  private val repoMapping: RepoMapping,
 ) : BazelExternalRulesetsQuery {
   override fun fetchExternalRulesetNames(cancelChecker: CancelChecker): List<String> =
     when {
       enabledRules.isNotEmpty() -> BazelEnabledRulesetsQueryImpl(enabledRules).fetchExternalRulesetNames(cancelChecker)
       else ->
-        BazelBzlModExternalRulesetsQueryImpl(bazelRunner, isBzlModEnabled, bspClientLogger).fetchExternalRulesetNames(cancelChecker) +
+        BazelBzlModExternalRulesetsQueryImpl(
+          bazelRunner,
+          isBzlModEnabled,
+          bspClientLogger,
+          repoMapping,
+        ).fetchExternalRulesetNames(cancelChecker) +
           BazelWorkspaceExternalRulesetsQueryImpl(
             bazelRunner,
             isWorkspaceEnabled,
@@ -109,6 +117,7 @@ class BazelBzlModExternalRulesetsQueryImpl(
   private val bazelRunner: BazelRunner,
   private val isBzlModEnabled: Boolean,
   private val bspClientLogger: BspClientLogger,
+  private val repoMapping: RepoMapping,
 ) : BazelExternalRulesetsQuery {
   private val gson = Gson()
 
@@ -118,6 +127,10 @@ class BazelBzlModExternalRulesetsQueryImpl(
       bazelRunner.buildBazelCommand {
         graph { options.add("--output=json") }
       }
+    val apparentRepoNameToCanonicalName =
+      (repoMapping as? BzlmodRepoMapping)?.apparentRepoNameToCanonicalName ?: emptyMap()
+    val canonicalNameToApparentRepoName =
+      apparentRepoNameToCanonicalName.entries.associateBy({ it.value }) { it.key }
     val bzlmodGraphJson =
       bazelRunner
         .runBazelCommand(command, logProcessOutput = false, serverPidFuture = null)
@@ -142,7 +155,13 @@ class BazelBzlModExternalRulesetsQueryImpl(
           .values
           .flatten()
 
-      return directDeps + indirectDeps
+      fun toApparentName(canonicalName: String) = canonicalNameToApparentRepoName.get(canonicalName)
+      val deps =
+        (directDeps + indirectDeps)
+          .map { toApparentName("$it~") ?: toApparentName("$it+") ?: it }
+          .distinct()
+
+      return deps
     } catch (e: Throwable) {
       log.warn("The returned bzlmod json is not parsable:\n$bzlmodGraphJson", e)
       emptyList()
diff --git a/server/server/src/main/kotlin/org/jetbrains/bsp/bazel/server/bsp/managers/BazelToolchainManager.kt b/server/server/src/main/kotlin/org/jetbrains/bsp/bazel/server/bsp/managers/BazelToolchainManager.kt
@@ -8,7 +8,7 @@ import org.jetbrains.bsp.protocol.FeatureFlags
 class BazelToolchainManager(private val bazelRunner: BazelRunner, private val featureFlags: FeatureFlags) {
   fun getToolchain(rulesetLanguage: RulesetLanguage, cancelChecker: CancelChecker): Label? =
     when (rulesetLanguage.language) {
-      Language.Scala -> Label.parse("@io_bazel_rules_scala//scala:toolchain_type")
+      Language.Scala -> Label.parse("@${rulesetLanguage.rulesetName}//scala:toolchain_type")
       Language.Java -> Label.parse("@bazel_tools//tools/jdk:runtime_toolchain_type")
       Language.Kotlin -> Label.parse("@${rulesetLanguage.rulesetName}//kotlin/internal:kt_toolchain_type")
       Language.Rust -> Label.parse("@${rulesetLanguage.rulesetName}//rust:toolchain_type")
diff --git a/server/server/src/main/kotlin/org/jetbrains/bsp/bazel/server/sync/ProjectResolver.kt b/server/server/src/main/kotlin/org/jetbrains/bsp/bazel/server/sync/ProjectResolver.kt
@@ -56,6 +56,10 @@ class ProjectResolver(
           "Reading project view and creating workspace context",
           workspaceContextProvider::currentWorkspaceContext,
         )
+      val repoMapping =
+        measured("Calculating external repository mapping") {
+          calculateRepoMapping(workspaceContext, bazelRunner, bazelInfo, bspClientLogger)
+        }
 
       val bazelExternalRulesetsQuery =
         BazelExternalRulesetsQueryImpl(
@@ -64,6 +68,7 @@ class ProjectResolver(
           bazelInfo.isWorkspaceEnabled,
           workspaceContext.enabledRules,
           bspClientLogger,
+          repoMapping,
         )
 
       val externalRulesetNames =
@@ -81,11 +86,6 @@ class ProjectResolver(
           "Mapping languages to toolchains",
         ) { ruleLanguages.associateWith { bazelToolchainManager.getToolchain(it, cancelChecker) } }
 
-      val repoMapping =
-        measured("Calculating external repository mapping") {
-          calculateRepoMapping(workspaceContext, bazelRunner, bazelInfo, bspClientLogger)
-        }
-
       measured("Realizing language aspect files from templates") {
         bazelBspAspectsManager.generateAspectsFromTemplates(ruleLanguages, workspaceContext, toolchains, bazelInfo.release, repoMapping)
       }
@@ -173,7 +173,7 @@ class ProjectResolver(
             outputGroups = outputGroups,
             shouldSyncManualFlags = workspaceContext.allowManualTargetsSync.value,
             isRustEnabled = featureFlags.isRustSupportEnabled,
-            shouldLogInvocation = false,
+            shouldLogInvocation = true,
           ).also {
             if (it.status == BazelStatus.OOM_ERROR) {
               bspClientLogger.warn(
@@ -223,7 +223,7 @@ class ProjectResolver(
                 outputGroups = outputGroups,
                 shouldSyncManualFlags = workspaceContext.allowManualTargetsSync.value,
                 isRustEnabled = featureFlags.isRustSupportEnabled,
-                shouldLogInvocation = false,
+                shouldLogInvocation = true,
               )
           if (result.isFailure) {
             bspClientLogger.warn("Failed to build $shardName")

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+common --enable_bzlmod`
	`2`	`+common --incompatible_use_plus_in_repo_names`
	`3`	`+build --java_runtime_version=remotejdk_11`