feat(forms): implement anonymity setting for new surveys and cloning existing surveys

Author: japsu

backend/events/kotaeexpo2025/management/commands/setup_kotaeexpo2025.py

@@ -283,7 +283,7 @@ def setup_forms(self):
                 slug="expense-claim",
                 key_fields=["title", "amount"],
                 login_required=True,
-                anonymity="name_and_email",
+                anonymity="NAME_AND_EMAIL",
                 active_from=datetime(2025, 1, 1, 0, 0, tzinfo=self.tz),
                 active_until=datetime(2025, 12, 31, 23, 59, tzinfo=self.tz),
             ),

backend/events/tracon2025/management/commands/setup_tracon2025.py

@@ -482,21 +482,21 @@ def setup_forms(self):
         for survey in [
             SurveyDTO(
                 slug="kickoff-signup",
-                anonymity="name_and_email",
+                anonymity="NAME_AND_EMAIL",
                 max_responses_per_user=1,
                 login_required=True,
             ),
             SurveyDTO(
                 slug="expense-claim",
                 key_fields=["title", "amount"],
                 login_required=True,
-                anonymity="name_and_email",
+                anonymity="NAME_AND_EMAIL",
             ),
             SurveyDTO(
                 slug="car-usage",
                 key_fields=["title", "kilometers"],
                 login_required=True,
-                anonymity="name_and_email",
+                anonymity="NAME_AND_EMAIL",
             ),
         ]:
             survey.save(self.event)

backend/forms/graphql/meta.py

@@ -1,3 +1,5 @@
+from enum import Enum
+
 import graphene
 from django.conf import settings
 from django.core.exceptions import SuspiciousOperation
@@ -10,17 +12,22 @@
 from ..models.response import Response
 from ..models.survey import Survey
 from .response import ProfileResponseType
-from .survey_full import SurveyType
+from .survey_full import FullSurveyType
 
 DEFAULT_LANGUAGE: str = settings.LANGUAGE_CODE
 
 
 SurveyAppType = graphene.Enum.from_enum(SurveyApp)
 
 
+class SurveyRelation(Enum):
+    SUBSCRIBED = "SUBSCRIBED"
+    ACCESSIBLE = "ACCESSIBLE"
+
+
 class FormsEventMetaType(graphene.ObjectType):
     surveys = graphene.List(
-        graphene.NonNull(SurveyType),
+        graphene.NonNull(FullSurveyType),
         include_inactive=graphene.Boolean(),
         app=graphene.NonNull(SurveyAppType),
     )
@@ -53,7 +60,7 @@ def resolve_surveys(
         return qs
 
     survey = graphene.Field(
-        SurveyType,
+        FullSurveyType,
         slug=graphene.String(required=True),
         app=graphene.Argument(SurveyAppType),
     )
@@ -114,15 +121,23 @@ def resolve_response(meta: FormsProfileMeta, info, id: str):
     )
 
     @staticmethod
-    def resolve_surveys(meta: FormsProfileMeta, info, event_slug: str | None = None):
+    def resolve_surveys(
+        meta: FormsProfileMeta,
+        info,
+        event_slug: str | None = None,
+        relation: SurveyRelation = SurveyRelation.ACCESSIBLE,
+    ):
         """
-        Returns all surveys subscribed to by the current user.
+        Returns all surveys accessible by the current user.
+        To limit to surveys subscribed to, specify `relation: SUBSCRIBED`.
+        To limit by event, specify `eventSlug: $eventSlug`.
         """
         if info.context.user != meta.person.user:
             raise SuspiciousOperation("User mismatch")
 
-        surveys = Survey.objects.filter(subscribers=meta.person.user)
-
+        surveys = Survey.objects.all()
+        if relation == SurveyRelation.SUBSCRIBED:
+            surveys = surveys.filter(subscribers=meta.person.user)
         if event_slug:
             surveys = surveys.filter(event__slug=event_slug)
 
@@ -141,8 +156,9 @@ def resolve_surveys(meta: FormsProfileMeta, info, event_slug: str | None = None)
 
     surveys = graphene.NonNull(
         graphene.List(
-            graphene.NonNull(SurveyType),
+            graphene.NonNull(FullSurveyType),
         ),
         event_slug=graphene.String(),
+        relation=graphene.Argument(graphene.Enum.from_enum(SurveyRelation)),
         description=normalize_whitespace(resolve_surveys.__doc__ or ""),
     )

backend/forms/graphql/mutations/create_survey.py

@@ -1,39 +1,72 @@
 import graphene
+from django.http import HttpRequest
 
-from access.cbac import graphql_check_model
+from access.cbac import graphql_check_instance, graphql_check_model
 from core.models import Event
 
-from ...models.survey import Survey
-from ..survey_full import SurveyType
+from ...models.survey import Anonymity, Survey, SurveyApp
+from ..survey_full import FullSurveyType
+from ..survey_limited import AnonymiType
 
 
 class CreateSurveyInput(graphene.InputObjectType):
     event_slug = graphene.String(required=True)
     survey_slug = graphene.String(required=True)
+    copy_from = graphene.String()
+    anonymity = graphene.InputField(AnonymiType, required=True)
 
 
 class CreateSurvey(graphene.Mutation):
     class Arguments:
         input = CreateSurveyInput(required=True)
 
-    survey = graphene.Field(SurveyType)
+    survey = graphene.Field(FullSurveyType)
 
     @staticmethod
     def mutate(
         root,
         info,
         input: CreateSurveyInput,
     ):
+        # TODO scope
         event = Event.objects.get(slug=input.event_slug)
+        request: HttpRequest = info.context
 
