feat(prevent): create endpoint that fetches repositories list (#95181)

This PR creates and endpoint that fetches a list of repositories
belonging to a specific owner

Notes 
- Added path to access endpoint
- Added query file with GQL query
- Added endpoint logic + its serializer
- Added test file for said logic

Author: adrianviquez

src/sentry/api/urls.py

@@ -78,6 +78,7 @@
 )
 from sentry.api.endpoints.trace_explorer_ai_setup import TraceExplorerAISetup
 from sentry.auth_v2.urls import AUTH_V2_URLS
+from sentry.codecov.endpoints.Repositories.repositories import RepositoriesEndpoint
 from sentry.codecov.endpoints.TestResults.test_results import TestResultsEndpoint
 from sentry.codecov.endpoints.TestResultsAggregates.test_results_aggregates import (
     TestResultsAggregatesEndpoint,
@@ -1066,6 +1067,11 @@ def create_group_urls(name_prefix: str) -> list[URLPattern | URLResolver]:
         TestResultsAggregatesEndpoint.as_view(),
         name="sentry-api-0-test-results-aggregates",
     ),
+    re_path(
+        r"^owner/(?P<owner>[^/]+)/repositories/$",
+        RepositoriesEndpoint.as_view(),
+        name="sentry-api-0-repositories",
+    ),
 ]
 
 

src/sentry/apidocs/parameters.py

@@ -1119,8 +1119,7 @@ class PreventParams:
         location="query",
         required=False,
         type=str,
