refactor: unify treeLatest and treeLatestHash

MarceloRobert · MarceloRobert · commit 9cd79d2aefe1 · 2025-09-17T09:56:39.000-03:00
Turns the commit_hash to an optional query parameter, allowing the endpoints to be combined. Updated types, documentation, integration tests, and frontend api call. Closes #1476
diff --git a/backend/kernelCI_app/tests/integrationTests/treeLatest_test.py b/backend/kernelCI_app/tests/integrationTests/treeLatest_test.py
@@ -33,52 +33,26 @@
             "android-mainline",
             {
                 "origin": "maestro",
-                "git_commit_hash": "1064be81d694bc2b3c308de6b2951c21a3f89677",
+                "commit_hash": "1064be81d694bc2b3c308de6b2951c21a3f89677",
             },
             False,
         ),
-    ],
-)
-def test_tree_latest(tree_name, git_branch, query, has_error_body):
-    response = client.get_tree_latest(
-        tree_name=tree_name, git_branch=git_branch, query=query
-    )
-    content = string_to_json(response.content.decode())
-    assert_status_code_and_error_response(
-        response=response,
-        content=content,
-        status_code=HTTPStatus.OK,
-        should_error=has_error_body,
-    )
-
-
-@pytest.mark.parametrize(
-    "tree_name, git_branch, commit_hash, query, has_error_body",
-    [
-        (
-            "android",
-            "android-mainline",
-            "8dec85f986c74f6c94895d3b56f518de02f9e820",
-            {},
-            False,
-        ),
         (
             "mainline",
             "master",
-            "c4dce0c094a89b1bc8fde1163342bd6fe29c0370",
-            {"origin": "microsoft"},
+            {
+                "origin": "microsoft",
+                "commit_hash": "c4dce0c094a89b1bc8fde1163342bd6fe29c0370",
+            },
             False,
         ),
-        ("android", "android-mainline", "wrong_hash", {}, True),
-        ("invalid_tree_name", "invalid_branch", "any_hash", {}, True),
+        ("android", "android-mainline", {"commit_hash": "wrong_hash"}, True),
+        ("invalid_tree_name", "invalid_branch", {"commit_hash": "any_hash"}, True),
     ],
 )
