API Improvements: Fix typings for various files pt2

Author: JerrySentry

core/commands/repository/repository.py

@@ -1,5 +1,5 @@
 import uuid
-from typing import Optional
+from typing import Awaitable, Optional
 
 from codecov.commands.base import BaseCommand
 from codecov_auth.models import Owner
@@ -38,7 +38,7 @@ def regenerate_repository_upload_token(
         self,
         repo_name: str,
         owner_username: str,
-    ) -> uuid.UUID:
+    ) -> Awaitable[uuid.UUID]:
         return self.get_interactor(RegenerateRepositoryUploadTokenInteractor).execute(
             repo_name, owner_username
         )

graphql_api/types/mutation/erase_repository/erase_repository.py

@@ -1,4 +1,7 @@
+from typing import Any, Dict
+
 from ariadne import UnionType
+from graphql import GraphQLResolveInfo
 
 from graphql_api.helpers.mutation import (
     require_authenticated,
@@ -9,7 +12,9 @@
 
 @wrap_error_handling_mutation
 @require_authenticated
-async def resolve_erase_repository(_, info, input) -> None:
+async def resolve_erase_repository(
+    _: Any, info: GraphQLResolveInfo, input: Dict[str, Any]
+) -> None:
     command = info.context["executor"].get_command("repository")
     current_owner = info.context["request"].current_owner
     repo_name = input.get("repo_name")

graphql_api/types/mutation/regenerate_repository_upload_token/regenerate_repository_upload_token.py

@@ -1,4 +1,8 @@
+import uuid
+from typing import Any, Dict
+
 from ariadne import UnionType
+from graphql import GraphQLResolveInfo
 
 from core.commands.repository.repository import RepositoryCommands
 from graphql_api.helpers.mutation import (
@@ -10,11 +14,13 @@
 
 @wrap_error_handling_mutation
 @require_authenticated
-async def resolve_regenerate_repository_upload_token(_, info, input):
+async def resolve_regenerate_repository_upload_token(
+    _: Any, info: GraphQLResolveInfo, input: Dict[str, str]
+) -> Dict[str, uuid.UUID]:
     command: RepositoryCommands = info.context["executor"].get_command("repository")
     token = await command.regenerate_repository_upload_token(
-        repo_name=input.get("repo_name"),
-        owner_username=input.get("owner"),
+        repo_name=input.get("repo_name", ""),
+        owner_username=input.get("owner", ""),
     )
 
     return {"token": token}

graphql_api/types/repository/repository.py

@@ -1,6 +1,6 @@
 import logging
 from datetime import datetime
-from typing import List, Optional
+from typing import Any, Dict, List, Optional
 
 import shared.rate_limits as rate_limits
 import yaml
@@ -9,8 +9,8 @@
 from graphql.type.definition import GraphQLResolveInfo
 
 from codecov.db import sync_to_async
-from codecov_auth.models import SERVICE_GITHUB, SERVICE_GITHUB_ENTERPRISE
-from core.models import Branch, Repository
+from codecov_auth.models import SERVICE_GITHUB, SERVICE_GITHUB_ENTERPRISE, Owner
+from core.models import Branch, Commit, Pull, Repository
 from graphql_api.actions.commits import repo_commits
 from graphql_api.dataloader.commit import CommitLoader
 from graphql_api.dataloader.owner import OwnerLoader
@@ -21,6 +21,7 @@
     CoverageAnalyticsProps,
 )
 from graphql_api.types.enums import OrderingDirection
+from graphql_api.types.enums.enum_types import PullRequestState
 from graphql_api.types.errors.errors import NotFoundError, OwnerNotActivatedError
 from services.profiling import CriticalFile, ProfilingSummary
 from services.redis_configuration import get_redis_connection
@@ -59,18 +60,18 @@ def resolve_branch(
 
 
 @repository_bindable.field("author")
-def resolve_author(repository: Repository, info: GraphQLResolveInfo):
+def resolve_author(repository: Repository, info: GraphQLResolveInfo) -> Owner:
     return OwnerLoader.loader(info).load(repository.author_id)
 
 
 @repository_bindable.field("commit")
-def resolve_commit(repository: Repository, info: GraphQLResolveInfo, id):
+def resolve_commit(repository: Repository, info: GraphQLResolveInfo, id: int) -> Commit:
     loader = CommitLoader.loader(info, repository.pk)
     return loader.load(id)
 
 
 @repository_bindable.field("uploadToken")
-def resolve_upload_token(repository: Repository, info: GraphQLResolveInfo):
+def resolve_upload_token(repository: Repository, info: GraphQLResolveInfo) -> str:
     should_hide_tokens = settings.HIDE_ALL_CODECOV_TOKENS
 
     current_owner = info.context["request"].current_owner
@@ -86,7 +87,7 @@ def resolve_upload_token(repository: Repository, info: GraphQLResolveInfo):
 
 
 @repository_bindable.field("pull")
-def resolve_pull(repository: Repository, info: GraphQLResolveInfo, id):
+def resolve_pull(repository: Repository, info: GraphQLResolveInfo, id: int) -> Pull:
     command = info.context["executor"].get_command("pull")
     return command.fetch_pull_request(repository, id)
 
@@ -95,10 +96,10 @@ def resolve_pull(repository: Repository, info: GraphQLResolveInfo, id):
 async def resolve_pulls(
     repository: Repository,
     info: GraphQLResolveInfo,
-    filters=None,
-    ordering_direction=OrderingDirection.DESC,
-    **kwargs,
-):
+    filters: Optional[Dict[str, List[PullRequestState]]] = None,
+    ordering_direction: Optional[OrderingDirection] = OrderingDirection.DESC,
+    **kwargs: Any,
+) -> List[Pull]:
     command = info.context["executor"].get_command("pull")
     queryset = await command.fetch_pull_requests(repository, filters)
     return await queryset_to_connection(
@@ -111,8 +112,11 @@ async def resolve_pulls(
 
 @repository_bindable.field("commits")
 async def resolve_commits(
-    repository: Repository, info: GraphQLResolveInfo, filters=None, **kwargs
-):
+    repository: Repository,
+    info: GraphQLResolveInfo,
+    filters: Optional[Dict[str, Any]] = None,
+    **kwargs: Any,
+) -> List[Commit]:
     queryset = await sync_to_async(repo_commits)(repository, filters)
     connection = await queryset_to_connection(
         queryset,
@@ -132,8 +136,11 @@ async def resolve_commits(
 
 @repository_bindable.field("branches")
 async def resolve_branches(
-    repository: Repository, info: GraphQLResolveInfo, filters=None, **kwargs
-):
+    repository: Repository,
+    info: GraphQLResolveInfo,
+    filters: Optional[Dict[str, str | bool]] = None,
+    **kwargs: Any,
+) -> List[Branch]:
     command = info.context["executor"].get_command("branch")
     queryset = await command.fetch_branches(repository, filters)
     return await queryset_to_connection(
@@ -145,18 +152,20 @@ async def resolve_branches(
 
 
 @repository_bindable.field("defaultBranch")
-def resolve_default_branch(repository: Repository, info: GraphQLResolveInfo):
+def resolve_default_branch(repository: Repository, info: GraphQLResolveInfo) -> str:
     return repository.branch
 
 
 @repository_bindable.field("profilingToken")
-def resolve_profiling_token(repository: Repository, info: GraphQLResolveInfo):
+def resolve_profiling_token(repository: Repository, info: GraphQLResolveInfo) -> str:
     command = info.context["executor"].get_command("repository")
     return command.get_repository_token(repository, token_type="profiling")
 
 
 @repository_bindable.field("staticAnalysisToken")
-def resolve_static_analysis_token(repository: Repository, info: GraphQLResolveInfo):
+def resolve_static_analysis_token(
+    repository: Repository, info: GraphQLResolveInfo
+) -> str:
     command = info.context["executor"].get_command("repository")
     return command.get_repository_token(repository, token_type="static_analysis")
 
@@ -178,20 +187,24 @@ def resolve_critical_files(
 
 
 @repository_bindable.field("graphToken")
-def resolve_graph_token(repository: Repository, info: GraphQLResolveInfo):
+def resolve_graph_token(repository: Repository, info: GraphQLResolveInfo) -> str:
     return repository.image_token
 
 
 @repository_bindable.field("yaml")
-def resolve_repo_yaml(repository: Repository, info: GraphQLResolveInfo):
+def resolve_repo_yaml(
+    repository: Repository, info: GraphQLResolveInfo
+) -> Optional[str]:
     if repository.yaml is None:
         return None
     return yaml.dump(repository.yaml)
 
 
 @repository_bindable.field("bot")
 @sync_to_async
-def resolve_repo_bot(repository: Repository, info: GraphQLResolveInfo):
+def resolve_repo_bot(
+    repository: Repository, info: GraphQLResolveInfo
+) -> Optional[Owner]:
     return repository.bot
 
 
@@ -212,7 +225,9 @@ def resolve_is_ats_configured(repository: Repository, info: GraphQLResolveInfo)
 
 
 @repository_bindable.field("repositoryConfig")
-def resolve_repository_config(repository: Repository, info: GraphQLResolveInfo):
+def resolve_repository_config(
+    repository: Repository, info: GraphQLResolveInfo
+) -> Repository:
     return repository
 
 
@@ -251,7 +266,7 @@ def resolve_coverage_enabled(
 
 
 @repository_result_bindable.type_resolver
-def resolve_repository_result_type(obj, *_):
+def resolve_repository_result_type(obj: Any, *_: Any) -> Optional[str]:
     if isinstance(obj, Repository):
         return "Repository"
     elif isinstance(obj, OwnerNotActivatedError):
@@ -262,7 +277,9 @@ def resolve_repository_result_type(obj, *_):
 
 @repository_bindable.field("isFirstPullRequest")
 @sync_to_async
-def resolve_is_first_pull_request(repository: Repository, info) -> bool:
+def resolve_is_first_pull_request(
+    repository: Repository, info: GraphQLResolveInfo
+) -> bool:
     has_one_pr = repository.pull_requests.count() == 1
 
     if has_one_pr:
@@ -274,7 +291,9 @@ def resolve_is_first_pull_request(repository: Repository, info) -> bool:
 
 @repository_bindable.field("isGithubRateLimited")
 @sync_to_async
-def resolve_is_github_rate_limited(repository: Repository, info) -> bool | None:
+def resolve_is_github_rate_limited(
+    repository: Repository, info: GraphQLResolveInfo
+) -> bool | None:
     if (
         repository.service != SERVICE_GITHUB
         and repository.service != SERVICE_GITHUB_ENTERPRISE

upload/tokenless/github_actions.py

@@ -1,5 +1,6 @@
 import logging
 from datetime import datetime, timedelta
+from typing import Any, Dict
 
 from asgiref.sync import async_to_sync
 from django.conf import settings
@@ -18,7 +19,7 @@ class TokenlessGithubActionsHandler(BaseTokenlessUploadHandler):
     client_id = settings.GITHUB_CLIENT_ID
     client_secret = settings.GITHUB_CLIENT_SECRET
 
-    def log_warning(self, message):
+    def log_warning(self, message: str) -> None:
         log.warning(
             message,
             extra=dict(
@@ -29,7 +30,7 @@ def log_warning(self, message):
             ),
         )
 
-    def get_build(self):
+    def get_build(self) -> Dict[str, Any]:
         git = get(
             "github",
             token=dict(key=self.actions_token),
@@ -73,7 +74,7 @@ def get_build(self):
 
         return actions_response
 
-    def verify(self):
+    def verify(self) -> str:
         if not self.upload_params.get("owner"):
             raise NotFound(
                 'Missing "owner" argument. Please upload with the Codecov repository upload token to resolve issue.'

upload/views/reports.py

@@ -1,8 +1,10 @@
 import logging
+from typing import Any, Callable
 
 from django.http import HttpRequest, HttpResponseNotAllowed
 from rest_framework.exceptions import ValidationError
 from rest_framework.generics import CreateAPIView, ListCreateAPIView, RetrieveAPIView
+from rest_framework.response import Response
 from shared.metrics import inc_counter
 
 from codecov_auth.authentication.repo_auth import (
@@ -14,6 +16,7 @@
     UploadTokenRequiredAuthenticationCheck,
     repo_auth_custom_exception_handler,
 )
+from core.models import Commit, Repository
 from reports.models import CommitReport, ReportResults
 from services.task import TaskService
 from upload.helpers import (
@@ -28,7 +31,9 @@
 log = logging.getLogger(__name__)
 
 
-def create_report(serializer, repository, commit):
+def create_report(
+    serializer: CommitReportSerializer, repository: Repository, commit: Commit
+) -> CommitReport:
     code = serializer.validated_data.get("code")
     if code == "default":
         serializer.validated_data["code"] = None
@@ -55,10 +60,10 @@ class ReportViews(ListCreateAPIView, GetterMixin):
         TokenlessAuthentication,
     ]
 
-    def get_exception_handler(self):
+    def get_exception_handler(self) -> Callable[[Exception, dict[str, Any]], Response]:
         return repo_auth_custom_exception_handler
 
-    def perform_create(self, serializer):
+    def perform_create(self, serializer: CommitReportSerializer) -> CommitReport:
         inc_counter(
             API_UPLOAD_COUNTER,
             labels=generate_upload_prometheus_metrics_labels(
@@ -91,7 +96,9 @@ def perform_create(self, serializer):
         )
         return instance
 
-    def list(self, request: HttpRequest, service: str, repo: str, commit_sha: str):
+    def list(
+        self, request: HttpRequest, service: str, repo: str, commit_sha: str
+    ) -> HttpResponseNotAllowed:
         return HttpResponseNotAllowed(permitted_methods=["POST"])
 
 
@@ -111,10 +118,10 @@ class ReportResultsView(
         TokenlessAuthentication,
     ]
 
-    def get_exception_handler(self):
+    def get_exception_handler(self) -> Callable[[Exception, dict[str, Any]], Response]:
         return repo_auth_custom_exception_handler
 
-    def perform_create(self, serializer):
+    def perform_create(self, serializer: ReportResultsSerializer) -> ReportResults:
         inc_counter(
             API_UPLOAD_COUNTER,
             labels=generate_upload_prometheus_metrics_labels(
@@ -154,7 +161,7 @@ def perform_create(self, serializer):
         )
         return instance
 
-    def get_object(self):
+    def get_object(self) -> ReportResults:
         repository = self.get_repo()
         commit = self.get_commit(repository)
         report = self.get_report(commit)