Add endpoints for rejecting and restoring all application options

Author: matti-lamppu

api/graphql/extensions/error_codes.py

@@ -39,3 +39,4 @@
 HELSINKI_PROFILE_USER_MISSING_PROFILE_ID = "HELSINKI_PROFILE_USER_MISSING_PROFILE_ID"
 
 CANNOT_REJECT_SECTION_OPTIONS = "CANNOT_REJECT_SECTION_OPTIONS"
+CANNOT_REJECT_APPLICATION_OPTIONS = "CANNOT_REJECT_APPLICATION_OPTIONS"

api/graphql/mutations.py

@@ -23,6 +23,8 @@
     ApplicationCreateMutation,
     ApplicationSendMutation,
     ApplicationUpdateMutation,
+    RejectAllApplicationOptionsMutation,
+    RestoreAllApplicationOptionsMutation,
 )
 from api.graphql.types.application_section.mutations import (
     ApplicationSectionCreateMutation,
@@ -104,6 +106,7 @@
     "RecurringReservationCreateMutation",
     "RecurringReservationUpdateMutation",
     "RefreshOrderMutation",
+    "RejectAllApplicationOptionsMutation",
     "RejectAllSectionOptionsMutation",
     "ReservationAdjustTimeMutation",
     "ReservationApproveMutation",
@@ -128,6 +131,7 @@
     "ResourceCreateMutation",
     "ResourceDeleteMutation",
     "ResourceUpdateMutation",
+    "RestoreAllApplicationOptionsMutation",
     "RestoreAllSectionOptionsMutation",
     "SpaceCreateMutation",
     "SpaceDeleteMutation",

api/graphql/schema.py

@@ -44,6 +44,7 @@
     RecurringReservationCreateMutation,
     RecurringReservationUpdateMutation,
     RefreshOrderMutation,
+    RejectAllApplicationOptionsMutation,
     RejectAllSectionOptionsMutation,
     ReservationAdjustTimeMutation,
     ReservationApproveMutation,
@@ -68,6 +69,7 @@
     ResourceCreateMutation,
     ResourceDeleteMutation,
     ResourceUpdateMutation,
+    RestoreAllApplicationOptionsMutation,
     RestoreAllSectionOptionsMutation,
     SpaceCreateMutation,
     SpaceDeleteMutation,
@@ -266,6 +268,8 @@ class Mutation(graphene.ObjectType):
     update_reservation_unit_option = ReservationUnitOptionUpdateMutation.Field()
     reject_all_section_options = RejectAllSectionOptionsMutation.Field()
     restore_all_section_options = RestoreAllSectionOptionsMutation.Field()
+    reject_all_application_options = RejectAllApplicationOptionsMutation.Field()
+    restore_all_application_options = RestoreAllApplicationOptionsMutation.Field()
     #
     # Reservable entities
     update_unit = UnitUpdateMutation.Field()

api/graphql/types/application/mutations.py

@@ -1,18 +1,22 @@
 from graphene_django_extensions import CreateMutation, UpdateMutation
 
-from api.graphql.types.application.permissions import ApplicationPermission
+from api.graphql.types.application.permissions import ApplicationPermission, UpdateAllApplicationOptionsPermission
 from api.graphql.types.application.serializers import (
     ApplicationCancelSerializer,
     ApplicationCreateSerializer,
     ApplicationSendSerializer,
     ApplicationUpdateSerializer,
+    RejectAllApplicationOptionsSerializer,
+    RestoreAllApplicationOptionsSerializer,
 )
 
 __all__ = [
     "ApplicationCancelMutation",
     "ApplicationCreateMutation",
     "ApplicationSendMutation",
     "ApplicationUpdateMutation",
+    "RejectAllApplicationOptionsMutation",
+    "RestoreAllApplicationOptionsMutation",
 ]
 
 
@@ -38,3 +42,15 @@ class ApplicationCancelMutation(UpdateMutation):
     class Meta:
         serializer_class = ApplicationCancelSerializer
         permission_classes = [ApplicationPermission]
+
+
+class RejectAllApplicationOptionsMutation(UpdateMutation):
+    class Meta:
+        serializer_class = RejectAllApplicationOptionsSerializer
+        permission_classes = [UpdateAllApplicationOptionsPermission]
+
+
+class RestoreAllApplicationOptionsMutation(UpdateMutation):
+    class Meta:
+        serializer_class = RestoreAllApplicationOptionsSerializer
+        permission_classes = [UpdateAllApplicationOptionsPermission]

api/graphql/types/application/permissions.py

@@ -2,10 +2,17 @@
 
 from typing import TYPE_CHECKING, Any
 
+from django.db.models import Prefetch
 from graphene_django_extensions.permissions import BasePermission
 
+from applications.models import ReservationUnitOption
 from common.typing import AnyUser
-from permissions.helpers import can_modify_application, can_read_application
+from permissions.helpers import (
+    can_modify_application,
+    can_read_application,
+    has_general_permission,
+    has_unit_permission,
+)
 
 if TYPE_CHECKING:
     from applications.models import Application
@@ -23,3 +30,26 @@ def has_node_permission(cls, instance: Application, user: AnyUser, filters: dict
     @classmethod
     def has_update_permission(cls, instance: Application, user: AnyUser, input_data: dict[str, Any]) -> bool:
         return can_modify_application(user, instance)
+
+
+class UpdateAllApplicationOptionsPermission(BasePermission):
+    @classmethod
+    def has_update_permission(cls, instance: Application, 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 = [
+            unit_id
+            for section in instance.application_sections.all().prefetch_related(
+                Prefetch(
+                    "reservation_unit_options",
+                    ReservationUnitOption.objects.all().select_related("reservation_unit__unit"),
+                )
+            )
+            for unit_id in section.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/serializers.py

@@ -4,14 +4,16 @@
 from django.utils import timezone
 from graphene_django_extensions import NestingModelSerializer
 from rest_framework import serializers
+from rest_framework.exceptions import ValidationError
 from rest_framework.settings import api_settings
 
+from api.graphql.extensions import error_codes
 from api.graphql.types.address.serializers import AddressSerializer
 from api.graphql.types.application_section.serializers import ApplicationSectionForApplicationSerializer
 from api.graphql.types.organisation.serializers import OrganisationSerializer
 from api.graphql.types.person.serializers import PersonSerializer
 from applications.choices import ApplicationStatusChoice
-from applications.models import Application
+from applications.models import AllocatedTimeSlot, Application, ReservationUnitOption
 from email_notification.helpers.application_email_notification_sender import ApplicationEmailNotificationSender
 from permissions.helpers import can_validate_unit_applications
 
@@ -126,3 +128,42 @@ def save(self, **kwargs: Any) -> Application:
         self.instance.cancelled_date = timezone.now()
         self.instance.save()
         return self.instance
+
+
+class RejectAllApplicationOptionsSerializer(NestingModelSerializer):
+    instance: Application
+
+    class Meta:
+        model = Application
+        fields = [
+            "pk",
+        ]
+
+    def validate(self, data: dict[str, Any]) -> dict[str, Any]:
+        slots_exist = AllocatedTimeSlot.objects.filter(
+            reservation_unit_option__application_section__application=self.instance,
+        ).exists()
+
+        if slots_exist:
+            msg = "Application has allocated time slots and cannot be rejected."
+            raise ValidationError(msg, code=error_codes.CANNOT_REJECT_APPLICATION_OPTIONS)
+
+        return data
+
+    def save(self, **kwargs: Any) -> Application:
+        ReservationUnitOption.objects.filter(application_section__application=self.instance).update(rejected=True)
+        return self.instance
+
+
+class RestoreAllApplicationOptionsSerializer(NestingModelSerializer):
+    instance: Application
+
+    class Meta:
+        model = Application
+        fields = [
+            "pk",
+        ]
+
+    def save(self, **kwargs: Any) -> Application:
+        ReservationUnitOption.objects.filter(application_section__application=self.instance).update(rejected=False)
+        return self.instance

tests/test_graphql_api/test_application/helpers.py

@@ -34,6 +34,14 @@
     "cancelApplication",
     "ApplicationCancelMutation",
 )
+REJECT_MUTATION = build_mutation(
+    "rejectAllApplicationOptions",
+    "RejectAllApplicationOptionsMutation",
+)
+RESTORE_MUTATION = build_mutation(
+    "restoreAllApplicationOptions",
+    "RestoreAllApplicationOptionsMutation",
+)
 
 
 def get_application_create_data(application_round: ApplicationRound, create_sections: bool = False) -> dict[str, Any]:

tests/test_graphql_api/test_application/test_reject_all_options.py

@@ -0,0 +1,69 @@
+import pytest
+
+from applications.choices import Weekday
+from tests.factories import ApplicationFactory, UserFactory
+
+from .helpers import REJECT_MUTATION
+
+# Applied to all tests
+pytestmark = [
+    pytest.mark.django_db,
+]
+
+
+def test_application__reject_all_options(graphql):
+    application = ApplicationFactory.create_in_status_in_allocation()
+    section = application.application_sections.first()
+    option = section.reservation_unit_options.first()
+    assert option.rejected is False
+
+    graphql.login_with_superuser()
+    response = graphql(REJECT_MUTATION, input_data={"pk": application.pk})
+
+    assert response.has_errors is False, response
+
+    option.refresh_from_db()
+    assert option.rejected is True
+
+
+def test_application__reject_all_options__has_allocations(graphql):
+    application = ApplicationFactory.create_in_status_in_allocation(
+        application_sections__reservation_unit_options__rejected=False,
+        application_sections__reservation_unit_options__allocated_time_slots__day_of_the_week=Weekday.MONDAY,
+    )
+    section = application.application_sections.first()
+    option = 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.pk})
+
+    assert response.error_message() == "Mutation was unsuccessful.", response
+    assert response.field_error_messages() == [
+        "Application has allocated time slots and cannot be rejected.",
+    ]
+
+
+def test_application__reject_all_options__general_admin(graphql):
+    application = ApplicationFactory.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.pk})
+
+    assert response.has_errors is False
+
+
+def test_application__reject_all_options__unit_admin(graphql):
+    application = ApplicationFactory.create_in_status_in_allocation()
+
+    section = application.application_sections.first()
+    unit = 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.pk})
+
+    assert response.has_errors is False

