feat: Use stable key for the selected trees on hardware details page.

  * Use a hash key from git_url, tree_name and branch to be sure we can
    select trees, without need of compatible ordering between frontend
    and backend.

  Closes #1909

Signed-off-by: Alan Peixinho <alan.peixinho@profusion.mobi>

Author: alanpeixinho

backend/generate-schema.sh

@@ -1 +1,9 @@
+import hashlib
+
 SELECTED_HEAD_TREE_VALUE = "head"
+TREE_KEY_HASH_LENGTH = 14
+
+
+def make_tree_key(tree_name: str, branch: str, url: str) -> str:
+    raw = f"{tree_name}|{branch}|{url}"
+    return hashlib.sha256(raw.encode()).hexdigest()[:TREE_KEY_HASH_LENGTH]

backend/kernelCI_app/constants/hardwareDetails.py

@@ -89,7 +89,19 @@ class DocStrings:
 
     HARDWARE_DETAILS_ORIGIN_DESCRIPTION = "Origin of the tests of the hardware"
     HARDWARE_DETAILS_SEL_COMMITS_DESCRIPTION = (
-        "Dictionary mapping tree names to selected commit hashes"
+        "Dictionary mapping stable tree keys to selected commit hashes. "
+        "Keys are the first 14 hexadecimal characters of SHA-256 over "
+        "'tree_name|git_repository_branch|git_repository_url', matching "
+        "Tree.index values returned by the hardware details endpoints. "
+        "Values are a git commit hash or 'head' to use the tree head commit. "
+        "An empty object selects all trees with their head commits. "
+        "Legacy clients may send numeric string keys ('0', '1', ...) that "
+        "map to trees by position in the sorted tree list."
+    )
+    HARDWARE_DETAILS_TREE_INDEX_DESCRIPTION = (
+        "Stable identifier for a tree, derived as the first 14 hexadecimal "
+        "characters of SHA-256 over "
+        "'tree_name|git_repository_branch|git_repository_url'"
     )
 
     HARDWARE_LISTING_ORIGIN_DESCRIPTION = "Origin of the hardware"

backend/kernelCI_app/constants/localization.py

@@ -92,15 +92,21 @@ def get_displayed_commit(*, tree: Tree, selected_commit: Optional[str]):
     return selected_commit
 
 
+def _is_legacy_numeric_keys(keys: Dict[str, str]) -> bool:
+    return bool(keys) and all(k.isdigit() for k in keys)
+
+
 def get_trees_with_selected_commit(
     *, trees: List[Tree], selected_commits: Dict[str, str]
 ) -> List[Tree]:
     selected: List[Tree] = []
 
-    for tree in trees:
-        tree_idx = tree.index
+    is_legacy = _is_legacy_numeric_keys(selected_commits)
+
+    for i, tree in enumerate(trees):
+        lookup_key = str(i) if is_legacy else tree.index
 
-        raw_selected_commit = selected_commits.get(tree_idx)
+        raw_selected_commit = selected_commits.get(lookup_key)
 
         is_tree_selected = raw_selected_commit is not None
 

backend/kernelCI_app/helpers/hardwareDetails.py

@@ -4,6 +4,7 @@
 from django.db import connection
 
 from kernelCI_app.cache import get_query_cache, set_query_cache
