Merge pull request #708 from maykinmedia/feature/706-resutaattype-filter

SilviaAmAm · web-flow · commit e4ca18534fa3 · 2025-02-21T14:07:28.000+01:00
[#706] Resutaattype filter - Backend
diff --git a/backend/docs/developers/logic.rst b/backend/docs/developers/logic.rst
@@ -35,4 +35,13 @@ Some aspects about the selectielijst resources that can be confusing:
 - Each zaak has an associated selectielijstklasse (a URL to a resource in the https://selectielijst.openzaak.nl/api/v1/resultaten API).
   Each selectielijstklasse is associated with a selectielijstprocestype. 
   The zaak can only be related to a selectielijstklasse whose procestype matches the procestype related to the zaaktype 
-  of the zaak.
+  of the zaak.
+
+Zaaktypen
+=========
+
+Facts to remember about the zaaktypen:
+
+- Published zaaktypen only have a unique constraint on the ``uuid`` in the database.
+- However, they should be unique within a ``catalogus`` on ``identificatie`` and begin/eind geldigheid.
+- This means that different version of a same zaaktype would have same identificatie but different begin/eind geldigheid. Their ``uuid`` would be different.
diff --git a/backend/src/openarchiefbeheer/api/urls.py b/backend/src/openarchiefbeheer/api/urls.py
@@ -31,10 +31,11 @@
 )
 from openarchiefbeheer.zaken.api.views import (
     CacheZakenView,
+    ExternalResultaattypeChoicesView,
     ExternalZaaktypenChoicesView,
     InformatieobjecttypeChoicesView,
+    InternalResultaattypeChoicesView,
     InternalZaaktypenChoicesView,
-    ResultaattypeChoicesView,
     SelectielijstklasseChoicesView,
     StatustypeChoicesView,
 )
@@ -172,9 +173,14 @@
                     name="retrieve-informatieobjecttype-choices",
                 ),
                 path(
-                    "_resultaattype-choices/",
-                    ResultaattypeChoicesView.as_view(),
-                    name="retrieve-resultaattype-choices",
+                    "_external-resultaattype-choices/",
+                    ExternalResultaattypeChoicesView.as_view(),
+                    name="retrieve-external-resultaattype-choices",
+                ),
+                path(
+                    "_internal-resultaattype-choices/",
+                    InternalResultaattypeChoicesView.as_view(),
+                    name="retrieve-internal-resultaattype-choices",
                 ),
                 path("", include(router.urls)),
                 path("", include(destruction_list_router.urls)),
diff --git a/backend/src/openarchiefbeheer/utils/tests/gherkin.py b/backend/src/openarchiefbeheer/utils/tests/gherkin.py
@@ -334,7 +334,7 @@ async def handle(route):
                 ]
                 await route.fulfill(json=json)
 
-            await page.route("**/*/api/v1/_resultaattype-choices/*", handle)
+            await page.route("**/*/api/v1/_external-resultaattype-choices/*", handle)
 
         async def selectielijstklasse_choices_are_available(self, page):
             async def handle(route):
diff --git a/backend/src/openarchiefbeheer/zaken/api/filtersets.py b/backend/src/openarchiefbeheer/zaken/api/filtersets.py
@@ -106,9 +106,9 @@ class ZaakFilterSet(FilterSet):
         field_name="_expand__zaaktype__omschrijving", lookup_expr="icontains"
     )
 
