Merge pull request #710 from maykinmedia/feature/706-behandelend-afdeling-filters

[#706] Behandelend afdeling filters - Backend

Author: SilviaAmAm

backend/src/openarchiefbeheer/api/urls.py

@@ -30,6 +30,7 @@
     SelectionView,
 )
 from openarchiefbeheer.zaken.api.views import (
+    BehandelendAfdelingInternalChoicesView,
     CacheZakenView,
     ExternalResultaattypeChoicesView,
     ExternalZaaktypenChoicesView,
@@ -182,6 +183,11 @@
                     InternalResultaattypeChoicesView.as_view(),
                     name="retrieve-internal-resultaattype-choices",
                 ),
+                path(
+                    "_retrieve-behandelend-afdeling-choices-choices/",
+                    BehandelendAfdelingInternalChoicesView.as_view(),
+                    name="retrieve-behandelend-afdeling-choices",
+                ),
                 path("", include(router.urls)),
                 path("", include(destruction_list_router.urls)),
             ]

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

@@ -0,0 +1,8 @@
+from django.core.cache import cache
+
+
+class ClearCacheMixin:
+    def setUp(self):
+        super().setUp()
+
+        self.addCleanup(cache.clear)

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

@@ -2,8 +2,6 @@
 
 from django.db.models import (
     Case,
-    CharField,
-    F,
     Func,
     IntegerField,
     Q,
@@ -121,10 +119,10 @@ class ZaakFilterSet(FilterSet):
         lookup_expr="icontains",
     )
 
-    behandelend_afdeling__icontains = CharFilter(
-        field_name="behandelend_afdeling__icontains",
+    behandelend_afdeling = CharFilter(
+        field_name="behandelend_afdeling",
         method="filter_behandelend_afdeling",
-        help_text="The 'behandelend afdeling' is the 'betrokkeneIdentificatie.identificatie' field of the roles related to the case which have betrokkeneType = organisatorische_eenheid.",
+        help_text="Filter the zaken that contain in their `_expand.rollen` field the specified rol.",
     )
 
     class Meta:
@@ -265,24 +263,7 @@ def filter_heeft_relaties(
     def filter_behandelend_afdeling(
         self, queryset: QuerySet[Zaak], name: str, value: str
     ) -> QuerySet[Zaak]:
-        zaken_with_afdeling = queryset.filter(
-            _expand__rollen__contains=[
-                {
-                    "betrokkene_type": "organisatorische_eenheid",
-                }
-            ]
-        )
-        json_path_expression = '$.rollen[*] ? (@.betrokkene_type == "organisatorische_eenheid").betrokkene_identificatie.identificatie'
-        zaken_with_afdeling = zaken_with_afdeling.annotate(
-            behandelend_afdeling=Func(
-                F("_expand"),
-                Value(json_path_expression),
-                function="jsonb_path_query_array",
-                output_field=CharField(),
-            )
-        )
-
-        return zaken_with_afdeling.filter(behandelend_afdeling__contains=value)
+        return queryset.filter(_expand__rollen__contains=[{"url": value}])
 
 
 class ZaakFilterBackend(DjangoFilterBackend):

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

@@ -276,5 +276,49 @@ def get(self, request, *args, **kwargs):
                     "value": resultaattype["url"],
                 }
             )
