Merge pull request aboutcode-org#830 from TG1999/fix_pagination

Paginate initial listings to display a small number of or records

CHANGELOG.rst

@@ -52,6 +52,9 @@ Version v30.0.0
 - Package endpoint will give fixed packages of only those that
  matches type, name, namespace, subpath and qualifiers of the package queried.
 
+- Paginated initial listings to display a small number of records 
+ and provided page per size with a maximum limit of 100 records per page.
+
 Other:
 
 - we dropped calver to use a plain semver.

vulnerabilities/api.py

@@ -177,7 +177,6 @@ def filter_purl(self, queryset, name, value):
 class PackageViewSet(viewsets.ReadOnlyModelViewSet):
  queryset = Package.objects.all()
  serializer_class = PackageSerializer
- paginate_by = 50
  filter_backends = (filters.DjangoFilterBackend,)
  filterset_class = PackageFilterSet
 
@@ -252,7 +251,6 @@ def get_queryset(self):
  )
 
  serializer_class = VulnerabilitySerializer
- paginate_by = 50
  filter_backends = (filters.DjangoFilterBackend,)
  filterset_class = VulnerabilityFilterSet
 
@@ -270,7 +268,6 @@ class CPEViewSet(viewsets.ReadOnlyModelViewSet):
  vulnerabilityreference__reference_id__startswith="cpe"
  ).distinct()
  serializer_class = VulnerabilitySerializer
- paginate_by = 50
  filter_backends = (filters.DjangoFilterBackend,)
  filterset_class = CPEFilterSet
 
@@ -286,6 +283,5 @@ def filter_alias(self, queryset, name, value):
 class AliasViewSet(viewsets.ReadOnlyModelViewSet):
  queryset = Vulnerability.objects.all()
  serializer_class = VulnerabilitySerializer
- paginate_by = 50
  filter_backends = (filters.DjangoFilterBackend,)
  filterset_class = AliasFilterSet

vulnerabilities/pagination.py

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

vulnerabilities/tests/test_fix_api.py

@@ -9,6 +9,7 @@
 
 from django.test import TestCase
 from django.utils.http import int_to_base36
+from packageurl import PackageURL
 from rest_framework import status
 
 from vulnerabilities.models import Alias
@@ -240,3 +241,38 @@ def test_api_status(self):
  def test_api_response(self):
  response = self.client.get("/api/alias?alias=CVE-9", format="json").data
  self.assertEqual(response["count"], 1)
+
+
+class BulkSearchAPI(TestCase):
+ def setUp(self):
+ packages = [
+ "pkg:nginx/nginx@0.6.18",
+ "pkg:nginx/nginx@1.20.0",
+ "pkg:nginx/nginx@1.21.0",
+ "pkg:nginx/nginx@1.20.1",
+ "pkg:nginx/nginx@1.9.5",
+ "pkg:nginx/nginx@1.17.2",
+ "pkg:nginx/nginx@1.17.3",
+ "pkg:nginx/nginx@1.16.1",
+ "pkg:nginx/nginx@1.15.5",
+ "pkg:nginx/nginx@1.15.6",
+ "pkg:nginx/nginx@1.14.1",
+ "pkg:nginx/nginx@1.0.7",
+ "pkg:nginx/nginx@1.0.15",
+ ]
+ self.packages = packages
+ for package in packages:
+ purl = PackageURL.from_string(package)
+ attrs = {k: v for k, v in purl.to_dict().items() if v}
+ Package.objects.create(**attrs)
+
+ def test_api_response(self):
+ request_body = {
+ "purls": self.packages,
+ }
+ response = self.client.post(
+ "/api/packages/bulk_search",
+ data=request_body,
+ content_type="application/json",
+ ).json()
+ assert len(response) == 13

vulnerablecode/settings.py

@@ -159,6 +159,7 @@
  "django_filters.rest_framework.DjangoFilterBackend",
  "rest_framework.filters.SearchFilter",
  ),
- "DEFAULT_PAGINATION_CLASS": "rest_framework.pagination.PageNumberPagination",
- "PAGE_SIZE": 100,
+ "DEFAULT_PAGINATION_CLASS": "vulnerabilities.pagination.SmallResultSetPagination",
+ # Limit the load on the Database returning a small number of records by default. https://github.com/nexB/vulnerablecode/issues/819
+ "PAGE_SIZE": 10,
 }