Ensure multi-tagged wheels are correctly identified as universal (#2692)

Author: freakboy3742

changes/2690.bugfix.md

@@ -0,0 +1 @@
+macOS wheels that are tagged with *both* `universal2` and individual architecture tags are now correctly processed as part of the architecture merging process.

src/briefcase/platforms/macOS/__init__.py

@@ -263,13 +263,6 @@ def _install_app_requirements(
 """,
             )
 
-            # Find all the packages with binary components.
-            # We can ignore any -universal2 packages; they're already fat.
-            binary_packages = self.find_binary_packages(
-                host_app_packages_path,
-                universal_suffix="_universal2",
-            )
-
             # Install dependencies for the architecture that isn't the host architecture
             other_arch = {
                 "arm64": "x86_64",
@@ -284,6 +277,13 @@ def _install_app_requirements(
                 self.tools.shutil.rmtree(other_app_packages_path)
             self.tools.os.mkdir(other_app_packages_path)
 
+            # Find all the packages with binary components.
+            # We can ignore any -universal2 packages; they're already fat.
+            binary_packages = self.find_binary_packages(
+                host_app_packages_path,
+                universal_suffix="_universal2",
+                other_suffix=f"_{other_arch}",
+            )
             if binary_packages:
                 with self.console.wait_bar(
                     f"Installing binary app requirements for {other_arch}..."

src/briefcase/platforms/macOS/utils.py

@@ -62,11 +62,15 @@ def find_binary_packages(
         self,
         install_path: Path,
         universal_suffix: str | None = None,
+        other_suffix: str | None = None,
     ) -> list[tuple[str, str]]:
         """Find the packages that have been installed that have binary components.
 
         :param install_path: The path into which packages have been installed.
         :param universal_suffix: The tag suffix that indicates a universal wheel.
+        :param other_suffix: The tag suffix for the *other* architecture. Presence of
+            this architecture implies a universal wheel, even if it isn't tagged as
+            such.
         :returns: A list of (package name, version) tuples, describing the packages that
             are in the install path that are non-universal and non-pure.
         """
@@ -78,15 +82,20 @@ def find_binary_packages(
             with (distinfo / "WHEEL").open("r", encoding="utf-8") as f:
                 wheel_data = email.message_from_string(f.read())
                 is_purelib = wheel_data.get("Root-Is-Purelib", "false") == "true"
-                tag = wheel_data["Tag"]
+                tags = wheel_data.get_all("Tag")
 
             # If the wheel is pure, it's not a binary package
             if is_purelib:
                 continue
 
             # If the tag ends with the universal tag, the binary package can be used on
             # all targets and doesn't need additional processing.
-            if universal_suffix and tag.endswith(universal_suffix):
+            if universal_suffix and any(tag.endswith(universal_suffix) for tag in tags):
+                continue
+
+            # If the wheel is tagged with the *other* architecture, it's a universal
+            # wheel even though it isn't tagged as such
+            if other_suffix and any(tag.endswith(other_suffix) for tag in tags):
                 continue
 
             # The wheel is a single platform binary wheel.

tests/platforms/macOS/app/test_create.py

@@ -421,6 +421,7 @@ def test_install_app_packages(
     create_command.find_binary_packages.assert_called_once_with(
         bundle_path / f"app_packages.{host_arch}",
         universal_suffix="_universal2",
+        other_suffix=f"_{other_arch}",
     )
 
     # A request was made to install requirements
@@ -553,6 +554,7 @@ def test_min_os_version(create_command, first_app_templated, old_config, tmp_pat
     create_command.find_binary_packages.assert_called_once_with(
         bundle_path / "app_packages.arm64",
         universal_suffix="_universal2",
+        other_suffix="_x86_64",
     )
 
     # A request was made to install requirements
@@ -700,6 +702,7 @@ def test_default_min_os_version(
     create_command.find_binary_packages.assert_called_once_with(
         bundle_path / "app_packages.arm64",
         universal_suffix="_universal2",
+        other_suffix="_x86_64",
     )
 
     # A request was made to install requirements
@@ -838,6 +841,7 @@ def test_install_app_packages_no_binary(
     create_command.find_binary_packages.assert_called_once_with(
         bundle_path / f"app_packages.{host_arch}",
         universal_suffix="_universal2",
+        other_suffix=f"_{other_arch}",
     )
 
     # A request was made to install requirements
@@ -938,6 +942,7 @@ def test_install_app_packages_failure(create_command, first_app_templated, tmp_p
     create_command.find_binary_packages.assert_called_once_with(
         bundle_path / "app_packages.arm64",
         universal_suffix="_universal2",
+        other_suffix="_x86_64",
     )
 
     # A request was made to install requirements

tests/platforms/macOS/test_AppPackagesMergeMixin__find_binary_packages.py

@@ -49,18 +49,55 @@ def test_find_binary_packages(dummy_command, tmp_path):
         version="9.9.9",
         tag="macOS_13_arm64",
     )
+    # Packages with multiple binary tags (see #2690)
+    # Multiple tags, where universal2 duplicates explicit tagging
+    create_installed_package(
+        tmp_path / "app-packages",
+        "multi-tagged-binary-package-1",
+        version="3.4.7",
+        tag=["macOS_11_x86-64", "macOS_11_arm64", "macOS_11_universal2"],
+    )
+    # Universal2 even though it isn't tagged as such
+    create_installed_package(
+        tmp_path / "app-packages",
+        "multi-tagged-binary-package-2",
+        version="3.4.8",
+        tag=["macOS_11_x86-64", "macOS_11_arm64"],
+    )
+    # Multiple tagged, but not a universal pair
+    create_installed_package(
+        tmp_path / "app-packages",
+        "multi-tagged-binary-package-3",
+        version="3.4.9",
+        tag=["macOS_11_arm64", "macOS_11_ppc"],
+    )
+    # Multiple tagged, includes universal and host, but *not* other
+    create_installed_package(
+        tmp_path / "app-packages",
+        "multi-tagged-binary-package-4",
+        version="3.4.10",
+        tag=["macOS_11_arm64", "macOS_11_universal2"],
+    )
+    # Multiple tagged, includes universal and other, but *not* host
+    create_installed_package(
+        tmp_path / "app-packages",
+        "multi-tagged-binary-package-5",
+        version="3.4.11",
+        tag=["macOS_11_x86_64", "macOS_11_universal2"],
+    )
 
     binary_packages = dummy_command.find_binary_packages(
         tmp_path / "app-packages",
         universal_suffix="_universal2",
+        other_suffix="_x86-64",
     )
 
     # Binary wheels are discovered. We don't care about the order they are returned in,
     # just that they're all found.
-    assert len(binary_packages) == 2
     assert set(binary_packages) == {
         ("binary-package-1", "3.4.5"),
         ("binary-package-2", "3.4.6"),
+        ("multi-tagged-binary-package-3", "3.4.9"),
     }
 
 

tests/utils.py

@@ -193,13 +193,13 @@ def _download_file(url, download_path, role):
 def distinfo_metadata(
     package: str = "dummy",
     version: str = "1.2.3",
-    tag: str = "py3-none-any",
+    tag: str | list[str] = "py3-none-any",
 ):
     """Generate the content for a distinfo folder.
 
     :param package: The name of the package.
     :param version: The version number of the package.
-    :param tag: The packaging tag for the package.
+    :param tag: The packaging tag (or tags) for the package.
     """
     content = []
 
@@ -221,7 +221,11 @@ def distinfo_metadata(
     wheel["Wheel-Version"] = "1.0"
     wheel["Generator"] = "test-case"
     wheel["Root-Is-Purelib"] = "true" if tag == "py3-none-any" else "false"
-    wheel["Tag"] = tag
+    if isinstance(tag, str):
+        wheel["Tag"] = tag
+    else:
+        for value in tag:
+            wheel["Tag"] = value
     content.append((f"{package}-{version}.dist-info/WHEEL", str(wheel)))
 
     # RECORD