feat(form): multiple files in file questions

Change the model to allow multiple files per answer to be stored. Migrate the existing questions to the new question type, and migrate the existing answers to the new schema. Updated the GraphQL schema to allow saving and updating multiple files on an answer. The answer's value is a list of dicts, each containing a file name, and optionally an ID. When you're creating new files, add an entry without ID to the value. Caluma will then save the file, and return it back WITH and ID.
projectcaluma · Jul 4, 2022 · 3882d1c · 3882d1c
1 parent a394273
commit 3882d1c
Show file tree

Hide file tree

Showing 29 changed files with 727 additions and 357 deletions.
diff --git a/caluma/caluma_analytics/tests/__snapshots__/test_run_analytics_cmdline.ambr b/caluma/caluma_analytics/tests/__snapshots__/test_run_analytics_cmdline.ambr
@@ -65,7 +65,7 @@
           FROM
                  "caluma_form_document" INNER JOIN "caluma_form_form" ON ("caluma_form_document"."form_id" = "caluma_form_form"."slug") -- qs ref
           ),
-          answer_b4215 AS (SELECT "caluma_form_answer"."created_at",  
+          answer_af542 AS (SELECT "caluma_form_answer"."created_at",  
           "caluma_form_answer"."modified_at",  
           "caluma_form_answer"."created_by_user",  
           "caluma_form_answer"."created_by_group",  
@@ -76,8 +76,7 @@
           "caluma_form_answer"."value",  
           "caluma_form_answer"."meta",  
           "caluma_form_answer"."document_id",  
-          "caluma_form_answer"."date",  
-          "caluma_form_answer"."file_id"
+          "caluma_form_answer"."date"
           FROM
                  "caluma_form_answer" INNER JOIN "caluma_form_question" ON ("caluma_form_answer"."question_id" = "caluma_form_question"."slug") -- qs ref
           )
@@ -92,22 +91,22 @@
           FROM document_2a07e AS "document_2a07e" 
           LEFT JOIN (
                   SELECT DISTINCT ON (document_id)
-                         (answer_b4215.value #>>'{}') AS "analytics_result_blablub",
+                         (answer_af542.value #>>'{}') AS "analytics_result_blablub",
                          "document_id"
-                  FROM answer_b4215 AS "answer_b4215" 
+                  FROM answer_af542 AS "answer_af542" 
                   WHERE "question_id" = 'top_question' 
                   ORDER BY document_id
 
 
-          ) AS "answer_b4215_caea5" ON (document_2a07e.id = "answer_b4215_caea5".document_id)
+          ) AS "answer_af542_caea5" ON (document_2a07e.id = "answer_af542_caea5".document_id)
           WHERE form_id = 'top_form'
           ORDER BY id
 
 
       ) AS "document_2a07e_27f15" ON (case_ac50e.document_id = "document_2a07e_27f15".id)
 
 
-      ) AS analytics_247d1
+      ) AS analytics_2a8de
       -- PARAMS: 
 
     ''',
@@ -156,7 +155,7 @@
           FROM
                  "caluma_form_document" INNER JOIN "caluma_form_form" ON ("caluma_form_document"."form_id" = "caluma_form_form"."slug") -- qs ref
           ),
-          answer_b4215 AS (SELECT "caluma_form_answer"."created_at",  
+          answer_af542 AS (SELECT "caluma_form_answer"."created_at",  
           "caluma_form_answer"."modified_at",  
           "caluma_form_answer"."created_by_user",  
           "caluma_form_answer"."created_by_group",  
@@ -167,8 +166,7 @@
           "caluma_form_answer"."value",  
           "caluma_form_answer"."meta",  
           "caluma_form_answer"."document_id",  
-          "caluma_form_answer"."date",  
-          "caluma_form_answer"."file_id"
+          "caluma_form_answer"."date"
           FROM
                  "caluma_form_answer" INNER JOIN "caluma_form_question" ON ("caluma_form_answer"."question_id" = "caluma_form_question"."slug") -- qs ref
           )
@@ -183,22 +181,22 @@
           FROM document_2a07e AS "document_2a07e" 
           LEFT JOIN (
                   SELECT DISTINCT ON (document_id)
-                         (answer_b4215.value #>>'{}') AS "analytics_result_blablub",
+                         (answer_af542.value #>>'{}') AS "analytics_result_blablub",
                          "document_id"
-                  FROM answer_b4215 AS "answer_b4215" 
+                  FROM answer_af542 AS "answer_af542" 
                   WHERE "question_id" = 'top_question' 
                   ORDER BY document_id
 
 
-          ) AS "answer_b4215_caea5" ON (document_2a07e.id = "answer_b4215_caea5".document_id)
+          ) AS "answer_af542_caea5" ON (document_2a07e.id = "answer_af542_caea5".document_id)
           WHERE form_id = 'top_form'
           ORDER BY id
 
 
       ) AS "document_2a07e_27f15" ON (case_ac50e.document_id = "document_2a07e_27f15".id)
 
 
-      ) AS analytics_247d1
+      ) AS analytics_2a8de
       WHERE analytics_result_blablub IN (%(flt_analytics_result_blablub_8201d)s, %(flt_analytics_result_blablub_8e5e6)s)
       -- PARAMS: 
       --     flt_analytics_result_blablub_8201d: Shelly Watson
@@ -246,7 +244,7 @@
           FROM
                  "caluma_form_document" INNER JOIN "caluma_form_form" ON ("caluma_form_document"."form_id" = "caluma_form_form"."slug") -- qs ref
           ),
-          answer_b4215 AS (SELECT "caluma_form_answer"."created_at",  
+          answer_af542 AS (SELECT "caluma_form_answer"."created_at",  
           "caluma_form_answer"."modified_at",  
           "caluma_form_answer"."created_by_user",  
           "caluma_form_answer"."created_by_group",  
@@ -257,8 +255,7 @@
           "caluma_form_answer"."value",  
           "caluma_form_answer"."meta",  
           "caluma_form_answer"."document_id",  
-          "caluma_form_answer"."date",  
-          "caluma_form_answer"."file_id"
+          "caluma_form_answer"."date"
           FROM
                  "caluma_form_answer" INNER JOIN "caluma_form_question" ON ("caluma_form_answer"."question_id" = "caluma_form_question"."slug") -- qs ref
           )
@@ -273,22 +270,22 @@
           FROM document_2a07e AS "document_2a07e" 
           LEFT JOIN (
                   SELECT DISTINCT ON (document_id)
-                         (answer_b4215.value #>>'{}') AS "analytics_result_blablub",
+                         (answer_af542.value #>>'{}') AS "analytics_result_blablub",
                          "document_id"
-                  FROM answer_b4215 AS "answer_b4215" 
+                  FROM answer_af542 AS "answer_af542" 
                   WHERE "question_id" = 'top_question' 
                   ORDER BY document_id
 
 
-          ) AS "answer_b4215_caea5" ON (document_2a07e.id = "answer_b4215_caea5".document_id)
+          ) AS "answer_af542_caea5" ON (document_2a07e.id = "answer_af542_caea5".document_id)
           WHERE form_id = 'top_form'
           ORDER BY id
 
 
       ) AS "document_2a07e_27f15" ON (case_ac50e.document_id = "document_2a07e_27f15".id)
 
 
-      ) AS analytics_247d1
+      ) AS analytics_2a8de
       -- PARAMS: 
 
     ''',
