refactor: Rename Component.local_key to component_code for openedx-core 0.43.0

Updates callers of get_component_by_key/component_exists_by_key (now
_by_code) and switches the local_key kwarg on create_component,
create_component_and_version, and related queries to component_code.
Also renames component.local_key reads to component.component_code and
adjusts a modulestore_migrator container query that filtered on
publishable_entity__key (now entity_ref).

Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>

Author: kdmccormick

cms/djangoapps/modulestore_migrator/tasks.py

@@ -346,13 +346,13 @@ def _import_structure(
             LibraryUsageLocatorV2(target_library.key, block_type, block_id)  # type: ignore[abstract]
             for block_type, block_id
             in content_api.get_components(migration.target.id).values_list(
-                "component_type__name", "local_key"
+                "component_type__name", "component_code"
             )
         ),
         used_container_slugs=set(
             content_api.get_containers(
                 migration.target.id
-            ).values_list("publishable_entity__key", flat=True)
+            ).values_list("publishable_entity__entity_ref", flat=True)
         ),
         previous_block_migrations=(
             get_migration_blocks(source_data.previous_migration.pk)
@@ -932,7 +932,7 @@ def _migrate_component(
     try:
         component = content_api.get_components(context.target_package_id).get(
             component_type=component_type,
-            local_key=target_key.block_id,
+            component_code=target_key.block_id,
         )
         component_existed = True
         # Do we have a specific method for this?
@@ -953,7 +953,7 @@ def _migrate_component(
         component = content_api.create_component(
             context.target_package_id,
             component_type=component_type,
-            local_key=target_key.block_id,
+            component_code=target_key.block_id,
             created=context.created_at,
             created_by=context.created_by,
         )

cms/djangoapps/modulestore_migrator/tests/test_tasks.py

@@ -718,7 +718,7 @@ def test_migrate_container_creates_new_container(self):
             component_type=content_api.get_or_create_component_type(
                 "xblock.v1", "problem"
             ),
-            local_key="child_problem_1",
+            component_code="child_problem_1",
             created=timezone.now(),
             created_by=self.user.id,
         )
@@ -734,7 +734,7 @@ def test_migrate_container_creates_new_container(self):
             component_type=content_api.get_or_create_component_type(
                 "xblock.v1", "html"
             ),
-            local_key="child_html_1",
+            component_code="child_html_1",
             created=timezone.now(),
             created_by=self.user.id,
         )
@@ -906,7 +906,7 @@ def test_migrate_container_preserves_child_order(self):
                 component_type=content_api.get_or_create_component_type(
                     "xblock.v1", "problem"
                 ),
-                local_key=f"child_problem_{i}",
+                component_code=f"child_problem_{i}",
                 created=timezone.now(),
                 created_by=self.user.id,
             )
@@ -946,7 +946,7 @@ def test_migrate_container_with_mixed_child_types(self):
             component_type=content_api.get_or_create_component_type(
                 "xblock.v1", "problem"
             ),
-            local_key="mixed_problem",
+            component_code="mixed_problem",
             created=timezone.now(),
             created_by=self.user.id,
         )
@@ -962,7 +962,7 @@ def test_migrate_container_with_mixed_child_types(self):
             component_type=content_api.get_or_create_component_type(
                 "xblock.v1", "html"
             ),
-            local_key="mixed_html",
+            component_code="mixed_html",
             created=timezone.now(),
             created_by=self.user.id,
         )
@@ -978,7 +978,7 @@ def test_migrate_container_with_mixed_child_types(self):
             component_type=content_api.get_or_create_component_type(
                 "xblock.v1", "video"
             ),
-            local_key="mixed_video",
+            component_code="mixed_video",
             created=timezone.now(),
             created_by=self.user.id,
         )

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

@@ -425,7 +425,7 @@ def _import_staged_block(
         component = content_api.create_component(  # noqa: F841
             learning_package.id,
             component_type=component_type,
-            local_key=usage_key.block_id,
+            component_code=usage_key.block_id,
             created=now,
             created_by=user.id,
         )
@@ -1046,7 +1046,7 @@ def _create_component_for_block(
         component, component_version = content_api.create_component_and_version(
             learning_package.id,
             component_type=component_type,
-            local_key=usage_key.block_id,
+            component_code=usage_key.block_id,
             title=display_name,
             created=now,
             created_by=user_id,

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

@@ -144,11 +144,11 @@ def update_library_collection_items(
             # Parse the block_family from the key to use as namespace.
             block_type = BlockTypeKey.from_string(str(opaque_key))
             try:
-                component = content_api.get_component_by_key(
+                component = content_api.get_component_by_code(
                     content_library.learning_package_id,
                     namespace=block_type.block_family,
                     type_name=opaque_key.block_type,
-                    local_key=opaque_key.block_id,
+                    component_code=opaque_key.block_id,
                 )
             except Component.DoesNotExist as exc:
                 raise ContentLibraryBlockNotFound(opaque_key) from exc

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

@@ -718,7 +718,7 @@ def library_component_usage_key(
     return LibraryUsageLocatorV2(  # type: ignore[abstract]
         library_key,
         block_type=component.component_type.name,
-        usage_id=component.local_key,
+        usage_id=component.component_code,
     )
 
 

openedx/core/djangoapps/content_libraries/library_context.py

@@ -95,11 +95,11 @@ def block_exists(self, usage_key: LibraryUsageLocatorV2):
         if learning_package is None:
             return False
 
-        return content_api.component_exists_by_key(
+        return content_api.component_exists_by_code(
             learning_package.id,
             namespace='xblock.v1',
             type_name=usage_key.block_type,
-            local_key=usage_key.block_id,
+            component_code=usage_key.block_id,
         )
 
     def send_block_updated_event(self, usage_key: UsageKeyV2):

openedx/core/djangoapps/xblock/api.py

@@ -202,11 +202,11 @@ def get_component_from_usage_key(usage_key: UsageKeyV2) -> Component:
     learning_package = content_api.get_learning_package_by_ref(
         str(usage_key.context_key)
     )
-    return content_api.get_component_by_key(
+    return content_api.get_component_by_code(
         learning_package.id,
         namespace='xblock.v1',
         type_name=usage_key.block_type,
-        local_key=usage_key.block_id,
+        component_code=usage_key.block_id,
     )
 
 

openedx/core/djangoapps/xblock/runtime/openedx_content_runtime.py

@@ -328,11 +328,11 @@ def _get_component_from_usage_key(self, usage_key):
         """
         learning_package = content_api.get_learning_package_by_ref(str(usage_key.lib_key))
         try:
-            component = content_api.get_component_by_key(
+            component = content_api.get_component_by_code(
                 learning_package.id,
                 namespace='xblock.v1',
                 type_name=usage_key.block_type,
-                local_key=usage_key.block_id,
+                component_code=usage_key.block_id,
             )
         except ObjectDoesNotExist as exc:
             raise NoSuchUsage(usage_key) from exc