TEMP: feat: Update containers in search index on components update/delete

cms/djangoapps/contentstore/core/course_optimizer_provider.py

@@ -8,6 +8,8 @@
 from cms.djangoapps.contentstore.tasks import CourseLinkCheckTask, LinkState
 from cms.djangoapps.contentstore.xblock_storage_handlers.view_handlers import get_xblock
 from cms.djangoapps.contentstore.xblock_storage_handlers.xblock_helpers import usage_key_with_run
+from xmodule.modulestore import ModuleStoreEnum
+from xmodule.modulestore.django import modulestore
 
 
 # Restricts status in the REST API to only those which the requesting user has permission to view.
@@ -285,3 +287,26 @@ def _create_dto_recursive(xblock_node, xblock_dictionary):
         xblock_children.append(xblock_entry)
 
     return {level: xblock_children} if level else None
+
+
+def sort_course_sections(course_key, data):
+    """Retrieve and sort course sections based on the published course structure."""
+    course_blocks = modulestore().get_items(
+        course_key,
+        qualifiers={'category': 'course'},
+        revision=ModuleStoreEnum.RevisionOption.published_only
+    )
+
+    if not course_blocks or 'LinkCheckOutput' not in data or 'sections' not in data['LinkCheckOutput']:
+        return data  # Return unchanged data if course_blocks or required keys are missing
+
+    sorted_section_ids = [section.location.block_id for section in course_blocks[0].get_children()]
+
+    sections_map = {section['id']: section for section in data['LinkCheckOutput']['sections']}
+    data['LinkCheckOutput']['sections'] = [
+        sections_map[section_id]
+        for section_id in sorted_section_ids
+        if section_id in sections_map
+    ]
+
+    return data

cms/djangoapps/contentstore/core/tests/test_course_optimizer_provider.py

@@ -1,12 +1,14 @@
 """
 Tests for course optimizer
 """
+from unittest import mock
 from unittest.mock import Mock
 
 from cms.djangoapps.contentstore.tests.utils import CourseTestCase
 from cms.djangoapps.contentstore.core.course_optimizer_provider import (
     _update_node_tree_and_dictionary,
-    _create_dto_recursive
+    _create_dto_recursive,
+    sort_course_sections
 )
 from cms.djangoapps.contentstore.tasks import LinkState
 
@@ -222,3 +224,74 @@ def test_create_dto_recursive_returns_for_full_tree(self):
         expected = _create_dto_recursive(mock_node_tree, mock_dictionary)
 
         self.assertEqual(expected_result, expected)
+
+    @mock.patch('cms.djangoapps.contentstore.core.course_optimizer_provider.modulestore', autospec=True)
+    def test_returns_unchanged_data_if_no_course_blocks(self, mock_modulestore):
+        """Test that the function returns unchanged data if no course blocks exist."""
+        mock_modulestore_instance = Mock()
+        mock_modulestore.return_value = mock_modulestore_instance
+        mock_modulestore_instance.get_items.return_value = []
+
+        data = {}
+        result = sort_course_sections("course-v1:Test+Course", data)
+        assert result == data  # Should return the original data
+
+    @mock.patch('cms.djangoapps.contentstore.core.course_optimizer_provider.modulestore', autospec=True)
+    def test_returns_unchanged_data_if_linkcheckoutput_missing(self, mock_modulestore):
+        """Test that the function returns unchanged data if 'LinkCheckOutput' is missing."""
+
+        mock_modulestore_instance = Mock()
+        mock_modulestore.return_value = mock_modulestore_instance
+
+        data = {'LinkCheckStatus': 'Uninitiated'}  # No 'LinkCheckOutput'
+        mock_modulestore_instance.get_items.return_value = data
+
+        result = sort_course_sections("course-v1:Test+Course", data)
+        assert result == data
+
+    @mock.patch('cms.djangoapps.contentstore.core.course_optimizer_provider.modulestore', autospec=True)
+    def test_returns_unchanged_data_if_sections_missing(self, mock_modulestore):
+        """Test that the function returns unchanged data if 'sections' is missing."""
+
+        mock_modulestore_instance = Mock()
+        mock_modulestore.return_value = mock_modulestore_instance
+
+        data = {'LinkCheckStatus': 'Success', 'LinkCheckOutput': {}}  # No 'LinkCheckOutput'
+        mock_modulestore_instance.get_items.return_value = data
+
+        result = sort_course_sections("course-v1:Test+Course", data)
+        assert result == data
+
+    @mock.patch('cms.djangoapps.contentstore.core.course_optimizer_provider.modulestore', autospec=True)
+    def test_sorts_sections_correctly(self, mock_modulestore):
+        """Test that the function correctly sorts sections based on published course structure."""
+
+        mock_course_block = Mock()
+        mock_course_block.get_children.return_value = [
+            Mock(location=Mock(block_id="section2")),
+            Mock(location=Mock(block_id="section3")),
+            Mock(location=Mock(block_id="section1")),
+        ]
+
+        mock_modulestore_instance = Mock()
+        mock_modulestore.return_value = mock_modulestore_instance
+        mock_modulestore_instance.get_items.return_value = [mock_course_block]
+
+        data = {
+            "LinkCheckOutput": {
+                "sections": [
+                    {"id": "section1", "name": "Intro"},
+                    {"id": "section2", "name": "Advanced"},
+                    {"id": "section3", "name": "Bonus"},  # Not in course structure
+                ]
+            }
+        }
+
+        result = sort_course_sections("course-v1:Test+Course", data)
+        expected_sections = [
+            {"id": "section2", "name": "Advanced"},
+            {"id": "section3", "name": "Bonus"},
+            {"id": "section1", "name": "Intro"},
+        ]
+
+        assert result["LinkCheckOutput"]["sections"] == expected_sections

