BUG: do not remove RPATH entries relative to $ORIGIN

for packages using internal shared libraries relocated by meson-python.

Author: dnicolodi

mesonpy/__init__.py

@@ -427,12 +427,6 @@ def _install_path(self, wheel_file: mesonpy._wheelfile.WheelFile, origin: Path,
 
         if self._has_internal_libs:
             if _is_native(origin):
-                # When an executable, libray, or Python extension module is
-                # dynamically linked to a library built as part of the project,
-                # Meson adds a library load path to it pointing to the build
-                # directory, in the form of a relative RPATH entry. meson-python
-                # relocates the shared libraries to the $project.mesonpy.libs
-                # folder. Rewrite the RPATH to point to that folder instead.
                 libspath = os.path.relpath(self._libs_dir, destination.parent)
                 mesonpy._rpath.fix_rpath(origin, libspath)
 

mesonpy/_rpath.py

@@ -39,11 +39,21 @@ def set_rpath(filepath: Path, old: List[str], rpath: List[str]) -> None:
     @classmethod
     def fix_rpath(cls, filepath: Path, libs_relative_path: str) -> None:
         old_rpath = cls.get_rpath(filepath)
-        new_rpath = []
-        for path in old_rpath:
-            if path.startswith(cls.origin):
-                path = os.path.join(cls.origin, libs_relative_path)
-            new_rpath.append(path)
+        new_rpath = old_rpath[:]
+
+        # When an executable, libray, or Python extension module is
+        # dynamically linked to a library built as part of the project, Meson
+        # adds a build RPATH pointing to the build directory, in the form of a
+        # relative RPATH entry. We can use the presence of any RPATH entries
+        # relative to ``$ORIGIN`` as an indicator that the installed object
+        # depends on shared libraries internal to the project. In this case we
+        # need to add an RPATH entry pointing to the meson-python shared
+        # library install location. This heuristic is not perfect: RPATH
+        # entries relative to ``$ORIGIN`` can exist for other reasons.
+        # However, this only results in harmless additional RPATH entries.
+        if any(path.startswith(cls.origin) for path in old_rpath):
+            new_rpath.append(os.path.join(cls.origin, libs_relative_path))
+
         new_rpath = unique(new_rpath)
         if new_rpath != old_rpath:
             cls.set_rpath(filepath, old_rpath, new_rpath)

tests/test_wheel.py

@@ -235,6 +235,8 @@ def test_link_against_local_lib_rpath(wheel_link_against_local_lib, tmp_path):
 
     origin = '@loader_path' if sys.platform == 'darwin' else '$ORIGIN'
     expected = {f'{origin}/../.link_against_local_lib.mesonpy.libs', 'custom-rpath',}
+    # This RPATH entry should be removed by meson-python but it is not.
+    expected.add(f'{origin}/lib')
 
     rpath = set(mesonpy._rpath.get_rpath(tmp_path / 'example' / f'_example{EXT_SUFFIX}'))
     assert rpath == expected
@@ -251,10 +253,6 @@ def test_link_against_local_lib_rpath_ldflags(package_link_against_local_lib, tm
     artifact = wheel.wheelfile.WheelFile(tmp_path / filename)
     artifact.extractall(tmp_path)
 
-    # The RPATH entry relative to $ORIGIN added via $LDFLAGS is
-    # erroneusly stripped by meson-python.
-    extra_rpath = {'/usr/lib/test-ldflags',}
-
     rpath = set(mesonpy._rpath.get_rpath(tmp_path / 'example' / f'_example{EXT_SUFFIX}'))
     assert extra_rpath <= rpath