squash!: Use DRF filters for sorting and searching

Author: rodmgwgu

openedx_authz/rest_api/v1/filters.py

@@ -0,0 +1,23 @@
+"""Custom DRF filter backends for the Open edX AuthZ REST API."""
+
+from rest_framework.filters import BaseFilterBackend
+
+from openedx_authz.rest_api.data import SortField, SortOrder
+from openedx_authz.rest_api.utils import filter_users, sort_users
+
+
+class TeamMemberSearchFilter(BaseFilterBackend):
+    """Filter team members by a search term."""
+
+    def filter_queryset(self, request, queryset, view):
+        search = request.query_params.get("search")
+        return filter_users(users=queryset, search=search, roles=None)
+
+
+class TeamMemberOrderingFilter(BaseFilterBackend):
+    """Sort team members by a given field and order."""
+
+    def filter_queryset(self, request, queryset, view):
+        sort_by = request.query_params.get("sort_by", SortField.USERNAME)
+        order = request.query_params.get("order", SortOrder.ASC)
+        return sort_users(users=queryset, sort_by=sort_by, order=order)

openedx_authz/rest_api/v1/views.py

@@ -16,7 +16,7 @@
 
 from openedx_authz import api
 from openedx_authz.constants import permissions
-from openedx_authz.rest_api.data import RoleOperationError, RoleOperationStatus, SortField, UserAssignmentsFilter
+from openedx_authz.rest_api.data import RoleOperationError, RoleOperationStatus, UserAssignmentsFilter
 from openedx_authz.rest_api.decorators import authz_permissions, view_auth_classes
 from openedx_authz.rest_api.utils import (
     filter_allowed_assignments,
@@ -27,6 +27,7 @@
     get_user_map,
     sort_users,
 )
+from openedx_authz.rest_api.v1.filters import TeamMemberOrderingFilter, TeamMemberSearchFilter
 from openedx_authz.rest_api.v1.paginators import AuthZAPIViewPagination
 from openedx_authz.rest_api.v1.permissions import DynamicScopePermission
 from openedx_authz.rest_api.v1.serializers import (
@@ -465,6 +466,7 @@ class TeamMembersAPIView(APIView):
     """
 
     pagination_class = AuthZAPIViewPagination
+    filter_backends = [TeamMemberSearchFilter, TeamMemberOrderingFilter]
 
     @apidocs.schema(
         parameters=[
@@ -494,32 +496,21 @@ def get(self, request: HttpRequest) -> Response:
         # Group assignments by user
         users_with_assignments = get_user_assignment_map(user_role_assignments)
 
-        scopes = query_params.get("scopes")
-        orgs = query_params.get("orgs")
-        search = query_params.get("search")
-        order = query_params.get("order")
-        sort_by = query_params.get("sort_by", SortField.USERNAME)
-
-        # Filter by scopes
         users_with_assignments = filter_user_assignments(
             users_with_assignments=users_with_assignments,
             by=UserAssignmentsFilter.SCOPES,
-            values=scopes,
+            values=query_params.get("scopes"),
         )
-
-        # Filter by orgs
         users_with_assignments = filter_user_assignments(
             users_with_assignments=users_with_assignments,
             by=UserAssignmentsFilter.ORGS,
-            values=orgs,
+            values=query_params.get("orgs"),
         )
 
-        team_members = TeamMemberSerializer(users_with_assignments, many=True)
-        # Search
-        filtered_team_members = filter_users(users=team_members.data, search=search, roles=None)
-        # Sort
-        sorted_team_members = sort_users(users=filtered_team_members, sort_by=sort_by, order=order)
-        # Paginate
+        team_members = TeamMemberSerializer(users_with_assignments, many=True).data
+        for backend in self.filter_backends:
+            team_members = backend().filter_queryset(request, team_members, self)
+
         paginator = self.pagination_class()
-        paginated_response_data = paginator.paginate_queryset(sorted_team_members, request)
+        paginated_response_data = paginator.paginate_queryset(team_members, request)
         return paginator.get_paginated_response(paginated_response_data)