Migrate schedule invitation type to Strawberry Django (#4758)

Author: patrick91

backend/api/schedule/mutations/update_schedule_invitation.py

@@ -1,25 +1,17 @@
-from api.context import Info
+import strawberry
 from django.db import transaction
-from api.schedule.types import (
-    ScheduleInvitationOption,
-)
-from submissions.models import Submission
-from schedule.models import (
-    ScheduleItem,
-)
-from typing import Union
+
+from api.context import Info
 from api.permissions import IsAuthenticated
-from api.schedule.types import (
-    ScheduleInvitation,
-)
+from api.schedule.types import ScheduleInvitation, ScheduleInvitationOption
 from api.submissions.permissions import IsSubmissionSpeakerOrStaff
-
+from schedule import models as schedule_models
 from schedule.tasks import (
     create_and_send_voucher_to_speaker,
     notify_new_schedule_invitation_answer_slack,
     send_schedule_invitation_plain_message,
 )
-import strawberry
+from submissions import models as submission_models
 
 
 @strawberry.input
@@ -37,8 +29,8 @@ class ScheduleInvitationNotFound:
 @strawberry.mutation(permission_classes=[IsAuthenticated])
 def update_schedule_invitation(
     info: Info, input: UpdateScheduleInvitationInput
-) -> Union[ScheduleInvitationNotFound, ScheduleInvitation]:
-    submission = Submission.objects.get_by_hashid(input.submission_id)
+) -> ScheduleInvitationNotFound | ScheduleInvitation:
+    submission = submission_models.Submission.objects.get_by_hashid(input.submission_id)
 
     if not IsSubmissionSpeakerOrStaff().has_object_permission(info, submission):
         return ScheduleInvitationNotFound()
