refactor: Rename PublishableEntity.key to entity_ref for openedx-core 0.43.0

Switches callers of get_publishable_entity_by_key (now _by_ref) to the
new name, and renames .key attribute reads on PublishableEntity,
Component, and Container (via PublishableEntityMixin) to .entity_ref.
Query filters using key__in/entity__key become entity_ref__in/
entity__entity_ref. The set_library_item_collections param entity_key
is renamed to entity_ref for consistency.

Collection.key reads are intentionally left for the collection_code
rename in a later commit.

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

Author: kdmccormick

openedx/core/djangoapps/content/search/api.py

@@ -535,7 +535,7 @@ def index_container_batch(batch, num_done, library_key) -> int:
                             doc.update(searchable_doc_containers(container_key, "sections"))
                     docs.append(doc)
                 except Exception as err:  # pylint: disable=broad-except
-                    status_cb(f"Error indexing container {container.key}: {err}")
+                    status_cb(f"Error indexing container {container.entity_ref}: {err}")
                 num_done += 1
 
             if docs:

openedx/core/djangoapps/content/search/documents.py

@@ -450,7 +450,7 @@ def searchable_doc_collections(object_id: OpaqueKey) -> dict:
             component = lib_api.get_component_from_usage_key(object_id)
             collections = content_api.get_entity_collections(
                 component.learning_package_id,
-                component.key,
+                component.entity_ref,
             ).values('key', 'title')
         elif isinstance(object_id, LibraryContainerLocator):
             container = lib_api.get_container(object_id, include_collections=True)

openedx/core/djangoapps/content/search/tests/test_api.py

@@ -523,7 +523,7 @@ def test_reindex_meilisearch_library_block_error(self, mock_meilisearch) -> None
 
         def mocked_from_component(lib_key, component):
             # Simulate an error when processing problem 1
-            if component.key == 'xblock.v1:problem:p1':
+            if component.entity_ref == 'xblock.v1:problem:p1':
                 raise Exception('Error')
 
             return orig_from_component(lib_key, component)

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

@@ -178,7 +178,7 @@ def get_library_block(usage_key: LibraryUsageLocatorV2, include_collections=Fals
     if include_collections:
         associated_collections = content_api.get_entity_collections(
             component.learning_package_id,
-            component.key,
+            component.entity_ref,
         ).values('key', 'title')
     else:
         associated_collections = None
@@ -725,7 +725,7 @@ def send_block_deleted_signal():
         send_block_deleted_signal()
         raise
 
-    affected_collections = content_api.get_entity_collections(component.learning_package_id, component.key)
+    affected_collections = content_api.get_entity_collections(component.learning_package_id, component.entity_ref)
     affected_containers = get_containers_contains_item(usage_key)
 
     content_api.soft_delete_draft(component.id, deleted_by=user_id)
@@ -770,7 +770,7 @@ def restore_library_block(usage_key: LibraryUsageLocatorV2, user_id: int | None
     """
     component = get_component_from_usage_key(usage_key)
     library_key = usage_key.context_key
-    affected_collections = content_api.get_entity_collections(component.learning_package_id, component.key)
+    affected_collections = content_api.get_entity_collections(component.learning_package_id, component.entity_ref)
 
     # Set draft version back to the latest available component version id.
     content_api.set_draft_version(
@@ -985,7 +985,7 @@ def publish_component_changes(usage_key: LibraryUsageLocatorV2, user_id: int):
     learning_package = content_library.learning_package
     assert learning_package
     # The core publishing API is based on draft objects, so find the draft that corresponds to this component:
-    drafts_to_publish = content_api.get_all_drafts(learning_package.id).filter(entity__key=component.key)
+    drafts_to_publish = content_api.get_all_drafts(learning_package.id).filter(entity__entity_ref=component.entity_ref)
     # Publish the component and update anything that needs to be updated (e.g. search index):
     publish_log = content_api.publish_from_drafts(
         learning_package.id, draft_qset=drafts_to_publish, published_by=user_id,

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

@@ -127,8 +127,8 @@ def update_library_collection_items(
     assert content_library.learning_package_id
     assert content_library.library_key == library_key
 
-    # Fetch the Component.key values for the provided UsageKeys.
-    item_keys = []
+    # Fetch the Component.entity_ref values for the provided UsageKeys.
+    item_refs = []
     for opaque_key in opaque_keys:
         if isinstance(opaque_key, LibraryContainerLocator):
             try:
@@ -139,7 +139,7 @@ def update_library_collection_items(
             except Collection.DoesNotExist as exc:
                 raise ContentLibraryContainerNotFound(opaque_key) from exc
 
-            item_keys.append(container.key)
+            item_refs.append(container.entity_ref)
         elif isinstance(opaque_key, UsageKeyV2):
             # Parse the block_family from the key to use as namespace.
             block_type = BlockTypeKey.from_string(str(opaque_key))
@@ -153,13 +153,13 @@ def update_library_collection_items(
             except Component.DoesNotExist as exc:
                 raise ContentLibraryBlockNotFound(opaque_key) from exc
 
-            item_keys.append(component.key)
+            item_refs.append(component.entity_ref)
         else:
             # This should never happen, but just in case.
             raise ValueError(f"Invalid opaque_key: {opaque_key}")
 
     entities_qset = PublishableEntity.objects.filter(
-        key__in=item_keys,
+        entity_ref__in=item_refs,
     )
 
     if remove:
@@ -181,7 +181,7 @@ def update_library_collection_items(
 
 def set_library_item_collections(
     library_key: LibraryLocatorV2,
-    entity_key: str,
+    entity_ref: str,
     *,
     collection_keys: list[str],
     created_by: int | None = None,
@@ -207,12 +207,12 @@ def set_library_item_collections(
     assert content_library.learning_package_id
     assert content_library.library_key == library_key
 
-    publishable_entity = content_api.get_publishable_entity_by_key(
+    publishable_entity = content_api.get_publishable_entity_by_ref(
         content_library.learning_package_id,
-        key=entity_key,
+        entity_ref=entity_ref,
     )
 
-    # Note: Component.key matches its PublishableEntity.key
+    # Note: Component.entity_ref matches its PublishableEntity.entity_ref
     collection_qs = content_api.get_collections(content_library.learning_package_id).filter(
         key__in=collection_keys
     )

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

@@ -366,7 +366,8 @@ def library_container_locator(
     if container_type_code not in LIBRARY_ALLOWED_CONTAINER_TYPES:
         raise ValueError(f"Unsupported container type for content libraries: {container!r}")
 
-    return LibraryContainerLocator(library_key, container_type=container_type_code, container_id=container.key)
+    # TODO: verify whether container_id should use entity_ref (opaque) or container_code (local slug).
+    return LibraryContainerLocator(library_key, container_type=container_type_code, container_id=container.entity_ref)
 
 
 def get_container_from_key(container_key: LibraryContainerLocator, include_deleted=False) -> Container:

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

@@ -226,7 +226,7 @@ def send_container_deleted_signal():
     # Fetch related collections and containers before soft-delete
     affected_collections = content_api.get_entity_collections(
         container.publishable_entity.learning_package_id,
-        container.key,
+        container.entity_ref,
     )
     affected_containers = get_containers_contains_item(container_key)
     # Get children containers or components to update their index data
@@ -291,7 +291,7 @@ def restore_container(container_key: LibraryContainerLocator) -> None:
 
     affected_collections = content_api.get_entity_collections(
         container.publishable_entity.learning_package_id,
-        container.key,
+        container.entity_ref,
     )
 
     content_api.set_draft_version(container.id, container.versioning.latest.pk)

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

@@ -272,7 +272,7 @@ def patch(self, request: RestRequest, usage_key_str) -> Response:
         collection_keys = serializer.validated_data['collection_keys']
         api.set_library_item_collections(
             library_key=key.lib_key,
-            entity_key=component.publishable_entity.key,
+            entity_ref=component.publishable_entity.entity_ref,
             collection_keys=collection_keys,
             created_by=request.user.id,
             content_library=content_library,

openedx/core/djangoapps/content_libraries/rest_api/containers.py

@@ -346,7 +346,7 @@ def patch(self, request: RestRequest, container_key: LibraryContainerLocator) ->
         collection_keys = serializer.validated_data['collection_keys']
         api.set_library_item_collections(
             library_key=container_key.lib_key,
-            entity_key=container_key.container_id,
+            entity_ref=container_key.container_id,
             collection_keys=collection_keys,
             created_by=request.user.id,
             content_library=content_library,

openedx/core/djangoapps/content_libraries/tasks.py

@@ -142,7 +142,7 @@ def send_events_after_publish(publish_log_pk: int, library_key_str: str) -> None
                 pass
         else:
             log.warning(
-                f"PublishableEntity {record.entity.pk} / {record.entity.key} was modified during publish operation "
+                f"PublishableEntity {record.entity.pk} / {record.entity.entity_ref} was modified during publish operation "
                 "but is of unknown type."
             )
 
@@ -246,13 +246,13 @@ def send_events_after_revert(draft_change_log_id: int, library_key_str: str) ->
                 updated_container_keys.add(container_key)
         else:
             log.warning(
-                f"PublishableEntity {record.entity.pk} / {record.entity.key} was modified during publish operation "
+                f"PublishableEntity {record.entity.pk} / {record.entity.entity_ref} was modified during publish operation "
                 "but is of unknown type."
             )
         # If any collections contain this entity, their item count may need to be updated, e.g. if this was a
         # newly created component in the collection and is now deleted, or this was deleted and is now re-added.
         for parent_collection in content_api.get_entity_collections(
-            record.entity.learning_package_id, record.entity.key,
+            record.entity.learning_package_id, record.entity.entity_ref,
         ):
             collection_key = api.library_collection_locator(
                 library_key=library_key,