Support index-import on all Xcode 16.x versions

This PR updates the index-import dependency to include both version 5.8 and 6.1 as the hash algorithm changed in Swift 6.1.
To make this change backwards compatible we switch to the 5.8 version on Xcode 16.2 and under.

Signed-off-by: Luis Padron <heyluispadron@gmail.com>

Author: luispadron

MODULE.bazel

@@ -10,7 +10,7 @@ bazel_dep(name = "bazel_features", version = "1.3.0")
 bazel_dep(name = "bazel_skylib", version = "1.3.0")
 bazel_dep(
     name = "rules_swift",
-    version = "1.18.0",
+    version = "2.8.0",
     max_compatibility_level = 2,
     repo_name = "build_bazel_rules_swift",
 )
@@ -27,7 +27,8 @@ use_repo(internal, "rules_xcodeproj_generated")
 non_module_deps = use_extension("//xcodeproj:extensions.bzl", "non_module_deps")
 use_repo(
     non_module_deps,
-    "rules_xcodeproj_index_import",
+    "rules_xcodeproj_index_import_5_8",
+    "rules_xcodeproj_index_import_6_1",
 )
 
 # Non-release dependencies
@@ -61,11 +62,6 @@ single_version_override(
     version = "1.17.1",
 )
 
-single_version_override(
-    module_name = "rules_swift",
-    version = "2.3.0",
-)
-
 # Some of our deps are forcing a new stardoc on us, so pinning for now
 single_version_override(
     module_name = "stardoc",

tools/BUILD

@@ -176,7 +176,7 @@ _XCSCHEMES = [
                 # targetIdsFile
                 "bazel-out/darwin_arm64-dbg/bin/external/_main~internal~rules_xcodeproj_generated/generator/tools/xcodeproj/xcodeproj_target_ids",
                 # indexImport
-                "bazel-out/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import",
+                "bazel-out/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import_5_8",
                 # resolvedRepositoriesFile
                 "bazel-out/darwin_arm64-dbg/bin/external/_main~internal~rules_xcodeproj_generated/generator/tools/generators/xcodeproj/xcodeproj_pbxproj_partials/resolved_repositories",
                 # minimumXcodeVersion

tools/generators/pbxproj_prefix/README.md

@@ -36,7 +36,7 @@ $ pbxproj_prefix \
     /tmp/workspace \
     bazel-output-base/rules_xcodeproj.noindex/build_output_base/execroot/_main/bazel-out/darwin_arm64-dbg/bin/external/_main~internal~rules_xcodeproj_generated/generator/tools/generators/xcodeproj/xcodeproj_execution_root_file \
     bazel-out/darwin_arm64-dbg/bin/external/_main~internal~rules_xcodeproj_generated/generator/tools/generators/xcodeproj/xcodeproj_target_ids \
-    bazel-out/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import \
+    bazel-out/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import_5_8 \
     bazel-out/darwin_arm64-dbg/bin/external/_main~internal~rules_xcodeproj_generated/generator/tools/generators/xcodeproj/xcodeproj_pbxproj_partials/resolved_repositories \
     14.0 \
     Release \
@@ -216,7 +216,7 @@ Here is an example output:
 				GCC_OPTIMIZATION_LEVEL = 0;
 				IMPORT_INDEX_BUILD_INDEXSTORES = YES;
 				INDEX_DATA_STORE_DIR = "$(INDEX_DATA_STORE_DIR)";
-				INDEX_IMPORT = "$(BAZEL_OUT)/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import";
+				INDEX_IMPORT = "$(BAZEL_OUT)/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import_5_8";
 				INDEX_FORCE_SCRIPT_EXECUTION = YES;
 				INSTALL_PATH = "$(BAZEL_PACKAGE_BIN_DIR)/$(TARGET_NAME)/bin";
 				INTERNAL_DIR = "$(PROJECT_FILE_PATH)/rules_xcodeproj";
@@ -276,7 +276,7 @@ Here is an example output:
 				GCC_OPTIMIZATION_LEVEL = 0;
 				IMPORT_INDEX_BUILD_INDEXSTORES = YES;
 				INDEX_DATA_STORE_DIR = "$(INDEX_DATA_STORE_DIR)";
-				INDEX_IMPORT = "$(BAZEL_OUT)/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import";
+				INDEX_IMPORT = "$(BAZEL_OUT)/darwin_arm64-opt-exec-2B5CBBC6/bin/external/_main~non_module_deps~rules_xcodeproj_index_import/index-import_5_8";
 				INDEX_FORCE_SCRIPT_EXECUTION = YES;
 				INSTALL_PATH = "$(BAZEL_PACKAGE_BIN_DIR)/$(TARGET_NAME)/bin";
 				INTERNAL_DIR = "$(PROJECT_FILE_PATH)/rules_xcodeproj";

xcodeproj/internal/xcode_version_util.bzl

@@ -0,0 +1,24 @@
+"""Utility functions for working with Xcode versions."""
+
+def is_xcode_at_least_version(xcode_config, desired_version):
+    """Returns True if the current Xcode version is at least the given version.
+
+    Args:
+        xcode_config: The Xcode version config.
+        desired_version: The desired version (e.g. "16.3")
+
+    Returns:
+        True if the current Xcode version is at least the given version, False otherwise.
+    """
+
+    current_version = xcode_config.xcode_version()
+    if not current_version:
+        fail("""\
+`xcode_version` not foundin `XcodeVersionConfig`.
+
+Please file a bug report here: \
+https://github.com/MobileNativeFoundation/rules_xcodeproj/issues/new?template=bug.md"
+""")
+
+    desired_version_value = apple_common.dotted_version(desired_version)
+    return current_version >= desired_version_value

xcodeproj/internal/xcodeproj_incremental_rule.bzl

@@ -31,6 +31,7 @@ load(
 load(":incremental_xcode_targets.bzl", xcode_targets_module = "incremental_xcode_targets")
 load(":selected_model_versions.bzl", "write_selected_model_versions_file")
 load(":target_id.bzl", "write_target_ids_list")
+load(":xcode_version_util.bzl", "is_xcode_at_least_version")
 load(":xcodeprojinfo.bzl", "XcodeProjInfo")
 
 # Utility
@@ -622,7 +623,6 @@ Are you using an `alias`? `xcodeproj.focused_targets` and \
     actions = ctx.actions
     colorize = ctx.attr.colorize
     config = ctx.attr.config
-    index_import = ctx.executable._index_import
     install_path = ctx.attr.install_path
     is_fixture = ctx.attr._is_fixture
     name = ctx.attr.name
@@ -635,6 +635,16 @@ Are you using an `alias`? `xcodeproj.focused_targets` and \
         ctx.attr.default_xcode_configuration or xcode_configurations[0]
     )
 
+    # TODO: Remove once we drop support for Xcode 16.x.
+    # We set a private environment variable when using a version older than Xcode 16.3
+    # which comes with Swift 6.1 which changes the hash algorithm for the index-import tool.
+    # When using an older version we switch to the older version of index-import.
+    xcode_toolchain_config = ctx.attr._xcode_config[apple_common.XcodeVersionConfig]
+    if not is_xcode_at_least_version(xcode_toolchain_config, "16.3"):
+        index_import = ctx.executable._index_import_5_8
+    else:
+        index_import = ctx.executable._index_import_6_1
+
     # Project contents
 
     (
@@ -871,9 +881,17 @@ def _xcodeproj_incremental_attrs(
             ),
             executable = True,
         ),
-        "_index_import": attr.label(
+        # TODO: we must depend on two versions of index-import to support backwards
+        # compatibility between Xcode 16.3+ and older versions, we can remove the older
+        # version once we drop support for Xcode 16.x.
+        "_index_import_5_8": attr.label(
+            cfg = "exec",
+            default = Label("@rules_xcodeproj_index_import_5_8//:index_import"),
+            executable = True,
+        ),
+        "_index_import_6_1": attr.label(
             cfg = "exec",
-            default = Label("@rules_xcodeproj_index_import//:index_import"),
+            default = Label("@rules_xcodeproj_index_import_6_1//:index_import"),
             executable = True,
         ),
         "_installer_template": attr.label(

xcodeproj/internal/xcodeproj_legacy_rule.bzl

@@ -35,6 +35,7 @@ load(":platforms.bzl", "platforms")
 load(":project_options.bzl", "project_options_to_dto")
 load(":resource_target.bzl", "process_resource_bundles")
 load(":target_id.bzl", "write_target_ids_list")
+load(":xcode_version_util.bzl", "is_xcode_at_least_version")
 load(":xcodeprojinfo.bzl", "XcodeProjInfo")
 
 # Utility
@@ -1584,6 +1585,18 @@ configurations: {}""".format(", ".join(xcode_configurations)))
         if s.id in targets
     ]
 
+    # TODO: Remove once we drop support for Xcode 16.x.
+    # We set a private environment variable when using a version older than Xcode 16.3
+    # which comes with Swift 6.1 which changes the hash algorithm for the index-import tool.
+    # When using an older version we switch to the older version of index-import.
+    xcode_toolchain_config = ctx.attr._xcode_config[apple_common.XcodeVersionConfig]
+    if not is_xcode_at_least_version(xcode_toolchain_config, "16.3"):
+        index_import = ctx.executable._index_import_5_8
+        index_import_files_to_run = ctx.attr._index_import_5_8[DefaultInfo].files_to_run
+    else:
+        index_import = ctx.executable._index_import_6_1
+        index_import_files_to_run = ctx.attr._index_import_6_1[DefaultInfo].files_to_run
+
     spec_files = _write_spec(
         actions = actions,
         args = args,
@@ -1592,7 +1605,7 @@ configurations: {}""".format(", ".join(xcode_configurations)))
         envs = envs,
         extra_files = extra_files,
         extra_folders = extra_folders,
-        index_import = ctx.executable._index_import,
+        index_import = index_import,
         infos = infos,
         is_fixture = is_fixture,
         minimum_xcode_version = minimum_xcode_version,
@@ -1735,7 +1748,7 @@ done
         execution_root_file = execution_root_file,
         extension_point_identifiers_file = extension_point_identifiers_file,
         generator = ctx.attr._generator[DefaultInfo].files_to_run,
-        index_import = ctx.attr._index_import[DefaultInfo].files_to_run,
+        index_import = index_import_files_to_run,
         install_path = install_path,
         is_fixture = is_fixture,
         name = name,
@@ -1760,7 +1773,7 @@ done
         input_files_output_groups = input_files.to_output_groups_fields(
             inputs = inputs,
             additional_bwx_generated = additional_bwx_generated,
-            index_import = ctx.executable._index_import,
+            index_import = index_import,
         )
         output_files_output_groups = {}
         all_targets_files = [
@@ -1773,7 +1786,7 @@ done
         output_files_output_groups = output_files.to_output_groups_fields(
             outputs = provider_outputs,
             additional_bwb_outputs = additional_bwb_outputs,
-            index_import = ctx.executable._index_import,
+            index_import = index_import,
         )
         all_targets_files = [output_files_output_groups["all_b"]]
 
@@ -1891,9 +1904,17 @@ def _xcodeproj_legacy_attrs(
             default = Label("//tools/generators/legacy:universal_generator"),
             executable = True,
         ),
-        "_index_import": attr.label(
+        # TODO: we must depend on two versions of index-import to support backwards
+        # compatibility between Xcode 16.3+ and older versions, we can remove the older
+        # version once we drop support for Xcode 16.x.
+        "_index_import_5_8": attr.label(
+            cfg = "exec",
+            default = Label("@rules_xcodeproj_index_import_5_8//:index_import"),
+            executable = True,
+        ),
+        "_index_import_6_1": attr.label(
             cfg = "exec",
-            default = Label("@rules_xcodeproj_index_import//:index_import"),
+            default = Label("@rules_xcodeproj_index_import_6_1//:index_import"),
             executable = True,
         ),
         "_installer_template": attr.label(

xcodeproj/repositories.bzl

@@ -121,8 +121,8 @@ def xcodeproj_rules_dependencies(
         _maybe(
             http_archive,
             name = "build_bazel_rules_swift",
-            sha256 = "bb01097c7c7a1407f8ad49a1a0b1960655cf823c26ad2782d0b7d15b323838e2",
-            url = "https://github.com/bazelbuild/rules_swift/releases/download/1.18.0/rules_swift.1.18.0.tar.gz",
+            sha256 = "68290c747eab415d924a3e2a8d2d32a4686dd1e0b091a6b4db4892d1bc0e8308",
+            url = "https://github.com/bazelbuild/rules_swift/releases/download/2.8.0/rules_swift.2.8.0.tar.gz",
             ignore_version_differences = ignore_version_differences,
         )
 
@@ -148,10 +148,10 @@ def xcodeproj_rules_dependencies(
     # here in order to reuse it, and in case `rules_swift` stops depending on it
     # in the future. We don't though, because we need 5.5.3.1 or higher, and the
     # current lowest version of rules_swift we support uses 5.3.2.6.
-    _maybe(
-        http_archive,
-        name = "rules_xcodeproj_index_import",
-        build_file_content = """\
+    # TODO: we must depend on two versions of index-import to support backwards
+    # compatibility between Xcode 16.3+ and older versions, we can remove the older
+    # version once we drop support for Xcode 16.x.
+    index_import_build_file_content = """\
 load("@bazel_skylib//rules:native_binary.bzl", "native_binary")
 
 native_binary(
@@ -160,11 +160,25 @@ native_binary(
     out = "index-import",
     visibility = ["//visibility:public"],
 )
-""",
+"""
+    _maybe(
+        http_archive,
+        name = "rules_xcodeproj_index_import_5_8",
+        build_file_content = index_import_build_file_content,
+        canonical_id = "index-import-5.8",
         sha256 = "28c1ffa39d99e74ed70623899b207b41f79214c498c603915aef55972a851a15",
         url = "https://github.com/MobileNativeFoundation/index-import/releases/download/5.8.0.1/index-import.tar.gz",
         ignore_version_differences = ignore_version_differences,
     )
+    _maybe(
+        http_archive,
+        name = "rules_xcodeproj_index_import_6_1",
+        build_file_content = index_import_build_file_content,
+        canonical_id = "index-import-6.1",
+        sha256 = "54d0477526bba0dc1560189dfc4f02d90aea536e9cb329e911f32b2a564b66f1",
+        url = "https://github.com/MobileNativeFoundation/index-import/releases/download/6.1.0/index-import.tar.gz",
+        ignore_version_differences = ignore_version_differences,
+    )
 
     # Source dependencies
     _xcodeproj_rules_source_dependencies(ignore_version_differences)