feat: test pr master

Makefile

@@ -7,6 +7,7 @@
   pre-requirements pull pull_translations push_translations requirements shell swagger \
   technical-docs test-requirements ubuntu-requirements upgrade-package upgrade
 
+
 # Careful with mktemp syntax: it has to work on Mac and Ubuntu, which have differences.
 PRIVATE_FILES := $(shell mktemp -u /tmp/private_files.XXXXXX)
 

README.rst

@@ -25,6 +25,7 @@ platform.  Functionally, the edx-platform repository provides two services:
 * CMS (Content Management Service), which powers Open edX Studio, the platform's learning content authoring environment; and
 * LMS (Learning Management Service), which delivers learning content.
 
+
 Documentation
 *************
 

cms/djangoapps/contentstore/management/commands/reindex_course.py

@@ -3,6 +3,7 @@
 
 import logging
 from textwrap import dedent
+from time import time
 
 from django.core.management import BaseCommand, CommandError
 from elasticsearch import exceptions
@@ -24,7 +25,7 @@ class Command(BaseCommand):
     Examples:
 
         ./manage.py reindex_course <course_id_1> <course_id_2> ... - reindexes courses with provided keys
-        ./manage.py reindex_course --all - reindexes all available courses
+        ./manage.py reindex_course --all --warning - reindexes all available courses with quieter logging
         ./manage.py reindex_course --setup - reindexes all courses for devstack setup
     """
     help = dedent(__doc__)
@@ -40,6 +41,10 @@ def add_arguments(self, parser):
         parser.add_argument('--setup',
                             action='store_true',
                             help='Reindex all courses on developers stack setup')
+        parser.add_argument('--warning',
+                            action='store_true',
+                            help='Reduce logging to a WARNING level of output for progress tracking'
+                            )
 
     def _parse_course_key(self, raw_value):
         """ Parses course key from string """
@@ -61,13 +66,18 @@ def handle(self, *args, **options):
         course_ids = options['course_ids']
         all_option = options['all']
         setup_option = options['setup']
+        readable_option = options['warning']
         index_all_courses_option = all_option or setup_option
 
         if (not len(course_ids) and not index_all_courses_option) or (len(course_ids) and index_all_courses_option):  # lint-amnesty, pylint: disable=len-as-condition
             raise CommandError("reindex_course requires one or more <course_id>s OR the --all or --setup flags.")
 
         store = modulestore()
 
+        if readable_option:
+            logging.disable(level=logging.INFO)
+            logging.warning('Reducing logging to WARNING level for easier progress tracking')
+
         if index_all_courses_option:
             index_names = (CoursewareSearchIndexer.INDEX_NAME, CourseAboutSearchIndexer.INDEX_NAME)
             if setup_option:
@@ -98,8 +108,18 @@ def handle(self, *args, **options):
             # in case course keys are provided as arguments
             course_keys = list(map(self._parse_course_key, course_ids))
 
+        total = len(course_keys)
+        logging.warning(f'Reindexing {total} courses')
+        reindexed = 0
+        start = time()
+
         for course_key in course_keys:
             try:
                 CoursewareSearchIndexer.do_course_reindex(store, course_key)
+                reindexed += 1
+                if reindexed % 10 == 0 or reindexed == total:
+                    now = time()
+                    t = now - start
+                    logging.warning(f'{reindexed}/{total} reindexed in {t:.1f} seconds')
             except Exception as exc:  # lint-amnesty, pylint: disable=broad-except
                 logging.exception('Error indexing course %s due to the error: %s', course_key, exc)

cms/djangoapps/contentstore/rest_api/serializers/common.py

@@ -50,3 +50,23 @@ def to_internal_value(self, data):
                 )
 
         return ret
+
+
+class ProctoringErrorModelSerializer(serializers.Serializer):
+    """
+    Serializer for proctoring error model item.
+    """
+    deprecated = serializers.BooleanField()
+    display_name = serializers.CharField()
+    help = serializers.CharField()
+    hide_on_enabled_publisher = serializers.BooleanField()
+    value = serializers.CharField()
+
+
+class ProctoringErrorListSerializer(serializers.Serializer):
+    """
+    Serializer for proctoring error list.
+    """
+    key = serializers.CharField()
+    message = serializers.CharField()
+    model = ProctoringErrorModelSerializer()

cms/djangoapps/contentstore/rest_api/v1/serializers/__init__.py

@@ -4,6 +4,7 @@
 from .course_details import CourseDetailsSerializer
 from .course_rerun import CourseRerunSerializer
 from .course_team import CourseTeamSerializer
+from .course_index import CourseIndexSerializer
 from .grading import CourseGradingModelSerializer, CourseGradingSerializer
 from .home import CourseHomeSerializer, CourseTabSerializer, LibraryTabSerializer
 from .proctoring import (

cms/djangoapps/contentstore/rest_api/v1/serializers/course_index.py

@@ -0,0 +1,31 @@
+"""
+API Serializers for course index
+"""
+
+from rest_framework import serializers
+
+from cms.djangoapps.contentstore.rest_api.serializers.common import ProctoringErrorListSerializer
+
+
+class InitialIndexStateSerializer(serializers.Serializer):
+    """Serializer for initial course index state"""
+    expanded_locators = serializers.ListSerializer(child=serializers.CharField())
+    locator_to_show = serializers.CharField()
+
+
+class CourseIndexSerializer(serializers.Serializer):
+    """Serializer for course index"""
+    course_release_date = serializers.CharField()
+    course_structure = serializers.DictField()
+    deprecated_blocks_info = serializers.DictField()
+    discussions_incontext_feedback_url = serializers.CharField()
+    discussions_incontext_learnmore_url = serializers.CharField()
+    initial_state = InitialIndexStateSerializer()
+    initial_user_clipboard = serializers.DictField()
+    language_code = serializers.CharField()
+    lms_link = serializers.CharField()
+    mfe_proctored_exam_settings_url = serializers.CharField()
+    notification_dismiss_url = serializers.CharField()
+    proctoring_errors = ProctoringErrorListSerializer(many=True)
+    reindex_link = serializers.CharField()
+    rerun_notification_id = serializers.IntegerField()

cms/djangoapps/contentstore/rest_api/v1/serializers/proctoring.py

@@ -4,6 +4,7 @@
 
 from rest_framework import serializers
 
+from cms.djangoapps.contentstore.rest_api.serializers.common import ProctoringErrorListSerializer
 from xmodule.course_block import get_available_providers
 
 
@@ -31,26 +32,6 @@ class ProctoredExamConfigurationSerializer(serializers.Serializer):
     course_start_date = serializers.DateTimeField()
 
 
-class ProctoringErrorModelSerializer(serializers.Serializer):
-    """
-    Serializer for proctoring error model item.
-    """
-    deprecated = serializers.BooleanField()
-    display_name = serializers.CharField()
-    help = serializers.CharField()
-    hide_on_enabled_publisher = serializers.BooleanField()
-    value = serializers.CharField()
-
-
-class ProctoringErrorListSerializer(serializers.Serializer):
-    """
-    Serializer for proctoring error list.
-    """
-    key = serializers.CharField()
-    message = serializers.CharField()
-    model = ProctoringErrorModelSerializer()
-
-
 class ProctoringErrorsSerializer(serializers.Serializer):
     """
     Serializer for proctoring errors with url to proctored exam settings.