-        # NOTE: default app=forms OK here as creating program forms goes through another mut
         graphql_check_model(
             Survey,
             event.scope,
             info,
             operation="create",
+            app="forms",  # program offer forms created via another mutation
         )
-        survey = Survey(event=event, slug=input.survey_slug)
-        survey.full_clean()  # Validate fields
-        survey.save()
+
+        anonymity = Anonymity(input.anonymity)
+        if input.copy_from:
+            source_event_slug, source_survey_slug = str(input.copy_from).split("/")
+            source_survey = Survey.objects.get(
+                event__slug=source_event_slug,
+                slug=source_survey_slug,
+            )
+
+            graphql_check_instance(
+                source_survey,
+                info,
+                app=source_survey.app,  # NOTE same check as in FormsProfileMeta.surveys
+            )
+
+            survey = source_survey.clone(
+                event=event,
+                slug=str(input.survey_slug),
+                anonymity=anonymity,
+                app=SurveyApp.FORMS,
+                created_by=request.user,  # type: ignore
+            )
+        else:
+            survey = Survey(
+                event=event,
+                slug=input.survey_slug,
+                anonymity=anonymity.value,
+            ).with_mandatory_attributes_for_app(SurveyApp.FORMS)
+            survey.full_clean()  # Validate fields
+            survey.save()
         return CreateSurvey(survey=survey)  # type: ignore

backend/forms/graphql/mutations/create_survey_response.py

@@ -51,7 +51,7 @@ def mutate(
             if survey.responses.filter(created_by=created_by).count() >= survey.max_responses_per_user:
                 raise Exception("Maximum number of responses reached")
 
-        if survey.anonymity == "hard":
+        if survey.anonymity == "HARD":
             created_by = None
             ip_address = ""
 

backend/forms/graphql/mutations/update_form.py

@@ -9,7 +9,7 @@
 
 from ...models.form import Form
 from ...models.survey import Survey
-from ..survey_full import SurveyType
+from ..survey_full import FullSurveyType
 
 
 class FormForm(django_forms.ModelForm):
@@ -40,7 +40,7 @@ class UpdateForm(graphene.Mutation):
     class Arguments:
         input = UpdateFormInput(required=True)
 
-    survey = graphene.Field(SurveyType)
+    survey = graphene.Field(FullSurveyType)
 
     @staticmethod
     def mutate(

backend/forms/graphql/mutations/update_form_fields.py

@@ -6,7 +6,7 @@
 
 from ...models.field import Field
 from ...models.survey import Survey
-from ..survey_full import SurveyType
+from ..survey_full import FullSurveyType
 
 
 class UpdateFormFieldsInput(graphene.InputObjectType):
@@ -24,7 +24,7 @@ class UpdateFormFields(graphene.Mutation):
     class Arguments:
         input = UpdateFormFieldsInput(required=True)
 
-    survey = graphene.Field(SurveyType)
+    survey = graphene.Field(FullSurveyType)
 
     @staticmethod
     def mutate(

backend/forms/graphql/mutations/update_survey.py

@@ -7,8 +7,8 @@
 from access.cbac import graphql_check_instance
 from core.utils.form_utils import camel_case_keys_to_snake_case
 
-from ...models.survey import Survey
-from ..survey_full import SurveyType
+from ...models.survey import Survey, SurveyApp
+from ..survey_full import FullSurveyType
 
 
 class SurveyForm(django_forms.ModelForm):
@@ -38,7 +38,7 @@ class UpdateSurvey(graphene.Mutation):
     class Arguments:
         input = UpdateSurveyInput(required=True)
 
-    survey = graphene.Field(SurveyType)
+    survey = graphene.Field(FullSurveyType)
 
     @staticmethod
     def mutate(
@@ -64,6 +64,8 @@ def mutate(
         if not form.is_valid():
             raise django_forms.ValidationError(form.errors)  # type: ignore
 
-        form.save()
+        survey: Survey = form.save(commit=False)
+        survey = survey.with_mandatory_attributes_for_app(SurveyApp.FORMS)
+        survey.save()
 
         return UpdateSurvey(survey=survey)  # type: ignore

backend/forms/graphql/response.py

@@ -55,7 +55,7 @@ def resolve_created_by(response: Response, info) -> User | None:
         Returns the user who submitted the response. If response is to an anonymous survey,
         this information will not be available.
         """
-        if (survey := response.form.survey) and survey.anonymity in ("hard", "soft"):
+        if (survey := response.form.survey) and survey.anonymity in ("HARD", "SOFT"):
             return None
 
         return response.created_by

backend/forms/graphql/survey_full.py

@@ -4,6 +4,7 @@
 from graphene.types.generic import GenericScalar
 
 from access.cbac import graphql_check_instance
+from core.graphql.event_limited import LimitedEventType
 from core.utils import normalize_whitespace
 from dimensions.graphql.dimension_filter_input import DimensionFilterInput
 
@@ -18,7 +19,7 @@
 DEFAULT_LANGUAGE: str = settings.LANGUAGE_CODE
 
 
-class SurveyType(LimitedSurveyType):
+class FullSurveyType(LimitedSurveyType):
     @staticmethod
     def resolve_form(
         parent: Survey,
@@ -212,6 +213,9 @@ def resolve_can_remove_responses(survey: Survey, info):
         description=normalize_whitespace(resolve_can_remove_responses.__doc__ or ""),
     )
 
+    # TODO change to Scope
+    event = graphene.NonNull(LimitedEventType)
+
     class Meta:
         model = Survey
         fields = (
@@ -224,4 +228,5 @@ class Meta:
             "anonymity",
             "max_responses_per_user",
             "protect_responses",
+            "event",
         )