tests/test_graphql_api/test_application/test_restore_all_options.py

@@ -0,0 +1,51 @@
+import pytest
+
+from tests.factories import ApplicationFactory, UserFactory
+
+from .helpers import RESTORE_MUTATION
+
+# Applied to all tests
+pytestmark = [
+    pytest.mark.django_db,
+]
+
+
+def test_application__restore_all_options(graphql):
+    application = ApplicationFactory.create_in_status_in_allocation(
+        application_sections__reservation_unit_options__rejected=True
+    )
+    section = application.application_sections.first()
+    option = section.reservation_unit_options.first()
+    assert option.rejected is True
+
+    graphql.login_with_superuser()
+    response = graphql(RESTORE_MUTATION, input_data={"pk": application.pk})
+
+    assert response.has_errors is False, response
+
+    option.refresh_from_db()
+    assert option.rejected is False
+
+
+def test_application__restore_all_options__general_admin(graphql):
+    application = ApplicationFactory.create_in_status_in_allocation()
+
+    admin = UserFactory.create_with_general_permissions(perms=["can_handle_applications"])
+    graphql.force_login(admin)
+
+    response = graphql(RESTORE_MUTATION, input_data={"pk": application.pk})
+
+    assert response.has_errors is False
+
+
+def test_application__restore_all_options__unit_admin(graphql):
+    application = ApplicationFactory.create_in_status_in_allocation()
+
+    section = application.application_sections.first()
+    unit = 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(RESTORE_MUTATION, input_data={"pk": application.pk})
+
+    assert response.has_errors is False