feat(forms): excel and zip export to önör dimension filters (closes #572)

Author: japsu

backend/dimensions/filters.py

@@ -0,0 +1,62 @@
+from dataclasses import dataclass, field
+from typing import Self, TypeVar
+
+from django.db import models
+from django.http import QueryDict
+
+from dimensions.graphql.dimension_filter_input import DimensionFilterInput
+
+T = TypeVar("T", bound=models.Model)
+
+
+@dataclass
+class DimensionFilters:
+    filters: dict[str, list[str]] = field(default_factory=dict)
+
+    @classmethod
+    def from_query_dict(
+        cls,
+        filters: QueryDict | dict[str, list[str]],
+    ) -> Self:
+        if isinstance(filters, QueryDict):
+            filters = {k: [str(v) for v in vs] for k, vs in filters.lists()}
+
+        filters = {
+            dimension_slug: [slug for slugs in value_slugs for slug in slugs.split(",")]
+            for (dimension_slug, value_slugs) in filters.items()
+        }
+
+        return cls(
+            filters=filters,
+        )
+
+    @classmethod
+    def from_graphql(
+        cls,
+        filters: list[DimensionFilterInput] | None,
+    ):
+        dimensions = (
+            {filter.dimension: ["*"] if filter.values is None else filter.values for filter in filters}
+            if filters
+            else {}
+        )
+
+        return cls(
+            filters=dimensions,  # type: ignore
+        )
+
+    def filter(
+        self,
+        queryset: models.QuerySet[T],
+    ):
+        for dimension_slug, value_slugs in self.filters.items():
+            value_slugs = [slug for slugs in value_slugs for slug in slugs.split(",")]
+            if "*" in value_slugs:
+                queryset = queryset.filter(dimensions__value__dimension__slug=dimension_slug)
+            else:
+                queryset = queryset.filter(
+                    dimensions__value__dimension__slug=dimension_slug,
+                    dimensions__value__slug__in=value_slugs,
+                )
+
+        return queryset.distinct()

backend/dimensions/graphql/dimension_filter_input.py

@@ -1,4 +1,4 @@
-from typing import Self, TypeVar
+from typing import TypeVar
 
 import graphene
 from django.db import models
@@ -16,19 +16,3 @@ class DimensionFilterInput(graphene.InputObjectType):
 
     dimension = graphene.NonNull(graphene.String)
     values = graphene.List(graphene.NonNull(graphene.String))
-
-    @classmethod
-    def filter(cls, queryset: models.QuerySet[T], filters: list[Self] | None) -> models.QuerySet[T]:
-        if filters is None:
-            filters = []
-
-        for filter in filters:
-            if filter.values is None:
-                queryset = queryset.filter(dimensions__value__dimension__slug=filter.dimension)
-            else:
-                queryset = queryset.filter(
-                    dimensions__value__dimension__slug=filter.dimension,
-                    dimensions__value__slug__in=filter.values,
-                )
-
-        return queryset

backend/forms/graphql/survey_full.py

@@ -6,6 +6,7 @@
 from access.cbac import graphql_check_instance
 from core.graphql.event_limited import LimitedEventType
 from core.utils import normalize_whitespace
+from dimensions.filters import DimensionFilters
 from dimensions.graphql.dimension_filter_input import DimensionFilterInput
 
 from ..models.form import Form
@@ -82,7 +83,7 @@ def resolve_responses(
         Authorization required.
         """
         graphql_check_instance(survey, info, app=survey.app, field="responses")
-        return DimensionFilterInput.filter(survey.responses.all(), filters)
+        return DimensionFilters.from_graphql(filters).filter(survey.responses.all()).order_by("created_at")
 
     responses = graphene.List(
         graphene.NonNull(LimitedResponseType),
@@ -130,7 +131,7 @@ def resolve_count_responses(
         Authorization required.
         """
         graphql_check_instance(survey, info, app=survey.app, field="responses")
-        return DimensionFilterInput.filter(survey.responses.all(), filters).count()
+        return DimensionFilters.from_graphql(filters).filter(survey.responses.all()).count()
 
     count_responses = graphene.Field(
         graphene.NonNull(graphene.Int),
@@ -151,7 +152,7 @@ def resolve_summary(
         not present in the base language is not guaranteed. Authorization required.
         """
         graphql_check_instance(survey, info, app=survey.app, field="responses")
-        responses = DimensionFilterInput.filter(survey.responses.all(), filters)
+        responses = DimensionFilters.from_graphql(filters).filter(survey.responses.all()).order_by("created_at")
         fields = survey.get_combined_fields(lang)
         valuesies = [response.get_processed_form_data(fields)[0] for response in responses.only("form_data")]
         summary = summarize_responses(fields, valuesies)

backend/forms/models/response.py

@@ -36,6 +36,7 @@
 
 
 class Response(models.Model):
+    # TODO UUID7
     id = models.UUIDField(primary_key=True, default=uuid.uuid4, editable=False)
     form = models.ForeignKey(Form, on_delete=models.CASCADE, related_name="responses")
     form_data = JSONField()

backend/forms/views/forms_survey_excel_export_view.py

@@ -4,6 +4,7 @@
 
 from access.cbac import graphql_check_instance
 from core.models import Event
+from dimensions.filters import DimensionFilters
 
 from ..excel_export import write_responses_as_excel
 from ..models.survey import Survey
@@ -32,10 +33,12 @@ def forms_survey_excel_export_view(
     response = HttpResponse(content_type="application/vnd.openxmlformats-officedocument.spreadsheetml.sheet")
     response["Content-Disposition"] = f'attachment; filename="{filename}"'
 
+    responses = DimensionFilters.from_query_dict(request.GET).filter(survey.responses.all())
+
     write_responses_as_excel(
         survey.dimensions.order_by("order"),
         survey.combined_fields,
-        survey.responses.order_by("created_at").only("form_data"),
+        responses.only("form_data").order_by("created_at"),
         response,
     )
 

backend/forms/views/forms_survey_zip_export_view.py

@@ -7,6 +7,7 @@
 from django.utils.timezone import now
 
 from access.cbac import graphql_check_instance
+from dimensions.filters import DimensionFilters
 from dimensions.models.scope import Scope
 
 from ..excel_export import write_responses_as_excel
@@ -38,6 +39,8 @@ def forms_survey_zip_export_view(
         operation="query",
     )
 
+    responses = DimensionFilters.from_query_dict(request.GET).filter(survey.responses.all())
+
     fields = survey.get_combined_fields()
     session = requests.Session()
     tempfile = TemporaryFile()
@@ -47,11 +50,11 @@ def forms_survey_zip_export_view(
             write_responses_as_excel(
                 survey.dimensions.order_by("order"),
                 survey.combined_fields,
-                survey.responses.order_by("created_at").only("form_data"),
+                responses.only("form_data").order_by("created_at"),
                 excel_file,  # type: ignore
             )
 
-        for form_response in survey.responses.all():
+        for form_response in responses:
             for attachment in form_response.get_attachments(fields):
                 attachment_bytes = attachment.download(session=session)
                 attachment_filename = truncate_filename(

frontend/src/app/[locale]/[eventSlug]/surveys/[surveySlug]/responses/page.tsx

@@ -227,9 +227,10 @@ export default async function FormResponsesPage({
   columns.push(...buildKeyDimensionColumns(dimensions));
 
   const exportBaseUrl = `${kompassiBaseUrl}/events/${eventSlug}/surveys/${surveySlug}/responses`;
+  const queryString = new URLSearchParams(searchParams).toString();
   const exportUrls = {
-    excel: `${exportBaseUrl}.xlsx`,
-    zip: `${exportBaseUrl}.zip`,
+    excel: `${exportBaseUrl}.xlsx?${queryString}`,
+    zip: `${exportBaseUrl}.zip?${queryString}`,
   };
   const responses = survey.responses || [];