Add proper pagination for API actions (#560)

Signed-off-by: Thomas Druez <[email protected]>

Author: tdruez

CHANGELOG.rst

@@ -21,6 +21,8 @@ v31.1.0 (unreleased)
   the project details view, inside the run status tag.
   https://github.com/nexB/scancode.io/issues/300
 
+- Add proper pagination for API actions: resources, packages, dependencies, and errors.
+
 - Refine the fields ordering in API Serializers based on the toolkit order.
   https://github.com/nexB/scancode.io/issues/546
 

scanpipe/api/views.py

@@ -169,7 +169,7 @@ def resources(self, request, *args, **kwargs):
         paginated_qs = self.paginate_queryset(queryset)
         serializer = CodebaseResourceSerializer(paginated_qs, many=True)
 
-        return Response(serializer.data)
+        return self.get_paginated_response(serializer.data)
 
     @action(detail=True)
     def packages(self, request, *args, **kwargs):
@@ -179,7 +179,7 @@ def packages(self, request, *args, **kwargs):
         paginated_qs = self.paginate_queryset(queryset)
         serializer = DiscoveredPackageSerializer(paginated_qs, many=True)
 
-        return Response(serializer.data)
+        return self.get_paginated_response(serializer.data)
 
     @action(detail=True)
     def dependencies(self, request, *args, **kwargs):
@@ -189,7 +189,7 @@ def dependencies(self, request, *args, **kwargs):
         paginated_qs = self.paginate_queryset(queryset)
         serializer = DiscoveredDependencySerializer(paginated_qs, many=True)
 
-        return Response(serializer.data)
+        return self.get_paginated_response(serializer.data)
 
     @action(detail=True)
     def errors(self, request, *args, **kwargs):
@@ -199,7 +199,7 @@ def errors(self, request, *args, **kwargs):
         paginated_qs = self.paginate_queryset(queryset)
         serializer = ProjectErrorSerializer(paginated_qs, many=True)
 
-        return Response(serializer.data)
+        return self.get_paginated_response(serializer.data)
 
     @action(detail=True, methods=["get"])
     def file_content(self, request, *args, **kwargs):

scanpipe/models.py

@@ -38,6 +38,7 @@
 from django.core import checks
 from django.core.exceptions import ObjectDoesNotExist
 from django.core.serializers.json import DjangoJSONEncoder
+from django.core.validators import EMPTY_VALUES
 from django.db import models
 from django.db import transaction
 from django.db.models import Count
@@ -1163,12 +1164,12 @@ def update_from_data(self, data, override=False):
         Update this object instance with the provided `data`.
         The `save()` is called only if at least one field was modified.
         """
-        model_fields = self.__class__.model_fields()
+        model_fields = self.model_fields()
         updated_fields = []
 
         for field_name, value in data.items():
             skip_reasons = [
-                not value,
+                value in EMPTY_VALUES,
                 field_name not in model_fields,
                 field_name in PURL_FIELDS,
             ]

scanpipe/tests/test_api.py

@@ -330,8 +330,12 @@ def test_scanpipe_api_project_action_resources(self):
         url = reverse("project-resources", args=[self.project1.uuid])
         response = self.csrf_client.get(url)
 
-        self.assertEqual(1, len(response.data))
-        resource = response.data[0]
+        self.assertEqual(1, response.data["count"])
+        self.assertIsNone(response.data["next"])
+        self.assertIsNone(response.data["previous"])
+        self.assertEqual(1, len(response.data["results"]))
+
+        resource = response.data["results"][0]
         self.assertEqual(
             ["pkg:deb/debian/[email protected]?uuid=610bed29-ce39-40e7-92d6-fd8b"],
             resource["for_packages"],
@@ -344,26 +348,49 @@ def test_scanpipe_api_project_action_resources(self):
         self.resource1.compliance_alert = CodebaseResource.Compliance.ERROR
         self.resource1.save()
         response = self.csrf_client.get(url)
-        self.assertEqual("error", response.data[0]["compliance_alert"])
+        self.assertEqual("error", response.data["results"][0]["compliance_alert"])
 
     def test_scanpipe_api_project_action_packages(self):
         url = reverse("project-packages", args=[self.project1.uuid])
         response = self.csrf_client.get(url)
+        self.assertEqual(1, response.data["count"])
+        self.assertIsNone(response.data["next"])
+        self.assertIsNone(response.data["previous"])
+        self.assertEqual(1, len(response.data["results"]))
 
-        self.assertEqual(1, len(response.data))
-        package = response.data[0]
+        package = response.data["results"][0]
         self.assertEqual("pkg:deb/debian/[email protected]?arch=all", package["purl"])
         self.assertEqual("adduser", package["name"])
 
+    def test_scanpipe_api_project_action_dependencies(self):
+        url = reverse("project-dependencies", args=[self.project1.uuid])
+        response = self.csrf_client.get(url)
+        self.assertEqual(1, response.data["count"])
+        self.assertIsNone(response.data["next"])
+        self.assertIsNone(response.data["previous"])
+        self.assertEqual(1, len(response.data["results"]))
+
+        dependency = response.data["results"][0]
+        self.assertEqual(dependency_data1["purl"], dependency["purl"])
+        self.assertEqual(dependency_data1["scope"], dependency["scope"])
+        self.assertEqual(dependency_data1["is_runtime"], dependency["is_runtime"])
+        self.assertEqual(
+            dependency_data1["dependency_uid"], dependency["dependency_uid"]
+        )
+
     def test_scanpipe_api_project_action_errors(self):
         url = reverse("project-errors", args=[self.project1.uuid])
         ProjectError.objects.create(
             project=self.project1, model="ModelName", details={}, message="Error"
         )
 
         response = self.csrf_client.get(url)
-        self.assertEqual(1, len(response.data))
-        error = response.data[0]
+        self.assertEqual(1, response.data["count"])
+        self.assertIsNone(response.data["next"])
+        self.assertIsNone(response.data["previous"])
+        self.assertEqual(1, len(response.data["results"]))
+
+        error = response.data["results"][0]
         self.assertEqual("ModelName", error["model"])
         self.assertEqual({}, error["details"])
         self.assertEqual("Error", error["message"])