[engine] Fix some type hints when request is passed (#9077)

Since we are adding custom attributes to the request object (such as
`uuid` or `iam_context`), using the `Request` type is no longer
appropriate.

changelog.d/20250212_115404_maria_fix_type_annotation.md

@@ -0,0 +1,4 @@
+### Fixed
+
+- 500 status code returned by API endpoints that support TUS OPTIONS requests
+  (<https://github.com/cvat-ai/cvat/pull/9077>)

cvat/apps/engine/background.py

@@ -16,7 +16,6 @@
 from django.utils import timezone
 from django_rq.queues import DjangoRQ, DjangoScheduler
 from rest_framework import serializers, status
-from rest_framework.request import Request
 from rest_framework.response import Response
 from rest_framework.reverse import reverse
 from rq.job import Job as RQJob
@@ -40,6 +39,7 @@
 from cvat.apps.engine.permissions import get_cloud_storage_for_import_or_export
 from cvat.apps.engine.rq_job_handler import RQId, RQJobMetaField
 from cvat.apps.engine.serializers import RqIdSerializer
+from cvat.apps.engine.types import ExtendedRequest
 from cvat.apps.engine.utils import (
     build_annotations_file_name,
     build_backup_file_name,
@@ -180,7 +180,7 @@ def location(self) -> Location:
     def __init__(
         self,
         db_instance: Union[models.Project, models.Task, models.Job],
-        request: Request,
+        request: ExtendedRequest,
         export_callback: Callable,
         save_images: Optional[bool] = None,
         *,
@@ -525,7 +525,7 @@ def location(self) -> Location:
     def __init__(
         self,
         db_instance: Union[models.Project, models.Task],
-        request: Request,
+        request: ExtendedRequest,
         *,
         version: int = 2,
     ) -> None:

cvat/apps/engine/backup.py

@@ -86,6 +86,7 @@
     ValidationParamsSerializer,
 )
 from cvat.apps.engine.task import JobFileMapping, _create_thread
+from cvat.apps.engine.types import ExtendedRequest
 from cvat.apps.engine.utils import (
     av_scan_paths,
     define_dependent_job,
@@ -1179,7 +1180,16 @@ def create_backup(
         log_exception(logger)
         raise
 
-def _import(importer, request, queue, rq_id, Serializer, file_field_name, location_conf, filename=None):
+def _import(
+    importer: TaskImporter | ProjectImporter,
+    request: ExtendedRequest,
+    queue: django_rq.queues.DjangoRQ,
+    rq_id: str,
+    Serializer: type[TaskFileSerializer] | type[ProjectFileSerializer],
+    file_field_name: str,
+    location_conf: dict,
+    filename: str | None = None,
+):
     rq_job = queue.fetch_job(rq_id)
 
     if (user_id_from_meta := getattr(rq_job, 'meta', {}).get(RQJobMetaField.USER, {}).get('id')) and user_id_from_meta != request.user.id:
@@ -1267,7 +1277,7 @@ def _import(importer, request, queue, rq_id, Serializer, file_field_name, locati
 def get_backup_dirname():
     return TmpDirManager.TMP_ROOT
 
-def import_project(request, queue_name, filename=None):
+def import_project(request: ExtendedRequest, queue_name: str, filename: str | None = None):
     if 'rq_id' in request.data:
         rq_id = request.data['rq_id']
     else:
@@ -1296,7 +1306,7 @@ def import_project(request, queue_name, filename=None):
         filename=filename
     )
 
-def import_task(request, queue_name, filename=None):
+def import_task(request: ExtendedRequest, queue_name: str, filename: str | None = None):
     rq_id = request.data.get('rq_id', RQId(
         RequestAction.IMPORT, RequestTarget.TASK, uuid.uuid4(),
         subresource=RequestSubresource.BACKUP,

cvat/apps/engine/filters.py

@@ -21,7 +21,8 @@
 from rest_framework import filters
 from rest_framework.compat import coreapi, coreschema
 from rest_framework.exceptions import ValidationError
-from rest_framework.request import Request
+
+from cvat.apps.engine.types import ExtendedRequest
 
 DEFAULT_FILTER_FIELDS_ATTR = 'filter_fields'
 DEFAULT_LOOKUP_MAP_ATTR = 'lookup_fields'
@@ -39,7 +40,7 @@ def get_lookup_fields(view, fields: Optional[Iterator[str]] = None) -> dict[str,
 
 
 class SearchFilter(filters.SearchFilter):
-    def get_search_fields(self, view, request):
+    def get_search_fields(self, view, request: ExtendedRequest):
         search_fields = getattr(view, 'search_fields') or []
         return get_lookup_fields(view, search_fields).values()
 
@@ -82,7 +83,7 @@ class OrderingFilter(filters.OrderingFilter):
     ordering_param = 'sort'
     reverse_flag = "-"
 
-    def get_ordering(self, request, queryset, view):
+    def get_ordering(self, request: ExtendedRequest, queryset, view):
         ordering = []
         lookup_fields = self._get_lookup_fields(request, queryset, view)
         for term in super().get_ordering(request, queryset, view):
@@ -94,7 +95,7 @@ def get_ordering(self, request, queryset, view):
 
         return ordering
 
-    def _get_lookup_fields(self, request, queryset, view):
+    def _get_lookup_fields(self, request: ExtendedRequest, queryset: QuerySet, view):
         ordering_fields = self.get_valid_fields(queryset, view, {'request': request})
         ordering_fields = [v[0] for v in ordering_fields]
         return get_lookup_fields(view, ordering_fields)
@@ -201,7 +202,7 @@ def apply_filter(self,
 
         return queryset.filter(q_object)
 
-    def filter_queryset(self, request, queryset, view):
+    def filter_queryset(self, request: ExtendedRequest, queryset: QuerySet, view):
         json_rules = request.query_params.get(self.filter_param)
         if json_rules:
             parsed_rules = self._parse_query(json_rules)
@@ -413,7 +414,7 @@ def get_schema_operation_parameters(self, view):
                 parameters.append(parameter)
         return parameters
 
-    def filter_queryset(self, request: Request, queryset: Iterable, view):
+    def filter_queryset(self, request: ExtendedRequest, queryset: Iterable, view):
         filtered_queryset = queryset
 
         query_params = request.query_params
@@ -455,7 +456,7 @@ class NonModelOrderingFilter(OrderingFilter, _NestedAttributeHandler):
     ?sort=-field1,-field2
     """
 
-    def get_ordering(self, request, queryset, view) -> tuple[list[str], bool]:
+    def get_ordering(self, request: ExtendedRequest, queryset: Iterable, view) -> tuple[list[str], bool]:
         ordering = super().get_ordering(request, queryset, view)
         result, reverse = [], False
         for field in ordering:
@@ -466,7 +467,7 @@ def get_ordering(self, request, queryset, view) -> tuple[list[str], bool]:
 
         return result, reverse
 
-    def filter_queryset(self, request: Request, queryset: Iterable, view) -> Iterable:
+    def filter_queryset(self, request: ExtendedRequest, queryset: Iterable, view) -> Iterable:
         ordering, reverse = self.get_ordering(request, queryset, view)
 
         if ordering:
@@ -521,7 +522,7 @@ def _apply_filter(self, rules, lookup_fields, obj):
         else:
             raise ValidationError(f'filter: {op} operation with {args} arguments is not implemented')
 
-    def filter_queryset(self, request: Request, queryset: Iterable, view) -> Iterable:
+    def filter_queryset(self, request: ExtendedRequest, queryset: Iterable, view) -> Iterable:
         filtered_queryset = queryset
         json_rules = request.query_params.get(self.filter_param)
         if json_rules:

cvat/apps/engine/middleware.py

@@ -2,9 +2,14 @@
 #
 # SPDX-License-Identifier: MIT
 
+from typing import Protocol
 from uuid import uuid4
 
 
+class WithUUID(Protocol):
+    uuid: str
+
+
 class RequestTrackingMiddleware:
     def __init__(self, get_response):
         self.get_response = get_response

cvat/apps/engine/mixins.py

@@ -20,7 +20,6 @@
 import django_rq
 from attr.converters import to_bool
 from django.conf import settings
-from django.http import HttpRequest
 from drf_spectacular.types import OpenApiTypes
 from drf_spectacular.utils import OpenApiParameter, OpenApiResponse, extend_schema
 from rest_framework import mixins, status
@@ -33,9 +32,18 @@
 from cvat.apps.engine.handlers import clear_import_cache
 from cvat.apps.engine.location import StorageType, get_location_configuration
 from cvat.apps.engine.log import ServerLogManager
-from cvat.apps.engine.models import Location, RequestAction, RequestSubresource, RequestTarget
+from cvat.apps.engine.models import (
+    Job,
+    Location,
+    Project,
+    RequestAction,
+    RequestSubresource,
+    RequestTarget,
+    Task,
+)
 from cvat.apps.engine.rq_job_handler import RQId
 from cvat.apps.engine.serializers import DataSerializer, RqIdSerializer
+from cvat.apps.engine.types import ExtendedRequest
 from cvat.apps.engine.utils import is_dataset_export
 
 slogger = ServerLogManager(__name__)
@@ -159,7 +167,7 @@ def create_file(metadata, file_size, upload_dir):
         return tus_file
 
 class TusChunk:
-    def __init__(self, request):
+    def __init__(self, request: ExtendedRequest):
         self.META = request.META
         self.offset = int(request.META.get("HTTP_UPLOAD_OFFSET", 0))
         self.size = int(request.META.get("CONTENT_LENGTH", settings.TUS_DEFAULT_CHUNK_SIZE))
@@ -215,7 +223,7 @@ def _tus_response(self, status, data=None, extra_headers=None):
                 response.__setitem__(key, value)
         return response
 
-    def _get_metadata(self, request):
+    def _get_metadata(self, request: ExtendedRequest):
         metadata = {}
         if request.META.get("HTTP_UPLOAD_METADATA"):
             for kv in request.META.get("HTTP_UPLOAD_METADATA").split(","):
@@ -230,7 +238,7 @@ def _get_metadata(self, request):
                     metadata[splited_metadata[0]] = ""
         return metadata
 
-    def upload_data(self, request):
+    def upload_data(self, request: ExtendedRequest):
         tus_request = request.headers.get('Upload-Length', None) is not None or request.method == 'OPTIONS'
         bulk_file_upload = request.headers.get('Upload-Multiple', None) is not None
         start_upload = request.headers.get('Upload-Start', None) is not None
@@ -247,9 +255,9 @@ def upload_data(self, request):
         else: # backward compatibility case - no upload headers were found
             return self.upload_finished(request)
 
-    def init_tus_upload(self, request):
+    def init_tus_upload(self, request: ExtendedRequest):
         if request.method == 'OPTIONS':
-            return self._tus_response(status=status.HTTP_204)
+            return self._tus_response(status=status.HTTP_204_NO_CONTENT)
         else:
             metadata = self._get_metadata(request)
             filename = metadata.get('filename', '')
@@ -321,7 +329,7 @@ def init_tus_upload(self, request):
                 extra_headers={'Location': urljoin(location, tus_file.file_id),
                                'Upload-Filename': tus_file.filename})
 
-    def append_tus_chunk(self, request, file_id):
+    def append_tus_chunk(self, request: ExtendedRequest, file_id: str):
         tus_file = TusFile(str(file_id), self.get_upload_dir())
         if request.method == 'HEAD':
             if tus_file.exists():
@@ -361,12 +369,12 @@ def is_valid_uploaded_file_name(self, filename: str) -> bool:
     def get_upload_dir(self) -> str:
         return self._object.data.get_upload_dirname()
 
-    def _get_request_client_files(self, request):
+    def _get_request_client_files(self, request: ExtendedRequest):
         serializer = DataSerializer(self._object, data=request.data)
         serializer.is_valid(raise_exception=True)
         return serializer.validated_data.get('client_files')
 
-    def append_files(self, request):
+    def append_files(self, request: ExtendedRequest):
         """
         Processes a single or multiple files sent in a single request inside
         a file uploading session.
@@ -385,13 +393,13 @@ def append_files(self, request):
                     destination.write(client_file['file'].read())
         return Response(status=status.HTTP_200_OK)
 
-    def upload_started(self, request):
+    def upload_started(self, request: ExtendedRequest):
         """
         Allows to do actions before upcoming file uploading.
         """
         return Response(status=status.HTTP_202_ACCEPTED)
 
-    def upload_finished(self, request):
+    def upload_finished(self, request: ExtendedRequest):
         """
         Allows to process uploaded files.
         """
@@ -405,22 +413,22 @@ class PartialUpdateModelMixin:
     Almost the same as UpdateModelMixin, but has no public PUT / update() method.
     """
 
-    def _update(self, request, *args, **kwargs):
+    def _update(self, request: ExtendedRequest, *args, **kwargs):
         # This method must not be named "update" not to be matched with the PUT method
         return mixins.UpdateModelMixin.update(self, request, *args, **kwargs)
 
     def perform_update(self, serializer):
         mixins.UpdateModelMixin.perform_update(self, serializer=serializer)
 
-    def partial_update(self, request, *args, **kwargs):
+    def partial_update(self, request: ExtendedRequest, *args, **kwargs):
         with mock.patch.object(self, 'update', new=self._update, create=True):
             return mixins.UpdateModelMixin.partial_update(self, request=request, *args, **kwargs)
 
 
 class DatasetMixin:
     def export_dataset_v1(
         self,
-        request,
+        request: ExtendedRequest,
         save_images: bool,
         *,
         get_data: Optional[Callable[[int], dict[str, Any]]] = None,
@@ -466,7 +474,7 @@ def export_dataset_v1(
         },
     )
     @action(detail=True, methods=['POST'], serializer_class=None, url_path='dataset/export')
-    def export_dataset_v2(self, request: HttpRequest, pk: int):
+    def export_dataset_v2(self, request: ExtendedRequest, pk: int):
         self._object = self.get_object() # force call of check_object_permissions()
 
         save_images = is_dataset_export(request)
@@ -476,7 +484,14 @@ def export_dataset_v2(self, request: HttpRequest, pk: int):
         return dataset_export_manager.export()
 
     # FUTURE-TODO: migrate to new API
-    def import_annotations(self, request, db_obj, import_func, rq_func, rq_id_factory):
+    def import_annotations(
+        self,
+        request: ExtendedRequest,
+        db_obj: Project | Task | Job,
+        import_func: Callable[..., None],
+        rq_func: Callable[..., None],
+        rq_id_factory: Callable[..., RQId],
+    ):
         is_tus_request = request.headers.get('Upload-Length', None) is not None or \
             request.method == 'OPTIONS'
         if is_tus_request:
@@ -508,7 +523,7 @@ def import_annotations(self, request, db_obj, import_func, rq_func, rq_id_factor
 
 
 class BackupMixin:
-    def export_backup_v1(self, request: HttpRequest) -> Response:
+    def export_backup_v1(self, request: ExtendedRequest) -> Response:
         db_object = self.get_object() # force to call check_object_permissions
 
         export_backup_manager = BackupExportManager(db_object, request, version=1)
@@ -520,7 +535,7 @@ def export_backup_v1(self, request: HttpRequest) -> Response:
         return response
 
     # FUTURE-TODO: migrate to new API
-    def import_backup_v1(self, request: HttpRequest, import_func: Callable) -> Response:
+    def import_backup_v1(self, request: ExtendedRequest, import_func: Callable) -> Response:
         location = request.query_params.get("location", Location.LOCAL)
         if location == Location.CLOUD_STORAGE:
             file_name = request.query_params.get("filename", "")
@@ -554,7 +569,7 @@ def import_backup_v1(self, request: HttpRequest, import_func: Callable) -> Respo
         },
     )
     @action(detail=True, methods=['POST'], serializer_class=None, url_path='backup/export')
-    def export_backup_v2(self, request: HttpRequest, pk: int):
+    def export_backup_v2(self, request: ExtendedRequest, pk: int):
         db_object = self.get_object() # force to call check_object_permissions
 
         export_backup_manager = BackupExportManager(db_object, request, version=2)

cvat/apps/engine/pagination.py

@@ -6,11 +6,13 @@
 
 from rest_framework.pagination import PageNumberPagination
 
+from cvat.apps.engine.types import ExtendedRequest
+
 
 class CustomPagination(PageNumberPagination):
     page_size_query_param = "page_size"
 
-    def get_page_size(self, request):
+    def get_page_size(self, request: ExtendedRequest):
         page_size = 0
         try:
             value = request.query_params[self.page_size_query_param]