feat: adds python and REST APIs to update a container's display_name

Author: pomegranited

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

@@ -16,13 +16,15 @@
 from openedx_events.content_authoring.data import LibraryContainerData
 from openedx_events.content_authoring.signals import (
     LIBRARY_CONTAINER_CREATED,
+    LIBRARY_CONTAINER_UPDATED,
 )
 from openedx_learning.api import authoring as authoring_api
 from openedx_learning.api import authoring_models
 
 from ..models import ContentLibrary
 from .libraries import PublishableItem
 
+
 # The public API is only the following symbols:
 __all__ = [
     "ContainerMetadata",
@@ -31,6 +33,7 @@
     "create_container",
     "get_container_children",
     "library_container_locator",
+    "update_container",
 ]
 
 
@@ -170,6 +173,42 @@ def create_container(
     return ContainerMetadata.from_container(library_key, container)
 
 
+def update_container(
+    container_key: LibraryContainerLocator,
+    display_name: str,
+    user_id: int | None,
+) -> ContainerMetadata:
+    """
+    Update a container (e.g. a Unit) title.
+    """
+    assert isinstance(container_key, LibraryContainerLocator)
+    library_key = container_key.library_key
+    content_library = ContentLibrary.objects.get_by_key(library_key)
+    learning_package = content_library.learning_package
+    assert learning_package is not None
+    container = authoring_api.get_container_by_key(
+        learning_package.id,
+        key=container_key.container_id,
+    )
+
+    assert container.unit
+    unit_version = authoring_api.create_next_unit_version(
+        container.unit,
+        title=display_name,
+        created=datetime.now(),
+        created_by=user_id,
+    )
+
+    LIBRARY_CONTAINER_UPDATED.send_event(
+        library_container=LibraryContainerData(
+            library_key=library_key,
+            container_key=str(container_key),
+        )
+    )
+
+    return ContainerMetadata.from_container(library_key, unit_version.container)
+
+
 def get_container_children(
     container_key: LibraryContainerLocator,
     published=False,

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

@@ -62,7 +62,7 @@ def post(self, request, lib_key_str):
 @view_auth_classes()
 class LibraryContainerView(GenericAPIView):
     """
-    View to get data about a specific container (a section, subsection, or unit)
+    View to retrieve or update data about a specific container (a section, subsection, or unit)
     """
     serializer_class = serializers.LibraryContainerMetadataSerializer
 
@@ -81,3 +81,28 @@ def get(self, request, container_key: LibraryContainerLocator):
         )
         container = api.get_container(container_key)
         return Response(serializers.LibraryContainerMetadataSerializer(container).data)
+
+    @convert_exceptions
+    @swagger_auto_schema(
+        request_body=serializers.LibraryContainerUpdateSerializer,
+        responses={200: serializers.LibraryContainerMetadataSerializer}
+    )
+    def patch(self, request, container_key: LibraryContainerLocator):
+        """
+        Update a Container.
+        """
+        api.require_permission_for_library_key(
+            container_key.library_key,
+            request.user,
+            permissions.CAN_EDIT_THIS_CONTENT_LIBRARY,
+        )
+        serializer = serializers.LibraryContainerUpdateSerializer(data=request.data)
+        serializer.is_valid(raise_exception=True)
+
+        container = api.update_container(
+            container_key,
+            display_name=serializer.validated_data['display_name'],
+            user_id=request.user.id,
+        )
+
+        return Response(serializers.LibraryContainerMetadataSerializer(container).data)

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

@@ -270,6 +270,13 @@ def to_internal_value(self, data):
         return result
 
 
+class LibraryContainerUpdateSerializer(serializers.Serializer):
+    """
+    Serializer for updating metadata for Containers like Sections, Subsections, Units
+    """
+    display_name = serializers.CharField()
+
+
 class ContentLibraryBlockImportTaskSerializer(serializers.ModelSerializer):
     """
     Serializer for a Content Library block import task.

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

@@ -363,3 +363,8 @@ def _create_container(self, lib_key, container_type, slug: str | None, display_n
     def _get_container(self, container_key: str, expect_response=200):
         """ Get a container (unit etc.) """
         return self._api('get', URL_LIB_CONTAINER.format(container_key=container_key), None, expect_response)
+
+    def _update_container(self, container_key: str, display_name: str, expect_response=200):
+        """ Update a container (unit etc.) """
+        data = {"display_name": display_name}
+        return self._api('patch', URL_LIB_CONTAINER.format(container_key=container_key), data, expect_response)

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

@@ -9,7 +9,7 @@
 
 from opaque_keys.edx.locator import LibraryLocatorV2
 from openedx_events.content_authoring.data import LibraryContainerData
-from openedx_events.content_authoring.signals import LIBRARY_CONTAINER_CREATED
+from openedx_events.content_authoring.signals import LIBRARY_CONTAINER_CREATED, LIBRARY_CONTAINER_UPDATED
 from openedx_events.tests.utils import OpenEdxEventsTestMixin
 
 from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest
@@ -38,6 +38,7 @@ class ContainersTestCase(OpenEdxEventsTestMixin, ContentLibrariesRestApiTest):
     """
     ENABLED_OPENEDX_EVENTS = [
         LIBRARY_CONTAINER_CREATED.event_type,
+        LIBRARY_CONTAINER_UPDATED.event_type,
     ]
 
     def test_unit_crud(self):
@@ -50,6 +51,9 @@ def test_unit_crud(self):
         create_receiver = mock.Mock()
         LIBRARY_CONTAINER_CREATED.connect(create_receiver)
 
+        update_receiver = mock.Mock()
+        LIBRARY_CONTAINER_UPDATED.connect(update_receiver)
+
         # Create a unit:
         create_date = datetime(2024, 9, 8, 7, 6, 5, tzinfo=timezone.utc)
         with freeze_time(create_date):
@@ -87,6 +91,32 @@ def test_unit_crud(self):
         # make sure it contains the same data when we read it back:
         self.assertDictContainsEntries(unit_as_read, expected_data)
 
+        # Update the unit:
+        modified_date = datetime(2024, 10, 9, 8, 7, 6, tzinfo=timezone.utc)
+        with freeze_time(modified_date):
+            container_data = self._update_container("lct:CL-TEST:containers:unit:u1", display_name="Unit ABC")
+        expected_data['last_draft_created'] = expected_data['modified'] = '2024-10-09T08:07:06Z'
+        expected_data['display_name'] = 'Unit ABC'
+        self.assertDictContainsEntries(container_data, expected_data)
+
+        assert update_receiver.call_count == 1
+        self.assertDictContainsSubset(
+            {
+                "signal": LIBRARY_CONTAINER_UPDATED,
+                "sender": None,
+                "library_container": LibraryContainerData(
+                    lib_key,
+                    container_key="lct:CL-TEST:containers:unit:u1",
+                ),
+            },
+            update_receiver.call_args_list[0].kwargs,
+        )
+
+        # Re-fetch the unit
+        unit_as_re_read = self._get_container(container_data["container_key"])
+        # make sure it contains the same data when we read it back:
+        self.assertDictContainsEntries(unit_as_re_read, expected_data)
+
     # TODO: test that a regular user with read-only permissions on the library cannot create units
 
     def test_unit_gets_auto_slugs(self):

openedx/core/djangoapps/content_libraries/urls.py

@@ -78,7 +78,7 @@
         ])),
         # Containers are Sections, Subsections, and Units
         path('containers/<lib_container_key:container_key>/', include([
-            # Get metadata about a specific container in this library, or delete the container:
+            # Get metadata about a specific container in this library, update or delete the container:
             path('', containers.LibraryContainerView.as_view()),
             # Update collections for a given container
             # path('collections/', views.LibraryContainerCollectionsView.as_view(), name='update-collections-ct'),