Merge pull request #2898 from alicevision/dev/psutilDep

[core] Rez plugins: Ensure dependencies for `meshroom_compute` are present

This PR introduces a mechanism to ensure that required dependencies for meshroom_compute, specifically psutil, are always included in the node execution environment for rez plugins. Dependencies for meshroom_compute are added to the environment without specifying any version or attempting to match Meshroom's, in order for it to be set directly during the environment resolution.

Author: fabiencastan

meshroom/core/desc/node.py

@@ -17,6 +17,7 @@
 
 _MESHROOM_ROOT = Path(meshroom.__file__).parent.parent.as_posix()
 _MESHROOM_COMPUTE = (Path(_MESHROOM_ROOT) / "bin" / "meshroom_compute").as_posix()
+_MESHROOM_COMPUTE_DEPS = ["psutil"]
 
 
 class MrNodeType(enum.Enum):

meshroom/core/plugins.py

@@ -14,7 +14,7 @@
 
 from meshroom.common import BaseObject
 from meshroom.core import desc
-from meshroom.core.desc.node import _MESHROOM_ROOT
+from meshroom.core.desc.node import _MESHROOM_ROOT, _MESHROOM_COMPUTE_DEPS
 
 
 def validateNodeDesc(nodeDesc: desc.Node) -> list:
@@ -161,10 +161,10 @@ def __init__(self, folder: str, configEnv: dict[str: str], uri: str = ""):
 
     def resolveRezSubrequires(self) -> list[str]:
         """
-        Return the list of packages defined for the node execution. These execution packages are named
-        subrequires.
-        Note: If a package does not have a version number, the version is aligned with the main Meshroom
-        environment (if this package is defined).
+        Return the list of packages defined for the node execution. These execution packages are
+        named subrequires.
+        Note: If a package does not have a version number, the version is aligned with the main
+        Meshroom environment (if this package is defined).
         """
         subrequires = os.environ.get(f"{self.uri.upper()}_SUBREQUIRES", "").split(os.pathsep)
         if not subrequires:
@@ -184,8 +184,8 @@ def resolveRezSubrequires(self) -> list[str]:
                 resolvedVersions[name] = version
         logging.debug("Packages in the current environment: " + ", ".join(currentEnvPackages))
 
-        # Take packages with the set versions for those which have one, and try to take packages in the current
-        # environment (if they are resolved in it)
+        # Take packages with the set versions for those which have one, and try to take packages
+        # in the current environment (if they are resolved in it)
         for package in subrequires:
             packageTuple = self.REZ_DELIMITER_PATTERN.split(package, maxsplit=1)
             match len(packageTuple):
@@ -202,6 +202,19 @@ def resolveRezSubrequires(self) -> list[str]:
                     # The subrequires ask for a specific version
                     packages.append(package)
 
+        def extractPackageName(packageString: str) -> str:
+            return self.REZ_DELIMITER_PATTERN.split(packageString, maxsplit=1)[0]
+        packageNames = [extractPackageName(package) for package in packages]
+
+        for package in _MESHROOM_COMPUTE_DEPS:
+            # For packages that are required by meshroom_compute, do not specify any version
+            # or align it with Meshroom's: the version will be found during the resolution of
+            # the environment based on the other packages.
+            # If any of these packages is already part of the environment a plugin's dependency,
+            # do not add it
+            if package not in packageNames:
+                packages.append(package)
+
         logging.debug("Packages for the execution environment: " + ", ".join(packages))
         return packages