-    resultaat__resultaattype__omschrijving__icontains = CharFilter(
-        field_name="_expand__resultaat___expand__resultaattype__omschrijving",
-        lookup_expr="icontains",
+    resultaat__resultaattype = CharFilter(
+        field_name="_expand__resultaat___expand__resultaattype__url",
+        help_text="Filter the zaken that have a resultaat of this resultaattype.",
     )
 
     resultaat__resultaattype__archiefactietermijn__icontains = CharFilter(
diff --git a/backend/src/openarchiefbeheer/zaken/api/views.py b/backend/src/openarchiefbeheer/zaken/api/views.py
@@ -213,7 +213,7 @@ def get(self, request, *args, **kwargs):
         return Response(serializer.data, status=status.HTTP_200_OK)
 
 
-class ResultaattypeChoicesView(FilterOnZaaktypeMixin, APIView):
+class ExternalResultaattypeChoicesView(FilterOnZaaktypeMixin, APIView):
     permission_classes = [IsAuthenticated]
 
     @extend_schema(
@@ -237,3 +237,44 @@ def get(self, request, *args, **kwargs):
         serializer.is_valid(raise_exception=True)
 
         return Response(serializer.data, status=status.HTTP_200_OK)
+
+
+class InternalResultaattypeChoicesView(APIView):
+    permission_classes = [IsAuthenticated]
+    filter_backends = (NoModelFilterBackend,)
+    filterset_class = ZaakFilterSet
+
+    @extend_schema(
+        summary=_("Retrieve internal resultaattype choices"),
+        description=_("Retrieve the resultaattypen of the zaken in the database. "),
+        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_resultaattypen = filterset.qs.filter(
+            _expand__resultaat___expand__resultaattype__isnull=False
+        ).values_list("_expand__resultaat___expand__resultaattype", flat=True)
+
+        existing_resultaattypen = []
+        formatted_choices = []
+        for resultaattype in zaken_resultaattypen:
+            if resultaattype["url"] in existing_resultaattypen:
+                continue
+
+            existing_resultaattypen.append(resultaattype["url"])
+            formatted_choices.append(
+                {
+                    "label": resultaattype["omschrijving"],
+                    "value": resultaattype["url"],
+                }
+            )
+
+        return Response(formatted_choices, status=status.HTTP_200_OK)
diff --git a/backend/src/openarchiefbeheer/zaken/tests/test_views.py b/backend/src/openarchiefbeheer/zaken/tests/test_views.py
@@ -114,7 +114,7 @@ def test_retrieve_zaaktypen_choices(self):
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(
-            response.json(),
+            sorted(response.json(), key=lambda choice: choice["label"]),
             [
                 {
                     "value": "http://catalogi-api.nl/catalogi/api/v1/zaakypen/111-111-111,http://catalogi-api.nl/catalogi/api/v1/zaakypen/222-222-222",
@@ -685,7 +685,7 @@ def setUp(self):
         self.addCleanup(retrieve_paginated_type.cache_clear)
 
     def test_not_authenticated(self):
-        endpoint = reverse("api:retrieve-resultaattype-choices")
+        endpoint = reverse("api:retrieve-external-resultaattype-choices")
 
         response = self.client.get(endpoint)
 
@@ -717,7 +717,9 @@ def test_retrieve_choices(self, m):
         )
 
         self.client.force_authenticate(user=user)
-        response = self.client.get(reverse("api:retrieve-resultaattype-choices"))
+        response = self.client.get(
+            reverse("api:retrieve-external-resultaattype-choices")
+        )
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(
@@ -760,12 +762,16 @@ def test_retrieve_choices_caches_request(self, m):
         )
 
         self.client.force_authenticate(user=user)
-        response = self.client.get(reverse("api:retrieve-resultaattype-choices"))
+        response = self.client.get(
+            reverse("api:retrieve-external-resultaattype-choices")
+        )
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
         # Repeat request
-        response = self.client.get(reverse("api:retrieve-resultaattype-choices"))
+        response = self.client.get(
+            reverse("api:retrieve-external-resultaattype-choices")
+        )
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
@@ -963,3 +969,136 @@ def test_retrieve_choices_caches_request(self, m):
 
         # Only one call to openzaak
         self.assertEqual(len(m.request_history), 1)
+
+
+class InternalResultaattypeChoicesViewTest(APITestCase):
+    def setUp(self):
+        super().setUp()
+
+        self.addCleanup(cache.clear)
+
+    def test_not_authenticated(self):
+        endpoint = reverse("api:retrieve-internal-resultaattype-choices")
+
+        response = self.client.get(endpoint)
+
+        self.assertEqual(response.status_code, status.HTTP_403_FORBIDDEN)
+
+    def test_get_all_choices(self):
+        user = UserFactory.create()
+
+        ZaakFactory.create(
+            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",
+                        }
+                    },
+                    "toelichting": "Testing resultaten",
+                    "resultaattype": "http://localhost:8003/catalogi/api/v1/resultaattypen/111-111-111",
+                }
+            },
+        )
+        ZaakFactory.create(
+            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",
+                        }
+                    },
+                    "toelichting": "Testing resultaten",
+                    "resultaattype": "http://localhost:8003/catalogi/api/v1/resultaattypen/222-222-222",
+                }
+            },
+        )
+
+        self.client.force_authenticate(user=user)
+        response = self.client.get(
+            reverse("api:retrieve-internal-resultaattype-choices")
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+
+        self.assertEqual(len(data), 2)
+        self.assertEqual(
+            [
+                {
+                    "value": "http://localhost:8003/catalogi/api/v1/resultaattypen/111-111-111",
+                    "label": "Afgehandeld",
+                },
+                {
+                    "value": "http://localhost:8003/catalogi/api/v1/resultaattypen/222-222-222",
+                    "label": "Lopend",
+                },
+            ],
+            sorted(data, key=lambda choice: choice["value"]),
+        )
+
+    def test_get_choices_with_filters(self):
+        user = UserFactory.create()
+
+        ZaakFactory.create(
+            identificatie="ZAAK-01",
+            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",
+                        }
+                    },
+                    "toelichting": "Testing resultaten",
+                    "resultaattype": "http://localhost:8003/catalogi/api/v1/resultaattypen/111-111-111",
+                }
+            },
+        )
+        ZaakFactory.create(
+            identificatie="ZAAK-02",
+            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",
+                        }
+                    },
+                    "toelichting": "Testing resultaten",
+                    "resultaattype": "http://localhost:8003/catalogi/api/v1/resultaattypen/222-222-222",
+                }
+            },
+        )
+
+        self.client.force_authenticate(user=user)
+        endpoint = furl(reverse("api:retrieve-internal-resultaattype-choices"))
+        endpoint.args["identificatie"] = "ZAAK-01"
+
+        response = self.client.get(endpoint.url)
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+
+        self.assertEqual(len(data), 1)
+        self.assertEqual(
+            [
+                {
+                    "value": "http://localhost:8003/catalogi/api/v1/resultaattypen/111-111-111",
+                    "label": "Afgehandeld",
+                },
+            ],
+            data,
+        )
diff --git a/backend/src/openarchiefbeheer/zaken/tests/test_viewsets.py b/backend/src/openarchiefbeheer/zaken/tests/test_viewsets.py
@@ -122,3 +122,38 @@ def test_filter_zaken_with_removed_zaken(self):
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(data["count"], 10)
+
+    def test_filter_zaken_on_resultaat(self):
+        zaken = ZaakFactory.create_batch(3)
+        zaken[0]._expand.update(
+            {
+                "resultaat": {
+                    "url": "http://localhost:8003/zaken/api/v1/resultaten/c81e0154-7d0f-4f1f-9264-06c45127d6a4",
+                    "uuid": "c81e0154-7d0f-4f1f-9264-06c45127d6a4",
+                    "_expand": {
+                        "resultaattype": {
+                            "url": "http://localhost:8003/catalogi/api/v1/resultaattypen/7759dcb7-de9a-4543-99e3-81472c488f32",
+                            "resultaattypeomschrijving": "Lopend",
+                        }
+                    },
+                    "toelichting": "Testing resultaattype",
+                    "resultaattype": "http://localhost:8003/catalogi/api/v1/resultaattypen/7759dcb7-de9a-4543-99e3-81472c488f32",
+                }
+            }
+        )
+        zaken[0].identificatie = "ZAAK-WITH-RESULTAAT"
+        zaken[0].save()
+
+        user = UserFactory(username="record_manager", post__can_start_destruction=True)
+
+        self.client.force_authenticate(user)
+        endpoint = furl(reverse("api:zaken-list"))
+        endpoint.args["resultaat__resultaattype"] = (
+            "http://localhost:8003/catalogi/api/v1/resultaattypen/7759dcb7-de9a-4543-99e3-81472c488f32"
+        )
+        response = self.client.get(endpoint.url)
+        data = response.json()
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+        self.assertEqual(data["count"], 1)
+        self.assertEqual(data["results"][0]["identificatie"], "ZAAK-WITH-RESULTAAT")
diff --git a/backend/src/openarchiefbeheer/zaken/tests/vcr/test_views.py b/backend/src/openarchiefbeheer/zaken/tests/vcr/test_views.py
@@ -98,7 +98,9 @@ def test_retrieve_all_choices(self):
         user = UserFactory.create()
 
         self.client.force_authenticate(user=user)
