Do not include the pagination in the filter query string #563 (#635)

* Do not include the pagination in the filter query string #563 Signed-off-by: Thomas Druez <[email protected]> --------- Signed-off-by: Thomas Druez <[email protected]>
aboutcode-org · Mar 14, 2023 · 5707dae · 5707dae
1 parent b3d4564
commit 5707dae
Show file tree

Hide file tree

Showing 6 changed files with 53 additions and 5 deletions.
diff --git a/CHANGELOG.rst b/CHANGELOG.rst
@@ -31,6 +31,10 @@ v33.0.0 (unreleased)
   with current Project/CodebaseResource path scheme.
   https://github.com/nexB/scancode.io/pull/624
 
+- Add ``SCANCODEIO_PAGINATE_BY`` setting to customize the number of items displayed per
+  page for each object type.
+  https://github.com/nexB/scancode.io/issues/563
+
 v32.0.1 (2023-02-20)
 --------------------
 

diff --git a/docs/scancodeio-settings.rst b/docs/scancodeio-settings.rst
@@ -171,6 +171,14 @@ A valid policies file is required to enable compliance-related features.
     Check out the :ref:`tutorial_license_policies` tutorial for in-depth coverage of
     this feature.
 
+SCANCODEIO_PAGINATE_BY
+----------------------
+
+The number of objects display per page for each object type can be customized with the
+following setting::
+
+    SCANCODEIO_PAGINATE_BY=project=30,error=50,resource=100,package=100,dependency=100
+
 SCANCODEIO_REST_API_PAGE_SIZE
 -----------------------------
 

diff --git a/scancodeio/settings.py b/scancodeio/settings.py
@@ -76,6 +76,19 @@
 # Default to 24 hours.
 SCANCODEIO_TASK_TIMEOUT = env.int("SCANCODEIO_TASK_TIMEOUT", default=86400)
 
+# List views pagination, controls the number of items displayed per page.
+# Syntax in .env: SCANCODEIO_PAGINATE_BY=project=10,project_error=10
+SCANCODEIO_PAGINATE_BY = env.dict(
+    "SCANCODEIO_PAGINATE_BY",
+    default={
+        "project": 20,
+        "error": 50,
+        "resource": 100,
+        "package": 100,
+        "dependency": 100,
+    },
+)
+
 # Default limit for "most common" entries in QuerySets.
 SCANCODEIO_MOST_COMMON_LIMIT = env.int("SCANCODEIO_MOST_COMMON_LIMIT", default=7)
 

diff --git a/scanpipe/filters.py b/scanpipe/filters.py
@@ -149,6 +149,9 @@ def render_option(self, name, selected_choices, option_value, option_label):
         data[name] = option_value
         selected = data == self.data or option_value in selected_choices
 
+        # Do not include the pagination in the filter query string.
+        data.pop(PAGE_VAR, None)
+
         css_class = str(self.extra_css_class)
         if selected:
             css_class += " is-active"
@@ -224,6 +227,7 @@ class ProjectFilterSet(FilterSetUtilsMixin, django_filters.FilterSet):
     class Meta:
         model = Project
         fields = ["is_archived"]
+        exclude = ["page"]
 
     def __init__(self, data=None, *args, **kwargs):
         """

diff --git a/scanpipe/tests/test_views.py b/scanpipe/tests/test_views.py
@@ -123,6 +123,25 @@ def test_scanpipe_views_project_list_state_of_filters_in_search_form(self):
         expected = '<input type="hidden" name="status" value="failed">'
         self.assertContains(response, expected, html=True)
 
+    @mock.patch("scanpipe.views.ProjectListView.get_paginate_by")
+    def test_scanpipe_views_project_list_filters_exclude_page(self, mock_paginate_by):
+        url = reverse("project_list")
+        # Create another project to enable pagination
+        Project.objects.create(name="project2")
+        mock_paginate_by.return_value = 1
+
+        data = {"page": "2"}
+        response = self.client.get(url, data=data)
+
+        expected = '<a class="is-black-link" href="?page=2&amp;sort=name">Name</a>'
+        self.assertContains(response, expected)
+        expected = '<li><a href="?status=" class="dropdown-item is-active">All</a></li>'
+        self.assertContains(response, expected)
+        expected = '<a href="?pipeline=" class="dropdown-item is-active">All</a>'
+        self.assertContains(response, expected)
+        expected = '<a href="?sort=" class="dropdown-item is-active">Newest</a>'
+        self.assertContains(response, expected)
+
     def test_scanpipe_views_project_details_is_archived(self):
         url = self.project1.get_absolute_url()
         expected1 = "WARNING: This project is archived and read-only."

diff --git a/scanpipe/views.py b/scanpipe/views.py
@@ -401,7 +401,7 @@ class ProjectListView(
     filterset_class = ProjectFilterSet
     template_name = "scanpipe/project_list.html"
     prefetch_related = ["runs"]
-    paginate_by = 20
+    paginate_by = settings.SCANCODEIO_PAGINATE_BY.get("project", 20)
     table_columns = [
         "name",
         {
@@ -847,7 +847,7 @@ class CodebaseResourceListView(
     model = CodebaseResource
     filterset_class = ResourceFilterSet
     template_name = "scanpipe/resource_list.html"
-    paginate_by = 100
+    paginate_by = settings.SCANCODEIO_PAGINATE_BY.get("resource", 100)
     prefetch_related = ["discovered_packages"]
     table_columns = [
         "path",
@@ -884,7 +884,7 @@ class DiscoveredPackageListView(
     model = DiscoveredPackage
     filterset_class = PackageFilterSet
     template_name = "scanpipe/package_list.html"
-    paginate_by = 100
+    paginate_by = settings.SCANCODEIO_PAGINATE_BY.get("package", 100)
     prefetch_related = ["codebase_resources"]
     table_columns = [
         "package_url",
@@ -906,7 +906,7 @@ class DiscoveredDependencyListView(
     model = DiscoveredDependency
     filterset_class = DependencyFilterSet
     template_name = "scanpipe/dependency_list.html"
-    paginate_by = 100
+    paginate_by = settings.SCANCODEIO_PAGINATE_BY.get("dependency", 100)
     prefetch_related = ["for_package", "datafile_resource"]
     table_columns = [
         "package_url",
@@ -932,7 +932,7 @@ class ProjectErrorListView(
     model = ProjectError
     filterset_class = ErrorFilterSet
     template_name = "scanpipe/error_list.html"
-    paginate_by = 50
+    paginate_by = settings.SCANCODEIO_PAGINATE_BY.get("error", 50)
     table_columns = [
         "model",
         "message",