feat: support depending on bzlmod deps that use rules_swift_package_manager

luispadron · luispadron · commit 4df4c1b33e7e · 2025-11-10T21:35:13.000-05:00
Fixes #769
diff --git a/examples/multiple_rules_spm_example/.bazelrc b/examples/multiple_rules_spm_example/.bazelrc
@@ -0,0 +1,8 @@
+# Import Shared settings
+import %workspace%/../../shared.bazelrc
+
+# Import CI settings.
+import %workspace%/../../ci.bazelrc
+
+# Try to import a local.rc file; typically, written by CI
+try-import %workspace%/../../local.bazelrc
diff --git a/examples/multiple_rules_spm_example/BUILD.bazel b/examples/multiple_rules_spm_example/BUILD.bazel
@@ -0,0 +1,17 @@
+load("@build_bazel_rules_apple//apple:macos.bzl", "macos_build_test")
+load("@build_bazel_rules_swift//swift:swift_binary.bzl", "swift_binary")
+
+swift_binary(
+    name = "multiple_rules_spm_example",
+    srcs = ["main.swift"],
+    deps = [
+        "@swiftpkg_vapor//:Vapor",
+        "@vapor_example//Sources/App"
+    ],
+)
+
+macos_build_test(
+    name = "multiple_rules_spm_example_build_test",
+    minimum_os_version = "13.0",
+    targets = [":multiple_rules_spm_example"],
+)
diff --git a/examples/multiple_rules_spm_example/MODULE.bazel b/examples/multiple_rules_spm_example/MODULE.bazel
@@ -0,0 +1,55 @@
+bazel_dep(
+    name = "rules_swift_package_manager",
+    version = "0.0.0",
+)
+local_path_override(
+    module_name = "rules_swift_package_manager",
+    path = "../..",
+)
+
+bazel_dep(name = "cgrindel_bazel_starlib", version = "0.27.0")
+bazel_dep(name = "bazel_skylib", version = "1.8.2")
+bazel_dep(name = "apple_support", version = "1.24.4")
+bazel_dep(
+    name = "rules_swift",
+    version = "3.2.0",
+    repo_name = "build_bazel_rules_swift",
+)
+bazel_dep(
+    name = "rules_apple",
+    version = "4.2.0",
+    repo_name = "build_bazel_rules_apple",
+)
+
+bazel_dep(
+    name = "bazel_skylib_gazelle_plugin",
+    version = "1.8.2",
+    dev_dependency = True,
+)
+
+swift_deps = use_extension(
+    "@rules_swift_package_manager//:extensions.bzl",
+    "swift_deps",
+)
+swift_deps.from_package(
+    resolved = "//:Package.resolved",
+    swift = "//:Package.swift",
+)
+use_repo(
+    swift_deps,
+    "swift_package",
+    "swiftpkg_fluent",
+    "swiftpkg_fluent_sqlite_driver",
+    "swiftpkg_swift_log",
+    "swiftpkg_vapor",
+)
+
+# Depend on another repository via Bzlmod that uses `rules_swift_package_manager` to declare its dependencies
+bazel_dep(
+    name = "vapor_example",
+    version = "0.0.0",
+)
+local_path_override(
+    module_name = "vapor_example",
+    path = "../vapor_example",
+)
diff --git a/examples/multiple_rules_spm_example/Package.resolved b/examples/multiple_rules_spm_example/Package.resolved
diff --git a/examples/multiple_rules_spm_example/Package.swift b/examples/multiple_rules_spm_example/Package.swift
@@ -0,0 +1,10 @@
+// swift-tools-version: 5.7
+
+import PackageDescription
+
+let package = Package(
+    name: "multiple_rules_spm_example",
+    dependencies: [
+        .package(url: "https://github.com/apple/swift-log", from: "1.5.2"),
+    ]
+)
diff --git a/examples/multiple_rules_spm_example/README.md b/examples/multiple_rules_spm_example/README.md
@@ -0,0 +1,3 @@
+# multiple_rules_spm Example
+
+This example demonstrates how one repository: `multiple_rules_spm` can depend on another repository: `vapor_example` via Bzlmod without issues.
diff --git a/examples/multiple_rules_spm_example/WORKSPACE b/examples/multiple_rules_spm_example/WORKSPACE
@@ -0,0 +1 @@
+# Intentionally blank: Using bzlmod
diff --git a/examples/multiple_rules_spm_example/WORKSPACE.bzlmod b/examples/multiple_rules_spm_example/WORKSPACE.bzlmod
@@ -0,0 +1 @@
+# Intentionally blank: Force bzlmod to strict mode
diff --git a/examples/multiple_rules_spm_example/do_test b/examples/multiple_rules_spm_example/do_test
@@ -0,0 +1,10 @@
+#!/usr/bin/env bash
+
+set -o errexit -o nounset -o pipefail
+
+# Use the Bazel binary specified by the integration test. Otherise, fall back
+# to bazel.
+bazel="${BIT_BAZEL_BINARY:-bazel}"
+
+# Ensure that it builds and tests pass
+"${bazel}" test //...
diff --git a/examples/multiple_rules_spm_example/main.swift b/examples/multiple_rules_spm_example/main.swift
@@ -0,0 +1,9 @@
+import App
+import Vapor
+
+var env = try Environment.detect()
+try LoggingSystem.bootstrap(from: &env)
+let app = Application(env)
+defer { app.shutdown() }
+try configure(app)
+try app.run()
diff --git a/examples/vapor_example/MODULE.bazel b/examples/vapor_example/MODULE.bazel
@@ -1,3 +1,7 @@
+module(
+    name = "vapor_example",
+)
+
 bazel_dep(
     name = "rules_swift_package_manager",
     version = "0.0.0",
@@ -52,14 +56,17 @@ swift_deps = use_extension(
     "swift_deps",
 )
 swift_deps.from_package(
-    declare_swift_deps_info = True,
+    # TODO: Fix before merging, these need to be disabled as they get generated
+    # more than once if consumed as a bzlmod dependency.
+    # We neeed to re-design how the swift_packge and swift_deps_info repositories are
+    # generated so that they are marked as dev dependencies and not root module dependencies.
+    declare_swift_deps_info = False,
+    declare_swift_package = False,
     resolved = "//swift:Package.resolved",
     swift = "//swift:Package.swift",
 )
 use_repo(
     swift_deps,
-    "swift_deps_info",
-    "swift_package",
     "swiftpkg_fluent",
     "swiftpkg_fluent_sqlite_driver",
     "swiftpkg_vapor",
diff --git a/swiftpkg/bzlmod/swift_deps.bzl b/swiftpkg/bzlmod/swift_deps.bzl
@@ -15,14 +15,22 @@ load("//swiftpkg/internal:swift_package_tool_repo.bzl", "swift_package_tool_repo
 
 _DO_WHILE_RANGE = range(1000)
 
-def _declare_pkgs_from_package(module_ctx, from_package, config_pkgs, config_swift_package):
+def _declare_pkgs_from_package(
+    module_ctx,
+    from_package,
+    config_pkgs,
+    config_swift_package,
+    is_root,
+    existing_package_repo_names):
     """Declare Swift packages from `Package.swift` and `Package.resolved`.
 
     Args:
         module_ctx: An instance of `module_ctx`.
         from_package: The data from the `from_package` tag.
         config_pkgs: The data from the `configure_package` tag.
         config_swift_package: The data from the `configure_swift_package` tag.
+        is_root: Whether the module is the root Bzlmod module.
+        existing_package_repo_names: The list of existing package repository names.
     """
 
     # Read Package.resolved.
@@ -95,20 +103,25 @@ the Swift package to make it available.\
             continue
 
         bazel_repo_name = bazel_repo_names.from_identity(dep.identity)
+
+        if bazel_repo_name in existing_package_repo_names:
+            print("\nWARNING: {bazel_repo_name} is declared by another module, preferring the first declared version.".format(bazel_repo_name = bazel_repo_name))
+            continue
+
         direct_dep_repo_names.append(bazel_repo_name)
         pkg_info_label = "@{}//:pkg_info.json".format(bazel_repo_name)
         direct_dep_pkg_infos[pkg_info_label] = dep.identity
 
     # Write info about the Swift deps that may be used by external tooling.
-    if from_package.declare_swift_deps_info:
+    if is_root and from_package.declare_swift_deps_info:
         swift_deps_info_repo_name = "swift_deps_info"
         swift_deps_info(
             name = swift_deps_info_repo_name,
             direct_dep_pkg_infos = direct_dep_pkg_infos,
         )
         direct_dep_repo_names.append(swift_deps_info_repo_name)
 
-    if from_package.declare_swift_package:
+    if is_root and from_package.declare_swift_package:
         swift_package_repo_name = "swift_package"
         _declare_swift_package_repo(
             name = swift_package_repo_name,
@@ -180,6 +193,11 @@ the Swift package to make it available.\
 
     # Declare the Bazel repositories.
     for dep in all_deps_by_id.values():
+        bazel_repo_name = bazel_repo_names.from_identity(dep.identity)
+        if bazel_repo_name in existing_package_repo_names:
+            print("\nWARNING: {bazel_repo_name} is declared by another module, preferring the first declared version.".format(bazel_repo_name = bazel_repo_name))
+            continue
+
         config_pkg = config_pkgs.get(dep.name)
         if config_pkg == None:
             config_pkg = config_pkgs.get(
@@ -317,8 +335,11 @@ Expected only one `configure_swift_package` tag, but found multiple.\
                     from_package,
                     config_pkgs,
                     config_swift_package,
+                    mod.is_root,
+                    direct_dep_repo_names,
                 ),
             )
+
     return module_ctx.extension_metadata(
         root_module_direct_deps = direct_dep_repo_names,
         root_module_direct_dev_deps = [],
@@ -332,6 +353,8 @@ _from_package_tag = tag_class(
                 doc = """\
 Declare a `swift_deps_info` repository that is used by external tooling (e.g. \
 Swift Gazelle plugin).\
+
+NOTE: This is only supported for the root module.
 """,
             ),
             "declare_swift_package": attr.bool(
@@ -350,6 +373,8 @@ They can be `bazel run` to update/resolve the `resolved` file:
 bazel run @swift_package//:update
 bazel run @swift_package//:resolve
 ```
+
+NOTE: This is only supported for the root module.
 """,
             ),
             "env": attr.string_dict(

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+# multiple_rules_spm Example`
	`2`	`+`
	`3`	+This example demonstrates how one repository: `multiple_rules_spm` can depend on another repository: `vapor_example` via Bzlmod without issues.
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+# Intentionally blank: Force bzlmod to strict mode`