@@ -333,7 +330,7 @@
           FROM
                  "caluma_form_document" INNER JOIN "caluma_form_form" ON ("caluma_form_document"."form_id" = "caluma_form_form"."slug") -- qs ref
           ),
-          answer_b4215 AS (SELECT "caluma_form_answer"."created_at",  
+          answer_af542 AS (SELECT "caluma_form_answer"."created_at",  
           "caluma_form_answer"."modified_at",  
           "caluma_form_answer"."created_by_user",  
           "caluma_form_answer"."created_by_group",  
@@ -344,8 +341,7 @@
           "caluma_form_answer"."value",  
           "caluma_form_answer"."meta",  
           "caluma_form_answer"."document_id",  
-          "caluma_form_answer"."date",  
-          "caluma_form_answer"."file_id"
+          "caluma_form_answer"."date"
           FROM
                  "caluma_form_answer" INNER JOIN "caluma_form_question" ON ("caluma_form_answer"."question_id" = "caluma_form_question"."slug") -- qs ref
           )
@@ -360,22 +356,22 @@
           FROM document_2a07e AS "document_2a07e" 
           LEFT JOIN (
                   SELECT DISTINCT ON (document_id)
-                         (answer_b4215.value #>>'{}') AS "analytics_result_blablub",
+                         (answer_af542.value #>>'{}') AS "analytics_result_blablub",
                          "document_id"
-                  FROM answer_b4215 AS "answer_b4215" 
+                  FROM answer_af542 AS "answer_af542" 
                   WHERE "question_id" = 'top_question' 
                   ORDER BY document_id
 
 
-          ) AS "answer_b4215_caea5" ON (document_2a07e.id = "answer_b4215_caea5".document_id)
+          ) AS "answer_af542_caea5" ON (document_2a07e.id = "answer_af542_caea5".document_id)
           WHERE form_id = 'top_form'
           ORDER BY id
 
 
       ) AS "document_2a07e_27f15" ON (case_ac50e.document_id = "document_2a07e_27f15".id)
 
 
-      ) AS analytics_247d1
+      ) AS analytics_2a8de
       WHERE analytics_result_blablub IN (%(flt_analytics_result_blablub_8201d)s, %(flt_analytics_result_blablub_8e5e6)s)
       -- PARAMS: 
       --     flt_analytics_result_blablub_8201d: Shelly Watson

diff --git a/caluma/caluma_form/domain_logic.py b/caluma/caluma_form/domain_logic.py
@@ -5,6 +5,7 @@
 from rest_framework.exceptions import ValidationError
 
 from caluma.caluma_core.models import BaseModel
+from caluma.caluma_core.relay import extract_global_id
 from caluma.caluma_form import models, validators
 from caluma.caluma_user.models import BaseUser
 from caluma.utils import update_model
