bugs: support obsoleting bugs when not exact version matches

When scanning for existing bugs, detect when the package list isn't an
exact match, in which case an obsoleting can be considered by the user.
Query the user for his decision and if obsoleting is chosen, after
filing the bug, batch update all obsoleted bugs in a single API request
to mark them as RESOLVED and with a See Also reference to the new bug.
The TOML editing also now includes the obsoletes field for easier manual
editing (which enables to manually add obsoletes).

Resolves: #206
Signed-off-by: Arthur Zamarin <arthurzam@gentoo.org>

Author: arthurzam

src/pkgdev/scripts/pkgdev_bugs.py

@@ -208,14 +208,15 @@ def parse_atom(pkg: str):
 
 
 class GraphNode:
-    __slots__ = ("pkgs", "edges", "bugno", "summary", "cc_arches")
+    __slots__ = ("pkgs", "edges", "bugno", "summary", "cc_arches", "obsoletes")
 
     def __init__(self, pkgs: tuple[tuple[package, set[str]], ...], bugno=None):
         self.pkgs = pkgs
         self.edges: set[GraphNode] = set()
         self.bugno = bugno
         self.summary = ""
         self.cc_arches = None
+        self.obsoletes: set[int] = set()
 
     def __eq__(self, __o: object):
         return self is __o
@@ -337,8 +338,35 @@ def file_bug(
         self.bugno = int(reply["id"])
         if observer is not None:
             observer(self)
+        self.obsolete_bugs(api_key)
         return self.bugno
 
+    def obsolete_bugs(self, api_key: str):
+        if not self.obsoletes:
+            return
+        assert self.bugno is not None
+
+        # Batch all bug IDs into a single PUT request
+        request_data = dict(
+            Bugzilla_api_key=api_key,
+            status="RESOLVED",
+            resolution="OBSOLETE",
+            see_also={"add": [f"https://bugs.gentoo.org/{self.bugno}"]},
+        )
+        if len(self.obsoletes) > 1:
+            request_data["ids"] = list(self.obsoletes)
+        request = urllib.Request(
+            url=f"https://bugs.gentoo.org/rest/bug/{','.join(map(str, self.obsoletes))}",
+            data=json.dumps(request_data).encode("utf-8"),
+            method="PUT",
+            headers={
+                "Content-Type": "application/json",
+                "Accept": "application/json",
+            },
+        )
+        with urllib.urlopen(request, timeout=30) as response:
+            json.loads(response.read().decode("utf-8"))
+
 
 class DependencyGraph:
     def __init__(self, out: Formatter, err: Formatter, options):
@@ -560,6 +588,7 @@ def output_graph_toml(self):
                 f'"bug-{i}"' for i, src in bugs.items() if node in src.edges
             ):
                 toml.write(f"blocks = [{node_blocks}]\n")
+            toml.write(f"obsoletes = {sorted(node.obsoletes)}\n")
             for pkg, arches in node.pkgs:
                 try:
                     match = next(self.modified_repo.itermatch(pkg.versioned_atom))
@@ -600,6 +629,7 @@ def load_graph_toml(self, toml_file: str):
         for node_name, data_node in data.items():
             new_bugs[node_name].summary = data_node.get("summary", "")
             new_bugs[node_name].cc_arches = data_node.get("cc_arches", None)
+            new_bugs[node_name].obsoletes = set(data_node.get("obsoletes", ()))
             for dep in data_node.get("depends", ()):
                 if isinstance(dep, int):
                     new_bugs[node_name].edges.add(new_bugs.setdefault(dep, GraphNode((), dep)))
@@ -748,15 +778,35 @@ def scan_existing_bugs(self, api_key: str) -> bool:
                 if line
             )
             bug_match = boolean.OrRestriction(*bug_atoms)
+            exact_match = boolean.OrRestriction(
+                *(
+                    parse_atom(line.split(" ", 1)[0])
+                    for line in map(str.strip, bug["cf_stabilisation_atoms"].splitlines())
+                    if line
+                )
+            )
             for node in self.nodes:
                 if node.bugno is None and all(bug_match.match(pkg[0]) for pkg in node.pkgs):
-                    node.bugno = bug["id"]
+                    is_exact_match = all(exact_match.match(pkg[0]) for pkg in node.pkgs)
                     self.out.write(
                         self.out.fg("yellow"),
-                        f"Found https://bugs.gentoo.org/{node.bugno} for node {node}",
+                        f"Found https://bugs.gentoo.org/{bug['id']} for node {node}",
                         self.out.reset,
+                        " (exact version match)" if is_exact_match else " (atom match)",
                     )
                     self.out.write(" -> bug summary: ", bug["summary"])
+                    if is_exact_match:
+                        node.bugno = bug["id"]
+                    else:
+                        if userquery(
+                            "Not an exact match. Do you want to obsolete?",
+                            self.out,
+                            self.err,
+                            default_answer=False,
+                        ):
+                            node.obsoletes.add(bug["id"])
+                        else:
+                            node.bugno = bug["id"]
                     has_output = True
                     break
         return has_output