-        response = self.client.get(reverse("api:retrieve-resultaattype-choices"))
+        response = self.client.get(
+            reverse("api:retrieve-external-resultaattype-choices")
+        )
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
@@ -120,7 +122,7 @@ def test_retrieve_all_choices(self):
     def test_retrieve_choices_with_filters(self):
         user = UserFactory.create()
 
-        endpoint = furl(reverse("api:retrieve-resultaattype-choices"))
+        endpoint = furl(reverse("api:retrieve-external-resultaattype-choices"))
         endpoint.args["zaaktype"] = (
             "http://localhost:8003/catalogi/api/v1/zaaktypen/be210495-20b6-48ff-8d3d-3e44f74c43a4"
         )
diff --git a/backend/src/openarchiefbeheer/zaken/utils.py b/backend/src/openarchiefbeheer/zaken/utils.py
@@ -144,7 +144,7 @@ def format_zaaktype_choices(zaaktypen: Iterable[dict]) -> list[DropDownChoice]:
     for identificatie, urls in zaaktypen_per_version.items():
         omschrijving = id_to_omschrijving_map[identificatie]["omschrijving"]
         label = f"{omschrijving} ({identificatie or _("no identificatie")})"
-        value = ",".join(urls)
+        value = ",".join(sorted(urls))
         formatted_zaaktypen.append({"label": label, "value": value})
     formatted_zaaktypen = sorted(formatted_zaaktypen, key=lambda x: x["label"])
     return formatted_zaaktypen