@@ -47,11 +39,11 @@ def update_schedule_invitation(
     # since currently we do not schedule the same talk to appear multiple times
     # in the future this needs to be fixed :)
     schedule_item = (
-        ScheduleItem.objects.filter(
+        schedule_models.ScheduleItem.objects.filter(
             submission_id=submission.id,
             conference_id=submission.conference_id,
         )
-        .exclude(status=ScheduleItem.STATUS.cancelled)
+        .exclude(status=schedule_models.ScheduleItem.STATUS.cancelled)
         .first()
     )
 
@@ -64,14 +56,14 @@ def update_schedule_invitation(
 
     if not status_changed and schedule_item.speaker_invitation_notes == new_notes:
         # If nothing changed, do nothing
-        return ScheduleInvitation.from_django_model(schedule_item)
+        return schedule_item
 
     with transaction.atomic():
         schedule_item.status = new_status
         schedule_item.speaker_invitation_notes = new_notes
         schedule_item.save()
 
-    if status_changed and new_status == ScheduleItem.STATUS.confirmed:
+    if status_changed and new_status == schedule_models.ScheduleItem.STATUS.confirmed:
         create_and_send_voucher_to_speaker.delay(schedule_item.id)
 
     request = info.context.request
@@ -90,4 +82,4 @@ def update_schedule_invitation(
             schedule_item_id=schedule_item.id,
             message=new_notes,
         )
-    return ScheduleInvitation.from_django_model(schedule_item)
+    return schedule_item

backend/api/schedule/queries/schedule_invitation.py

@@ -1,39 +1,26 @@
-from api.context import Info
-from schedule.models import ScheduleItem as ScheduleItemModel
-from api.submissions.permissions import IsSubmissionSpeakerOrStaff
-from submissions.models import Submission as SubmissionModel
 import strawberry
-from api.schedule.types.schedule_invitation import ScheduleInvitation
+import strawberry_django
+
+from api.context import Info
 from api.permissions import IsAuthenticated
+from api.schedule.types.schedule_invitation import ScheduleInvitation
+from api.submissions.permissions import IsSubmissionSpeakerOrStaff
+from schedule import models as schedule_models
+from submissions import models as submission_models
 
 
-@strawberry.field(permission_classes=[IsAuthenticated])
+@strawberry_django.field(permission_classes=[IsAuthenticated])
 def schedule_invitation(
     info: Info, submission_id: strawberry.ID
 ) -> ScheduleInvitation | None:
-    submission = SubmissionModel.objects.get_by_hashid(submission_id)
+    submission = submission_models.Submission.objects.get_by_hashid(submission_id)
 
     if not IsSubmissionSpeakerOrStaff().has_object_permission(info, submission):
         return None
 
     # TODO: A submission could be added to multiple schedule item
     # in the future we should support it
-    schedule_item = (
-        ScheduleItemModel.objects.filter(
-            conference_id=submission.conference_id,
-            submission_id=submission.id,
-        )
-        .prefetch_related(
-            "submission",
-            "submission__duration",
-            "slot",
-            "slot__day",
-        )
-        .exclude(status=ScheduleItemModel.STATUS.cancelled)
-        .first()
-    )
-
-    if not schedule_item:
-        return None
-
-    return ScheduleInvitation.from_django_model(schedule_item)
+    return schedule_models.ScheduleItem.objects.filter(
+        conference_id=submission.conference_id,
+        submission_id=submission.id,
+    ).exclude(status=schedule_models.ScheduleItem.STATUS.cancelled)

backend/api/schedule/tests/test_schedule_invitation_frontend_query.py

@@ -64,7 +64,7 @@ def test_schedule_invitation_frontend_query(
     )
     graphql_client.force_login(user)
 
-    with django_assert_num_queries(8):
+    with django_assert_num_queries(4):
         response = graphql_client.query(
             SCHEDULE_INVITATION_QUERY,
             variables={"language": "en", "submissionId": submission.hashid},

backend/api/schedule/tests/test_update_schedule_invitation.py

@@ -1,8 +1,8 @@
-from submissions.tests.factories import SubmissionFactory
-from schedule.tests.factories import DayFactory, ScheduleItemFactory, SlotFactory
 from pytest import mark
 
 from schedule.models import ScheduleItem
+from schedule.tests.factories import DayFactory, ScheduleItemFactory, SlotFactory
+from submissions.tests.factories import SubmissionFactory
 
 pytestmark = mark.django_db
 
@@ -52,6 +52,7 @@ def test_update_invitation_answer(
         updateScheduleInvitation(input: $input) {
             __typename
             ... on ScheduleInvitation {
+                id
                 option
                 notes
             }
@@ -69,6 +70,7 @@ def test_update_invitation_answer(
     assert not response.get("errors")
     assert response["data"]["updateScheduleInvitation"] == {
         "__typename": "ScheduleInvitation",
+        "id": submission.hashid,
         "option": option,
         "notes": "notes",
     }

backend/api/schedule/types/schedule_invitation.py

@@ -2,27 +2,21 @@
 from enum import Enum
 
 import strawberry
+import strawberry_django
 
 from api.submissions.types import Submission
-from schedule.models import ScheduleItem as ScheduleItemModel
+from schedule import models
 
 
-@strawberry.type
+@strawberry_django.type(models.ScheduleItem)
 class ScheduleInvitationDate:
-    id: strawberry.ID
+    id: strawberry.auto
     start: datetime
     end: datetime
-    duration: int
 
-    @classmethod
-    def from_django(cls, schedule_item):
-        duration = schedule_item.duration or schedule_item.slot.duration
-        return cls(
-            id=schedule_item.id,
-            start=schedule_item.start,
-            end=schedule_item.end,
-            duration=duration,
-        )
+    @strawberry_django.field
+    def duration(self) -> int:
+        return self.duration or self.slot.duration
 
 
 @strawberry.enum
@@ -33,43 +27,40 @@ class ScheduleInvitationOption(Enum):
     REJECT = "reject"
     CANT_ATTEND = "cant_attend"
 
-    def to_schedule_item_status(self):
-        return MAP_OPTION_TO_ITEM_STATUS.get(self)
-
-    @staticmethod
-    def from_schedule_item_status(schedule_item_status: str):
-        return MAP_ITEM_STATUS_TO_OPTION.get(schedule_item_status)
+    def to_schedule_item_status(self) -> str:
+        return MAP_OPTION_TO_ITEM_STATUS[self]
 
 
 MAP_OPTION_TO_ITEM_STATUS = {
-    ScheduleInvitationOption.CONFIRM: ScheduleItemModel.STATUS.confirmed,
-    ScheduleInvitationOption.MAYBE: ScheduleItemModel.STATUS.maybe,
-    ScheduleInvitationOption.REJECT: ScheduleItemModel.STATUS.rejected,
-    ScheduleInvitationOption.CANT_ATTEND: ScheduleItemModel.STATUS.cant_attend,
-    ScheduleInvitationOption.NO_ANSWER: ScheduleItemModel.STATUS.waiting_confirmation,
+    ScheduleInvitationOption.CONFIRM: models.ScheduleItem.STATUS.confirmed,
+    ScheduleInvitationOption.MAYBE: models.ScheduleItem.STATUS.maybe,
+    ScheduleInvitationOption.REJECT: models.ScheduleItem.STATUS.rejected,
+    ScheduleInvitationOption.CANT_ATTEND: models.ScheduleItem.STATUS.cant_attend,
+    ScheduleInvitationOption.NO_ANSWER: models.ScheduleItem.STATUS.waiting_confirmation,
 }
 
 MAP_ITEM_STATUS_TO_OPTION = {
     item: option for option, item in MAP_OPTION_TO_ITEM_STATUS.items()
 }
 
 
-@strawberry.type
+@strawberry_django.type(models.ScheduleItem)
 class ScheduleInvitation:
-    id: strawberry.ID
-    option: ScheduleInvitationOption
-    notes: str
-    title: str
+    id: strawberry.ID = strawberry_django.field(
+        resolver=lambda self: self.submission.hashid,
+        select_related=["submission"],
+    )
+    option: ScheduleInvitationOption = strawberry_django.field(
+        resolver=lambda self: MAP_ITEM_STATUS_TO_OPTION[self.status],
+        only=["status"],
+    )
+    notes: str = strawberry_django.field(field_name="speaker_invitation_notes")
+    title: strawberry.auto
     submission: Submission
-    dates: list[ScheduleInvitationDate]
 
-    @classmethod
-    def from_django_model(cls, instance):
-        return cls(
-            id=instance.submission.hashid,
-            title=instance.title,
-            option=ScheduleInvitationOption.from_schedule_item_status(instance.status),
-            notes=instance.speaker_invitation_notes,
-            submission=instance.submission,
-            dates=[ScheduleInvitationDate.from_django(instance)],
-        )
+    @strawberry_django.field(
+        only=["duration", "slot__duration", "slot__hour", "slot__day__day"],
+        select_related=["slot__day"],
+    )
+    def dates(self) -> list[ScheduleInvitationDate]:
+        return [self]