cms/djangoapps/contentstore/helpers.py

@@ -82,6 +82,22 @@ def is_unit(xblock, parent_xblock=None):
     return False
 
 
+def is_library_content(xblock):
+    """
+    Returns true if the specified xblock is library content.
+    """
+    return xblock.category == 'library_content'
+
+
+def get_parent_if_split_test(xblock):
+    """
+    Returns the parent of the specified xblock if it is a split test, otherwise returns None.
+    """
+    parent_xblock = get_parent_xblock(xblock)
+    if parent_xblock and parent_xblock.category == 'split_test':
+        return parent_xblock
+
+
 def xblock_has_own_studio_page(xblock, parent_xblock=None):
     """
     Returns true if the specified xblock has an associated Studio page. Most xblocks do

cms/djangoapps/contentstore/rest_api/v0/views/course_optimizer.py

@@ -6,7 +6,7 @@
 from rest_framework.response import Response
 from user_tasks.models import UserTaskStatus
 
-from cms.djangoapps.contentstore.core.course_optimizer_provider import get_link_check_data
+from cms.djangoapps.contentstore.core.course_optimizer_provider import get_link_check_data, sort_course_sections
 from cms.djangoapps.contentstore.rest_api.v0.serializers.course_optimizer import LinkCheckSerializer
 from cms.djangoapps.contentstore.tasks import check_broken_links
 from common.djangoapps.student.auth import has_course_author_access, has_studio_read_access
@@ -139,6 +139,7 @@ def get(self, request: Request, course_id: str):
             self.permission_denied(request)
 
         data = get_link_check_data(request, course_id)
-        serializer = LinkCheckSerializer(data)
+        data = sort_course_sections(course_key, data)
 
+        serializer = LinkCheckSerializer(data)
         return Response(serializer.data)

cms/djangoapps/contentstore/tasks.py

@@ -1369,13 +1369,13 @@ def _filter_by_status(results):
     retry_list = []
     for result in results:
         status, block_id, url = result['status'], result['block_id'], result['url']
-        if status is None:
+        if status is None and _is_studio_url(url):
             retry_list.append([block_id, url])
         elif status == 200:
             continue
         elif status == 403 and _is_studio_url(url):
             filtered_results.append([block_id, url, LinkState.LOCKED])
-        elif status == 403 and not _is_studio_url(url):
+        elif status in [403, None] and not _is_studio_url(url):
             filtered_results.append([block_id, url, LinkState.EXTERNAL_FORBIDDEN])
         else:
             filtered_results.append([block_id, url, LinkState.BROKEN])

cms/djangoapps/contentstore/tests/test_tasks.py

@@ -498,18 +498,20 @@ def test_filter_by_status(self):
             {'status': 200, 'block_id': 'block1', 'url': 'https://example.com'},
             {'status': None, 'block_id': 'block2', 'url': 'https://retry.com'},
             {'status': 403, 'block_id': 'block3', 'url': 'https://' + settings.CMS_BASE},
+            {'status': None, 'block_id': 'block3', 'url': 'https://' + settings.CMS_BASE},
             {'status': 403, 'block_id': 'block4', 'url': 'https://external.com'},
             {'status': 404, 'block_id': 'block5', 'url': 'https://broken.com'}
         ]
 
         expected_filtered_results = [
+            ['block2', 'https://retry.com', LinkState.EXTERNAL_FORBIDDEN],
             ['block3', 'https://' + settings.CMS_BASE, LinkState.LOCKED],
             ['block4', 'https://external.com', LinkState.EXTERNAL_FORBIDDEN],
             ['block5', 'https://broken.com', LinkState.BROKEN],
         ]
 
         expected_retry_list = [
-            ['block2', 'https://retry.com']
+            ['block3', 'https://' + settings.CMS_BASE]
         ]
 
         filtered_results, retry_list = _filter_by_status(results)

cms/djangoapps/contentstore/views/component.py

@@ -25,7 +25,11 @@
 from common.djangoapps.student.auth import has_course_author_access
 from common.djangoapps.xblock_django.api import authorable_xblocks, disabled_xblocks
 from common.djangoapps.xblock_django.models import XBlockStudioConfigurationFlag
-from cms.djangoapps.contentstore.helpers import is_unit
+from cms.djangoapps.contentstore.helpers import (
+    get_parent_if_split_test,
+    is_unit,
+    is_library_content,
+)
 from cms.djangoapps.contentstore.toggles import (
     libraries_v1_enabled,
     libraries_v2_enabled,
@@ -148,11 +152,12 @@ def container_handler(request, usage_key_string):  # pylint: disable=too-many-st
             except ItemNotFoundError:
                 return HttpResponseBadRequest()
 
-            is_unit_page = is_unit(xblock)
-            unit = xblock if is_unit_page else None
+            if use_new_unit_page(course.id):
+                if is_unit(xblock) or is_library_content(xblock):
+                    return redirect(get_unit_url(course.id, xblock.location))
 
-            if is_unit_page and use_new_unit_page(course.id):
-                return redirect(get_unit_url(course.id, unit.location))
+                if split_xblock := get_parent_if_split_test(xblock):
+                    return redirect(get_unit_url(course.id, split_xblock.location))
 
             container_handler_context = get_container_handler_context(request, usage_key, course, xblock)
             container_handler_context.update({

cms/djangoapps/contentstore/xblock_storage_handlers/view_handlers.py

@@ -611,6 +611,7 @@ def _create_block(request):
         modulestore().update_item(created_block, request.user.id)
         response["upstreamRef"] = upstream_ref
         response["static_file_notices"] = asdict(static_file_notices)
+        response["parent_locator"] = parent_locator
 
     return JsonResponse(response)
 

cms/envs/common.py

@@ -1879,6 +1879,7 @@
     "openedx_learning.apps.authoring.components",
     "openedx_learning.apps.authoring.contents",
     "openedx_learning.apps.authoring.publishing",
+    "openedx_learning.apps.authoring.units",
 ]
 
 

cms/static/js/views/components/add_xblock.js

@@ -42,10 +42,38 @@ function($, _, gettext, BaseView, ViewUtils, AddXBlockButton, AddXBlockMenu, Add
         },
 
         showComponentTemplates: function(event) {
-            var type;
+            var type, parentLocator, model, parentBlockType;
             event.preventDefault();
             event.stopPropagation();
+
             type = $(event.currentTarget).data('type');
+            parentLocator = $(event.currentTarget).closest('.xblock[data-usage-id]').data('usage-id');
+            parentBlockType  = $(event.currentTarget).parents('.xblock-author_view').last().data('block-type');
+            model = this.collection.models.find(function(item) { return item.type === type; }) || {};
+
+            try {
+                if (this.options.isIframeEmbed && parentBlockType !== 'split_test') {
+                    window.parent.postMessage(
+                        {
+                            type: 'showComponentTemplates',
+                            payload: {
+                                type: type,
+                                parentLocator: parentLocator,
+                                model: {
+                                    type: model.type,
+                                    display_name: model.display_name,
+                                    templates: model.templates,
+                                    support_legend: model.support_legend,
+                                },
+                            }
+                        }, document.referrer
+                    );
+                    return true;
+                }
+            } catch (e) {
+                console.error(e);
+            }
+
             this.$('.new-component').slideUp(250);
             this.$('.new-component-' + type).slideDown(250);
             this.$('.new-component-' + type + ' div').focus();
@@ -65,11 +93,25 @@ function($, _, gettext, BaseView, ViewUtils, AddXBlockButton, AddXBlockMenu, Add
             var self = this,
                 $element = $(event.currentTarget),
                 saveData = $element.data(),
-                oldOffset = ViewUtils.getScrollOffset(this.$el);
+                oldOffset = ViewUtils.getScrollOffset(this.$el),
+                usageId = $element.closest('.xblock[data-usage-id]').data('usage-id');
             event.preventDefault();
             this.closeNewComponent(event);
 
             if (saveData.type === 'library_v2') {
+                try {
+                  if (this.options.isIframeEmbed) {
+                    return window.parent.postMessage(
+                      {
+                        type: 'showSingleComponentPicker',
+                        payload: { usageId },
+                      }, document.referrer
+                    );
+                  }
+                } catch (e) {
+                  console.error(e);
+                }
+
                 var modal = new AddLibraryContent();
                 modal.showComponentPicker(
                     this.options.libraryContentPickerUrl,