feat: Use default pagination class for v2 library views (#34879)

This ensures `num_pages` is included in paginated response.
This commit is contained in:
Yusuf Musleh
2024-06-11 21:15:25 +03:00
committed by GitHub
parent 0b45e99128
commit 221e333154
2 changed files with 19 additions and 23 deletions

View File

@@ -137,7 +137,7 @@ class ContentLibrariesTestCase(ContentLibrariesRestApiTest, OpenEdxEventsTestMix
}
@skip("This endpoint shouldn't support num_blocks and has_unpublished_*.")
@patch("openedx.core.djangoapps.content_libraries.views.LibraryApiPagination.page_size", new=2)
@patch("openedx.core.djangoapps.content_libraries.views.LibraryRootView.pagination_class.page_size", new=2)
def test_list_library(self):
"""
Test the /libraries API and its pagination
@@ -374,7 +374,7 @@ class ContentLibrariesTestCase(ContentLibrariesRestApiTest, OpenEdxEventsTestMix
assert 'resources' in fragment
assert 'Hello world!' in fragment['content']
@patch("openedx.core.djangoapps.content_libraries.views.LibraryApiPagination.page_size", new=2)
@patch("openedx.core.djangoapps.content_libraries.views.LibraryBlocksView.pagination_class.page_size", new=2)
def test_list_library_blocks(self):
"""
Test the /libraries/{lib_key_str}/blocks API and its pagination

View File

@@ -90,11 +90,11 @@ from organizations.exceptions import InvalidOrganizationException
from organizations.models import Organization
from rest_framework import status
from rest_framework.exceptions import NotFound, PermissionDenied, ValidationError
from rest_framework.pagination import PageNumberPagination
from rest_framework.generics import GenericAPIView
from rest_framework.parsers import MultiPartParser
from rest_framework.response import Response
from rest_framework.views import APIView
from rest_framework.viewsets import ViewSet
from rest_framework.viewsets import GenericViewSet
from openedx.core.djangoapps.content_libraries import api, permissions
from openedx.core.djangoapps.content_libraries.serializers import (
@@ -153,13 +153,10 @@ def convert_exceptions(fn):
return wrapped_fn
class LibraryApiPagination(PageNumberPagination):
class LibraryApiPaginationDocs:
"""
Paginates over ContentLibraryMetadata objects.
API docs for query params related to paginating ContentLibraryMetadata objects.
"""
page_size = 50
page_size_query_param = 'page_size'
apidoc_params = [
apidocs.query_parameter(
'pagination',
@@ -181,14 +178,14 @@ class LibraryApiPagination(PageNumberPagination):
@method_decorator(non_atomic_requests, name="dispatch")
@view_auth_classes()
class LibraryRootView(APIView):
class LibraryRootView(GenericAPIView):
"""
Views to list, search for, and create content libraries.
"""
@apidocs.schema(
parameters=[
*LibraryApiPagination.apidoc_params,
*LibraryApiPaginationDocs.apidoc_params,
apidocs.query_parameter(
'org',
str,
@@ -211,21 +208,20 @@ class LibraryRootView(APIView):
library_type = serializer.validated_data['type']
text_search = serializer.validated_data['text_search']
paginator = LibraryApiPagination()
queryset = api.get_libraries_for_user(
request.user,
org=org,
library_type=library_type,
text_search=text_search,
)
paginated_qs = paginator.paginate_queryset(queryset, request)
paginated_qs = self.paginate_queryset(queryset)
result = api.get_metadata(paginated_qs)
serializer = ContentLibraryMetadataSerializer(result, many=True)
# Verify `pagination` param to maintain compatibility with older
# non pagination-aware clients
if request.GET.get('pagination', 'false').lower() == 'true':
return paginator.get_paginated_response(serializer.data)
return self.get_paginated_response(serializer.data)
return Response(serializer.data)
def post(self, request):
@@ -506,13 +502,14 @@ class LibraryCommitView(APIView):
@method_decorator(non_atomic_requests, name="dispatch")
@view_auth_classes()
class LibraryBlocksView(APIView):
class LibraryBlocksView(GenericAPIView):
"""
Views to work with XBlocks in a specific content library.
"""
@apidocs.schema(
parameters=[
*LibraryApiPagination.apidoc_params,
*LibraryApiPaginationDocs.apidoc_params,
apidocs.query_parameter(
'text_search',
str,
@@ -538,13 +535,12 @@ class LibraryBlocksView(APIView):
api.require_permission_for_library_key(key, request.user, permissions.CAN_VIEW_THIS_CONTENT_LIBRARY)
components = api.get_library_components(key, text_search=text_search, block_types=block_types)
paginator = LibraryApiPagination()
paginated_xblock_metadata = [
api.LibraryXBlockMetadata.from_component(key, component)
for component in paginator.paginate_queryset(components, request)
for component in self.paginate_queryset(components)
]
serializer = LibraryXBlockMetadataSerializer(paginated_xblock_metadata, many=True)
return paginator.get_paginated_response(serializer.data)
return self.get_paginated_response(serializer.data)
@convert_exceptions
def post(self, request, lib_key_str):
@@ -742,7 +738,7 @@ class LibraryBlockAssetView(APIView):
@method_decorator(non_atomic_requests, name="dispatch")
@view_auth_classes()
class LibraryImportTaskViewSet(ViewSet):
class LibraryImportTaskViewSet(GenericViewSet):
"""
Import blocks from Courseware through modulestore.
"""
@@ -760,9 +756,9 @@ class LibraryImportTaskViewSet(ViewSet):
)
queryset = api.ContentLibrary.objects.get_by_key(library_key).import_tasks
result = ContentLibraryBlockImportTaskSerializer(queryset, many=True).data
paginator = LibraryApiPagination()
return paginator.get_paginated_response(
paginator.paginate_queryset(result, request)
return self.get_paginated_response(
self.paginate_queryset(result)
)
@convert_exceptions