+        return Response(formatted_choices, status=status.HTTP_200_OK)
+
+
+class BehandelendAfdelingInternalChoicesView(APIView):
+    permission_classes = [IsAuthenticated]
+    filter_backends = (NoModelFilterBackend,)
+    filterset_class = ZaakFilterSet
+
+    @extend_schema(
+        summary=_("Retrieve behandelend afdeling choices"),
+        description=_(
+            "Retrieve the behandelend afdelingen the zaken in the database. "
+            'These have rollen with betrokkeneType equal to "organisatorische_eenheid".'
+        ),
+        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_rollen = filterset.qs.filter(
+            _expand__rollen__contains=[{"betrokkene_type": "organisatorische_eenheid"}]
+        ).values_list("_expand__rollen", flat=True)
+
+        existing_rollen = []
+        formatted_choices = []
+        for zaak_rollen in zaken_rollen:
+            for rol in zaak_rollen:
+                if (
+                    rol["url"] in existing_rollen
+                    or rol["betrokkene_type"] != "organisatorische_eenheid"
+                ):
+                    continue
+
+                existing_rollen.append(rol["url"])
+                formatted_choices.append(
+                    {"label": rol.get("omschrijving", rol["url"]), "value": rol["url"]}
+                )
 
         return Response(formatted_choices, status=status.HTTP_200_OK)

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

@@ -258,63 +258,71 @@ def test_filter_out_zaken_already_in_destruction_lists_except_one(self):
         self.assertEqual(item.zaak.url, urls_zaken[0])
 
     def test_filter_behandelend_afdeling(self):
-        # Should NOT be returned: natuurlijk_persoon != organisatorische_eenheid
         ZaakFactory.create(
+            identificatie="ZAAK-01",
             post___expand={
                 "rollen": [
                     {
-                        "betrokkene_type": "natuurlijk_persoon",
-                        "betrokkene_identificatie": {"identificatie": "BLA1"},
+                        "url": "http://localhost:8003/zaken/api/v1/rollen/111-111-111",
+                        "betrokkene_type": "organisatorische_eenheid",
+                        "omschrijving": "Maykin Support Afdeling",
+                    },
+                    {
+                        "url": "http://localhost:8003/zaken/api/v1/rollen/222-222-222",
+                        "betrokkene_type": "organisatorische_eenheid",
+                        "omschrijving": "Maykin Dev Afdeling",
                     },
                 ]
-            }
+            },
         )
-        # Should be returned
         ZaakFactory.create(
+            identificatie="ZAAK-02",
             post___expand={
                 "rollen": [
                     {
+                        "url": "http://localhost:8003/zaken/api/v1/rollen/111-111-111",
                         "betrokkene_type": "organisatorische_eenheid",
-                        "betrokkene_identificatie": {"identificatie": "BLA1"},
+                        "omschrijving": "Maykin Support Afdeling",
                     },
                 ]
-            }
+            },
         )
-        # Should NOT be returned: identificatie does not contain BLA
         ZaakFactory.create(
+            identificatie="ZAAK-03",
             post___expand={
                 "rollen": [
                     {
+                        "url": "http://localhost:8003/zaken/api/v1/rollen/333-333-333",
                         "betrokkene_type": "organisatorische_eenheid",
-                        "betrokkene_identificatie": {"identificatie": "BLU1"},
+                        "omschrijving": "Maykin Design Afdeling",
+                    },
+                    {
+                        "url": "http://localhost:8003/zaken/api/v1/rollen/444-444-444",
+                        "betrokkene_type": "vestiging",
+                        "omschrijving": "Kantoor",
                     },
                 ]
-            }
+            },
         )
-
-        # Should NOT be returned: no roles
-        ZaakFactory.create(_expand={"rollen": []})
-
-        # Should be returned
         ZaakFactory.create(
+            identificatie="ZAAK-04",
             post___expand={
                 "rollen": [
                     {
-                        "betrokkene_type": "organisatorische_eenheid",
-                        "betrokkene_identificatie": {"identificatie": "BLO1"},
-                    },
-                    {
-                        "betrokkene_type": "organisatorische_eenheid",
-                        "betrokkene_identificatie": {"identificatie": "BLA2"},
-                    },
+                        "url": "http://localhost:8003/zaken/api/v1/rollen/444-444-444",
+                        "betrokkene_type": "vestiging",
+                        "omschrijving": "Kantoor",
+                    }
                 ]
-            }
+            },
         )
 
         user = UserFactory(username="record_manager", post__can_start_destruction=True)
 
         endpoint = furl(reverse("api:zaken-list"))
-        endpoint.args["behandelend_afdeling__icontains"] = "BLA"
+        endpoint.args["behandelend_afdeling"] = (
+            "http://localhost:8003/zaken/api/v1/rollen/111-111-111"
+        )
 
         self.client.force_authenticate(user)
         response = self.client.get(endpoint.url)
@@ -323,6 +331,10 @@ def test_filter_behandelend_afdeling(self):
         self.assertEqual(response.status_code, status.HTTP_200_OK)
         self.assertEqual(data["count"], 2)
 
+        zaken_returned = [zaak["identificatie"] for zaak in data["results"]]
+        self.assertIn("ZAAK-01", zaken_returned)
+        self.assertIn("ZAAK-02", zaken_returned)
+
     def test_ordering(self):
         zaak_2 = ZaakFactory.create(identificatie="ZAAK-0000-0000000002")
         zaak_1 = ZaakFactory.create(identificatie="ZAAK-0000-0000000001")