cms/djangoapps/contentstore/rest_api/v1/serializers/videos.py

@@ -56,9 +56,6 @@ class VideoModelSerializer(serializers.Serializer):
     transcripts = serializers.ListField(
         child=serializers.CharField()
     )
-    usage_locations = serializers.ListField(
-        child=serializers.DictField()
-    )
 
 
 class VideoActiveTranscriptPreferencesSerializer(serializers.Serializer):
@@ -99,7 +96,6 @@ class CourseVideosSerializer(serializers.Serializer):
             child=serializers.CharField()
         )
     )
-    # transcript_available_languages = serializers.BooleanField(required=False, allow_null=True)
     video_transcript_settings = VideoTranscriptSettingsSerializer()
     pagination_context = serializers.DictField(
         child=serializers.CharField(),

cms/djangoapps/contentstore/rest_api/v1/urls.py

@@ -7,6 +7,7 @@
 from .views import (
     CourseDetailsView,
     CourseTeamView,
+    CourseIndexView,
     CourseGradingView,
     CourseRerunView,
     CourseSettingsView,
@@ -69,6 +70,11 @@
         CourseSettingsView.as_view(),
         name="course_settings"
     ),
+    re_path(
+        fr'^course_index/{COURSE_ID_PATTERN}$',
+        CourseIndexView.as_view(),
+        name="course_index"
+    ),
     re_path(
         fr'^course_details/{COURSE_ID_PATTERN}$',
         CourseDetailsView.as_view(),

cms/djangoapps/contentstore/rest_api/v1/views/__init__.py

@@ -2,6 +2,7 @@
 Views for v1 contentstore API.
 """
 from .course_details import CourseDetailsView
+from .course_index import CourseIndexView
 from .course_team import CourseTeamView
 from .course_rerun import CourseRerunView
 from .grading import CourseGradingView

cms/djangoapps/contentstore/rest_api/v1/views/course_index.py

@@ -0,0 +1,98 @@
+"""API Views for course index"""
+
+import edx_api_doc_tools as apidocs
+from django.conf import settings
+from opaque_keys.edx.keys import CourseKey
+from rest_framework.request import Request
+from rest_framework.response import Response
+from rest_framework.views import APIView
+
+from cms.djangoapps.contentstore.rest_api.v1.serializers import CourseIndexSerializer
+from cms.djangoapps.contentstore.utils import get_course_index_context
+from common.djangoapps.student.auth import has_studio_read_access
+from openedx.core.lib.api.view_utils import DeveloperErrorViewMixin, verify_course_exists, view_auth_classes
+
+
+@view_auth_classes(is_authenticated=True)
+class CourseIndexView(DeveloperErrorViewMixin, APIView):
+    """View for Course Index"""
+
+    @apidocs.schema(
+        parameters=[
+            apidocs.string_parameter("course_id", apidocs.ParameterLocation.PATH, description="Course ID"),
+            apidocs.string_parameter(
+                "show",
+                apidocs.ParameterLocation.QUERY,
+                description="Query param to set initial state which fully expanded to see the item",
+            )],
+        responses={
+            200: CourseIndexSerializer,
+            401: "The requester is not authenticated.",
+            403: "The requester cannot access the specified course.",
+            404: "The requested course does not exist.",
+        },
+    )
+    @verify_course_exists()
+    def get(self, request: Request, course_id: str):
+        """
+        Get an object containing course index for outline.
+
+        **Example Request**
+
+            GET /api/contentstore/v1/course_index/{course_id}?show=block-v1:edx+101+y+type@course+block@course
+
+        **Response Values**
+
+        If the request is successful, an HTTP 200 "OK" response is returned.
+
+        The HTTP 200 response contains a single dict that contains keys that
+        are the course's outline.
+
+        **Example Response**
+
+        ```json
+        {
+            "course_release_date": "Set Date",
+            "course_structure": {},
+            "deprecated_blocks_info": {
+                "deprecated_enabled_block_types": [],
+                "blocks": [],
+                "advance_settings_url": "/settings/advanced/course-v1:edx+101+y76"
+            },
+            "discussions_incontext_feedback_url": "",
+            "discussions_incontext_learnmore_url": "",
+            "initial_state": {
+                "expanded_locators": [
+                "block-v1:edx+101+y76+type@chapter+block@03de0adc9d1c4cc097062d80eb04abf6",
+                "block-v1:edx+101+y76+type@sequential+block@8a85e287e30a47e98d8c1f37f74a6a9d"
+                ],
+                "locator_to_show": "block-v1:edx+101+y76+type@chapter+block@03de0adc9d1c4cc097062d80eb04abf6"
+            },
+            "initial_user_clipboard": {
+                "content": null,
+                "source_usage_key": "",
+                "source_context_title": "",
+                "source_edit_url": ""
+            },
+            "language_code": "en",
+            "lms_link": "//localhost:18000/courses/course-v1:edx+101+y76/jump_to/block-v1:edx+101+y76",
+            "mfe_proctored_exam_settings_url": "",
+            "notification_dismiss_url": "/course_notifications/course-v1:edx+101+y76/2",
+            "proctoring_errors": [],
+            "reindex_link": "/course/course-v1:edx+101+y76/search_reindex",
+            "rerun_notification_id": 2
+        }
+        ```
+        """
+
+        course_key = CourseKey.from_string(course_id)
+        if not has_studio_read_access(request.user, course_key):
+            self.permission_denied(request)
+        course_index_context = get_course_index_context(request, course_key)
+        course_index_context.update({
+            "discussions_incontext_learnmore_url": settings.DISCUSSIONS_INCONTEXT_LEARNMORE_URL,
+            "discussions_incontext_feedback_url": settings.DISCUSSIONS_INCONTEXT_FEEDBACK_URL,
+        })
+
+        serializer = CourseIndexSerializer(course_index_context)
+        return Response(serializer.data)