feat: follow migrated legacy library content block

cms/djangoapps/contentstore/tasks.py

@@ -1677,7 +1677,7 @@ def handle_update_xblock_upstream_link(usage_key):
     except (ItemNotFoundError, InvalidKeyError):
         LOGGER.exception(f'Could not find item for given usage_key: {usage_key}')
         return
-    if not xblock.upstream or not xblock.upstream_version:
+    if not xblock.upstream or xblock.upstream_version is None:
         return
     create_or_update_xblock_upstream_link(xblock)
 

cms/djangoapps/modulestore_migrator/api.py

@@ -2,22 +2,25 @@
 API for migration from modulestore to learning core
 """
 from celery.result import AsyncResult
-from opaque_keys.edx.keys import CourseKey, LearningContextKey
-from opaque_keys.edx.locator import LibraryLocator, LibraryLocatorV2
+from opaque_keys import InvalidKeyError
+from opaque_keys.edx.keys import CourseKey, LearningContextKey, UsageKey
+from opaque_keys.edx.locator import LibraryLocator, LibraryLocatorV2, LibraryUsageLocatorV2
 from openedx_learning.api.authoring import get_collection
+from openedx_learning.api.authoring_models import Component
 from user_tasks.models import UserTaskStatus
 
-from openedx.core.djangoapps.content_libraries.api import get_library
+from openedx.core.djangoapps.content_libraries.api import get_library, library_component_usage_key
 from openedx.core.types.user import AuthUser
 
 from . import tasks
-from .models import ModulestoreSource
+from .models import ModulestoreBlockMigration, ModulestoreSource
 
 __all__ = (
     "start_migration_to_library",
     "start_bulk_migration_to_library",
     "is_successfully_migrated",
     "get_migration_info",
+    "get_target_block_usage_keys",
 )
 
 
@@ -102,13 +105,17 @@ def start_bulk_migration_to_library(
     )
 
 
-def is_successfully_migrated(source_key: CourseKey | LibraryLocator) -> bool:
+def is_successfully_migrated(
+    source_key: CourseKey | LibraryLocator,
+    source_version: str | None = None,
+) -> bool:
     """
     Check if the source course/library has been migrated successfully.
     """
-    return ModulestoreSource.objects.get_or_create(key=str(source_key))[0].migrations.filter(
-        task_status__state=UserTaskStatus.SUCCEEDED
-    ).exists()
+    filters = {"task_status__state": UserTaskStatus.SUCCEEDED}
+    if source_version is not None:
+        filters["source_version"] = source_version
+    return ModulestoreSource.objects.get_or_create(key=str(source_key))[0].migrations.filter(**filters).exists()
 
 
 def get_migration_info(source_keys: list[CourseKey | LibraryLocator]) -> dict:
@@ -129,3 +136,26 @@ def get_migration_info(source_keys: list[CourseKey | LibraryLocator]) -> dict:
             named=True,
         )
     }
+
+
+def get_target_block_usage_keys(source_key: CourseKey | LibraryLocator) -> dict[UsageKey, LibraryUsageLocatorV2 | None]:
+    """
+    For given source_key, get a map of legacy block key and its new location in migrated v2 library.
+    """
+    query_set = ModulestoreBlockMigration.objects.filter(overall_migration__source__key=source_key).select_related(
+        'source', 'target__component__component_type', 'target__learning_package'
+    )
+
+    def construct_usage_key(lib_key_str: str, component: Component) -> LibraryUsageLocatorV2 | None:
+        try:
+            lib_key = LibraryLocatorV2.from_string(lib_key_str)
+        except InvalidKeyError:
+            return None
+        return library_component_usage_key(lib_key, component)
+
+    # Use LibraryUsageLocatorV2 and construct usage key
+    return {
+        obj.source.key: construct_usage_key(obj.target.learning_package.key, obj.target.component)
+        for obj in query_set
+        if obj.source.key is not None
+    }

cms/djangoapps/modulestore_migrator/tests/test_api.py

@@ -38,6 +38,9 @@ def setUp(self):
         )
         self.library_v2 = lib_api.ContentLibrary.objects.get(slug=self.lib_key_v2.slug)
         self.learning_package = self.library_v2.learning_package
+        self.blocks = []
+        for _ in range(3):
+            self.blocks.append(self._add_simple_content_block().usage_key)
 
     def test_start_migration_to_library(self):
         """
@@ -384,3 +387,24 @@ def test_get_migration_info(self):
             assert row.migrations__target__title == "Test Library"
             assert row.migrations__target_collection__key == collection_key
         assert row.migrations__target_collection__title == "Test Collection"
+
+    def test_get_target_block_usage_keys(self):
+        """
+        Test that the API can get the list of target block usage keys for a given library.
+        """
+        user = UserFactory()
+
+        api.start_migration_to_library(
+            user=user,
+            source_key=self.lib_key,
+            target_library_key=self.library_v2.library_key,
+            target_collection_slug=None,
+            composition_level=CompositionLevel.Component.value,
+            repeat_handling_strategy=RepeatHandlingStrategy.Skip.value,
+            preserve_url_slugs=True,
+            forward_source_to_target=True,
+        )
+        with self.assertNumQueries(1):
+            result = api.get_target_block_usage_keys(self.lib_key)
+        for key in self.blocks:
+            assert result.get(key) is not None

cms/lib/xblock/upstream_sync.py

@@ -17,17 +17,17 @@
 
 import logging
 import typing as t
-from dataclasses import dataclass, asdict
+from dataclasses import asdict, dataclass
 
 from django.conf import settings
 from django.utils.translation import gettext_lazy as _
 from opaque_keys import InvalidKeyError
