Error handling

Author: marcoacierno

backend/api/submissions/mutations.py

@@ -29,6 +29,13 @@
 LINKEDIN_LINK_MATCH = re.compile(r"^http(s)?:\/\/(www\.)?linkedin\.com\/")
 
 
+@strawberry.type
+class ProposalMaterialErrors:
+    file_id: list[str] = strawberry.field(default_factory=list)
+    url: list[str] = strawberry.field(default_factory=list)
+    id: list[str] = strawberry.field(default_factory=list)
+
+
 @strawberry.type
 class SendSubmissionErrors(BaseErrorType):
     @strawberry.type
@@ -46,6 +53,7 @@ class _SendSubmissionErrors:
         audience_level: list[str] = strawberry.field(default_factory=list)
         tags: list[str] = strawberry.field(default_factory=list)
         short_social_summary: list[str] = strawberry.field(default_factory=list)
+        materials: list[ProposalMaterialErrors] = strawberry.field(default_factory=list)
 
         speaker_bio: list[str] = strawberry.field(default_factory=list)
         speaker_photo: list[str] = strawberry.field(default_factory=list)
@@ -249,6 +257,16 @@ class UpdateSubmissionInput(BaseSubmissionInput):
     tags: list[ID] = strawberry.field(default_factory=list)
     materials: list[SubmissionMaterialInput] = strawberry.field(default_factory=list)
 
