Merge pull request #268 from maykinmedia/feature/262-paginate-destruction-list-item

[#262] Paginate destruction list item and order on processing status

Author: SilviaAmAm

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

@@ -1,7 +1,9 @@
-from django.db.models import QuerySet
+from django.db.models import Case, QuerySet, Value, When
+from django.utils.translation import gettext_lazy as _
 
 from django_filters import FilterSet, NumberFilter, OrderingFilter, UUIDFilter
 
+from ..constants import InternalStatus
 from ..models import (
     DestructionList,
     DestructionListItem,
@@ -12,9 +14,36 @@
 
 
 class DestructionListItemFilterset(FilterSet):
+    destruction_list = UUIDFilter(
+        field_name="destruction_list",
+        method="filter_in_destruction_list",
+        help_text=_(
+            "Retrieve the items that are in a destruction list and "
+            "order them based on processing status."
+        ),
+    )
+
     class Meta:
         model = DestructionListItem
-        fields = ("destruction_list",)
+        fields = ("destruction_list", "status", "processing_status")
+
+    def filter_in_destruction_list(
+        self, queryset: QuerySet[DestructionListItem], name: str, value: str
+    ) -> QuerySet[DestructionListItem]:
+        return (
+            queryset.filter(destruction_list__uuid=value)
+            .annotate(
+                processing_status_index=Case(
+                    When(processing_status=InternalStatus.failed, then=Value(1)),
+                    When(processing_status=InternalStatus.processing, then=Value(2)),
+                    When(processing_status=InternalStatus.queued, then=Value(3)),
+                    When(processing_status=InternalStatus.new, then=Value(4)),
+                    When(processing_status=InternalStatus.succeeded, then=Value(5)),
+                    default=Value(1),
+                ),
+            )
+            .order_by("processing_status_index")
+        )
 
 
 class DestructionListFilterset(FilterSet):

backend/src/openarchiefbeheer/destruction/api/serializers.py

@@ -111,6 +111,7 @@ class Meta:
             "status",
             "extra_zaak_data",
             "zaak_data",
+            "processing_status",
         )
 
     def validate(self, attrs: dict) -> dict:

backend/src/openarchiefbeheer/destruction/api/viewsets.py

@@ -11,6 +11,7 @@
 from rest_framework.response import Response
 
 from openarchiefbeheer.logging import logevent
+from openarchiefbeheer.utils.paginators import PageNumberPagination
 
 from ..constants import InternalStatus, ListRole
 from ..models import (
@@ -299,6 +300,7 @@ class DestructionListItemsViewSet(
     queryset = DestructionListItem.objects.all()
     filter_backends = (DjangoFilterBackend,)
     filterset_class = DestructionListItemFilterset
+    pagination_class = PageNumberPagination
 
 
 @extend_schema_view(

backend/src/openarchiefbeheer/destruction/tests/test_endpoints.py

@@ -871,7 +871,7 @@ def test_retrieve_destruction_list_items(self):
 
         self.assertEqual(response.status_code, status.HTTP_200_OK)
 
-        data = sorted(response.json(), key=lambda item: item["zaak"])
+        data = sorted(response.json()["results"], key=lambda item: item["zaak"])
 
         self.assertEqual(
             data[0]["zaakData"]["omschrijving"],
@@ -910,7 +910,7 @@ def test_filter_items_on_destruction_list(self):
 
         self.client.force_authenticate(user=record_manager)
         endpoint = furl(reverse("api:destruction-list-items-list"))
-        endpoint.args["destruction_list"] = destruction_list.pk
+        endpoint.args["destruction_list"] = str(destruction_list.uuid)
 
         response = self.client.get(
             endpoint.url,
@@ -920,7 +920,42 @@ def test_filter_items_on_destruction_list(self):
 
         data = response.json()
 
-        self.assertEqual(len(data), 2)
+        self.assertEqual(data["count"], 2)
+
+    def test_order_on_processing_status(self):
+        record_manager = UserFactory.create(username="record_manager")
+        destruction_list = DestructionListFactory.create()
+        item1 = DestructionListItemFactory.create(
+            status=ListItemStatus.suggested,
+            destruction_list=destruction_list,
+            processing_status=InternalStatus.succeeded,
+        )
+        item2 = DestructionListItemFactory.create(
+            status=ListItemStatus.suggested,
+            destruction_list=destruction_list,
+            processing_status=InternalStatus.processing,
+        )
+        item3 = DestructionListItemFactory.create(
+            status=ListItemStatus.suggested,
+            destruction_list=destruction_list,
+            processing_status=InternalStatus.failed,
+        )
+
+        self.client.force_authenticate(user=record_manager)
+        endpoint = furl(reverse("api:destruction-list-items-list"))
+        endpoint.args["destruction_list"] = str(destruction_list.uuid)
+
+        response = self.client.get(
+            endpoint.url,
+        )
+
+        self.assertEqual(response.status_code, status.HTTP_200_OK)
+
+        data = response.json()
+
+        self.assertEqual(data["results"][0]["pk"], item3.pk)
+        self.assertEqual(data["results"][1]["pk"], item2.pk)
+        self.assertEqual(data["results"][2]["pk"], item1.pk)
 
 
 class DestructionListReviewViewSetTest(APITestCase):

backend/src/openarchiefbeheer/utils/paginators.py

@@ -0,0 +1,6 @@
+from rest_framework.pagination import PageNumberPagination as _PageNumberPagination
+
+
+class PageNumberPagination(_PageNumberPagination):
+    page_size_query_param = "page_size"
+    page_size = 100

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

@@ -4,24 +4,19 @@
 from drf_spectacular.utils import extend_schema, extend_schema_view
 from rest_framework import mixins, viewsets
 from rest_framework.filters import OrderingFilter
-from rest_framework.pagination import PageNumberPagination as _PageNumberPagination
 from rest_framework.permissions import IsAuthenticated
 
 from openarchiefbeheer.destruction.api.permissions import (
     CanReviewPermission,
     CanStartDestructionPermission,
 )
+from openarchiefbeheer.utils.paginators import PageNumberPagination
 
 from ..models import Zaak
 from .filtersets import ZaakFilter
 from .serializers import ZaakSerializer
 
 
-class PageNumberPagination(_PageNumberPagination):
-    page_size_query_param = "page_size"
-    page_size = 100
-
-
 @extend_schema_view(
     list=extend_schema(
         summary=_("List zaken"),

frontend/src/fixtures/destructionListItem.ts

@@ -0,0 +1,34 @@
+import {
+  DestructionListItem,
+  PaginatedDestructionListItems,
+} from "../lib/api/destructionListsItem";
+import { createArrayFactory, createObjectFactory } from "./factory";
+import { zaakFactory } from "./zaak";
+
+export const FIXTURE_DESTRUCTION_LIST_ITEM: DestructionListItem = {
+  pk: 1,
+  zaak: zaakFactory().url,
+  status: "suggested",
+  extraZaakData: null,
+  zaakData: zaakFactory(),
+  processingStatus: "new",
+};
+
+export const destructionListItemFactory = createObjectFactory(
+  FIXTURE_DESTRUCTION_LIST_ITEM,
+);
+export const destructionListItemsFactory = createArrayFactory([
+  FIXTURE_DESTRUCTION_LIST_ITEM,
+]);
+
+const FIXTURE_PAGINATED_DESTRUCTION_LIST_ITEMS = {
+  count: 10,
+  next: null,
+  previous: null,
+  results: destructionListItemsFactory(),
+};
+
+export const paginatedDestructionListItemsFactory =
+  createObjectFactory<PaginatedDestructionListItems>(
+    FIXTURE_PAGINATED_DESTRUCTION_LIST_ITEMS,
+  );

frontend/src/lib/api/destructionLists.ts

@@ -2,6 +2,7 @@ import { isPrimitive } from "@maykin-ui/admin-ui";
 
 import { Zaak } from "../../types";
 import { User } from "./auth";
+import { ProcessingStatus } from "./processingStatus";
 import { request } from "./request";
 
 export type DestructionList = {
@@ -13,7 +14,7 @@ export type DestructionList = {
   created: string;
   name: string;
   status: DestructionListStatus;
-  processingStatus: DestructionListProcessingStatus;
+  processingStatus: ProcessingStatus;
   statusChanged: string | null;
   uuid: string;
 };
@@ -35,13 +36,6 @@ export const DESTRUCTION_LIST_STATUSES = [
 // Inferring the type of the array, so that we don't have to repeat the same.
 export type DestructionListStatus = (typeof DESTRUCTION_LIST_STATUSES)[number];
 
-export type DestructionListProcessingStatus =
-  | "new"
-  | "queued"
-  | "processing"
-  | "failed"
-  | "succeeded";
-
 export type DestructionListUpdateData = {
   assignees?: DestructionListAssigneeUpdate[];
   items?: DestructionListItemUpdate[];

frontend/src/lib/api/destructionListsItem.ts

@@ -0,0 +1,41 @@
+import { Zaak } from "../../types";
+import { PaginatedResults } from "./paginatedResults";
+import { ProcessingStatus } from "./processingStatus";
+import { request } from "./request";
+
+export type DestructionListItem = {
+  pk: number;
+  zaak: Zaak["url"];
+  status?: DestructionListItemStatus;
+  extraZaakData?: Record<string, unknown> | null;
+  zaakData: Zaak | null;
+  processingStatus?: ProcessingStatus;
+};
+
+export type DestructionListItemStatus = "removed" | "suggested";
+
+export type PaginatedDestructionListItems =
+  PaginatedResults<DestructionListItem>;
+
+/**
+ * List destruction lists.
+ */
+export async function listDestructionListItems(
+  destructionListUuid: string,
+  params?:
+    | URLSearchParams
+    | {
+        page?: number;
+        page_size?: number;
+        processing_status?: ProcessingStatus;
+        status: DestructionListItemStatus; // TODO ?
+      },
+) {
+  const response = await request("GET", "/destruction-list-items/", {
+    destruction_list: destructionListUuid,
+    status: "suggested",
+    ...params,
+  } as typeof params & { destruction_list: string });
+  const promise: Promise<PaginatedDestructionListItems> = response.json();
+  return promise;
+}

frontend/src/lib/api/paginatedResults.d.ts

@@ -0,0 +1,6 @@
+export type PaginatedResults<T> = {
+  count: number;
+  next: string | null;
+  previous: string | null;
+  results: T[];
+};

frontend/src/lib/api/processingStatus.d.ts

@@ -0,0 +1,6 @@
+export type ProcessingStatus =
+  | "new"
+  | "queued"
+  | "processing"
+  | "failed"
+  | "succeeded";

frontend/src/lib/api/reviewResponse.ts

@@ -1,4 +1,3 @@
-import { DestructionList } from "./destructionLists";
 import { request } from "./request";
 import { Review, ReviewItem } from "./review";
 

frontend/src/lib/api/zaken.ts

@@ -1,12 +1,8 @@
 import { Zaak } from "../../types";
+import { PaginatedResults } from "./paginatedResults";
 import { request } from "./request";
 
-export type PaginatedZaken = {
-  count: number;
-  next: string | null;
-  previous: string | null;
-  results: Zaak[];
-};
+export type PaginatedZaken = PaginatedResults<Zaak>;
 
 /**
  * Retrieve zaken using the configured ZRC service. For information over the query parameters accepted and the schema of

frontend/src/pages/constants.tsx

@@ -2,9 +2,9 @@ import { BadgeProps, Outline } from "@maykin-ui/admin-ui";
 
 import {
   DESTRUCTION_LIST_STATUSES,
-  DestructionListProcessingStatus,
   DestructionListStatus,
 } from "../lib/api/destructionLists";
+import { ProcessingStatus } from "../lib/api/processingStatus";
 import { Review } from "../lib/api/review";
 
 export const REVIEW_DECISION_MAPPING: Record<Review["decision"], string> = {
@@ -45,7 +45,7 @@ export const STATUS_LEVEL_MAPPING: {
 };
 
 export const PROCESSING_STATUS_MAPPING: {
-  [key in DestructionListProcessingStatus]: string;
+  [key in ProcessingStatus]: string;
 } = {
   new: "new",
   queued: "queued",
@@ -55,7 +55,7 @@ export const PROCESSING_STATUS_MAPPING: {
 };
 
 export const PROCESSING_STATUS_ICON_MAPPING: {
-  [key in DestructionListProcessingStatus]: React.ReactNode;
+  [key in ProcessingStatus]: React.ReactNode;
 } = {
   new: <Outline.PlusCircleIcon />,
   queued: <Outline.CircleStackIcon />,
@@ -65,7 +65,7 @@ export const PROCESSING_STATUS_ICON_MAPPING: {
 };
 
 export const PROCESSING_STATUS_LEVEL_MAPPING: {
-  [key in DestructionListProcessingStatus]: BadgeProps["level"];
+  [key in ProcessingStatus]: BadgeProps["level"];
 } = {
   new: "info",
   queued: "info",