refactor: assign media at time of component version creation

Author: ormsbee

cms/djangoapps/modulestore_migrator/tasks.py

@@ -959,16 +959,18 @@ def _migrate_component(
         return component.versioning.draft.publishable_entity_version, None
 
     # If component existed and was deleted or we have to replace the current version
-    # Create the new component version for it
-    component_version = libraries_api.set_library_block_olx(target_key, new_olx_str=olx)
+    paths_to_media_ids = {}
     for filename, media_pk in context.content_by_filename.items():
         filename_no_ext, _ = os.path.splitext(filename)
         if filename_no_ext not in olx:
             continue
         new_path = f"static/{filename}"
-        content_api.create_component_version_media(
-            component_version.pk, media_pk, path=new_path
-        )
+        paths_to_media_ids[new_path] = media_pk
+
+    # Create the new component version for it
+    component_version = libraries_api.set_library_block_olx(
+        target_key, new_olx_str=olx, paths_to_media=paths_to_media_ids,
+    )
 
     # Publish the component
     libraries_api.publish_component_changes(target_key, context.created_by)

openedx/core/djangoapps/content_libraries/api/blocks.py

@@ -399,7 +399,11 @@ def get_library_component_creation_entry(
     )
 
 
-def set_library_block_olx(usage_key: LibraryUsageLocatorV2, new_olx_str: str) -> ComponentVersion:
+def set_library_block_olx(
+    usage_key: LibraryUsageLocatorV2,
+    new_olx_str: str,
+    paths_to_media: dict = None,
+) -> ComponentVersion:
     """
     Replace the OLX source of the given XBlock.
 
@@ -410,6 +414,7 @@ def set_library_block_olx(usage_key: LibraryUsageLocatorV2, new_olx_str: str) ->
     Returns the version number of the newly created ComponentVersion.
     """
     assert isinstance(usage_key, LibraryUsageLocatorV2)
+    paths_to_media = paths_to_media or {}
 
     # HTMLBlock uses CDATA to preserve HTML inside the XML, so make sure we
     # don't strip that out.
@@ -446,7 +451,7 @@ def set_library_block_olx(usage_key: LibraryUsageLocatorV2, new_olx_str: str) ->
     now = datetime.now(tz=timezone.utc)  # noqa: UP017
 
     with transaction.atomic():
-        new_content = content_api.get_or_create_text_media(
+        new_olx_media = content_api.get_or_create_text_media(
             component.learning_package_id,
             get_or_create_olx_media_type(usage_key.block_type).id,
             text=new_olx_str,
@@ -456,7 +461,8 @@ def set_library_block_olx(usage_key: LibraryUsageLocatorV2, new_olx_str: str) ->
             component.id,
             title=new_title,
             media_to_replace={
-                'block.xml': new_content.pk,
+                **paths_to_media,
+                'block.xml': new_olx_media.pk,
             },
             created=now,
         )
@@ -606,11 +612,7 @@ def _import_staged_block(
             created_by=user.id,
         )
 
-        # This will create the first component version and set the OLX/title
-        # appropriately. It will not publish. Once we get the newly created
-        # ComponentVersion back from this, we can attach all our files to it.
-        component_version = set_library_block_olx(usage_key, olx_str)
-
+        paths_to_media = {}
         for staged_content_file_data in staged_content_files:
             # The ``data`` attribute is going to be None because the clipboard
             # is optimized to not do redundant file copying when copying/pasting
@@ -657,17 +659,18 @@ def _import_staged_block(
                 media_type_str = "application/octet-stream"
 
             media_type = content_api.get_or_create_media_type(media_type_str)
-            content = content_api.get_or_create_file_media(
+            media = content_api.get_or_create_file_media(
                 learning_package.id,
                 media_type.id,
                 data=file_data,
                 created=now,
             )
-            content_api.create_component_version_media(
-                component_version.pk,
-                content.id,
-                path=filename,
-            )
+            paths_to_media[filename] = media.id
+
+        # This will create the first component version and set the OLX/title
+        # appropriately. It will not publish. Once we get the newly created
+        # ComponentVersion back from this, we can attach all our files to it.
+        set_library_block_olx(usage_key, olx_str, paths_to_media)
 
     # Now return the metadata about the new block
     return get_library_block(usage_key)
@@ -1087,25 +1090,23 @@ def _create_component_for_block(
         component_type = content_api.get_or_create_component_type(
             "xblock.v1", usage_key.block_type
         )
-        component, component_version = content_api.create_component_and_version(
+        block_olx_media = content_api.get_or_create_text_media(
+            learning_package.id,
+            get_or_create_olx_media_type(usage_key.block_type).id,
+            text=xml_text,
+            created=now,
+        )
+        _component, component_version = content_api.create_component_and_version(
             learning_package.id,
             component_type=component_type,
             component_code=usage_key.block_id,
             title=display_name,
             created=now,
             created_by=user_id,
             can_stand_alone=can_stand_alone,
-        )
-        content = content_api.get_or_create_text_media(
-            learning_package.id,
-            get_or_create_olx_media_type(usage_key.block_type).id,
-            text=xml_text,
-            created=now,
-        )
-        content_api.create_component_version_media(
-            component_version.pk,
-            content.id,
-            path="block.xml",
+            media={
+                'block.xml': block_olx_media
+            }
         )
 
         return component_version

requirements/constraints.txt

@@ -65,7 +65,7 @@ numpy<2.0.0
 # breaking changes which openedx-core devs want to roll out manually. New patch versions
 # are OK to accept automatically.
 # Issue for unpinning: https://github.com/openedx/edx-platform/issues/35269
-openedx-core<0.47
+openedx-core<0.48
 
 # Date: 2023-11-29
 # Open AI version 1.0.0 dropped support for openai.ChatCompletion which is currently in use in enterprise.