Remove "conflict detection" for the hdrs attribute and the generated umbrella header to consistently allow users to override the umbrella header via public_hdrs or hdrs, where available.

nglevin · swiple-rules-gardener · commit 94c1a7fda77a · 2023-08-04T08:42:13.000-07:00
PiperOrigin-RevId: 553817824
diff --git a/apple/internal/partials/framework_header_modulemap.bzl b/apple/internal/partials/framework_header_modulemap.bzl
@@ -119,27 +119,20 @@ def _create_umbrella_header(actions, output, headers):
     content = "\n".join(import_lines) + "\n"
     actions.write(output = output, content = content)
 
-def _verify_headers(
+def _exported_headers(
         *,
         public_hdrs,
-        umbrella_header_name):
-    """Raises an error if a public header conflicts with the umbrella header.
+        generated_umbrella_header_file):
+    """Determines if the generated umbrella header needs to be an output of public headers.
 
     Args:
       public_hdrs: The list of headers to bundle.
-      umbrella_header_name: The basename of the umbrella header file, or None if
-          there is no umbrella header.
+      generated_umbrella_header_file: The generated umbrella header file.
     """
-    conflicting_headers = []
     for public_hdr in public_hdrs:
-        if public_hdr.basename == umbrella_header_name:
-            conflicting_headers.append(public_hdr.path)
-    if conflicting_headers:
-        fail(("Found imported header file(s) which conflict(s) with the name \"%s\" of the " +
-              "generated umbrella header for this target. Check input files:\n%s\n\nPlease " +
-              "remove the references to these files from your rule's list of headers to import " +
-              "or rename the headers if necessary.\n") %
-             (umbrella_header_name, ", ".join(conflicting_headers)))
+        if public_hdr.basename == generated_umbrella_header_file.basename:
+            return public_hdrs
+    return public_hdrs + [generated_umbrella_header_file]
 
 def _framework_header_modulemap_partial_impl(
         *,
@@ -182,13 +175,13 @@ def _framework_header_modulemap_partial_impl(
                 (processor.location.bundle, "Headers", depset(hdrs)),
             )
         else:
-            _verify_headers(
+            exported_hdrs = _exported_headers(
                 public_hdrs = hdrs,
-                umbrella_header_name = umbrella_header_name,
+                generated_umbrella_header_file = umbrella_header_file,
             )
 
             bundle_files.append(
-                (processor.location.bundle, "Headers", depset(hdrs + [umbrella_header_file])),
+                (processor.location.bundle, "Headers", depset(exported_hdrs)),
             )
     else:
         umbrella_header_name = None
@@ -227,7 +220,7 @@ def framework_header_modulemap_partial(
         output_discriminator = None,
         sdk_dylibs = [],
         sdk_frameworks = [],
-        umbrella_header):
+        umbrella_header = None):
     """Constructor for the framework headers and modulemaps partial.
 
     This partial bundles the headers and modulemaps for sdk frameworks.
@@ -243,7 +236,7 @@ def framework_header_modulemap_partial(
           or `None`.
       sdk_dylibs: A list of dynamic libraries referenced by this framework.
       sdk_frameworks: A list of frameworks referenced by this framework.
-      umbrella_header: An umbrella header to use instead of generating one
+      umbrella_header: An umbrella header to use instead of generating one. Optional.
 
     Returns:
       A partial that returns the bundle location of the sdk framework header and modulemap
diff --git a/apple/internal/xcframework_rules.bzl b/apple/internal/xcframework_rules.bzl
@@ -668,7 +668,6 @@ def _apple_xcframework_impl(ctx):
                     hdrs = ctx.files.public_hdrs,
                     label_name = label.name,
                     output_discriminator = library_identifier,
-                    umbrella_header = None,
                 ),
             )
 
@@ -941,7 +940,6 @@ def _apple_static_xcframework_impl(ctx):
                 hdrs = ctx.files.public_hdrs,
                 label_name = label.name,
                 output_discriminator = library_identifier,
-                umbrella_header = None,
                 sdk_frameworks = sdk_frameworks,
                 sdk_dylibs = sdk_dylibs,
             ))
diff --git a/test/starlark_tests/apple_xcframework_tests.bzl b/test/starlark_tests/apple_xcframework_tests.bzl
@@ -20,7 +20,6 @@ load(
 )
 load(
     "//test/starlark_tests/rules:analysis_failure_message_test.bzl",
-    "analysis_failure_message_test",
     "analysis_failure_message_with_tree_artifact_outputs_test",
 )
 load(
@@ -525,15 +524,6 @@ def apple_xcframework_test_suite(name):
         tags = [name],
     )
 