-from opaque_keys.edx.keys import CourseKey
+from opaque_keys.edx.keys import CourseKey, UsageKey
 from opaque_keys.edx.locator import LibraryContainerLocator, LibraryUsageLocatorV2
-from opaque_keys.edx.keys import UsageKey
+from xblock.core import XBlock, XBlockMixin
 from xblock.exceptions import XBlockNotFoundError
-from xblock.fields import Scope, String, Integer, List
-from xblock.core import XBlockMixin, XBlock
+from xblock.fields import Integer, List, Scope, String
+
 from xmodule.util.keys import BlockKey
 
 if t.TYPE_CHECKING:

cms/static/js/views/pages/container.js

@@ -632,13 +632,13 @@ function($, _, Backbone, gettext, BasePage,
                     doneAddingBlock = (addResult) => {
                         const $placeholderEl = $(this.createPlaceholderElement());
                         const placeholderElement = $placeholderEl.insertBefore($insertSpot);
-                        placeholderElement.data('locator', addResult.locator);
-                        return this.refreshXBlock(placeholderElement, true);
+                        return this.onNewXBlock(placeholderElement, 0, false, addResult);
                     };
                     doneAddingAllBlocks = () => {};
                 }
                 // Note: adding all the XBlocks in parallel will cause a race condition 😢 so we have to add
                 // them one at a time:
+
                 let lastAdded = $.when();
                 for (const { usageKey, blockType } of selectedBlocks) {
                     const addData = {
@@ -1220,12 +1220,13 @@ function($, _, Backbone, gettext, BasePage,
         refreshXBlock: function(element, block_added, is_duplicate) {
             var xblockElement = this.findXBlockElement(element),
                 parentElement = xblockElement.parent(),
-                rootLocator = this.xblockView.model.id;
+                rootLocator = this.xblockView.model.id,
+                parentBlockType = parentElement.data('block-type');
             if (xblockElement.length === 0 || xblockElement.data('locator') === rootLocator) {
                 if (block_added) {
                     this.render({refresh: true, block_added: block_added});
                 }
-            } else if (parentElement.hasClass('reorderable-container')) {
+            } else if (parentElement.hasClass('reorderable-container') || ["itembank", "library_content"].includes(parentBlockType) ) {
                 this.refreshChildXBlock(xblockElement, block_added, is_duplicate);
             } else {
                 this.refreshXBlock(this.findXBlockElement(parentElement));

xmodule/assets/library_content/public/js/library_content_edit.js

@@ -1,11 +1,39 @@
 /* JavaScript for special editing operations that can be done on LibraryContentXBlock */
-window.LibraryContentAuthorView = function(runtime, element) {
+window.LibraryContentAuthorView = function(runtime, element, initArgs) {
     'use strict';
     var $element = $(element);
     var usage_id = $element.data('usage-id');
     // The "Update Now" button is not a child of 'element', as it is in the validation message area
     // But it is still inside this xblock's wrapper element, which we can easily find:
     var $wrapper = $element.parents('*[data-locator="' + usage_id + '"]');
+    var { is_root: isRoot = false } = initArgs;
+
+    function postMessageToParent(body, callbackFn = null) {
+        try {
+            window.parent.postMessage(body, document.referrer);
+            if (callbackFn) {
+              callbackFn();
+            }
+        } catch (e) {
+            console.error('Failed to post message:', e);
+        }
+    };
+
+    function reloadPreviewPage() {
+        if (window.self !== window.top) {
+            // We are inside iframe
+            // Normal location.reload() reloads the iframe but subsequent calls to
+            // postMessage fails. So we are using postMessage to tell the parent page
+            // to reload the iframe.
+            postMessageToParent({
+                type: 'refreshIframe',
+                message: 'Refresh Iframe',
+                payload: {},
+            })
+        } else {
+            location.reload();
+        }
+    }
 
     $wrapper.on('click', '.library-update-btn', function(e) {
         e.preventDefault();
@@ -20,17 +48,33 @@ window.LibraryContentAuthorView = function(runtime, element) {
                 state: 'end',
                 element: element
             });
-            if ($element.closest('.wrapper-xblock').is(':not(.level-page)')) {
-                // We are on a course unit page. The notify('save') should refresh this block,
-                // but that is only working on the container page view of this block.
-                // Why? On the unit page, this XBlock's runtime has no reference to the
-                // XBlockContainerPage - only the top-level XBlock (a vertical) runtime does.
-                // But unfortunately there is no way to get a reference to our parent block's
-                // JS 'runtime' object. So instead we must refresh the whole page:
-                location.reload();
+            if (isRoot) {
+                // We are inside preview page where all children blocks are listed.
+                reloadPreviewPage();
             }
         });
     });
+
+    $wrapper.on('click', '.library-block-migrate-btn', function(e) {
+        e.preventDefault();
+        // migrate library content block to item bank block
+        runtime.notify('save', {
+            state: 'start',
+            element: element,
+            message: gettext('Migrating to Problem Bank')
+        });
+        $.post(runtime.handlerUrl(element, 'upgrade_to_v2_library')).done(function() {
+            runtime.notify('save', {
+                state: 'end',
+                element: element
+            });
+            if (isRoot) {
+                // We are inside preview page where all children blocks are listed.
+                reloadPreviewPage();
+            }
+        });
+    });
+
     // Hide loader and show element when update task finished.
     var $loader = $wrapper.find('.ui-loading');
     var $xblockHeader = $wrapper.find('.xblock-header');