Merge pull request #319 from Mosquito-Alert/api_search_filter

Added search filter for reports

Author: epou

api/serializers.py

@@ -710,6 +710,7 @@ class Meta:
             read_only_fields = fields
 
     uuid = BaseReportSerializer().fields['uuid']
+    short_id = BaseReportSerializer().fields['short_id']
     # NOTE: user_uuid is used by AIMA for knowing who to send notifications.
     user_uuid = BaseReportSerializer().fields['user_uuid']
     created_at = BaseReportSerializer().fields['created_at']
@@ -724,6 +725,7 @@ class Meta:
         model = BaseReportSerializer.Meta.model
         fields = (
             "uuid",
+            "short_id",
             "user_uuid",
             "created_at",
             "created_at_local",

api/tests/integration/identification_tasks/assignments/schema.yml

@@ -8,6 +8,7 @@ variables:
   response_data_validation: &retrieve_validation
     observation:
       uuid: !re_fullmatch "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+      short_id: !anystr
       user:
         uuid: !re_fullmatch "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
         locale: !anystr

api/tests/integration/identification_tasks/schema.yml

@@ -8,6 +8,7 @@ variables:
   response_data_validation: &retrieve_validation
     observation:
       uuid: !re_fullmatch "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
+      short_id: !anystr
       user_uuid: !re_fullmatch "^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$"
       created_at: !re_fullmatch \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}Z
       created_at_local: !re_fullmatch \d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}.\d{6}([+-]\d{2}:\d{2}|Z)

api/views.py

@@ -17,6 +17,7 @@
 from rest_framework import status
 from rest_framework.decorators import action
 from rest_framework.exceptions import ValidationError
+from rest_framework.filters import SearchFilter
 from rest_framework.mixins import (
     CreateModelMixin,
     ListModelMixin,
@@ -238,11 +239,14 @@ class BaseReportViewSet(
             "photos",
             queryset=Photo.objects.visible()
         )
+    ).annotate(
+        pk_str=models.functions.Cast('pk', output_field=models.CharField()),
     ).non_deleted().filter(point__isnull=False).order_by('-server_upload_time')
 
     lookup_url_kwarg = "uuid"
 
-    filter_backends = (DjangoFilterBackend,)
+    filter_backends = (DjangoFilterBackend, SearchFilter)
+    search_fields = ("report_id", "pk_str")
 
     permission_classes = (ReportPermissions,)
 
@@ -535,9 +539,13 @@ class IdentificationTaskViewSet(RetrieveModelMixin, ListModelMixin, GenericNoMob
             "report__photos",
             queryset=Photo.objects.visible(),
         )
+    ).annotate(
+        pk_str=models.functions.Cast('pk', output_field=models.CharField()),
     )
     serializer_class = IdentificationTaskSerializer
     filterset_class = IdentificationTaskFilter
+    filter_backends = (DjangoFilterBackend, SearchFilter)
+    search_fields = ("report__report_id", "pk_str")
     permission_classes = (IdentificationTaskPermissions | UserRolePermission,)
 
     lookup_field = 'pk'
@@ -678,9 +686,14 @@ class AnnotationViewSet(IdentificationTaskNestedAttribute, NestedViewSetMixin, L
                     report=models.OuterRef('report')
                 )
             )
+        ).annotate(
+            report_pk_str=models.functions.Cast('report_id', output_field=models.CharField()),
         )
+
         serializer_class = AnnotationSerializer
+        filter_backends = (DjangoFilterBackend, SearchFilter)
         filterset_class = AnnotationFilter
+        search_fields = ("report_pk_str",) #NOTE: not filtering by 'report__report_id' because in not being shown in the response.
         permission_classes = (AnnotationPermissions | UserRolePermission, )
 
         parent_lookup_kwargs = {
@@ -736,7 +749,9 @@ def get_queryset(self):
 class MyAnnotationViewSet(ListModelMixin, GenericNoMobileViewSet):
     queryset = IdentificationTaskViewSet.AnnotationViewSet.queryset
     serializer_class = IdentificationTaskViewSet.AnnotationViewSet.serializer_class
+    filter_backends = IdentificationTaskViewSet.AnnotationViewSet.filter_backends
     filterset_class = IdentificationTaskViewSet.AnnotationViewSet.filterset_class
+    search_fields = IdentificationTaskViewSet.AnnotationViewSet.search_fields
     permission_classes = (MyAnnotationPermissions, )
 
     lookup_field = 'pk'