feat: adds python and REST APIs to delete a container

Author: pomegranited

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

@@ -16,6 +16,7 @@
 from openedx_events.content_authoring.data import LibraryContainerData
 from openedx_events.content_authoring.signals import (
     LIBRARY_CONTAINER_CREATED,
+    LIBRARY_CONTAINER_DELETED,
     LIBRARY_CONTAINER_UPDATED,
 )
 from openedx_learning.api import authoring as authoring_api
@@ -35,6 +36,7 @@
     "get_container_children",
     "library_container_locator",
     "update_container",
+    "delete_container",
 ]
 
 
@@ -218,6 +220,31 @@ def update_container(
     return ContainerMetadata.from_container(library_key, unit_version.container)
 
 
+def delete_container(
+    container_key: LibraryContainerLocator,
+) -> None:
+    """
+    Delete a container (e.g. a Unit) (soft delete).
+
+    No-op if container doesn't exist or has already been soft-deleted.
+    """
+    try:
+        container = _get_container(container_key)
+    except ContentLibraryContainerNotFound:
+        return
+
+    authoring_api.soft_delete_draft(container.pk)
+
+    LIBRARY_CONTAINER_DELETED.send_event(
+        library_container=LibraryContainerData(
+            library_key=container_key.library_key,
+            container_key=str(container_key),
+        )
+    )
+
+    # TODO: trigger a LIBRARY_COLLECTION_UPDATED for each collection the container was in
+
+
 def get_container_children(
     container_key: LibraryContainerLocator,
     published=False,

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

@@ -106,3 +106,20 @@ def patch(self, request, container_key: LibraryContainerLocator):
         )
 
         return Response(serializers.LibraryContainerMetadataSerializer(container).data)
+
+    @convert_exceptions
+    def delete(self, request, container_key: LibraryContainerLocator):
+        """
+        Delete a Container (soft delete).
+        """
+        api.require_permission_for_library_key(
+            container_key.library_key,
+            request.user,
+            permissions.CAN_EDIT_THIS_CONTENT_LIBRARY,
+        )
+
+        api.delete_container(
+            container_key,
+        )
+
+        return Response({})

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

@@ -34,6 +34,9 @@ def wrapped_fn(*args, **kwargs):
         except api.ContentLibraryCollectionNotFound:
             log.exception("Collection not found in content library")
             raise NotFound  # lint-amnesty, pylint: disable=raise-missing-from
+        except api.ContentLibraryContainerNotFound:
+            log.exception("Container not found in content library")
+            raise NotFound  # lint-amnesty, pylint: disable=raise-missing-from
         except api.LibraryCollectionAlreadyExists as exc:
             log.exception(str(exc))
             raise ValidationError(str(exc))  # lint-amnesty, pylint: disable=raise-missing-from

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

@@ -368,3 +368,7 @@ def _update_container(self, container_key: str, display_name: str, expect_respon
         """ 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)
+
+    def _delete_container(self, container_key: str, expect_response=200):
+        """ Delete a container (unit etc.) """
+        return self._api('delete', URL_LIB_CONTAINER.format(container_key=container_key), None, expect_response)

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

@@ -9,7 +9,11 @@
 
 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, LIBRARY_CONTAINER_UPDATED
+from openedx_events.content_authoring.signals import (
+    LIBRARY_CONTAINER_CREATED,
+    LIBRARY_CONTAINER_DELETED,
+    LIBRARY_CONTAINER_UPDATED,
+)
 from openedx_events.tests.utils import OpenEdxEventsTestMixin
 
 from openedx.core.djangoapps.content_libraries.tests.base import ContentLibrariesRestApiTest
@@ -38,6 +42,7 @@ class ContainersTestCase(OpenEdxEventsTestMixin, ContentLibrariesRestApiTest):
     """
     ENABLED_OPENEDX_EVENTS = [
         LIBRARY_CONTAINER_CREATED.event_type,
+        LIBRARY_CONTAINER_DELETED.event_type,
         LIBRARY_CONTAINER_UPDATED.event_type,
     ]
 
@@ -54,6 +59,9 @@ def test_unit_crud(self):
         update_receiver = mock.Mock()
         LIBRARY_CONTAINER_UPDATED.connect(update_receiver)
 
+        delete_receiver = mock.Mock()
+        LIBRARY_CONTAINER_DELETED.connect(delete_receiver)
+
         # Create a unit:
         create_date = datetime(2024, 9, 8, 7, 6, 5, tzinfo=timezone.utc)
         with freeze_time(create_date):
@@ -117,6 +125,25 @@ def test_unit_crud(self):
         # make sure it contains the same data when we read it back:
         self.assertDictContainsEntries(unit_as_re_read, expected_data)
 
+        # Delete the unit
+        self._delete_container(container_data["container_key"])
+        assert delete_receiver.call_count == 1
+        self.assertDictContainsSubset(
+            {
+                "signal": LIBRARY_CONTAINER_DELETED,
+                "sender": None,
+                "library_container": LibraryContainerData(
+                    lib_key,
+                    container_key="lct:CL-TEST:containers:unit:u1",
+                ),
+            },
+            delete_receiver.call_args_list[0].kwargs,
+        )
+
+        # Make sure it's gone
+        deleted = self._get_container(container_data["container_key"], expect_response=404)
+        assert deleted is None
+
     # TODO: test that a regular user with read-only permissions on the library cannot create units
 
     def test_unit_gets_auto_slugs(self):