feat: add pagination to the support tool customer list (#2252)

CHANGELOG.rst

@@ -17,6 +17,10 @@ Unreleased
 ----------
 * nothing unreleased
 
+[4.25.17]
+---------
+* feat: add pagination to the support tool customer list
+
 [4.25.16]
 ---------
 * feat: add a waffle flag for enterprise groups v2 feature

enterprise/__init__.py

@@ -2,4 +2,4 @@
 Your project description goes here.
 """
 
-__version__ = "4.25.16"
+__version__ = "4.25.17"

enterprise/api/v1/views/enterprise_customer.py

@@ -124,17 +124,22 @@ def basic_list(self, request, *arg, **kwargs):
     # pylint: disable=unused-argument
     def support_tool(self, request, *arg, **kwargs):
         """
-        Enterprise Customer's detail data for the support tool
+        Enterprise Customer's detail data with pagination for the support tool
 
         Supported query param:
         - uuid: filter the enterprise customer uuid .
+        - user_query: filter the enterprise customer name.
         """
         enterprise_uuid = request.GET.get('uuid')
+        user_query = request.GET.get("user_query", None)
         queryset = self.get_queryset().order_by('name')
+        if user_query:
+            queryset = queryset.filter(Q(slug__icontains=user_query) | Q(name__icontains=user_query))
         if enterprise_uuid:
             queryset = queryset.filter(uuid=enterprise_uuid)
-        serializer = self.get_serializer(queryset, many=True)
-        return Response(serializer.data)
+        page = self.paginate_queryset(queryset)
+        serializer = self.get_serializer(page, many=True)
+        return self.get_paginated_response(serializer.data)
 
     @has_any_permissions('enterprise.can_access_admin_dashboard',
                          ENTERPRISE_CUSTOMER_PROVISIONING_ADMIN_ACCESS_PERMISSION)

tests/test_enterprise/api/test_views.py

@@ -1946,7 +1946,7 @@ def test_enterprise_customer_support_tool(
         self.create_items(factory, model_items)
         response = self.client.get(settings.TEST_SERVER + url)
         response = self.load_json(response.content)
-        assert sorted(expected_json, key=sorting_key) == sorted(response, key=sorting_key)
+        assert sorted(expected_json, key=sorting_key) == sorted(response['results'], key=sorting_key)
 
     @ddt.data(
         # Request missing required permissions query param.