+    def validate(self, conference: Conference, submission: SubmissionModel):
+        errors = super().validate(conference)
+
+        if self.materials:
+            for index, material in enumerate(self.materials):
+                with errors.with_prefix("materials", index):
+                    material.validate(errors, submission)
+
+        return errors
+
 
 SendSubmissionOutput = Annotated[
     Union[Submission, SendSubmissionErrors],
@@ -277,7 +295,7 @@ def update_submission(
 
         conference = instance.conference
 
-        errors = input.validate(conference=conference)
+        errors = input.validate(conference=conference, submission=instance)
 
         if errors.has_errors:
             return errors
@@ -295,6 +313,7 @@ def update_submission(
         instance.speaker_level = input.speaker_level
         instance.previous_talk_video = input.previous_talk_video
         instance.short_social_summary = input.short_social_summary
+
         languages = Language.objects.filter(code__in=input.languages).all()
         instance.languages.set(languages)
 
@@ -304,13 +323,16 @@ def update_submission(
 
         materials_to_create = []
         materials_to_update = []
-        materials_to_delete = []
 
-        existing_materials = list(instance.materials.all())
+        existing_materials = {
+            existing_material.id: existing_material
+            for existing_material in instance.materials.all()
+        }
         for material in input.materials:
-            existing_material = next(
-                (m for m in existing_materials if m.id == material.id), None
+            existing_material = (
+                existing_materials.get(int(material.id)) if material.id else None
             )
+
             if existing_material:
                 existing_material.name = material.name
                 existing_material.url = material.url
@@ -326,12 +348,12 @@ def update_submission(
                     )
                 )
 
-        for material in existing_materials:
-            if material not in materials_to_update:
-                materials_to_delete.append(material)
-
         ProposalMaterial.objects.filter(
-            id__in=[m.id for m in materials_to_delete]
+            id__in=[
+                m.id
+                for m in existing_materials.values()
+                if m not in materials_to_update
+            ]
         ).delete()
         ProposalMaterial.objects.bulk_create(materials_to_create)
         ProposalMaterial.objects.bulk_update(

backend/api/submissions/tests/test_edit_submission.py

@@ -1,10 +1,20 @@
+from uuid import uuid4
+from users.tests.factories import UserFactory
 from conferences.tests.factories import ConferenceFactory
-from submissions.tests.factories import SubmissionFactory, SubmissionTagFactory
-from files_upload.tests.factories import FileFactory
+from submissions.tests.factories import (
+    ProposalMaterialFactory,
+    SubmissionFactory,
+    SubmissionTagFactory,
+)
+from files_upload.tests.factories import (
+    FileFactory,
+    ParticipantAvatarFileFactory,
+    ProposalMaterialFileFactory,
+)
 from pytest import mark
 
 from participants.models import Participant
-from submissions.models import Submission
+from submissions.models import ProposalMaterial, Submission
 
 pytestmark = mark.django_db
 
@@ -13,11 +23,11 @@ def _update_submission(
     graphql_client,
     *,
     submission,
-    new_topic,
-    new_audience,
-    new_type,
-    new_tag,
-    new_duration,
+    new_topic=None,
+    new_audience=None,
+    new_type=None,
+    new_tag=None,
+    new_duration=None,
     new_title=None,
     new_elevator_pitch=None,
     new_abstract=None,
@@ -34,13 +44,20 @@ def _update_submission(
     new_speaker_facebook_url="",
     new_speaker_mastodon_handle="",
     new_speaker_availabilities=None,
+    new_materials=None,
 ):
+    new_topic = new_topic or submission.topic
+    new_audience = new_audience or submission.audience_level
+    new_type = new_type or submission.type
+    new_tag = new_tag or submission.tags.first()
+    new_duration = new_duration or submission.duration
     new_title = new_title or {"en": "new title to use"}
     new_elevator_pitch = new_elevator_pitch or {"en": "This is an elevator pitch"}
     new_abstract = new_abstract or {"en": "abstract here"}
     short_social_summary = new_short_social_summary or ""
     new_speaker_photo = new_speaker_photo or FileFactory().id
     new_speaker_availabilities = new_speaker_availabilities or {}
+    new_materials = new_materials or []
 
     return graphql_client.query(
         """
@@ -114,6 +131,11 @@ def _update_submission(
                     validationSpeakerInstagramHandle: speakerInstagramHandle
                     validationSpeakerLinkedinUrl: speakerLinkedinUrl
                     validationSpeakerFacebookUrl: speakerFacebookUrl
+                    validationMaterials: materials {
+                        fileId
+                        url
+                        id
+                    }
                 }
             }
         }
@@ -144,6 +166,7 @@ def _update_submission(
                 "speakerFacebookUrl": new_speaker_facebook_url,
                 "speakerMastodonHandle": new_speaker_mastodon_handle,
                 "speakerAvailabilities": new_speaker_availabilities,
+                "materials": new_materials,
             }
         },
     )
@@ -204,6 +227,222 @@ def test_update_submission(graphql_client, user):
     assert participant.linkedin_url == "http://linkedin.com/company/pythonpizza"
 
 
+def test_update_submission_with_materials(graphql_client, user):
+    conference = ConferenceFactory(
+        topics=("life", "diy"),
+        languages=("it", "en"),
+        durations=("10", "20"),
+        active_cfp=True,
+        audience_levels=("adult", "senior"),
+        submission_types=("talk", "workshop"),
+    )
+
+    submission = SubmissionFactory(
+        speaker_id=user.id,
+        custom_topic="life",
+        custom_duration="10m",
+        custom_audience_level="adult",
+        custom_submission_type="talk",
+        languages=["it"],
+        tags=["python", "ml"],
+        conference=conference,
+        speaker_level=Submission.SPEAKER_LEVELS.intermediate,
+        previous_talk_video="https://www.youtube.com/watch?v=SlPhMPnQ58k",
+    )
+
+    graphql_client.force_login(user)
+
+    new_file = FileFactory()
+    response = _update_submission(
+        graphql_client,
+        submission=submission,
+        new_materials=[
+            {
+                "fileId": new_file.id,
+                "url": "",
+                "name": "test.pdf",
+            },
+            {
+                "fileId": None,
+                "url": "https://www.google.com",
+                "name": "https://www.google.com",
+            },
+        ],
+    )
+
+    submission.refresh_from_db()
+    materials = submission.materials.order_by("id").all()
+
+    assert len(materials) == 2
+    assert materials[0].file_id == new_file.id
+    assert materials[0].url == ""
+    assert materials[0].name == "test.pdf"
+
+    assert materials[1].file_id is None
+    assert materials[1].url == "https://www.google.com"
+    assert materials[1].name == "https://www.google.com"
+
+    assert response["data"]["updateSubmission"]["__typename"] == "Submission"
+
+
+def test_update_submission_with_existing_materials(graphql_client, user):
+    conference = ConferenceFactory(
+        topics=("life", "diy"),
+        languages=("it", "en"),
+        durations=("10", "20"),
+        active_cfp=True,
+        audience_levels=("adult", "senior"),
+        submission_types=("talk", "workshop"),
+    )
+
+    submission = SubmissionFactory(
+        speaker_id=user.id,
+        custom_topic="life",
+        custom_duration="10m",
+        custom_audience_level="adult",
+        custom_submission_type="talk",
+        languages=["it"],
+        tags=["python", "ml"],
+        conference=conference,
+        speaker_level=Submission.SPEAKER_LEVELS.intermediate,
+        previous_talk_video="https://www.youtube.com/watch?v=SlPhMPnQ58k",
+    )
+    existing_material = ProposalMaterialFactory(proposal=submission, file=FileFactory())
+    to_delete_material = ProposalMaterialFactory(
+        proposal=submission, file=FileFactory()
+    )
+
+    graphql_client.force_login(user)
+
+    new_file = FileFactory()
+    response = _update_submission(
+        graphql_client,
+        submission=submission,
+        new_materials=[
+            {
+                "fileId": new_file.id,
+                "url": "",
+                "name": "test.pdf",
+            },
+            {
+                "id": existing_material.id,
+                "fileId": None,
+                "url": "https://www.google.com",
+                "name": "https://www.google.com",
+            },
+        ],
+    )
+
+    submission.refresh_from_db()
+    materials = submission.materials.order_by("id").all()
+
+    assert len(materials) == 2
+
+    existing_material.refresh_from_db()
+
+    assert existing_material.file_id is None
+    assert existing_material.url == "https://www.google.com"
+    assert existing_material.name == "https://www.google.com"
+
+    assert response["data"]["updateSubmission"]["__typename"] == "Submission"
+
+    assert not ProposalMaterial.objects.filter(id=to_delete_material.id).exists()
+
+
+def test_update_submission_with_invalid_materials(graphql_client, user):
+    conference = ConferenceFactory(
+        topics=("life", "diy"),
+        languages=("it", "en"),
+        durations=("10", "20"),
+        active_cfp=True,
+        audience_levels=("adult", "senior"),
+        submission_types=("talk", "workshop"),
+    )
+
+    submission = SubmissionFactory(
+        speaker_id=user.id,
+        custom_topic="life",
+        custom_duration="10m",
+        custom_audience_level="adult",
+        custom_submission_type="talk",
+        languages=["it"],
+        tags=["python", "ml"],
+        conference=conference,
+        speaker_level=Submission.SPEAKER_LEVELS.intermediate,
+        previous_talk_video="https://www.youtube.com/watch?v=SlPhMPnQ58k",
+    )
+    other_submission_material = ProposalMaterialFactory(
+        proposal=SubmissionFactory(conference=conference),
+        file=ProposalMaterialFileFactory(uploaded_by=user),
+    )
+    to_delete_material = ProposalMaterialFactory(
+        proposal=submission, file=ProposalMaterialFileFactory(uploaded_by=user)
+    )
+
+    graphql_client.force_login(user)
+
+    response = _update_submission(
+        graphql_client,
+        submission=submission,
+        new_materials=[
+            {
+                "fileId": None,
+                "url": "invalid-url",
+                "name": "test.pdf",
+            },
+            {
+                "id": other_submission_material.id,
+                "fileId": None,
+                "url": "https://www.google.com",
+                "name": "https://www.google.com",
+            },
+            {
+                "id": "invalid-id",
+                "fileId": None,
+                "url": "https://www.google.com",
+                "name": "https://www.google.com",
+            },
+            {
+                "fileId": uuid4(),
+                "url": "",
+                "name": "name",
+            },
+            {
+                "fileId": ProposalMaterialFileFactory(uploaded_by=UserFactory()).id,
+                "url": "",
+                "name": "name",
+            },
+            {
+                "fileId": ParticipantAvatarFileFactory(uploaded_by=user).id,
+                "url": "",
+                "name": "name",
+            },
+        ],
+    )
+
+    assert response["data"]["updateSubmission"]["__typename"] == "SendSubmissionErrors"
+    assert response["data"]["updateSubmission"]["errors"]["validationMaterials"][0][
+        "url"
+    ] == ["Invalid URL"]
+    assert response["data"]["updateSubmission"]["errors"]["validationMaterials"][1][
+        "id"
+    ] == ["Material not found"]
+    assert response["data"]["updateSubmission"]["errors"]["validationMaterials"][2][
+        "id"
+    ] == ["Invalid material id"]
+    assert response["data"]["updateSubmission"]["errors"]["validationMaterials"][3][
+        "fileId"
+    ] == ["File not found"]
+    assert response["data"]["updateSubmission"]["errors"]["validationMaterials"][4][
+        "fileId"
+    ] == ["File not found"]
+    assert response["data"]["updateSubmission"]["errors"]["validationMaterials"][5][
+        "fileId"
+    ] == ["File not found"]
+
+    assert ProposalMaterial.objects.filter(id=to_delete_material.id).exists()
+
+
 def test_update_submission_speaker_availabilities(graphql_client, user):
     conference = ConferenceFactory(
         topics=("life", "diy"),