-def test_tree_latest_hash(tree_name, git_branch, commit_hash, query, has_error_body):
-    response = client.get_tree_latest_hash(
-        tree_name=tree_name,
-        git_branch=git_branch,
-        commit_hash=commit_hash,
-        query=query,
+def test_tree_latest(tree_name, git_branch, query, has_error_body):
+    response = client.get_tree_latest(
+        tree_name=tree_name, git_branch=git_branch, query=query
     )
     content = string_to_json(response.content.decode())
     assert_status_code_and_error_response(
diff --git a/backend/kernelCI_app/tests/utils/client/treeClient.py b/backend/kernelCI_app/tests/utils/client/treeClient.py
@@ -34,20 +34,6 @@ def get_tree_latest(
         url = self.get_endpoint(path=path, query=query)
         return requests.get(url)
 
-    def get_tree_latest_hash(
-        self, *, tree_name: str, git_branch: str, commit_hash: str, query: dict
-    ) -> requests.Response:
-        path = reverse(
-            "treeLatestHash",
-            kwargs={
-                "tree_name": tree_name,
-                "git_branch": git_branch,
-                "commit_hash": commit_hash,
-            },
-        )
-        url = self.get_endpoint(path=path, query=query)
-        return requests.get(url)
-
     def get_tree_details_summary(
         self,
         *,
diff --git a/backend/kernelCI_app/typeModels/treeDetails.py b/backend/kernelCI_app/typeModels/treeDetails.py
@@ -16,15 +16,15 @@
 class TreeLatestPathParameters(BaseModel):
     tree_name: str = Field(description=DocStrings.TREE_LATEST_TREE_NAME_DESCRIPTION)
     git_branch: str = Field(description=DocStrings.TREE_LATEST_GIT_BRANCH_DESCRIPTION)
-    commit_hash: Optional[str] = Field(
-        description=DocStrings.TREE_LATEST_COMMIT_HASH_DESCRIPTION
-    )
 
 
 class TreeLatestQueryParameters(BaseModel):
     origin: str = Field(
         DEFAULT_ORIGIN, description=DocStrings.TREE_LATEST_ORIGIN_DESCRIPTION
     )
+    commit_hash: Optional[str] = Field(
+        None, description=DocStrings.TREE_LATEST_COMMIT_HASH_DESCRIPTION
+    )
 
 
 class TreeLatestResponse(BaseCheckouts):
diff --git a/backend/kernelCI_app/urls.py b/backend/kernelCI_app/urls.py
@@ -86,13 +86,8 @@ def view_cache(view):
         name="treeDetailsTestsDirectView",
     ),
     path(
-        "tree/<str:tree_name>/<str:git_branch>/<str:commit_hash>",
-        view_cache(views.TreeCheckoutInfo),
-        name="treeLatestHash",
-    ),
-    path(
-        "tree/<str:tree_name>/<str:git_branch>",
-        view_cache(views.TreeLatestCheckout),
+        "tree/<str:tree_name>/<path:git_branch>",
+        view_cache(views.TreeLatest),
         name="treeLatest",
     ),
     path("build/<str:build_id>", view_cache(views.BuildDetails), name="buildDetails"),
diff --git a/backend/kernelCI_app/views/treeLatestView.py b/backend/kernelCI_app/views/treeLatestView.py
@@ -1,19 +1,16 @@
 from http import HTTPStatus
-from typing import Optional
 from urllib.parse import urlencode
 from drf_spectacular.utils import extend_schema
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
-from django.http import JsonResponse
+from django.http import HttpRequest, JsonResponse
 from django.urls import reverse
 from pydantic import ValidationError
 
 from kernelCI_app.constants.general import DEFAULT_ORIGIN
-from kernelCI_app.helpers.errorHandling import create_api_error_response
 from kernelCI_app.queries.tree import get_latest_tree
 from kernelCI_app.typeModels.commonOpenApiParameters import (
-    COMMIT_HASH_PATH_PARAM,
     GIT_BRANCH_PATH_PARAM,
     TREE_NAME_PATH_PARAM,
 )
@@ -25,46 +22,57 @@
 from kernelCI_app.constants.localization import ClientStrings
 
 
-class BaseTreeLatest(APIView):
-
+class TreeLatest(APIView):
+    @extend_schema(
+        responses=TreeLatestResponse,
+        parameters=[
+            TREE_NAME_PATH_PARAM,
+            GIT_BRANCH_PATH_PARAM,
+            TreeLatestQueryParameters,
+        ],
+        methods=["GET"],
+    )
     def get(
         self,
-        request,
+        request: HttpRequest,
         tree_name: str,
         git_branch: str,
-        commit_hash: Optional[str] = None,
     ) -> JsonResponse:
         try:
             parsed_params = TreeLatestPathParameters(
-                tree_name=tree_name, git_branch=git_branch, commit_hash=commit_hash
+                tree_name=tree_name, git_branch=git_branch
             )
+            query_params = TreeLatestQueryParameters(**request.GET.dict())
         except ValidationError as e:
             return Response(data=e.json, status=HTTPStatus.BAD_REQUEST)
 
-        tree_not_found_error_message = ClientStrings.TREE_NOT_FOUND
-        origin = request.GET.get("origin")
-        if origin is None:
-            origin = DEFAULT_ORIGIN
-            tree_not_found_error_message += (
-                f"{ClientStrings.TREE_LATEST_DEFAULT_ORIGIN} {DEFAULT_ORIGIN}"
-            )
+        origin = query_params.origin
 
         tree_data = get_latest_tree(
             tree_name=parsed_params.tree_name,
             git_branch=parsed_params.git_branch,
             origin=origin,
-            git_commit_hash=parsed_params.commit_hash,
+            git_commit_hash=query_params.commit_hash,
         )
 
         if tree_data is None:
-            return create_api_error_response(
-                error_message=tree_not_found_error_message,
-                status_code=HTTPStatus.OK,
+            tree_not_found_error_message = ClientStrings.TREE_NOT_FOUND
+            if request.GET.get("origin") is None:
+                tree_not_found_error_message += (
+                    f" {ClientStrings.TREE_LATEST_DEFAULT_ORIGIN} {DEFAULT_ORIGIN}"
+                )
+
+            params = parsed_params.model_dump()
+            params.update(query_params.model_dump())
+
+            return Response(
+                data={"error": tree_not_found_error_message, "params": params},
+                status=HTTPStatus.OK,
             )
 
         # The `old_api_url` is only used in the backend response in order to
         # keep compatibility with the full treeDetails endpoint in case someone
-        # expects this format. It should be removed soon.
+        # expects this format. It should be removed when we drop the support for the old format.
         # TODO: remove this field from the response.
         old_base_url = reverse(
             "treeDetailsView",
@@ -106,48 +114,3 @@ def get(
             return Response(data=e.json(), status=HTTPStatus.INTERNAL_SERVER_ERROR)
 
         return Response(valid_response.model_dump())
-
-
-class TreeCheckoutInfo(BaseTreeLatest):
-    @extend_schema(
-        responses=TreeLatestResponse,
-        parameters=[
-            COMMIT_HASH_PATH_PARAM,
-            TREE_NAME_PATH_PARAM,
-            GIT_BRANCH_PATH_PARAM,
-            TreeLatestQueryParameters,
-        ],
-        methods=["GET"],
-    )
-    def get(
-        self,
-        request,
-        tree_name: str,
-        git_branch: str,
-        commit_hash: str,
-    ) -> JsonResponse:
-        return super().get(
-            request=request,
-            commit_hash=commit_hash,
-            tree_name=tree_name,
-            git_branch=git_branch,
-        )
-
-
-class TreeLatestCheckout(BaseTreeLatest):
-    @extend_schema(
-        responses=TreeLatestResponse,
-        parameters=[
-            TREE_NAME_PATH_PARAM,
-            GIT_BRANCH_PATH_PARAM,
-            TreeLatestQueryParameters,
-        ],
-        methods=["GET"],
-    )
-    def get(
-        self,
-        request,
-        tree_name: str,
-        git_branch: str,
-    ) -> JsonResponse:
-        return super().get(request=request, tree_name=tree_name, git_branch=git_branch)
diff --git a/backend/requests/tree-latest-get.sh b/backend/requests/tree-latest-get.sh
@@ -1,28 +1,26 @@
-http 'http://localhost:8000/api/tree/android/android-mainline'
-
-# For more specific results, you can use origin parameter or add a git_commit_hash to the route
-http 'http://localhost:8000/api/tree/mainline/master/a33b5a08cbbdd7aadff95f40cbb45ab86841679e' origin==microsoft
+http 'http://localhost:8000/api/tree/mainline/master' origin==microsoft commit_hash==a33b5a08cbbdd7aadff95f40cbb45ab86841679e
 
 # HTTP/1.1 200 OK
 # Allow: GET, HEAD, OPTIONS
 # Cache-Control: max-age=0
-# Content-Length: 489
+# Content-Length: 578
 # Content-Type: application/json
 # Cross-Origin-Opener-Policy: same-origin
-# Date: Thu, 26 Jun 2025 11:51:01 GMT
-# Expires: Thu, 26 Jun 2025 11:51:01 GMT
+# Date: Wed, 17 Sep 2025 11:59:45 GMT
+# Expires: Wed, 17 Sep 2025 11:59:45 GMT
 # Referrer-Policy: same-origin
 # Server: WSGIServer/0.2 CPython/3.12.7
 # Vary: Accept, Cookie, origin
 # X-Content-Type-Options: nosniff
 # X-Frame-Options: DENY
 
 # {
-#     "api_url": "/api/tree/mainline/master/a33b5a08cbbdd7aadff95f40cbb45ab86841679e/full?origin=microsoft&git_url=https%3A%2F%2Fgit.kernel.org%2Fpub%2Fscm%2Flinux%2Fkernel%2Fgit%2Ftorvalds%2Flinux.git&git_branch=master",
+#     "api_url": "/api/tree/mainline/master/a33b5a08cbbdd7aadff95f40cbb45ab86841679e/full?origin=microsoft",
 #     "git_commit_hash": "a33b5a08cbbdd7aadff95f40cbb45ab86841679e",
 #     "git_commit_name": "v6.15-rc3-8-ga33b5a08cbbd",
 #     "git_repository_branch": "master",
 #     "git_repository_url": "https://git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git",
+#     "old_api_url": "/api/tree/a33b5a08cbbdd7aadff95f40cbb45ab86841679e/full?origin=microsoft&git_url=https%3A%2F%2Fgit.kernel.org%2Fpub%2Fscm%2Flinux%2Fkernel%2Fgit%2Ftorvalds%2Flinux.git&git_branch=master",
 #     "origin": "microsoft",
 #     "tree_name": "mainline"
-# }
+# }
diff --git a/backend/schema.yml b/backend/schema.yml
@@ -1286,48 +1286,15 @@ paths:
     get:
       operationId: tree_retrieve_2
       parameters:
-      - in: path
-        name: git_branch
-        schema:
-          type: string
-        description: Git branch name of the tree
-        required: true
       - in: query
-        name: origin
-        schema:
-          default: maestro
-          title: Origin
-          type: string
-        description: Origin filter to retrieve tree information
-      - in: path
-        name: tree_name
-        schema:
-          type: string
-        description: Name of the tree
-        required: true
-      tags:
-      - tree
-      security:
-      - cookieAuth: []
-      - basicAuth: []
-      - {}
-      responses:
-        '200':
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/TreeLatestResponse'
-          description: ''
-  /api/tree/{tree_name}/{git_branch}/{commit_hash}:
-    get:
-      operationId: tree_retrieve_3
-      parameters:
-      - in: path
         name: commit_hash
         schema:
-          type: string
-        description: Commit hash of the tree
-        required: true
+          anyOf:
+          - type: string
+          - type: 'null'
+          default: null
+          title: Commit Hash
+        description: Commit hash to retrieve tree information
       - in: path
         name: git_branch
         schema:
@@ -3185,9 +3152,11 @@ components:
       additionalProperties:
         additionalProperties:
           additionalProperties:
-            items:
-              $ref: '#/components/schemas/RegressionHistoryItem'
-            type: array
+            additionalProperties:
+              items:
+                $ref: '#/components/schemas/RegressionHistoryItem'
+              type: array
+            type: object
           type: object
         type: object
       type: object
diff --git a/dashboard/src/api/tree.ts b/dashboard/src/api/tree.ts