-        description="""The cursor to start the query from. Will return results after the cursor if used with `first` or before the cursor if used with `last`.
-        """,
+        description="""The cursor to start the query from. Will return results after the cursor if used with `first` or before the cursor if used with `last`.""",
     )
     TERM = OpenApiParameter(
         name="term",

src/sentry/codecov/endpoints/Repositories/query.py

@@ -0,0 +1,38 @@
+query = """query ReposForOwner(
+  $owner: String!
+  $filters: RepositorySetFilters!
+  $ordering: RepositoryOrdering!
+  $direction: OrderingDirection!
+  $first: Int
+  $after: String
+  $last: Int
+  $before: String
+) {
+  owner(username: $owner) {
+    repositories(
+      filters: $filters
+      ordering: $ordering
+      orderingDirection: $direction
+      first: $first
+      after: $after
+      last: $last
+      before: $before
+    ) {
+      edges {
+        node {
+          name
+          updatedAt
+          latestCommitAt
+          defaultBranch
+        }
+      }
+      pageInfo {
+          startCursor
+          endCursor
+          hasNextPage
+          hasPreviousPage
+      }
+      totalCount
+    }
+  }
+}"""

src/sentry/codecov/endpoints/Repositories/repositories.py

@@ -0,0 +1,94 @@
+from drf_spectacular.utils import extend_schema
+from rest_framework import status
+from rest_framework.request import Request
+from rest_framework.response import Response
+
+from sentry.api.api_owners import ApiOwner
+from sentry.api.api_publish_status import ApiPublishStatus
+from sentry.api.base import region_silo_endpoint
+from sentry.apidocs.constants import RESPONSE_BAD_REQUEST, RESPONSE_FORBIDDEN, RESPONSE_NOT_FOUND
+from sentry.apidocs.parameters import GlobalParams, PreventParams
+from sentry.codecov.base import CodecovEndpoint
+from sentry.codecov.client import CodecovApiClient
+from sentry.codecov.endpoints.Repositories.query import query
+from sentry.codecov.endpoints.Repositories.serializers import RepositoriesSerializer
+from sentry.codecov.enums import OrderingDirection
+
+MAX_RESULTS_PER_PAGE = 50
+
+
+@extend_schema(tags=["Prevent"])
+@region_silo_endpoint
+class RepositoriesEndpoint(CodecovEndpoint):
+    __test__ = False
+
+    owner = ApiOwner.CODECOV
+    publish_status = {
+        "GET": ApiPublishStatus.PUBLIC,
+    }
+
+    @extend_schema(
+        operation_id="Retrieves repository list for a given owner",
+        parameters=[
+            GlobalParams.ORG_ID_OR_SLUG,
+            PreventParams.OWNER,
+            PreventParams.FIRST,
+            PreventParams.LAST,
+            PreventParams.CURSOR,
+            PreventParams.TERM,
+        ],
+        request=None,
+        responses={
+            200: RepositoriesSerializer,
+            400: RESPONSE_BAD_REQUEST,
+            403: RESPONSE_FORBIDDEN,
+            404: RESPONSE_NOT_FOUND,
+        },
+    )
+    def get(self, request: Request, owner: str, **kwargs) -> Response:
+        """
+        Retrieves repository data for a given owner.
+        """
+
+        first_param = request.query_params.get("first")
+        last_param = request.query_params.get("last")
+        cursor = request.query_params.get("cursor")
+
+        # When calling request.query_params, the URL is decoded so + is replaced with spaces. We need to change them back so Codecov can properly fetch the next page.
+        if cursor:
+            cursor = cursor.replace(" ", "+")
+
+        try:
+            first = int(first_param) if first_param is not None else None
+            last = int(last_param) if last_param is not None else None
+        except ValueError:
+            return Response(
+                status=status.HTTP_400_BAD_REQUEST,
+                data={"details": "Query parameters 'first' and 'last' must be integers."},
+            )
+
+        if first is not None and last is not None:
+            return Response(
+                status=status.HTTP_400_BAD_REQUEST,
+                data={"details": "Cannot specify both `first` and `last`"},
+            )
+
+        if first is None and last is None:
+            first = MAX_RESULTS_PER_PAGE
+
+        variables = {
+            "owner": owner,
+            "filters": {"term": request.query_params.get("term")},
+            "direction": OrderingDirection.DESC.value,
+            "ordering": "COMMIT_DATE",
+            "first": first,
+            "last": last,
+            "before": cursor if cursor and last else None,
+            "after": cursor if cursor and first else None,
+        }
+
+        client = CodecovApiClient(git_provider_org=owner)
+        graphql_response = client.query(query=query, variables=variables)
+        repositories = RepositoriesSerializer().to_representation(graphql_response.json())
+
+        return Response(repositories)

src/sentry/codecov/endpoints/Repositories/serializers.py

@@ -0,0 +1,88 @@
+import logging
+
+import sentry_sdk
+from rest_framework import serializers
+
+logger = logging.getLogger(__name__)
+
+
+class RepositoryNodeSerializer(serializers.Serializer):
+    """
+    Serializer for individual repository nodes from GraphQL response
+    """
+
+    __test__ = False
+
+    name = serializers.CharField()
+    updatedAt = serializers.DateTimeField()
+    latestCommitAt = serializers.DateTimeField()
+    defaultBranch = serializers.CharField()
+
+
+class PageInfoTempSerializer(serializers.Serializer):
+    """
+    Serializer for pagination information
+    """
+
+    startCursor = serializers.CharField(allow_null=True)
+    endCursor = serializers.CharField(allow_null=True)
+    hasNextPage = serializers.BooleanField()
+    hasPreviousPage = serializers.BooleanField()
+
+
+class RepositoriesSerializer(serializers.Serializer):
+    """
+    Serializer for repositories response
+    """
+
+    __test__ = False
+
+    results = RepositoryNodeSerializer(many=True)
+    pageInfo = PageInfoTempSerializer()
+    totalCount = serializers.IntegerField()
+
+    def to_representation(self, graphql_response):
+        """
+        Transform the GraphQL response to the serialized format
+        """
+        try:
+            repository_data = graphql_response["data"]["owner"]["repositories"]
+            repositories = repository_data["edges"]
+            page_info = repository_data.get("pageInfo", {})
+
+            nodes = []
+            for edge in repositories:
+                node = edge["node"]
+                nodes.append(node)
+
+            response_data = {
+                "results": nodes,
+                "pageInfo": repository_data.get(
+                    "pageInfo",
+                    {
+                        "hasNextPage": page_info.get("hasNextPage", False),
+                        "hasPreviousPage": page_info.get("hasPreviousPage", False),
+                        "startCursor": page_info.get("startCursor"),
+                        "endCursor": page_info.get("endCursor"),
+                    },
+                ),
+                "totalCount": repository_data.get("totalCount", len(nodes)),
+            }
+
+            return super().to_representation(response_data)
+
+        except (KeyError, TypeError) as e:
+            sentry_sdk.capture_exception(e)
+            logger.exception(
+                "Error parsing GraphQL response",
+                extra={
+                    "error": str(e),
+                    "endpoint": "repositories",
+                    "response_keys": (
+                        list(graphql_response.keys())
+                        if isinstance(graphql_response, dict)
+                        else None
+                    ),
+                },
+            )
+            raise