@@ -42,13 +43,58 @@ def get_new_answer(cls, data, user, answer):
             cls.validate_for_save(data, user, answer=answer, origin=True)
         )
 
+        files = validated_data.pop("files", None)
         if answer is None:
             answer = cls.create(validated_data, user)
         else:
             answer = cls.update(answer, validated_data, user)
 
+        # FILES type needs a bit more work due to the rverse
+        # relation of file -> answer
+        if answer.question.type == models.Question.TYPE_FILES:
+            if files is None:
+                raise ValidationError("Files input must be a list")
+            cls.update_answer_files(answer, files)
+
         return cls.post_save(answer)
 
+    @classmethod
+    def update_answer_files(cls, answer: models.Answer, files: list):
+        """Update the files of a "FILES" answer.
+
+        The files parameter is expected to be a list of dicts, where
+        each entry has a "name" (the file name), and optionally an "id"
+        for the case when the given file already exists.
+        """
+        if not files:
+            files = []
+
+        updated = []
+
+        to_update = {
+            str(ex_f.pk): ex_f
+            for ex_f in answer.files.filter(
+                pk__in=[extract_global_id(f["id"]) for f in files if "id" in f]
+            )
+        }
+        for file_ in files:
+            file_id = str(file_.get("id"))
+            file_name = file_["name"]
+            if file_id in to_update:
+                if to_update[file_id].name != file_name:
+                    to_update[file_id].rename(file_name)
+                    to_update[file_id].save()
+                updated.append(file_id)
+                # else: already there, no change required
+            else:
+                # need to be created, regardless whether the file_id
+                # exists or not
+                created = answer.files.create(name=file_name)
+                updated.append(created.pk)
+
+        for file in answer.files.exclude(pk__in=updated):
+            file.delete()
+
     @staticmethod
     def validate_for_save(
         data: dict, user: BaseUser, answer: models.Answer = None, origin: bool = False
@@ -68,8 +114,8 @@ def validate_for_save(
                 else models.Document.objects.none()
             )
             del data["value"]
-        elif question.type == models.Question.TYPE_FILE and not data.get("file"):
-            data["file"] = data["value"]
+        elif question.type == models.Question.TYPE_FILES and not data.get("files"):
+            data["files"] = data["value"]
             del data["value"]
         elif question.type == models.Question.TYPE_DATE and not data.get("date"):
             data["date"] = data["value"]
@@ -91,35 +137,35 @@ def post_save(answer: models.Answer) -> models.Answer:
         # TODO emit events
         return answer
 
-    @staticmethod
+    @classmethod
     @transaction.atomic
-    def create(validated_data: dict, user: Optional[BaseUser] = None) -> models.Answer:
-        if validated_data["question"].type == models.Question.TYPE_FILE:
-            validated_data = __class__.set_file(validated_data)
+    def create(
+        cls, validated_data: dict, user: Optional[BaseUser] = None
+    ) -> models.Answer:
 
         if validated_data["question"].type == models.Question.TYPE_TABLE:
             documents = validated_data.pop("documents")
 
+        files = validated_data.pop("files", None)
         answer = BaseLogic.create(models.Answer, validated_data, user)
 
+        if validated_data["question"].type == models.Question.TYPE_FILES:
+            cls.update_answer_files(answer, files)
+
         if answer.question.type == models.Question.TYPE_TABLE:
             answer.create_answer_documents(documents)
 
         return answer
 
-    @staticmethod
+    @classmethod
     @transaction.atomic
-    def update(answer, validated_data, user: Optional[BaseUser] = None):
+    def update(cls, answer, validated_data, user: Optional[BaseUser] = None):
         if answer.question.type == models.Question.TYPE_TABLE:
             documents = validated_data.pop("documents")
             answer.unlink_unused_rows(docs_to_keep=documents)
 
-        if (
-            answer.question.type == models.Question.TYPE_FILE
-            and answer.file.name is not validated_data["file"]
-        ):
-            answer.file.delete()
-            validated_data = __class__.set_file(validated_data)
+        if answer.question.type == models.Question.TYPE_FILES:
+            cls.update_answer_files(answer, validated_data.pop("files", None))
 
         BaseLogic.update(answer, validated_data, user)
 
@@ -129,21 +175,14 @@ def update(answer, validated_data, user: Optional[BaseUser] = None):
         answer.refresh_from_db()
         return answer
 
-    @staticmethod
-    def set_file(validated_data):
-        file_name = validated_data.get("file")
-        file = models.File.objects.create(name=file_name)
-        validated_data["file"] = file
-        return validated_data
-
 
 class SaveDefaultAnswerLogic(SaveAnswerLogic):
     @staticmethod
     def validate_for_save(
         data: dict, user: BaseUser, answer: models.Answer = None, origin: bool = False
     ) -> dict:
         if data["question"].type in [
-            models.Question.TYPE_FILE,
+            models.Question.TYPE_FILES,
             models.Question.TYPE_STATIC,
             models.Question.TYPE_DYNAMIC_CHOICE,
             models.Question.TYPE_DYNAMIC_MULTIPLE_CHOICE,