-    # Test that an actionable error is produced for the user when a header to
-    # bundle conflicts with the generated umbrella header.
-    analysis_failure_message_test(
-        name = "{}_umbrella_header_conflict_test".format(name),
-        target_under_test = "//test/starlark_tests/targets_under_test/apple:ios_dynamic_xcframework_with_umbrella_header_conflict",
-        expected_error = "Found imported header file(s) which conflict(s) with the name \"UmbrellaHeaderConflict.h\" of the generated umbrella header for this target. Check input files:\nthird_party/bazel_rules/rules_apple/test/starlark_tests/resources/UmbrellaHeaderConflict.h\n\nPlease remove the references to these files from your rule's list of headers to import or rename the headers if necessary.",
-        tags = [name],
-    )
-
     # Test tvOS XCFramework binaries contain Mach-O load commands for device or simulator.
     archive_contents_test(
         name = "{}_tvos_simulator_binary_contains_macho_load_cmd_test".format(name),
diff --git a/test/starlark_tests/ios_static_framework_tests.bzl b/test/starlark_tests/ios_static_framework_tests.bzl
@@ -18,10 +18,6 @@ load(
     ":common.bzl",
     "common",
 )
-load(
-    "//test/starlark_tests/rules:analysis_failure_message_test.bzl",
-    "analysis_failure_message_test",
-)
 load(
     "//test/starlark_tests/rules:common_verification_tests.bzl",
     "archive_contents_test",
@@ -149,15 +145,6 @@ def ios_static_framework_test_suite(name):
         tags = [name],
     )
 
-    # Test that an actionable error is produced for the user when a header to
-    # bundle conflicts with the generated umbrella header.
-    analysis_failure_message_test(
-        name = "{}_umbrella_header_conflict_test".format(name),
-        target_under_test = "//test/starlark_tests/targets_under_test/ios:static_framework_with_umbrella_header_conflict",
-        expected_error = "Found imported header file(s) which conflict(s) with the name \"UmbrellaHeaderConflict.h\" of the generated umbrella header for this target. Check input files:\nthird_party/bazel_rules/rules_apple/test/starlark_tests/resources/UmbrellaHeaderConflict.h\n\nPlease remove the references to these files from your rule's list of headers to import or rename the headers if necessary.",
-        tags = [name],
-    )
-
     # Tests that attempting to generate dSYMs does not cause the build to fail
     # (apple_static_library does not generate dSYMs, and the bundler should not
     # unconditionally assume that the provider will be present).
diff --git a/test/starlark_tests/resources/UmbrellaHeaderConflict.h b/test/starlark_tests/resources/UmbrellaHeaderConflict.h
diff --git a/test/starlark_tests/targets_under_test/apple/BUILD b/test/starlark_tests/targets_under_test/apple/BUILD
@@ -665,31 +665,6 @@ apple_xcframework(
     deps = [":Swift3PFmwkWithGenHeader"],
 )
 
-apple_xcframework(
-    name = "ios_dynamic_xcframework_with_umbrella_header_conflict",
-    bundle_id = "com.google.example",
-    bundle_name = "UmbrellaHeaderConflict",
-    # TODO(b/239957001): Remove this when the rule no longer forces library
-    # evolution.
-    features = ["apple.no_legacy_swiftinterface"],
-    infoplists = [
-        "//test/starlark_tests/resources:Info.plist",
-    ],
-    ios = {
-        "simulator": ["x86_64"],
-        "device": ["arm64"],
-    },
-    minimum_os_versions = {
-        "ios": common.min_os_ios.baseline,
-    },
-    public_hdrs = [
-        "//test/starlark_tests/resources:shared.h",
-        "//test/starlark_tests/resources:UmbrellaHeaderConflict.h",
-    ],
-    tags = common.fixture_tags,
-    deps = [":fmwk_lib"],
-)
-
 apple_static_xcframework(
     name = "ios_static_xcframework_oldest_supported",
     # TODO(b/239957001): Remove this when the rule no longer forces library
diff --git a/test/starlark_tests/targets_under_test/ios/BUILD b/test/starlark_tests/targets_under_test/ios/BUILD
@@ -2895,21 +2895,6 @@ ios_static_framework(
     deps = [":SwiftStaticFmwkWithGenHeader"],
 )
 
-ios_static_framework(
-    name = "static_framework_with_umbrella_header_conflict",
-    hdrs = [
-        "//test/starlark_tests/resources:UmbrellaHeaderConflict.h",
-        "//test/starlark_tests/resources:shared.h",
-    ],
-    bundle_name = "UmbrellaHeaderConflict",
-    # TODO(b/239957001): Remove this when the rule no longer forces library
-    # evolution.
-    features = ["apple.no_legacy_swiftinterface"],
-    minimum_os_version = common.min_os_ios.baseline,
-    tags = common.fixture_tags,
-    deps = [":shared_lib"],
-)
-
 ios_static_framework(
     name = "static_framework_from_objc_library",
     # TODO(b/239957001): Remove this when the rule no longer forces library
