Merge pull request #747 from maykinmedia/feature/709-add-internal-choices-selectielijstklasse

[#709] Add internal choices selectielijstklasse

Author: SilviaAmAm

backend/src/openarchiefbeheer/api/urls.py

@@ -33,11 +33,12 @@
     BehandelendAfdelingInternalChoicesView,
     CacheZakenView,
     ExternalResultaattypeChoicesView,
+    ExternalSelectielijstklasseChoicesView,
     ExternalZaaktypenChoicesView,
     InformatieobjecttypeChoicesView,
     InternalResultaattypeChoicesView,
+    InternalSelectielijstklasseChoicesView,
     InternalZaaktypenChoicesView,
-    SelectielijstklasseChoicesView,
     StatustypeChoicesView,
 )
 from openarchiefbeheer.zaken.api.viewsets import ZakenViewSet
@@ -160,9 +161,14 @@
                 ),
                 path(
                     "_selectielijstklasse-choices/",
-                    SelectielijstklasseChoicesView.as_view(),
+                    ExternalSelectielijstklasseChoicesView.as_view(),
                     name="retrieve-selectielijstklasse-choices",
                 ),
+                path(
+                    "_internal-selectielijstklasse-choices/",
+                    InternalSelectielijstklasseChoicesView.as_view(),
+                    name="retrieve-internal-selectielijstklasse-choices",
+                ),
                 path(
                     "_statustype-choices/",
                     StatustypeChoicesView.as_view(),

backend/src/openarchiefbeheer/utils/tests/gherkin.py

@@ -364,6 +364,9 @@ async def handle(route):
                 await route.fulfill(json=json)
 
             await page.route("**/*/api/v1/_selectielijstklasse-choices/*", handle)
+            await page.route(
+                "**/*/api/v1/_internal-selectielijstklasse-choices/*", handle
+            )
 
         async def statustype_choices_are_available(self, page):
             async def handle(route):

backend/src/openarchiefbeheer/zaken/api/views.py

@@ -1,3 +1,6 @@
+from django.db.models import Case, F, Q, URLField, When
+from django.db.models.fields.json import KT
+from django.db.models.functions import Cast
 from django.shortcuts import get_object_or_404
 from django.utils.decorators import method_decorator
 from django.utils.translation import gettext_lazy as _
@@ -134,7 +137,7 @@ def get(self, request, *args, **kwargs):
         return Response(zaaktypen_choices, status=status.HTTP_200_OK)
 
 
-class SelectielijstklasseChoicesView(APIView):
+class ExternalSelectielijstklasseChoicesView(APIView):
     permission_classes = [IsAuthenticated]
 
     @extend_schema(
@@ -164,6 +167,63 @@ def get(self, request, *args, **kwargs):
         return Response(data=choices)
 
 
+class InternalSelectielijstklasseChoicesView(FilterOnZaaktypeMixin, APIView):
+    permission_classes = [IsAuthenticated]
+
+    @extend_schema(
+        summary=_("Retrieve internal selectielijstklasse choices"),
+        description=_(
+            "Retrieve the selectielijstklasse choices for zaken in the database. "
+            "Note: if a zaak does not have a selectielijstklasse specified, it is deduced from the "
+            "resultaat -> resultaattype -> selectielijstklasse."
+        ),
+        parameters=[ZaaktypeFilterSerializer],
+        tags=["private"],
+        responses={
+            200: ChoiceSerializer(many=True),
+        },
+    )
+    @method_decorator(cache_page(60 * 15))
+    def get(self, request, *args, **kwargs):
+        filterset = ZaakFilterSet(data=request.query_params or request.data)
+        is_valid = filterset.is_valid()
+        if not is_valid:
+            raise ValidationError(filterset.errors)
+
+        zaken_selectielijstklasse = (
+            filterset.qs.annotate(
+                resolved_selectielijstklasse=Case(
+                    When(~Q(selectielijstklasse=""), then=F("selectielijstklasse")),
+                    When(
+                        selectielijstklasse="",
+                        then=Cast(
+                            # KT is needed otherwise we get '"http://bla.bla"' (extra quotes)
+                            KT(
+                                "_expand__resultaat___expand__resultaattype__selectielijstklasse"
+                            ),
+                            output_field=URLField(),
+                        ),
+                    ),
+                )
+            )
+            .distinct("resolved_selectielijstklasse")
+            .order_by("resolved_selectielijstklasse")
+            .values_list("resolved_selectielijstklasse", flat=True)
+        )
+
+        all_selectielijstklasse_choices = {
+            choice["value"]: choice for choice in retrieve_selectielijstklasse_choices()
+        }
+
+        formatted_choices = []
+        for item in zaken_selectielijstklasse:
+            formatted_choice = all_selectielijstklasse_choices.get(item)
+            if formatted_choice:
+                formatted_choices.append(formatted_choice)
+
+        return Response(formatted_choices, status=status.HTTP_200_OK)
+
+
 class StatustypeChoicesView(FilterOnZaaktypeMixin, APIView):
     permission_classes = [IsAuthenticated]
 

backend/src/openarchiefbeheer/zaken/tests/test_views.py

@@ -21,9 +21,9 @@
     DestructionListReviewFactory,
 )
 from openarchiefbeheer.utils.tests.mixins import ClearCacheMixin
-from openarchiefbeheer.zaken.utils import retrieve_paginated_type
 
 from ..tasks import retrieve_and_cache_zaken_from_openzaak
+from ..utils import retrieve_paginated_type, retrieve_selectielijstklasse_choices
 from .factories import ZaakFactory
 
 
@@ -655,6 +655,214 @@ def test_response_cached(self, m):
         self.assertEqual(len(m.request_history), 1)
 
 
+class InternalSelectielijstklasseChoicesViewTests(ClearCacheMixin, APITestCase):
+    def setUp(self):
+        super().setUp()
+
+        retrieve_selectielijstklasse_choices.cache_clear()
+
+        self.addCleanup(retrieve_selectielijstklasse_choices.cache_clear)
+
+    def test_not_authenticated(self):
+        endpoint = reverse("api:retrieve-internal-selectielijstklasse-choices")
+
+        response = self.client.get(endpoint)
+
+        self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+
+    @Mocker()
+    def test_retrieve_internal_choices(self, m):
+        """
+        Test that only the selectielijstklassen of the zaken in the database are returned.
+
+        We have:
+
+        - A zaak with selectielijstklasse specified on the zaak
+        - A zaak with selectielijstklasse derived from resultaat -> resultaattype -> selectielijstklasse
+        - A zaak without selectielijstklasse
+
+        We mock the selectielijstklasse API endpoint to return 3 resultaten, two of which are referenced in the zaken
+        in the db. So the internal selectielijstklasse choices endpoint should only return 2 choices.
+        """
+        selectielist_service = ServiceFactory.create(
+            api_type=APITypes.orc,
+            api_root="http://selectielijst.nl/api/v1",
+        )
+        user = UserFactory.create(post__can_start_destruction=True)
+        ZaakFactory.create(
+            selectielijstklasse="http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+            post___expand={
+                "resultaat": {
+                    "url": "http://localhost:8003/zaken/api/v1/resultaten/821b4d8f-3244-4ece-8d33-791fa6d2a2f3",
+                    "uuid": "821b4d8f-3244-4ece-8d33-791fa6d2a2f3",
+                    "_expand": {
+                        "resultaattype": {
+                            "url": "http://localhost:8003/catalogi/api/v1/resultaattypen/111-111-111",
+                            "omschrijving": "Afgehandeld",
+                            "selectielijstklasse": "http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
+                        }
+                    },
+                    "toelichting": "Testing resultaten",
+                    "resultaattype": "http://localhost:8003/catalogi/api/v1/resultaattypen/111-111-111",
+                }
+            },
+        )
+        ZaakFactory.create(
+            selectielijstklasse="",
+            post___expand={
+                "resultaat": {
+                    "url": "http://localhost:8003/zaken/api/v1/resultaten/821b4d8f-3244-4ece-8d33-791fa6d2a2f3",
+                    "uuid": "821b4d8f-3244-4ece-8d33-791fa6d2a2f3",
+                    "_expand": {
+                        "resultaattype": {
+                            "url": "http://localhost:8003/catalogi/api/v1/resultaattypen/222-222-222",
+                            "omschrijving": "Lopend",
+                            "selectielijstklasse": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
+                        }
+                    },
+                    "toelichting": "Testing resultaten",
+                    "resultaattype": "http://localhost:8003/catalogi/api/v1/resultaattypen/222-222-222",
+                }
+            },
+        )
+        ZaakFactory.create(selectielijstklasse="", post___expand={})
+
+        m.get(
+            "http://selectielijst.nl/api/v1/resultaten",
+            json={
+                "count": 3,
+                "results": [
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
+                        "nummer": 1,
+                        "volledigNummer": "11.1",
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                        "bewaartermijn": "P1Y",
+                    },
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+                        "nummer": 1,
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                        "bewaartermijn": "P2Y",
+                    },
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
+                        "nummer": 2,
+                        "volledigNummer": "11.1.2",
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                    },
+                ],
+            },
+        )
+
+        self.client.force_authenticate(user=user)
+        endpoint = furl(reverse("api:retrieve-internal-selectielijstklasse-choices"))
+
+        with patch(
+            "openarchiefbeheer.zaken.utils.APIConfig.get_solo",
+            return_value=APIConfig(selectielijst_api_service=selectielist_service),
+        ):
+            response = self.client.get(endpoint.url)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(
+            response.json(),
+            [
+                {
+                    "value": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+                    "label": "1 - Verleend - vernietigen - P2Y",
+                    "extraData": {
+                        "bewaartermijn": "P2Y",
+                    },
+                },
+                {
+                    "value": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
+                    "label": "11.1.2 - Verleend - vernietigen",
+                    "extraData": {
+                        "bewaartermijn": None,
+                    },
+                },
+            ],
+        )
+
+    @Mocker()
+    def test_retrieve_internal_choices_with_filters(self, m):
+        """
+        Test that only the selectielijstklassen of the filtered zaken in the database are returned.
+        """
+        selectielist_service = ServiceFactory.create(
+            api_type=APITypes.orc,
+            api_root="http://selectielijst.nl/api/v1",
+        )
+        user = UserFactory.create(post__can_start_destruction=True)
+        ZaakFactory.create(
+            identificatie="ZAAK-1",
+            selectielijstklasse="http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+        )
+        ZaakFactory.create(
+            identificatie="ZAAK-2",
+            selectielijstklasse="http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
+        )
+
+        m.get(
+            "http://selectielijst.nl/api/v1/resultaten",
+            json={
+                "count": 3,
+                "results": [
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/2e86a8ca-0269-446c-8da2-6f4d08be422d",
+                        "nummer": 1,
+                        "volledigNummer": "11.1",
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                        "bewaartermijn": "P1Y",
+                    },
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+                        "nummer": 1,
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                        "bewaartermijn": "P2Y",
+                    },
+                    {
+                        "url": "http://selectielijst.nl/api/v1/resultaten/5d102cc6-4a74-4262-a14a-538bbfe3f2da",
+                        "nummer": 2,
+                        "volledigNummer": "11.1.2",
+                        "naam": "Verleend",
+                        "waardering": "vernietigen",
+                    },
+                ],
+            },
+        )
+
+        self.client.force_authenticate(user=user)
+        endpoint = furl(reverse("api:retrieve-internal-selectielijstklasse-choices"))
+        endpoint.args["identificatie"] = "ZAAK-1"
+
+        with patch(
+            "openarchiefbeheer.zaken.utils.APIConfig.get_solo",
+            return_value=APIConfig(selectielijst_api_service=selectielist_service),
+        ):
+            response = self.client.get(endpoint.url)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(
+            response.json(),
+            [
+                {
+                    "value": "http://selectielijst.nl/api/v1/resultaten/5038528b-0eb7-4502-a415-a3093987d69b",
+                    "label": "1 - Verleend - vernietigen - P2Y",
+                    "extraData": {
+                        "bewaartermijn": "P2Y",
+                    },
+                }
+            ],
+        )
+
+
 class ResultaattypenChoicesViewTests(ClearCacheMixin, APITestCase):
     def setUp(self):
         super().setUp()

frontend/.storybook/mockData.ts

@@ -158,18 +158,30 @@ export const MOCKS = {
     status: 200,
     response: FIXTURE_SELECTIELIJSTKLASSE_CHOICES,
   },
+  INTERNAL_SELECTIE_LIJST_CHOICES: {
+    url: "http://localhost:8000/api/v1/_internal-selectielijstklasse-choices/",
+    method: "GET",
+    status: 200,
+    response: FIXTURE_SELECTIELIJSTKLASSE_CHOICES,
+  },
   WHOAMI: {
     url: "http://localhost:8000/api/v1/whoami/",
     method: "GET",
     status: 200,
     response: userFactory(),
   },
   ZAAKTYPE_CHOICES: {
-    url: "http://localhost:8000/api/v1/_zaaktypen-choices",
+    url: "http://localhost:8000/api/v1/_zaaktypen-choices/",
     method: "GET",
     status: 200,
     response: zaaktypeChoicesFactory(),
   },
+  ZAAKTYPE_CHOICES_POST: {
+    url: "http://localhost:8000/api/v1/_zaaktypen-choices/",
+    method: "POST",
+    status: 200,
+    response: zaaktypeChoicesFactory(),
+  },
   ZAAKTYPE_CHOICES_IN_REVIEW: {
     url: "http://localhost:8000/api/v1/_zaaktypen-choices/?inReview=1",
     method: "GET",

frontend/src/components/DestructionListReviewer/DestructionListReviewer.stories.tsx

@@ -60,6 +60,7 @@ const meta: Meta<typeof DestructionListReviewerComponent> = {
       MOCKS.REVIEWERS,
       MOCKS.DESTRUCTION_LIST_CO_REVIEWERS,
       MOCKS.OIDC_INFO,
+      MOCKS.INTERNAL_SELECTIE_LIJST_CHOICES,
       {
         url: "http://localhost:8000/api/v1/users?role=co_reviewer",
         method: "GET",