Add REST API tests for /requests API && test both versions of the export API

changelog.d/20240820_134050_maria_rest_api_tests.md

@@ -0,0 +1,9 @@
+### Fixed
+
+- Prevent export process from restarting when downloading a result file,
+  that resulted in downloading a file with new request ID
+  (<https://github.com/cvat-ai/cvat/pull/8216>)
+- Race condition occurred while handling parallel export requests
+  (<https://github.com/cvat-ai/cvat/pull/8216>)
+- Requests filtering using format and target filters
+  (<https://github.com/cvat-ai/cvat/pull/8216>)

cvat/apps/engine/filters.py

@@ -16,7 +16,7 @@
 from django.db.models.query import QuerySet
 from django.utils.translation import gettext_lazy as _
 from django.utils.encoding import force_str
-from django.http import HttpRequest
+from rest_framework.request import Request
 from rest_framework import filters
 from rest_framework.compat import coreapi, coreschema
 from rest_framework.exceptions import ValidationError
@@ -412,11 +412,11 @@ def get_schema_operation_parameters(self, view):
                 parameters.append(parameter)
         return parameters
 
-    def filter_queryset(self, request: HttpRequest, queryset: Iterable, view):
+    def filter_queryset(self, request: Request, queryset: Iterable, view):
         filtered_queryset = queryset
 
         query_params = request.query_params
-        filters_to_use = set(query_params)
+        filters_to_use = set(query_params.keys())
 
         simple_filters = getattr(view, self.filter_fields_attr, None)
         lookup_fields = self.get_lookup_fields(view)
@@ -465,7 +465,7 @@ def get_ordering(self, request, queryset, view) -> Tuple[List[str], bool]:
 
         return result, reverse
 
-    def filter_queryset(self, request: HttpRequest, queryset: Iterable, view) -> Iterable:
+    def filter_queryset(self, request: Request, queryset: Iterable, view) -> Iterable:
         ordering, reverse = self.get_ordering(request, queryset, view)
 
         if ordering:
@@ -520,7 +520,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: HttpRequest, queryset: Iterable, view) -> Iterable:
+    def filter_queryset(self, request: Request, queryset: Iterable, view) -> Iterable:
         filtered_queryset = queryset
         json_rules = request.query_params.get(self.filter_param)
         if json_rules:

cvat/apps/engine/mixins.py

@@ -29,7 +29,7 @@
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
-from cvat.apps.engine.background_operations import (BackupExportManager,
+from cvat.apps.engine.background import (BackupExportManager,
                                                     DatasetExportManager)
 from cvat.apps.engine.handlers import clear_import_cache
 from cvat.apps.engine.location import StorageType, get_location_configuration

cvat/apps/engine/utils.py

@@ -203,6 +203,10 @@ def get_rq_lock_by_user(queue: DjangoRQ, user_id: int) -> Union[Lock, nullcontex
         return queue.connection.lock(f'{queue.name}-lock-{user_id}', timeout=30)
     return nullcontext()
 
+def get_rq_lock_for_job(queue: DjangoRQ, rq_id: str) -> Lock:
+    # lock timeout corresponds to the nginx request timeout (proxy_read_timeout)
+    return queue.connection.lock(f'lock-for-job-{rq_id}'.lower(), timeout=60)
+
 def get_rq_job_meta(
     request: HttpRequest,
     db_obj: Any,

cvat/apps/engine/views.py

@@ -491,7 +491,7 @@ def upload_finished(self, request):
         return Response(data='Unknown upload was finished',
                         status=status.HTTP_400_BAD_REQUEST)
 
-    @extend_schema(summary='Get project annotations or export them as a dataset',
+    @extend_schema(summary='Export project annotations as a dataset',
         description=textwrap.dedent("""\
             Deprecation warning:
 
@@ -535,11 +535,7 @@ def upload_finished(self, request):
     def annotations(self, request, pk):
         # FUTURE-TODO: mark exporting dataset using this endpoint as deprecated when new API for result file downloading will be implemented
         self._object = self.get_object() # force call of check_object_permissions()
-        return self.export_dataset_v1(
-            request=request,
-            save_images=False,
-            get_data=dm.task.get_job_data,
-        )
+        return self.export_dataset_v1(request=request, save_images=False)
 
     @extend_schema(summary='Back up a project',
         description=textwrap.dedent("""\
@@ -3275,6 +3271,7 @@ class RequestViewSet(viewsets.GenericViewSet):
         'job_id',
         # derivatives fields (from parsed rq_id)
         'action',
+        'target',
         'subresource',
         'format',
     ]
@@ -3284,7 +3281,9 @@ class RequestViewSet(viewsets.GenericViewSet):
     lookup_fields = {
         'created_date': 'created_at',
         'action': 'parsed_rq_id.action',
+        'target': 'parsed_rq_id.target',
         'subresource': 'parsed_rq_id.subresource',
+        'format': 'parsed_rq_id.format',
         'status': 'get_status',
         'project_id': 'meta.project_id',
         'task_id': 'meta.task_id',
@@ -3300,6 +3299,7 @@ class RequestViewSet(viewsets.GenericViewSet):
         'task_id': SchemaField('integer'),
         'job_id': SchemaField('integer'),
         'action': SchemaField('string', RequestAction.choices),
+        'target': SchemaField('string', RequestTarget.choices),
         'subresource': SchemaField('string', RequestSubresource.choices),
         'format': SchemaField('string'),
         'org': SchemaField('string'),

cvat/schema.yml

@@ -3552,7 +3552,7 @@ paths:
         - POST /api/projects/<project_id>/dataset/export?save_images=False to initiate exporting process
         - GET /api/requests/<rq_id> to check export status,
             where rq_id is request id returned on initializing request'
-      summary: Get project annotations or export them as a dataset
+      summary: Export project annotations as a dataset
       parameters:
       - in: query
         name: action
@@ -4541,7 +4541,7 @@ paths:
 
           Details about the syntax used can be found at the link: https://jsonlogic.com/
 
-           Available filter_fields: ['status', 'project_id', 'task_id', 'job_id', 'action', 'subresource', 'format'].
+           Available filter_fields: ['status', 'project_id', 'task_id', 'job_id', 'action', 'target', 'subresource', 'format'].
         schema:
           type: string
       - name: format
@@ -4602,6 +4602,15 @@ paths:
           - annotations
           - dataset
           - backup
+      - name: target
+        in: query
+        description: A simple equality filter for the target field
+        schema:
+          type: string
+          enum:
+          - project
+          - task
+          - job
       - name: task_id
         in: query
         description: A simple equality filter for the task_id field

dev/format_python_code.sh

@@ -24,6 +24,7 @@ for paths in \
     "cvat/apps/quality_control" \
     "cvat/apps/analytics_report" \
     "cvat/apps/engine/lazy_list.py" \
+    "cvat/apps/engine/background.py" \
     ; do
     ${BLACK} -- ${paths}
     ${ISORT} -- ${paths}

tests/python/rest_api/test_cloud_storages.py

@@ -149,7 +149,7 @@ def _get_endpoint(self, api_client: ApiClient) -> Endpoint:
         ("provider_type", "name", "resource", "credentials_type", "owner"),
     )
     def test_can_use_simple_filter_for_object_list(self, field):
-        return super().test_can_use_simple_filter_for_object_list(field)
+        return super()._test_can_use_simple_filter_for_object_list(field)
 
 
 @pytest.mark.usefixtures("restore_db_per_function")

tests/python/rest_api/test_invitations.py

@@ -121,7 +121,7 @@ def _get_endpoint(self, api_client: ApiClient) -> Endpoint:
         ("owner",),
     )
     def test_can_use_simple_filter_for_object_list(self, field):
-        return super().test_can_use_simple_filter_for_object_list(field)
+        return super()._test_can_use_simple_filter_for_object_list(field)
 
 
 @pytest.mark.usefixtures("restore_db_per_class")

tests/python/rest_api/test_issues.py

@@ -355,7 +355,7 @@ def _get_endpoint(self, api_client: ApiClient) -> Endpoint:
         ("owner", "assignee", "job_id", "resolved", "frame_id"),
     )
     def test_can_use_simple_filter_for_object_list(self, field):
-        return super().test_can_use_simple_filter_for_object_list(field)
+        return super()._test_can_use_simple_filter_for_object_list(field)
 
 
 class TestCommentsListFilters(CollectionSimpleFilterTestBase):
@@ -393,7 +393,7 @@ def _get_field_samples(self, field: str) -> Tuple[Any, List[Dict[str, Any]]]:
         ("owner", "issue_id", "job_id", "frame_id"),
     )
     def test_can_use_simple_filter_for_object_list(self, field):
-        return super().test_can_use_simple_filter_for_object_list(field)
+        return super()._test_can_use_simple_filter_for_object_list(field)
 
 
 @pytest.mark.usefixtures("restore_db_per_class")