diff --git a/frontend/src/lib/api/private.ts b/frontend/src/lib/api/private.ts
@@ -52,9 +52,13 @@ export async function listResultaatTypeChoices(zaaktypeUrl?: string) {
   return cacheMemo(
     "listResultaatTypeChoices",
     async () => {
-      const response = await request("GET", "/_resultaattype-choices/", {
-        zaaktype: zaaktypeUrl,
-      });
+      const response = await request(
+        "GET",
+        "/_external-resultaattype-choices/",
+        {
+          zaaktype: zaaktypeUrl,
+        },
+      );
       const promise: Promise<Option[]> = response.json();
 
       return promise;
diff --git a/frontend/src/pages/settings/pages/destruction-report/DestructionReportSettingsPage.stories.tsx b/frontend/src/pages/settings/pages/destruction-report/DestructionReportSettingsPage.stories.tsx

Original file line number	Diff line number	Diff line change
`@@ -334,7 +334,7 @@ async def handle(route):`
`334`	`334`	`]`
`335`	`335`	`await route.fulfill(json=json)`
`336`	`336`
`337`		`- await page.route("*//api/v1/_resultaattype-choices/*", handle)`
	`337`	`+ await page.route("*//api/v1/_external-resultaattype-choices/*", handle)`
`338`	`338`
`339`	`339`	`async def selectielijstklasse_choices_are_available(self, page):`
`340`	`340`	`async def handle(route):`
Original file line number	Diff line number	Diff line change
`@@ -106,9 +106,9 @@ class ZaakFilterSet(FilterSet):`
`106`	`106`	`field_name="_expand__zaaktype__omschrijving", lookup_expr="icontains"`
`107`	`107`	`)`
`108`	`108`
`109`		`- resultaat__resultaattype__omschrijving__icontains = CharFilter(`
`110`		`- field_name="_expand__resultaat___expand__resultaattype__omschrijving",`
`111`		`- lookup_expr="icontains",`
	`109`	`+ resultaat__resultaattype = CharFilter(`
	`110`	`+ field_name="_expand__resultaat___expand__resultaattype__url",`
	`111`	`+ help_text="Filter the zaken that have a resultaat of this resultaattype.",`
`112`	`112`	`)`
`113`	`113`
`114`	`114`	`resultaat__resultaattype__archiefactietermijn__icontains = CharFilter(`