+from kernelCI_app.constants.hardwareDetails import make_tree_key
 from kernelCI_app.helpers.database import dict_fetchall
 from kernelCI_app.queries.duration import (
     get_boot_test_duration_clause,
@@ -715,6 +716,8 @@ def get_hardware_trees_head_commits(
             TH.git_repository_url,
             TH.git_commit_hash
         ) TH.tree_name,
+        TH.git_repository_branch,
+        TH.git_repository_url,
         TH.git_commit_hash
     FROM
         tests
@@ -749,8 +752,15 @@ def get_hardware_trees_head_commits(
         cursor.execute(query, params)
         tree_records = dict_fetchall(cursor)
         trees = [
-            (str(idx), tree["git_commit_hash"])
-            for (idx, tree) in enumerate(tree_records)
+            (
+                make_tree_key(
+                    tree["tree_name"] or "",
+                    tree.get("git_repository_branch", "") or "",
+                    tree.get("git_repository_url", "") or "",
+                ),
+                tree["git_commit_hash"],
+            )
+            for tree in tree_records
         ]
         set_query_cache(key=cache_key, params=cache_params, rows=trees)
 
@@ -825,10 +835,15 @@ def get_hardware_trees_data(
             tree_records = dict_fetchall(cursor)
 
         trees = []
-        for idx, tree in enumerate(tree_records):
+        for tree in tree_records:
+            tree_index = make_tree_key(
+                tree["tree_name"] or "",
+                tree["git_repository_branch"] or "",
+                tree["git_repository_url"] or "",
+            )
             trees.append(
                 Tree(
-                    index=str(idx),
+                    index=tree_index,
                     tree_name=tree["tree_name"],
                     origin=tree["origin"],
                     git_repository_branch=tree["git_repository_branch"],

backend/kernelCI_app/queries/hardware.py

@@ -1,5 +1,6 @@
 from collections import defaultdict
 
+from kernelCI_app.constants.hardwareDetails import make_tree_key
 from kernelCI_app.typeModels.common import StatusCount
 from kernelCI_app.typeModels.commonDetails import (
     TestArchSummaryItem,
@@ -10,8 +11,13 @@
 
 def create_tree(**overrides):
     """Create Tree."""
+    tree_name = overrides.get("tree_name", "mainline")
+    branch = overrides.get("git_repository_branch", "master")
+    url = overrides.get("git_repository_url", "https://git.kernel.org")
+    default_index = make_tree_key(tree_name, branch, url)
+
     base_tree = Tree(
-        index="1",
+        index=overrides.get("index", default_index),
         origin="test",
         tree_name="mainline",
         git_repository_branch="master",
@@ -29,12 +35,16 @@ def create_tree(**overrides):
     return base_tree
 
 
+BASE_TREE_KEY = make_tree_key("mainline", "master", "https://git.kernel.org")
+DIFF_TREE_KEY = make_tree_key("stable", "linux-5.4.y", "https://git.kernel.org")
+
+
 def create_tree_status_summary(**overrides):
     """Create tree status summary."""
     summary = defaultdict(lambda: defaultdict(lambda: defaultdict(int)))
 
-    summary["1"]["builds"]["PASS"] = 5
-    summary["2"]["builds"]["FAIL"] = 2
+    summary[BASE_TREE_KEY]["builds"]["PASS"] = 5
+    summary[DIFF_TREE_KEY]["builds"]["FAIL"] = 2
 
     for tree_id, tree_data in overrides.items():
         for category, status_data in tree_data.items():
@@ -127,7 +137,6 @@ def create_test_summary(**overrides):
 base_tree = create_tree()
 
 tree_with_different_commit = create_tree(
-    index="2",
     tree_name="stable",
     git_repository_branch="linux-5.4.y",
     head_git_commit_name="commit2",

backend/kernelCI_app/tests/unitTests/helpers/fixtures/hardware_details_data.py

@@ -41,6 +41,8 @@
     update_issues,
 )
 from kernelCI_app.tests.unitTests.helpers.fixtures.hardware_details_data import (
+    BASE_TREE_KEY,
+    DIFF_TREE_KEY,
     base_tree,
     base_tree_status_summary,
     create_test_summary,
@@ -126,9 +128,24 @@ def test_get_displayed_commit_with_head_tree_value(self):
 
 class TestGetTreesWithSelectedCommit:
     def test_get_trees_with_selected_commit(self):
-        """Test get_trees_with_selected_commit function."""
+        """Test get_trees_with_selected_commit function with stable keys."""
         trees = [base_tree, tree_with_different_commit]
-        selected_commits = {"1": "custom123", "2": None}
+        selected_commits = {BASE_TREE_KEY: "custom123", DIFF_TREE_KEY: None}
+
+        result = get_trees_with_selected_commit(
+            trees=trees, selected_commits=selected_commits
+        )
+
+        assert len(result) == 2
+        assert result[0].head_git_commit_hash == "custom123"
+        assert result[0].is_selected is True
+        assert result[1].head_git_commit_hash == "def456"
+        assert result[1].is_selected is False
+
+    def test_get_trees_with_selected_commit_legacy_numeric_keys(self):
+        """Test backward compat: numeric keys still work for one release."""
+        trees = [base_tree, tree_with_different_commit]
+        selected_commits = {"0": "custom123"}
 
         result = get_trees_with_selected_commit(
             trees=trees, selected_commits=selected_commits

backend/kernelCI_app/tests/unitTests/helpers/hardwareDetails_helpers_test.py

@@ -79,7 +79,7 @@ class CommitHistoryValidCheckout(BaseModel):
 
 
 class Tree(BaseModel):
-    index: str
+    index: str = Field(description=DocStrings.HARDWARE_DETAILS_TREE_INDEX_DESCRIPTION)
     origin: Origin
     tree_name: Optional[str]
     git_repository_branch: Optional[str]

backend/kernelCI_app/typeModels/hardwareDetails.py

@@ -13,6 +13,7 @@
 from rest_framework.views import APIView
 
 from kernelCI_app.constants.general import UNKNOWN_STRING
+from kernelCI_app.constants.hardwareDetails import make_tree_key
 from kernelCI_app.constants.localization import ClientStrings
 from kernelCI_app.helpers.errorHandling import create_api_error_response
 from kernelCI_app.helpers.filters import (
@@ -366,8 +367,12 @@ def aggregate_common(
                 t.head_git_commit_name or "",
             ),
         )
-        for i, tree in enumerate(sorted_trees):
-            tree.index = str(i)
+        for tree in sorted_trees:
+            tree.index = make_tree_key(
+                tree.tree_name or "",
+                tree.git_repository_branch or "",
+                tree.git_repository_url or "",
+            )
 
         return sorted_trees, sorted(all_compatibles)
 
@@ -469,19 +474,32 @@ def valid_filter_status(self) -> bool:
             )
         )
 
+    def _is_legacy_numeric_keys(self, keys: dict[str, str]) -> bool:
+        return all(k.isdigit() for k in keys)
+
     def select_commits_hashes(
         self,
-        tree_heads: list[(str, str)],
+        tree_heads: list[tuple[str, str]],
         selected_commits: Optional[dict[str, str]] = None,
     ):
         selected_commit_hashes = []
         if selected_commits:
-            for idx, head in tree_heads:
-                if idx in self.selected_commits:
-                    selected_commit = self.selected_commits.get(idx, "head")
-                    selected_commit_hashes.append(
-                        head if selected_commit == "head" else selected_commit
-                    )
+            if self._is_legacy_numeric_keys(self.selected_commits):
+                indexed_heads = list(enumerate(tree_heads))
+                for i, (_, head) in indexed_heads:
+                    str_i = str(i)
+                    if str_i in self.selected_commits:
+                        selected_commit = self.selected_commits.get(str_i, "head")
+                        selected_commit_hashes.append(
+                            head if selected_commit == "head" else selected_commit
+                        )
+            else:
+                for key, head in tree_heads:
+                    if key in self.selected_commits:
+                        selected_commit = self.selected_commits.get(key, "head")
+                        selected_commit_hashes.append(
+                            head if selected_commit == "head" else selected_commit
+                        )
         else:
             selected_commit_hashes = [head for (_, head) in tree_heads]
         return selected_commit_hashes

backend/kernelCI_app/views/hardwareDetailsSummaryView.py

@@ -2849,7 +2849,13 @@ components:
         selectedCommits:
           additionalProperties:
             type: string
-          description: Dictionary mapping tree names to selected commit hashes
+          description: Dictionary mapping stable tree keys to selected commit hashes.
+            Keys are the first 14 hexadecimal characters of SHA-256 over 'tree_name|git_repository_branch|git_repository_url',
+            matching Tree.index values returned by the hardware details endpoints.
+            Values are a git commit hash or 'head' to use the tree head commit. An
+            empty object selects all trees with their head commits. Legacy clients
+            may send numeric string keys ('0', '1', ...) that map to trees by position
+            in the sorted tree list.
           title: Selectedcommits
           type: object
         filter:
@@ -3885,7 +3891,7 @@ components:
         id:
           $ref: '#/components/schemas/Test__Id'
         status:
-          $ref: '#/components/schemas/Test__Status'
+          $ref: '#/components/schemas/StatusValues'
         git_commit_hash:
           $ref: '#/components/schemas/Checkout__GitCommitHash'
       required:
@@ -4052,6 +4058,8 @@ components:
     Tree:
       properties:
         index:
+          description: Stable identifier for a tree, derived as the first 14 hexadecimal
+            characters of SHA-256 over 'tree_name|git_repository_branch|git_repository_url'
           title: Index
           type: string
         origin: