Add endpoints for rejecting and restoring all section options

Author: matti-lamppu

api/graphql/extensions/error_codes.py

@@ -37,3 +37,5 @@
 HELSINKI_PROFILE_RESERVATION_USER_MISSING = "HELSINKI_PROFILE_RESERVATION_USER_MISSING"
 HELSINKI_PROFILE_APPLICATION_USER_MISSING = "HELSINKI_PROFILE_APPLICATION_USER_MISSING"
 HELSINKI_PROFILE_USER_MISSING_PROFILE_ID = "HELSINKI_PROFILE_USER_MISSING_PROFILE_ID"
+
+CANNOT_REJECT_SECTION_OPTIONS = "CANNOT_REJECT_SECTION_OPTIONS"

api/graphql/mutations.py

@@ -2,15 +2,18 @@
 Import all mutation classes to this file.
 
 This is done to avoid issues where the mutation class's model serializer has other
-model serializers as fields. In this case, graphene-django requires that a matching
+model serializers as fields. In this case, `graphene-django` requires that a matching
 ObjectType for the sub-serializer's model is created before the mutation class is created.
 If the import order in `schema.py` is such that the mutation class is imported first,
 the mutation class creation fails.
 
-Importing all mutations to this file and then to the schema.py file AFTER importing
-the corresponding `queries.py` with all the ObjectTypes mitigates this issue.
+Importing all queries to this file from `queries.py` before importing any mutations,
+and then importing both to `schema.py` from these respective files solves the import order issue.
 """
 
+# Import all queries before importing any mutations! See explanation above.
+from .queries import *  # noqa: F403  # isort:skip
+
 from api.graphql.types.allocated_time_slot.mutations import (
     AllocatedTimeSlotCreateMutation,
     AllocatedTimeSlotDeleteMutation,
@@ -25,6 +28,8 @@
     ApplicationSectionCreateMutation,
     ApplicationSectionDeleteMutation,
     ApplicationSectionUpdateMutation,
+    RejectAllSectionOptionsMutation,
+    RestoreAllSectionOptionsMutation,
 )
 from api.graphql.types.banner_notification.mutations import (
     BannerNotificationCreateMutation,
@@ -99,6 +104,7 @@
     "RecurringReservationCreateMutation",
     "RecurringReservationUpdateMutation",
     "RefreshOrderMutation",
+    "RejectAllSectionOptionsMutation",
     "ReservationAdjustTimeMutation",
     "ReservationApproveMutation",
     "ReservationCancellationMutation",
@@ -122,6 +128,7 @@
     "ResourceCreateMutation",
     "ResourceDeleteMutation",
     "ResourceUpdateMutation",
+    "RestoreAllSectionOptionsMutation",
     "SpaceCreateMutation",
     "SpaceDeleteMutation",
     "SpaceUpdateMutation",

api/graphql/queries.py

@@ -1,7 +1,7 @@
 """
 Import all ObjectTypes backing django models to this file.
 This avoids issues in creating mutation classes (see mutation.py for more information).
-Note that the type should be imported here even if it's not imported to schema.py,
+Note that the type should be imported here even if it's not imported to `schema.py`,
 simply so that it's registered before any mutations.
 """
 

api/graphql/schema.py

@@ -20,44 +20,7 @@
 from users.helauth.typing import UserProfileInfo
 from users.models import User
 
-# NOTE: Queries __need__ to be imported before mutations, see mutations.py!
-from .queries import (  # isort:skip
-    AgeGroupNode,
-    AllocatedTimeSlotNode,
-    ApplicationNode,
-    ApplicationRoundNode,
-    ApplicationSectionNode,
-    BannerNotificationNode,
-    CityNode,
-    EquipmentCategoryNode,
-    EquipmentNode,
-    HelsinkiProfileDataNode,
-    KeywordCategoryNode,
-    KeywordGroupNode,
-    KeywordNode,
-    PaymentOrderNode,
-    PurposeNode,
-    QualifierNode,
-    RecurringReservationNode,
-    ReservationCancelReasonNode,
-    ReservationDenyReasonNode,
-    ReservationMetadataSetNode,
-    ReservationNode,
-    ReservationPurposeNode,
-    ReservationUnitCancellationRuleNode,
-    ReservationUnitNode,
-    ReservationUnitTypeNode,
-    ResourceNode,
-    ServiceSectorNode,
-    SpaceNode,
-    TaxPercentageNode,
-    TermsOfUseNode,
-    UnitNode,
-    UserNode,
-)
-from .types.merchants.permissions import PaymentOrderPermission
-
-from .mutations import (  # isort:skip
+from .mutations import (
     AllocatedTimeSlotCreateMutation,
     AllocatedTimeSlotDeleteMutation,
     ApplicationCancelMutation,
@@ -81,6 +44,7 @@
     RecurringReservationCreateMutation,
     RecurringReservationUpdateMutation,
     RefreshOrderMutation,
+    RejectAllSectionOptionsMutation,
     ReservationAdjustTimeMutation,
     ReservationApproveMutation,
     ReservationCancellationMutation,
@@ -104,12 +68,48 @@
     ResourceCreateMutation,
     ResourceDeleteMutation,
     ResourceUpdateMutation,
+    RestoreAllSectionOptionsMutation,
     SpaceCreateMutation,
     SpaceDeleteMutation,
     SpaceUpdateMutation,
     UnitUpdateMutation,
     UserUpdateMutation,
 )
+from .queries import (
+    AgeGroupNode,
+    AllocatedTimeSlotNode,
+    ApplicationNode,
+    ApplicationRoundNode,
+    ApplicationSectionNode,
+    BannerNotificationNode,
+    CityNode,
+    EquipmentCategoryNode,
+    EquipmentNode,
+    HelsinkiProfileDataNode,
+    KeywordCategoryNode,
+    KeywordGroupNode,
+    KeywordNode,
+    PaymentOrderNode,
+    PurposeNode,
+    QualifierNode,
+    RecurringReservationNode,
+    ReservationCancelReasonNode,
+    ReservationDenyReasonNode,
+    ReservationMetadataSetNode,
+    ReservationNode,
+    ReservationPurposeNode,
+    ReservationUnitCancellationRuleNode,
+    ReservationUnitNode,
+    ReservationUnitTypeNode,
+    ResourceNode,
+    ServiceSectorNode,
+    SpaceNode,
+    TaxPercentageNode,
+    TermsOfUseNode,
+    UnitNode,
+    UserNode,
+)
+from .types.merchants.permissions import PaymentOrderPermission
 
 
 class Query(graphene.ObjectType):
@@ -264,6 +264,8 @@ class Mutation(graphene.ObjectType):
     create_allocated_timeslot = AllocatedTimeSlotCreateMutation.Field()
     delete_allocated_timeslot = AllocatedTimeSlotDeleteMutation.Field()
     update_reservation_unit_option = ReservationUnitOptionUpdateMutation.Field()
+    reject_all_section_options = RejectAllSectionOptionsMutation.Field()
+    restore_all_section_options = RestoreAllSectionOptionsMutation.Field()
     #
     # Reservable entities
     update_unit = UnitUpdateMutation.Field()

api/graphql/types/application_section/mutations.py

@@ -1,15 +1,24 @@
 from graphene_django_extensions import CreateMutation, DeleteMutation, UpdateMutation
 from rest_framework.exceptions import ValidationError
 
-from api.graphql.types.application_section.permissions import ApplicationSectionPermission
-from api.graphql.types.application_section.serializers import ApplicationSectionSerializer
+from api.graphql.types.application_section.permissions import (
+    ApplicationSectionPermission,
+    UpdateAllSectionOptionsPermission,
+)
+from api.graphql.types.application_section.serializers import (
+    ApplicationSectionSerializer,
+    RejectAllSectionOptionsSerializer,
+    RestoreAllSectionOptionsSerializer,
+)
 from applications.models import ApplicationSection
 from common.typing import AnyUser
 
 __all__ = [
     "ApplicationSectionCreateMutation",
     "ApplicationSectionDeleteMutation",
     "ApplicationSectionUpdateMutation",
+    "RejectAllSectionOptionsMutation",
+    "RestoreAllSectionOptionsMutation",
 ]
 
 
@@ -34,3 +43,15 @@ class Meta:
     def validate_deletion(cls, instance: ApplicationSection, user: AnyUser) -> None:
         if not instance.status.can_delete:
             raise ValidationError("Application section has been allocated and cannot be deleted anymore.")
+
+
+class RejectAllSectionOptionsMutation(UpdateMutation):
+    class Meta:
+        serializer_class = RejectAllSectionOptionsSerializer
+        permission_classes = [UpdateAllSectionOptionsPermission]
+
+
+class RestoreAllSectionOptionsMutation(UpdateMutation):
+    class Meta:
+        serializer_class = RestoreAllSectionOptionsSerializer
+        permission_classes = [UpdateAllSectionOptionsPermission]

api/graphql/types/application_section/permissions.py

@@ -6,10 +6,11 @@
 from api.graphql.extensions import error_codes
 from applications.models import Application, ApplicationSection
 from common.typing import AnyUser
-from permissions.helpers import can_modify_application
+from permissions.helpers import can_modify_application, has_general_permission, has_unit_permission
 
 __all__ = [
     "ApplicationSectionPermission",
+    "UpdateAllSectionOptionsPermission",
 ]
 
 
@@ -39,3 +40,17 @@ def has_update_permission(cls, instance: ApplicationSection, user: AnyUser, inpu
     @classmethod
     def has_delete_permission(cls, instance: ApplicationSection, user: AnyUser, input_data: dict[str, Any]) -> bool:
         return can_modify_application(user, instance.application)
+
+
+class UpdateAllSectionOptionsPermission(BasePermission):
+    @classmethod
+    def has_update_permission(cls, instance: ApplicationSection, user: AnyUser, input_data: dict[str, Any]) -> bool:
+        if user.is_anonymous:
+            return False
+        if user.is_superuser:
+            return True
+        if has_general_permission(user, required_permission="can_handle_applications"):
+            return True
+
+        units = list(instance.reservation_unit_options.all().values_list("reservation_unit__unit__id", flat=True))
+        return has_unit_permission(user, "can_handle_applications", units)

api/graphql/types/application_section/serializers.py

@@ -6,9 +6,10 @@
 from graphene_django_extensions.serializers import NotProvided
 from rest_framework.exceptions import ValidationError
 
+from api.graphql.extensions import error_codes
 from api.graphql.types.reservation_unit_option.serializers import ReservationUnitOptionApplicantSerializer
 from api.graphql.types.suitable_time_range.serializers import SuitableTimeRangeSerializer
-from applications.models import Application, ApplicationRound, ApplicationSection
+from applications.models import AllocatedTimeSlot, Application, ApplicationRound, ApplicationSection
 from common.utils import comma_sep_str
 
 __all__ = [
@@ -151,3 +152,42 @@ class ApplicationSectionForApplicationSerializer(ApplicationSectionSerializer):
     class Meta:
         model = ApplicationSection
         fields = [item for item in ApplicationSectionSerializer.Meta.fields if item != "application"]
+
+
+class RejectAllSectionOptionsSerializer(NestingModelSerializer):
+    instance: ApplicationSection
+
+    class Meta:
+        model = ApplicationSection
+        fields = [
+            "pk",
+        ]
+
+    def validate(self, data: dict[str, Any]) -> dict[str, Any]:
+        slots_exist = AllocatedTimeSlot.objects.filter(
+            reservation_unit_option__application_section=self.instance,
+        ).exists()
+
+        if slots_exist:
+            msg = "Application section has allocated time slots and cannot be rejected."
+            raise ValidationError(msg, code=error_codes.CANNOT_REJECT_SECTION_OPTIONS)
+
+        return data
+
+    def save(self, **kwargs: Any) -> ApplicationSection:
+        self.instance.reservation_unit_options.all().update(rejected=True)
+        return self.instance
+
+
+class RestoreAllSectionOptionsSerializer(NestingModelSerializer):
+    instance: ApplicationSection
+
+    class Meta:
+        model = ApplicationSection
+        fields = [
+            "pk",
+        ]
+
+    def save(self, **kwargs: Any) -> ApplicationSection:
+        self.instance.reservation_unit_options.all().update(rejected=False)
+        return self.instance

tests/test_graphql_api/test_application_section/helpers.py

@@ -23,6 +23,14 @@
     "ApplicationSectionDeleteMutation",
     fields="deleted",
 )
+REJECT_MUTATION = build_mutation(
+    "rejectAllSectionOptions",
+    "RejectAllSectionOptionsMutation",
+)
+RESTORE_MUTATION = build_mutation(
+    "restoreAllSectionOptions",
+    "RestoreAllSectionOptionsMutation",
+)
 
 
 def get_application_section_create_data(application: Application) -> dict[str, Any]:

tests/test_graphql_api/test_application_section/test_reject_all_options.py

@@ -0,0 +1,66 @@
+import pytest
+
+from applications.choices import Weekday
+from tests.factories import ApplicationSectionFactory, UserFactory
+
+from .helpers import REJECT_MUTATION
+
+# Applied to all tests
+pytestmark = [
+    pytest.mark.django_db,
+]
+
+
+def test_application_section__reject_all_options(graphql):
+    application_section = ApplicationSectionFactory.create_in_status_in_allocation()
+    option = application_section.reservation_unit_options.first()
+    assert option.rejected is False
+
+    graphql.login_with_superuser()
+    response = graphql(REJECT_MUTATION, input_data={"pk": application_section.pk})
+
+    assert response.has_errors is False, response
+
+    option.refresh_from_db()
+    assert option.rejected is True
+
+
+def test_application_section__reject_all_options__has_allocations(graphql):
+    application_section = ApplicationSectionFactory.create_in_status_in_allocation(
+        reservation_unit_options__rejected=False,
+        reservation_unit_options__allocated_time_slots__day_of_the_week=Weekday.MONDAY,
+    )
+    option = application_section.reservation_unit_options.first()
+    assert option.rejected is False
+    assert option.allocated_time_slots.exists()
+
+    graphql.login_with_superuser()
+    response = graphql(REJECT_MUTATION, input_data={"pk": application_section.pk})
+
+    assert response.error_message() == "Mutation was unsuccessful.", response
+    assert response.field_error_messages() == [
+        "Application section has allocated time slots and cannot be rejected.",
+    ]
+
+
+def test_application_section__reject_all_options__general_admin(graphql):
+    application_section = ApplicationSectionFactory.create_in_status_in_allocation()
+
+    admin = UserFactory.create_with_general_permissions(perms=["can_handle_applications"])
+    graphql.force_login(admin)
+
+    response = graphql(REJECT_MUTATION, input_data={"pk": application_section.pk})
+
+    assert response.has_errors is False
+
+
+def test_application_section__reject_all_options__unit_admin(graphql):
+    application_section = ApplicationSectionFactory.create_in_status_in_allocation()
+
+    unit = application_section.reservation_unit_options.first().reservation_unit.unit
+    admin = UserFactory.create_with_unit_permissions(unit=unit, perms=["can_handle_applications"])
+    graphql.force_login(admin)
+
+    response = graphql(REJECT_MUTATION, input_data={"pk": application_section.pk})
+
+    assert response.has_errors is False