Merge pull request #63 from rabbitmq/improve-dep-resolution-error

Improve the error message when erlang_package deps conflict

Author: HoloRin

bzlmod/erlang_package.bzl

@@ -13,6 +13,7 @@ load(
 )
 
 HexPackage = provider(fields = [
+    "module",
     "name",
     "version",
     "sha256",
@@ -24,6 +25,7 @@ HexPackage = provider(fields = [
 ])
 
 GitPackage = provider(fields = [
+    "module",
     "name",
     "version",
     "remote",
@@ -41,7 +43,7 @@ def log(ctx, msg):
 
 def hex_tree(
         ctx,
-        otp_installation_names = None,
+        module = None,
         name = None,
         version = None):
     log(ctx, "Fetching release info for {}@{} from hex.pm".format(name, version))
@@ -57,6 +59,7 @@ def hex_tree(
             requirements.append(props)
 
     return HexPackage(
+        module = module,
         name = name,
         version = version,
         sha256 = sha256,
@@ -69,13 +72,14 @@ def hex_tree(
 
 def hex_package(
         ctx,
-        otp_installation_names = None,
+        module = None,
         name = None,
         version = None,
         sha256 = None,
         build_file_content = None,
         patch_cmds = None):
     return HexPackage(
+        module = module,
         name = name,
         version = version,
         sha256 = sha256,
@@ -96,7 +100,7 @@ def _infer_app_name(remote):
 
 def git_package(
         ctx,
-        otp_installation_names = None,
+        module = None,
         dep = None):
     if dep.remote != "" and dep.repository != "":
         fail("'remote' and 'repository' are mutually exclusive options")
@@ -121,6 +125,7 @@ def git_package(
         version = dep.branch
 
     return GitPackage(
+        module = module,
         name = name,
         version = version,
         remote = remote,
@@ -145,6 +150,7 @@ def without_requirement(name, package):
                 new_requirements.append(r)
 
         return HexPackage(
+            module = package.module,
             name = package.name,
             version = package.version,
             sha256 = package.sha256,

bzlmod/extensions.bzl

@@ -1,7 +1,6 @@
 load(
     ":hex_pm.bzl",
     "hex_package_info",
-    "newest",
     "satisfies",
 )
 load(
@@ -12,6 +11,11 @@ load(
     "log",
     "without_requirement",
 )
+load(
+    ":semver.bzl",
+    "lt",
+    "version_from_string",
+)
 load(
     "//:rules_erlang.bzl",
     "xref_runner_sources",
@@ -76,6 +80,25 @@ def _resolve_hex_pm(ctx, packages):
             return resolved
     fail("Dependencies were not resolved after {} passes.".format(_RESOLVE_MAX_PASSES))
 
+def _newest(a, b):
+    if a.version == b.version:
+        return a
+
+    a_version = version_from_string(a.version)
+    b_version = version_from_string(b.version)
+    if a_version == None or b_version == None:
+        fail("Version {dep_name}@{a_version} (required by {a_module}) & {dep_name}@{b_version} (required by {b_module}) cannot be resolved".format(
+            dep_name = a.name,
+            a_version = a.version,
+            a_module = a.module.name,
+            b_version = b.version,
+            b_module = b.module.name,
+        ))
+    elif lt(a_version, b_version):
+        return b
+    else:
+        return a
+
 def _resolve_local(packages):
     deduped = []
     packages_by_name = {}
@@ -87,7 +110,7 @@ def _resolve_local(packages):
     for (_, dupes) in packages_by_name.items():
         p = dupes[0]
         for dupe in dupes[1:]:
-            p = newest(p, dupe)
+            p = _newest(p, dupe)
         deduped.append(p)
     return deduped
 
@@ -99,12 +122,14 @@ def _erlang_package(ctx):
         for dep in mod.tags.hex_package_tree:
             packages.append(hex_tree(
                 ctx,
+                module = mod,
                 name = dep.name,
                 version = dep.version,
             ))
         for dep in mod.tags.hex_package:
             packages.append(hex_package(
                 ctx,
+                module = mod,
                 name = dep.name,
                 version = dep.version,
                 sha256 = dep.sha256,
@@ -114,6 +139,7 @@ def _erlang_package(ctx):
         for dep in mod.tags.git_package:
             packages.append(git_package(
                 ctx,
+                module = mod,
                 dep = dep,
             ))
 

bzlmod/hex_pm.bzl

@@ -1,3 +1,12 @@
+load(
+    ":semver.bzl",
+    "Version",
+    "eq",
+    "gte",
+    "lt",
+    "version_from_string",
+)
+
 def hex_package_info(ctx, name):
     curl = ctx.which("curl")
     endpoint = "https://hex.pm/api/packages/{}".format(name)
@@ -20,68 +29,19 @@ def hex_release_info(ctx, name, version):
         fail("hex.pm api returned {} for {}".format(response.return_code, endpoint))
     return json.decode(response.stdout)
 
-Version = provider(fields = ["major", "minor", "patch"])
-
-def _version(version):
-    [major, minor, patch] = version.split(".", 2)
-    if not patch.isdigit():
-        return None
-    return Version(
-        major = int(major),
-        minor = int(minor),
-        patch = int(patch),
-    )
-
-def _gte(a, b):
-    if a.major > b.major:
-        return True
-    elif a.major == b.major:
-        if a.minor > b.minor:
-            return True
-        elif a.minor == b.minor:
-            return a.patch >= b.patch
-        else:
-            return False
-    else:
-        return False
-
-def _lt(a, b):
-    if a.major < b.major:
-        return True
-    elif a.major == b.major:
-        if a.minor < b.minor:
-            return True
-        elif a.minor == b.minor:
-            return a.patch < b.patch
-        else:
-            return False
-    else:
-        return False
-
-def _eq(a, b):
-    return a.major == b.major and a.minor == b.minor and a.patch == b.patch
-
-def newest(a, b):
-    if a.version == b.version:
-        return a
-    if _lt(_version(a.version), _version(b.version)):
-        return b
-    else:
-        return a
-
 def satisfies(version, requirement):
-    v = _version(version)
+    v = version_from_string(version)
     if v == None:
         # print("Ignoring version", version)
         return False
     if requirement.startswith("~>"):
-        min = _version(requirement.removeprefix("~>").lstrip())
+        min = version_from_string(requirement.removeprefix("~>").lstrip())
         if min == None:
             print("Ignoring requirement", requirement)
             return False
         max = Version(major = min.major, minor = min.minor + 1, patch = 0)
-        return _gte(v, min) and _lt(v, max)
-    elif _version(requirement) != None:
-        return _eq(v, _version(requirement))
+        return gte(v, min) and lt(v, max)
+    elif version_from_string(requirement) != None:
+        return eq(v, version_from_string(requirement))
     else:
         fail(requirement)

bzlmod/semver.bzl

@@ -0,0 +1,47 @@
+Version = provider(fields = ["major", "minor", "patch"])
+
+def version_from_string(version):
+    parts = version.split(".", 2)
+    if len(parts) != 3:
+        return None
+    [major, minor, patch] = parts
+    if not major.isdigit():
+        return None
+    if not minor.isdigit():
+        return None
+    if not patch.isdigit():
+        return None
+    return Version(
+        major = int(major),
+        minor = int(minor),
+        patch = int(patch),
+    )
+
+def gte(a, b):
+    if a.major > b.major:
+        return True
+    elif a.major == b.major:
+        if a.minor > b.minor:
+            return True
+        elif a.minor == b.minor:
+            return a.patch >= b.patch
+        else:
+            return False
+    else:
+        return False
+
+def lt(a, b):
+    if a.major < b.major:
+        return True
+    elif a.major == b.major:
+        if a.minor < b.minor:
+            return True
+        elif a.minor == b.minor:
+            return a.patch < b.patch
+        else:
+            return False
+    else:
+        return False
+
+def eq(a, b):
+    return a.major == b.major and a.minor == b.minor and a.patch == b.patch