Migrate grant type to Strawberry Django (#4745)

Author: patrick91

backend/api/grants/mutations.py

@@ -1,6 +1,6 @@
 from dataclasses import asdict
 from enum import Enum
-from typing import Annotated, Optional, Union
+from typing import Annotated
 
 import strawberry
 from django.db import transaction
@@ -17,7 +17,7 @@
 )
 from generic_forms.models import Form, FormAnswer
 from generic_forms.services import validate_answers, wrap_answers
-from grants.models import Grant as GrantModel
+from grants import models as grant_models
 from grants.tasks import (
     create_and_send_voucher_to_grantee,
     get_name,
@@ -196,7 +196,7 @@ class SendGrantInput(BaseGrantInput):
     def validate(self, conference: Conference, user: User) -> GrantErrors | None:
         errors = super().validate(conference=conference, user=user)
 
-        if GrantModel.objects.of_user(user).for_conference(conference).exists():
+        if grant_models.Grant.objects.of_user(user).for_conference(conference).exists():
             errors.add_error("non_field_errors", "Grant already submitted!")
 
         return errors.if_has_errors
@@ -239,11 +239,11 @@ def validate(self, conference: Conference, user: User) -> GrantErrors | None:
 
 
 SendGrantResult = Annotated[
-    Union[Grant, GrantErrors], strawberry.union(name="SendGrantResult")
+    Grant | GrantErrors, strawberry.union(name="SendGrantResult")
 ]
 
 UpdateGrantResult = Annotated[
-    Union[Grant, GrantErrors], strawberry.union(name="UpdateGrantResult")
+    Grant | GrantErrors, strawberry.union(name="UpdateGrantResult")
 ]
 
 
@@ -252,14 +252,14 @@ class StatusOption(Enum):
     confirmed = "confirmed"
     refused = "refused"
 
-    def to_grant_status(self) -> GrantModel.Status:
-        return GrantModel.Status(self.name)
+    def to_grant_status(self) -> grant_models.Grant.Status:
+        return grant_models.Grant.Status(self.name)
 
 
 @strawberry.input
 class SendGrantReplyInput:
     instance: strawberry.ID
-    status: Optional[StatusOption]
+    status: StatusOption | None
 
 
 @strawberry.type
@@ -268,7 +268,7 @@ class SendGrantReplyError:
 
 
 SendGrantReplyResult = Annotated[
-    Union[Grant, SendGrantReplyError], strawberry.union(name="SendGrantReplyResult")
+    Grant | SendGrantReplyError, strawberry.union(name="SendGrantReplyResult")
 ]
 
 
@@ -300,33 +300,29 @@ def send_grant(self, info: Info, input: SendGrantInput) -> SendGrantResult:
         if errors := input.validate(conference=conference, user=request.user):
             return errors
 
-        instance = GrantModel.objects.create(
-            **{
-                "user_id": request.user.id,
-                "conference": conference,
-                "name": input.name,
-                "full_name": input.full_name,
-                # soft columns are NOT NULL; on the answers path they are
-                # omitted from the input and stored empty
-                "age_group": input.age_group or "",
-                "gender": input.gender or "",
-                "occupation": input.occupation or "",
-                "grant_type": input.grant_type,
-                "python_usage": input.python_usage or "",
-                "been_to_other_events": input.been_to_other_events or "",
-                "community_contribution": input.community_contribution or "",
-                "needs_funds_for_travel": input.needs_funds_for_travel,
-                "need_visa": input.need_visa,
-                "need_accommodation": input.need_accommodation,
-                "why": input.why or "",
-                "notes": input.notes or "",
-                "departure_country": input.departure_country,
-                "nationality": input.nationality,
-                "departure_city": input.departure_city,
-                "form_answer": _persist_form_answer(
-                    input.answers, conference, request.user
-                ),
-            }
+        instance = grant_models.Grant.objects.create(
+            user_id=request.user.id,
+            conference=conference,
+            name=input.name,
+            full_name=input.full_name,
+            # soft columns are NOT NULL; on the answers path they are
+            # omitted from the input and stored empty
+            age_group=input.age_group or "",
+            gender=input.gender or "",
+            occupation=input.occupation or "",
+            grant_type=input.grant_type,
+            python_usage=input.python_usage or "",
+            been_to_other_events=input.been_to_other_events or "",
+            community_contribution=input.community_contribution or "",
+            needs_funds_for_travel=input.needs_funds_for_travel,
+            need_visa=input.need_visa,
+            need_accommodation=input.need_accommodation,
+            why=input.why or "",
+            notes=input.notes or "",
+            departure_country=input.departure_country,
+            nationality=input.nationality,
+            departure_city=input.departure_city,
+            form_answer=_persist_form_answer(input.answers, conference, request.user),
         )
 
         record_privacy_policy_acceptance(
@@ -362,16 +358,14 @@ def send_grant(self, info: Info, input: SendGrantInput) -> SendGrantResult:
 
         create_addition_admin_log_entry(request.user, instance, "Grant created.")
 
-        # hack because we return django models
-        instance.__strawberry_definition__ = Grant.__strawberry_definition__
         return instance
 
     @strawberry.mutation(permission_classes=[IsAuthenticated])
     @transaction.atomic
     def update_grant(self, info: Info, input: UpdateGrantInput) -> UpdateGrantResult:
         request = info.context.request
 
-        instance = GrantModel.objects.get(id=input.instance)
+        instance = grant_models.Grant.objects.get(id=input.instance)
         if not instance.can_edit(request.user):
             return GrantErrors.with_error(
                 "non_field_errors", "You cannot edit this grant"
@@ -415,7 +409,6 @@ def update_grant(self, info: Info, input: UpdateGrantInput) -> UpdateGrantResult
             },
         )
 
-        instance.__strawberry_definition__ = Grant.__strawberry_definition__
         return instance
 
     @strawberry.mutation(permission_classes=[IsAuthenticated])
@@ -424,19 +417,25 @@ def send_grant_reply(
     ) -> SendGrantReplyResult:
         request = info.context.request
 
-        grant = GrantModel.objects.get(id=input.instance)
+        grant = grant_models.Grant.objects.get(id=input.instance)
         if not grant.can_edit(request.user):
             return SendGrantReplyError(message="You cannot reply to this grant")
 
         # Can't modify the status if the grant is still pending or was already rejected
-        if grant.status in (GrantModel.Status.pending, GrantModel.Status.rejected):
+        if grant.status in (
+            grant_models.Grant.Status.pending,
+            grant_models.Grant.Status.rejected,
+        ):
             return SendGrantReplyError(message="You cannot reply to this grant")
 
         old_status = grant.status
         grant.status = input.status.to_grant_status()
         grant.save()
 
-        if old_status != grant.status and grant.status == GrantModel.Status.confirmed:
+        if (
+            old_status != grant.status
+            and grant.status == grant_models.Grant.Status.confirmed
+        ):
             transaction.on_commit(
                 lambda gid=grant.id: create_and_send_voucher_to_grantee.delay(
                     grant_id=gid
@@ -450,4 +449,4 @@ def send_grant_reply(
         admin_url = request.build_absolute_uri(grant.get_admin_url())
         notify_new_grant_reply_slack.delay(grant_id=grant.id, admin_url=admin_url)
 
-        return Grant.from_model(grant)
+        return grant

backend/api/grants/tests/test_frontend_queries.py

@@ -60,7 +60,7 @@ def test_frontend_my_grant_query(graphql_client, django_assert_num_queries, user
     )
     grant.save()
 
-    with django_assert_num_queries(4):
+    with django_assert_num_queries(3):
         response = graphql_client.query(
             MY_GRANT_QUERY,
             variables={"conference": grant.conference.code},

backend/api/grants/types.py

@@ -1,76 +1,54 @@
-from __future__ import annotations
-
-from datetime import datetime
-from typing import Optional
-
 import strawberry
+import strawberry_django
 from strawberry.scalars import JSON
 
 from generic_forms.services import unwrap_answers
-from grants.models import Grant as GrantModel
+from grants import models
 
-Status = strawberry.enum(GrantModel.Status)
-AgeGroup = strawberry.enum(GrantModel.AgeGroup)
-Occupation = strawberry.enum(GrantModel.Occupation)
-GrantType = strawberry.enum(GrantModel.GrantType)
+Status = strawberry.enum(models.Grant.Status)
+AgeGroup = strawberry.enum(models.Grant.AgeGroup)
+Occupation = strawberry.enum(models.Grant.Occupation)
+GrantType = strawberry.enum(models.Grant.GrantType)
 
 
-@strawberry.type
+@strawberry_django.type(
+    models.Grant,
+    only=["status", "pending_status", "country_type"],
+)
 class Grant:
-    id: strawberry.ID
+    id: strawberry.auto
     status: Status
-    name: str
-    full_name: str
-    age_group: Optional[AgeGroup]
-    gender: str
+    name: strawberry.auto
+    full_name: strawberry.auto
+
+    age_group: AgeGroup | None
+
+    @strawberry_django.field(only=["age_group"])
+    def age_group(self) -> AgeGroup | None:
+        return AgeGroup(self.age_group) if self.age_group else None
+
+    gender: strawberry.auto
     occupation: Occupation
     grant_type: list[GrantType]
-    python_usage: str
-    community_contribution: str
-    been_to_other_events: str
-    needs_funds_for_travel: bool
-    need_visa: bool
-    need_accommodation: bool
-    why: str
-    notes: str
-    departure_country: Optional[str]
-    nationality: Optional[str]
-    departure_city: Optional[str]
-    applicant_reply_deadline: Optional[datetime]
-
-    @strawberry.field
+    python_usage: strawberry.auto
+    community_contribution: strawberry.auto
+    been_to_other_events: strawberry.auto
+    needs_funds_for_travel: strawberry.auto
+    need_visa: strawberry.auto
+    need_accommodation: strawberry.auto
+    why: strawberry.auto
+    notes: strawberry.auto
+    departure_country: strawberry.auto
+    nationality: strawberry.auto
+    departure_city: strawberry.auto
+    applicant_reply_deadline: strawberry.auto
+
+    @strawberry_django.field(
+        only=["form_answer_id", "form_answer__answers"],
+        select_related=["form_answer"],
+    )
     def form_answers(self) -> JSON | None:
-        # root is either the Django model (mutations return it directly)
-        # or a from_model()-built instance, which attaches form_answer below
-        form_answer = getattr(self, "form_answer", None)
-        if form_answer is None:
+        if self.form_answer_id is None:
             return None
-        return unwrap_answers(form_answer.answers)
 
-    @classmethod
-    def from_model(cls, grant: GrantModel) -> Grant:
-        instance = cls(
-            id=grant.id,
-            status=Status(grant.status),
-            name=grant.name,
-            full_name=grant.full_name,
-            age_group=AgeGroup(grant.age_group) if grant.age_group else None,
-            gender=grant.gender,
-            occupation=Occupation(grant.occupation),
-            grant_type=[GrantType(g) for g in grant.grant_type],
-            python_usage=grant.python_usage,
-            community_contribution=grant.community_contribution,
-            been_to_other_events=grant.been_to_other_events,
-            needs_funds_for_travel=grant.needs_funds_for_travel,
-            need_visa=grant.need_visa,
-            need_accommodation=grant.need_accommodation,
-            why=grant.why,
-            notes=grant.notes,
-            departure_country=grant.departure_country,
-            nationality=grant.nationality,
-            departure_city=grant.departure_city,
-            applicant_reply_deadline=grant.applicant_reply_deadline,
-        )
-        # not a declared strawberry field; read by the form_answers resolver
-        instance.form_answer = grant.form_answer
-        return instance
+        return unwrap_answers(self.form_answer.answers)

backend/api/users/types.py

@@ -1,5 +1,4 @@
 from datetime import date
-from logging import getLogger
 
 import strawberry
 import strawberry_django
@@ -22,7 +21,7 @@
 from badges.roles import ConferenceRole, get_conference_roles_for_user
 from billing.models import BillingAddress as BillingAddressModel
 from conferences.models import Conference
-from grants.models import Grant as GrantModel
+from grants import models as grant_models
 from participants import models as participant_models
 from pretix import user_has_admission_ticket
 from pycon.signing import sign_path
@@ -37,8 +36,6 @@
     InvitationLetterRequestOnBehalfOf,
 )
 
-logger = getLogger(__name__)
-
 PRETIX_ORDERS_STATUS_ORDER = [
     PretixOrderStatus.PAID,
     PretixOrderStatus.PENDING,
@@ -134,15 +131,12 @@ def booked_schedule_items(self, info: Info, conference: str) -> list[ScheduleIte
             .order_by("slot__day__day", "slot__hour")
         )
 
-    @strawberry.field
-    def grant(self, info: Info, conference: str) -> Grant | None:
-        grant = GrantModel.objects.filter(
-            user_id=self.id, conference__code=conference
-        ).first()
-        logger.info(
-            "Grant: user_id: %s, conference: %s, grant: %s", self.id, conference, grant
+    @strawberry_django.field
+    def grant(self, conference: str) -> Grant | None:
+        return grant_models.Grant.objects.filter(
+            user_id=self.id,
+            conference__code=conference,
         )
-        return Grant.from_model(grant) if grant else None
 
     @strawberry_django.field
     def participant(self, info: Info, conference: str) -> Participant | None: