Merge pull request #429 from con2/feat/forms-sequence-numbers

feat(forms): add intra-Survey sequence numbers to Responses

backend/forms/admin.py

@@ -22,9 +22,17 @@ class ResponseDimensionValueInline(admin.TabularInline):
 @admin.register(Response)
 class ResponseAdmin(admin.ModelAdmin):
     model = Response
-    list_display = ("created_at", "form", "created_by")
+    list_display = ("created_at", "form", "sequence_number", "created_by")
     list_filter = ("form__event", "form")
-    readonly_fields = ("form", "form_data", "created_by", "ip_address", "created_at", "updated_at")
+    readonly_fields = (
+        "form",
+        "form_data",
+        "created_by",
+        "ip_address",
+        "created_at",
+        "updated_at",
+        "sequence_number",
+    )
     fields = readonly_fields
     inlines = (ResponseDimensionValueInline,)
 

backend/forms/graphql/mutations/create_survey_response.py

@@ -1,4 +1,5 @@
 import graphene
+from django.db import transaction
 from graphene.types.generic import GenericScalar
 
 from core.utils import get_ip
@@ -54,13 +55,15 @@ def mutate(
             created_by = None
             ip_address = ""
 
-        response = Response.objects.create(
-            form=form,
-            form_data=input.form_data,
-            created_by=created_by,
-            ip_address=ip_address,
-        )
+        with transaction.atomic():
+            response = Response.objects.create(
+                form=form,
+                form_data=input.form_data,
+                created_by=created_by,
+                ip_address=ip_address,
+                sequence_number=survey.get_next_sequence_number(),
+            )
 
-        response.lift_dimension_values()
+            response.lift_dimension_values()
 
         return CreateSurveyResponse(response=response)  # type: ignore

backend/forms/graphql/response.py

@@ -95,7 +95,12 @@ def resolve_cached_dimensions(response: Response, info, key_dimensions_only: boo
 
     class Meta:
         model = Response
-        fields = ("id", "form_data", "created_at")
+        fields = (
+            "id",
+            "form_data",
+            "created_at",
+            "sequence_number",
+        )
 
 
 class FullResponseType(LimitedResponseType):
@@ -125,6 +130,7 @@ class Meta:
             "id",
             "form_data",
             "created_at",
+            "sequence_number",
         )
 
 

backend/forms/migrations/0023_response_sequence_number.py

@@ -0,0 +1,34 @@
+# Generated by Django 5.0.2 on 2024-02-12 18:25
+
+from django.db import migrations, models
+
+
+def number_existing_responses(apps, schema_editor):
+    Response = apps.get_model("forms", "Response")
+    Survey = apps.get_model("forms", "Survey")
+
+    for survey in Survey.objects.all():
+        responses = Response.objects.filter(
+            form__in=survey.languages.all(),
+            sequence_number=0,
+        ).order_by("created_at")
+        for i, response in enumerate(responses):
+            response.sequence_number = i + 1
+            response.save(update_fields=["sequence_number"])
+
+
+class Migration(migrations.Migration):
+    dependencies = [
+        ("forms", "0022_dimension_is_shown_to_respondent"),
+    ]
+
+    operations = [
+        migrations.AddField(
+            model_name="response",
+            name="sequence_number",
+            field=models.PositiveIntegerField(
+                default=0, help_text="Sequence number of this response within the use case (eg. survey)."
+            ),
+        ),
+        migrations.RunPython(number_existing_responses, reverse_code=migrations.RunPython.noop),
+    ]

backend/forms/models/response.py

@@ -38,6 +38,11 @@ class Response(models.Model):
         verbose_name=_("IP address"),
     )
 
+    sequence_number = models.PositiveIntegerField(
+        default=0,
+        help_text="Sequence number of this response within the use case (eg. survey).",
+    )
+
     # denormalized fields
     cached_dimensions = models.JSONField(
         default=dict,

backend/forms/models/survey.py

@@ -155,6 +155,9 @@ def responses(self):
 
         return Response.objects.filter(form__in=self.languages.all()).order_by("created_at")
 
+    def get_next_sequence_number(self):
+        return (self.responses.all().aggregate(models.Max("sequence_number"))["sequence_number__max"] or 0) + 1
+
     def preload_dimensions(self, dimension_values: Mapping[str, Collection[str]] | None = None):
         dimensions = self.dimensions.all().prefetch_related("values")
         if dimension_values is not None: