feat: container collections support

Author: rpenido

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

@@ -4,34 +4,21 @@
 """
 from django.db import IntegrityError
 from opaque_keys.edx.keys import BlockTypeKey, UsageKeyV2
-from opaque_keys.edx.locator import (
-    LibraryLocatorV2,
-    LibraryCollectionLocator,
-)
-
+from opaque_keys.edx.locator import LibraryCollectionLocator, LibraryLocatorV2
 from openedx_events.content_authoring.data import LibraryCollectionData
 from openedx_events.content_authoring.signals import LIBRARY_COLLECTION_UPDATED
-
 from openedx_learning.api import authoring as authoring_api
-from openedx_learning.api.authoring_models import (
-    Collection,
-    Component,
-    PublishableEntity,
-)
-
-from .exceptions import (
-    ContentLibraryBlockNotFound,
-    ContentLibraryCollectionNotFound,
-    LibraryCollectionAlreadyExists,
-)
+from openedx_learning.api.authoring_models import Collection, Component, PublishableEntity
+
 from ..models import ContentLibrary
+from .exceptions import ContentLibraryBlockNotFound, ContentLibraryCollectionNotFound, LibraryCollectionAlreadyExists
 
 # The public API is only the following symbols:
 __all__ = [
     "create_library_collection",
     "update_library_collection",
     "update_library_collection_components",
-    "set_library_component_collections",
+    "set_library_item_collections",
     "get_library_collection_usage_key",
     "get_library_collection_from_usage_key",
 ]
@@ -173,27 +160,27 @@ def update_library_collection_components(
     return collection
 
 
-def set_library_component_collections(
+def set_library_item_collections(
     library_key: LibraryLocatorV2,
-    component: Component,
+    publishable_entity: PublishableEntity,
     *,
     collection_keys: list[str],
     created_by: int | None = None,
     # As an optimization, callers may pass in a pre-fetched ContentLibrary instance
     content_library: ContentLibrary | None = None,
-) -> Component:
+) -> PublishableEntity:
     """
-    It Associates the component with collections for the given collection keys.
+    It Associates the publishable_entity with collections for the given collection keys.
 
-    Only collections in queryset are associated with component, all previous component-collections
+    Only collections in queryset are associated with publishable_entity, all previous publishable_entity-collections
     associations are removed.
 
     If you've already fetched the ContentLibrary, pass it in to avoid refetching.
 
     Raises:
     * ContentLibraryCollectionNotFound if any of the given collection_keys don't match Collections in the given library.
 
-    Returns the updated Component.
+    Returns the updated PublishableEntity.
     """
     if not content_library:
         content_library = ContentLibrary.objects.get_by_key(library_key)  # type: ignore[attr-defined]
@@ -208,7 +195,7 @@ def set_library_component_collections(
 
     affected_collections = authoring_api.set_collections(
         content_library.learning_package_id,
-        component,
+        publishable_entity,
         collection_qs,
         created_by=created_by,
     )
@@ -224,7 +211,7 @@ def set_library_component_collections(
             )
         )
 
-    return component
+    return publishable_entity
 
 
 def get_library_collection_usage_key(

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

@@ -37,6 +37,7 @@
     "ContainerMetadata",
     "ContainerType",
     # API methods
+    "get_container_from_key",
     "get_container",
     "create_container",
     "get_container_children",
@@ -121,7 +122,7 @@ def library_container_locator(
     )
 
 
-def _get_container(container_key: LibraryContainerLocator) -> Container:
+def get_container_from_key(container_key: LibraryContainerLocator) -> Container:
     """
     Internal method to fetch the Container object from its LibraryContainerLocator
 
@@ -144,7 +145,7 @@ def get_container(container_key: LibraryContainerLocator) -> ContainerMetadata:
     """
     Get a container (a Section, Subsection, or Unit).
     """
-    container = _get_container(container_key)
+    container = get_container_from_key(container_key)
     container_meta = ContainerMetadata.from_container(container_key.library_key, container)
     assert container_meta.container_type.value == container_key.container_type
     return container_meta
@@ -205,7 +206,7 @@ def update_container(
     """
     Update a container (e.g. a Unit) title.
     """
-    container = _get_container(container_key)
+    container = get_container_from_key(container_key)
     library_key = container_key.library_key
 
     assert container.unit
@@ -235,7 +236,7 @@ def delete_container(
     No-op if container doesn't exist or has already been soft-deleted.
     """
     try:
-        container = _get_container(container_key)
+        container = get_container_from_key(container_key)
     except ContentLibraryContainerNotFound:
         return
 
@@ -258,7 +259,7 @@ def get_container_children(
     """
     Get the entities contained in the given container (e.g. the components/xblocks in a unit)
     """
-    container = _get_container(container_key)
+    container = get_container_from_key(container_key)
     if container_key.container_type == ContainerType.Unit.value:
         child_components = authoring_api.get_components_in_unit(container.unit, published=published)
         return [LibraryXBlockMetadata.from_component(
@@ -280,7 +281,7 @@ def get_container_children_count(
     """
     Get the count of entities contained in the given container (e.g. the components/xblocks in a unit)
     """
-    container = _get_container(container_key)
+    container = get_container_from_key(container_key)
     return authoring_api.get_container_children_count(container, published=published)
 
 
@@ -295,7 +296,7 @@ def update_container_children(
     """
     library_key = container_key.library_key
     container_type = container_key.container_type
-    container = _get_container(container_key)
+    container = get_container_from_key(container_key)
     match container_type:
         case ContainerType.Unit.value:
             components = [get_component_from_usage_key(key) for key in children_ids]  # type: ignore[arg-type]

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

@@ -1,35 +1,34 @@
 """
 Content Library REST APIs related to XBlocks/Components and their static assets
 """
+import edx_api_doc_tools as apidocs
 from django.core.exceptions import ObjectDoesNotExist
 from django.db.transaction import non_atomic_requests
 from django.http import Http404, HttpResponse, StreamingHttpResponse
 from django.urls import reverse
 from django.utils.decorators import method_decorator
 from drf_yasg.utils import swagger_auto_schema
+from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2
+from openedx_learning.api import authoring as authoring_api
 from rest_framework import status
 from rest_framework.exceptions import NotFound, ValidationError
 from rest_framework.generics import GenericAPIView
 from rest_framework.parsers import MultiPartParser
 from rest_framework.response import Response
 from rest_framework.views import APIView
 
-import edx_api_doc_tools as apidocs
-from opaque_keys.edx.locator import LibraryLocatorV2, LibraryUsageLocatorV2
-from openedx_learning.api import authoring as authoring_api
-
 from openedx.core.djangoapps.content_libraries import api, permissions
 from openedx.core.djangoapps.content_libraries.rest_api.serializers import (
-    ContentLibraryComponentCollectionsUpdateSerializer,
+    ContentLibraryItemCollectionsUpdateSerializer,
     LibraryXBlockCreationSerializer,
     LibraryXBlockMetadataSerializer,
     LibraryXBlockOlxSerializer,
     LibraryXBlockStaticFileSerializer,
-    LibraryXBlockStaticFilesSerializer,
+    LibraryXBlockStaticFilesSerializer
 )
+from openedx.core.djangoapps.xblock import api as xblock_api
 from openedx.core.lib.api.view_utils import view_auth_classes
 from openedx.core.types.http import RestRequest
-from openedx.core.djangoapps.xblock import api as xblock_api
 
 from .libraries import LibraryApiPaginationDocs
 from .utils import convert_exceptions
@@ -259,13 +258,13 @@ def patch(self, request: RestRequest, usage_key_str) -> Response:
             permissions.CAN_EDIT_THIS_CONTENT_LIBRARY
         )
         component = api.get_component_from_usage_key(key)
-        serializer = ContentLibraryComponentCollectionsUpdateSerializer(data=request.data)
+        serializer = ContentLibraryItemCollectionsUpdateSerializer(data=request.data)
         serializer.is_valid(raise_exception=True)
 
         collection_keys = serializer.validated_data['collection_keys']
-        api.set_library_component_collections(
+        api.set_library_item_collections(
             library_key=key.lib_key,
-            component=component,
+            publishable_entity=component.publishable_entity,
             collection_keys=collection_keys,
             created_by=request.user.id,
             content_library=content_library,

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

@@ -18,6 +18,7 @@
 
 from openedx.core.djangoapps.content_libraries import api, permissions
 from openedx.core.lib.api.view_utils import view_auth_classes
+from openedx.core.types.http import RestRequest
 from . import serializers
 from .utils import convert_exceptions
 
@@ -273,3 +274,38 @@ def patch(self, request, container_key: LibraryContainerLocator):
             container_key,
             action=authoring_api.ChildrenEntitiesAction.REPLACE,
         )
+
+
+@method_decorator(non_atomic_requests, name="dispatch")
+@view_auth_classes()
+class LibraryContainerCollectionsView(GenericAPIView):
+    """
+    View to set collections for a container.
+    """
+    @convert_exceptions
+    def patch(self, request: RestRequest, container_key_str: str) -> Response:
+        """
+        Sets Collections for a Component.
+
+        Collection and Components must all be part of the given library/learning package.
+        """
+        key = LibraryContainerLocator.from_string(container_key_str)
+        content_library = api.require_permission_for_library_key(
+            key.library_key,
+            request.user,
+            permissions.CAN_EDIT_THIS_CONTENT_LIBRARY
+        )
+        container = api.get_container_from_key(key)
+        serializer = serializers.ContentLibraryItemCollectionsUpdateSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        collection_keys = serializer.validated_data['collection_keys']
+        api.set_library_item_collections(
+            library_key=key.library_key,
+            publishable_entity=container.publishable_entity,
+            collection_keys=collection_keys,
+            created_by=request.user.id,
+            content_library=content_library,
+        )
+
+        return Response({'count': len(collection_keys)})

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

@@ -357,9 +357,9 @@ class ContentLibraryComponentKeysSerializer(serializers.Serializer):
     usage_keys = serializers.ListField(child=UsageKeyV2Serializer(), allow_empty=False)
 
 
-class ContentLibraryComponentCollectionsUpdateSerializer(serializers.Serializer):
+class ContentLibraryItemCollectionsUpdateSerializer(serializers.Serializer):
     """
-    Serializer for adding/removing Collections to/from a Component.
+    Serializer for adding/removing Collections to/from a Library Item (component, unit, etc..).
     """
 
     collection_keys = serializers.ListField(child=serializers.CharField(), allow_empty=True)

openedx/core/djangoapps/content_libraries/signal_handlers.py

@@ -20,12 +20,11 @@
     LIBRARY_COLLECTION_DELETED,
     LIBRARY_COLLECTION_UPDATED,
 )
-from openedx_learning.api.authoring import get_component, get_components
-from openedx_learning.api.authoring_models import Collection, CollectionPublishableEntity, Component, PublishableEntity
+from openedx_learning.api.authoring import get_components, get_containers
+from openedx_learning.api.authoring_models import Collection, CollectionPublishableEntity, PublishableEntity
 
 from lms.djangoapps.grades.api import signals as grades_signals
 
-from .api import library_component_usage_key
 from .models import ContentLibrary, LtiGradedResource
 
 log = logging.getLogger(__name__)
@@ -118,8 +117,8 @@ def library_collection_deleted(sender, instance, **kwargs):
     )
 
 
-def _library_collection_component_changed(
-    component: Component,
+def _library_collection_entity_changed(
+    publishable_entity: PublishableEntity,
     library_key: LibraryLocatorV2 | None = None,
 ) -> None:
     """
@@ -128,23 +127,19 @@ def _library_collection_component_changed(
     if not library_key:
         try:
             library = ContentLibrary.objects.get(
-                learning_package_id=component.learning_package_id,
+                learning_package_id=publishable_entity.learning_package_id,
             )
         except ContentLibrary.DoesNotExist:
-            log.error("{component} is not associated with a content library.")
+            log.error("{publishable_entity} is not associated with a content library.")
             return
 
         library_key = library.library_key
 
     assert library_key
 
-    usage_key = library_component_usage_key(
-        library_key,
-        component,
-    )
     CONTENT_OBJECT_ASSOCIATIONS_CHANGED.send_event(
         content_object=ContentObjectChangedData(
-            object_id=str(usage_key),
+            object_id=str(publishable_entity.key),
             changes=["collections"],
         ),
     )
@@ -156,9 +151,7 @@ def library_collection_entity_saved(sender, instance, created, **kwargs):
     Sends a CONTENT_OBJECT_ASSOCIATIONS_CHANGED event for components added to a collection.
     """
     if created:
-        # Component.pk matches its entity.pk
-        component = get_component(instance.entity_id)
-        _library_collection_component_changed(component)
+        _library_collection_entity_changed(instance.entity)
 
 
 @receiver(post_delete, sender=CollectionPublishableEntity, dispatch_uid="library_collection_entity_deleted")
@@ -168,9 +161,7 @@ def library_collection_entity_deleted(sender, instance, **kwargs):
     """
     # Only trigger component updates if CollectionPublishableEntity was cascade deleted due to deletion of a collection.
     if isinstance(kwargs.get('origin'), Collection):
-        # Component.pk matches its entity.pk
-        component = get_component(instance.entity_id)
-        _library_collection_component_changed(component)
+        _library_collection_entity_changed(instance.entity)
 
 
 @receiver(m2m_changed, sender=CollectionPublishableEntity, dispatch_uid="library_collection_entities_changed")
@@ -190,15 +181,17 @@ def library_collection_entities_changed(sender, instance, action, pk_set, **kwar
         return
 
     if isinstance(instance, PublishableEntity):
-        _library_collection_component_changed(instance.component, library.library_key)
+        _library_collection_entity_changed(instance, library.library_key)
         return
 
     # When action=="post_clear", pk_set==None
     # Since the collection instance now has an empty entities set,
     # we don't know which ones were removed, so we need to update associations for all library components.
     components = get_components(instance.learning_package_id)
+    containers = get_containers(instance.learning_package_id)
     if pk_set:
         components = components.filter(pk__in=pk_set)
+        containers = containers.filter(pk__in=pk_set)
 
-    for component in components.all():
-        _library_collection_component_changed(component, library.library_key)
+    for entity in [components.all(), containers.all()]:
+        _library_collection_entity_changed(entity.publishable_entity, library.library_key)

openedx/core/djangoapps/content_libraries/tests/test_api.py

@@ -520,9 +520,9 @@ def test_set_library_component_collections(self):
         assert not list(self.col2.entities.all())
         component = api.get_component_from_usage_key(UsageKey.from_string(self.lib2_problem_block["id"]))
 
-        api.set_library_component_collections(
+        api.set_library_item_collections(
             self.lib2.library_key,
-            component,
+            component.publishable_entity,
             collection_keys=[self.col2.key, self.col3.key],
         )