feat: move containers into a new applet

Author: bradenmacdonald

.importlinter

@@ -48,7 +48,9 @@ layers=
     # Problems, Videos, and blocks of HTML text. This is also the type we would
     # associate with a single "leaf" XBlock–one that is not a container type and
     # has no child elements.
-    openedx_content.applets.components
+    # The "containers" app is built on top of publishing, and is a peer to
+    # "components" but they do not depend on each other.
+    openedx_content.applets.components | openedx_content.applets.publishing
 
     # The "media" applet stores the simplest pieces of binary and text data,
     # without versioning information. These belong to a single Learning Package.

src/openedx_content/api.py

@@ -12,6 +12,7 @@
 # pylint: disable=wildcard-import
 from .applets.backup_restore.api import *
 from .applets.collections.api import *
+from .applets.containers.api import *
 from .applets.components.api import *
 from .applets.media.api import *
 from .applets.publishing.api import *

src/openedx_content/applets/backup_restore/zipper.py

@@ -32,6 +32,7 @@
 from ..collections import api as collections_api
 from ..components import api as components_api
 from ..media import api as media_api
+from ..containers import api as containers_api
 from ..publishing import api as publishing_api
 from ..units.models import Unit
 from ..subsections.models import Subsection
@@ -809,15 +810,15 @@ def _save_container(
         learning_package,
         containers,
         *,
-        container_type: publishing_api.ContainerType,
+        container_type: containers_api.ContainerType,
         container_map: dict,
         children_map: dict,
     ):
         """Internal logic for _save_units, _save_subsections, and _save_sections"""
         type_code = container_type.type_code  # e.g. "unit"
         for data in containers.get(type_code, []):
             entity_key = data.get("key")
-            container = publishing_api.create_container(
+            container = containers_api.create_container(
                 learning_package.id,
                 **data,  # should this be allowed to override any of the following fields?
                 created_by=self.user_id,
@@ -831,7 +832,7 @@ def _save_container(
             self.all_published_entities_versions.add(
                 (entity_key, valid_published.get('version_num'))
             )  # Track published version
-            publishing_api.create_next_container_version(
+            containers_api.create_next_container_version(
                 container_map[entity_key],
                 **valid_published,  # should this be allowed to override any of the following fields?
                 force_version_num=valid_published.pop("version_num", None),
@@ -889,7 +890,7 @@ def _save_draft_versions(self, components, containers, component_static_files):
             )
 
         def _process_draft_containers(
-            container_type: publishing_api.ContainerType,
+            container_type: containers_api.ContainerType,
             container_map: dict,
             children_map: dict,
         ):
@@ -900,7 +901,7 @@ def _process_draft_containers(
                     continue
                 children = self._resolve_children(valid_draft, children_map)
                 del valid_draft["version_num"]
-                publishing_api.create_next_container_version(
+                containers_api.create_next_container_version(
                     container_map[entity_key],
                     **valid_draft,  # should this be allowed to override any of the following fields?
                     entities=children,

src/openedx_content/applets/collections/api.py

@@ -8,8 +8,9 @@
 from django.core.exceptions import ValidationError
 from django.db.models import QuerySet
 
+from ..containers.models import Container
 from ..publishing import api as publishing_api
-from ..publishing.models import Container, PublishableEntity
+from ..publishing.models import PublishableEntity
 from .models import Collection, CollectionPublishableEntity
 
 # The public API that will be re-exported by openedx_content.api

src/openedx_content/applets/containers/__init__.py

@@ -0,0 +1,294 @@
+"""
+Django admin for containers models
+"""
+
+from __future__ import annotations
+
+import functools
+
+from django.contrib import admin
+from django.utils.html import format_html
+from django.utils.safestring import SafeText
+
+from openedx_django_lib.admin_utils import ReadOnlyModelAdmin, model_detail_link, one_to_one_related_model_html
+
+from .models import (
+    Container,
+    ContainerVersion,
+    EntityList,
+    EntityListRow,
+)
+
+
+def _entity_list_detail_link(el: EntityList) -> SafeText:
+    """
+    A link to the detail page for an EntityList which includes its PK and length.
+    """
+    num_rows = el.entitylistrow_set.count()
+    rows_noun = "row" if num_rows == 1 else "rows"
+    return model_detail_link(el, f"EntityList #{el.pk} with {num_rows} {rows_noun}")
+
+
+class ContainerVersionInlineForContainer(admin.TabularInline):
+    """
+    Inline admin view of ContainerVersions in a given Container
+    """
+
+    model = ContainerVersion
+    ordering = ["-publishable_entity_version__version_num"]
+    fields = [
+        "pk",
+        "version_num",
+        "title",
+        "children",
+        "created",
+        "created_by",
+    ]
+    readonly_fields = fields  # type: ignore[assignment]
+    extra = 0
+
+    def get_queryset(self, request):
+        return super().get_queryset(request).select_related("publishable_entity_version")
+
+    def children(self, obj: ContainerVersion):
+        return _entity_list_detail_link(obj.entity_list)
+
+
+@admin.register(Container)
+class ContainerAdmin(ReadOnlyModelAdmin):
+    """
+    Django admin configuration for Container
+    """
+
+    list_display = ("key", "created", "draft", "published", "see_also")
+    fields = [
+        "pk",
+        "publishable_entity",
+        "learning_package",
+        "draft",
+        "published",
+        "created",
+        "created_by",
+        "see_also",
+        "most_recent_parent_entity_list",
+    ]
+    readonly_fields = fields  # type: ignore[assignment]
+    search_fields = ["publishable_entity__uuid", "publishable_entity__key"]
+    inlines = [ContainerVersionInlineForContainer]
+
+    def learning_package(self, obj: Container) -> SafeText:
+        return model_detail_link(
+            obj.publishable_entity.learning_package,
+            obj.publishable_entity.learning_package.key,
+        )
+
+    def get_queryset(self, request):
+        return (
+            super()
+            .get_queryset(request)
+            .select_related(
+                "publishable_entity",
+                "publishable_entity__learning_package",
+                "publishable_entity__published__version",
+                "publishable_entity__draft__version",
+            )
+        )
+
+    def draft(self, obj: Container) -> str:
+        """
+        Link to this Container's draft ContainerVersion
+        """
+        if draft := obj.versioning.draft:
+            return format_html(
+                'Version {} "{}" ({})', draft.version_num, draft.title, _entity_list_detail_link(draft.entity_list)
+            )
+        return "-"
+
+    def published(self, obj: Container) -> str:
+        """
+        Link to this Container's published ContainerVersion
+        """
+        if published := obj.versioning.published:
+            return format_html(
+                'Version {} "{}" ({})',
+                published.version_num,
+                published.title,
+                _entity_list_detail_link(published.entity_list),
+            )
+        return "-"
+
+    def see_also(self, obj: Container):
+        return one_to_one_related_model_html(obj)
+
+    def most_recent_parent_entity_list(self, obj: Container) -> str:
+        if latest_row := EntityListRow.objects.filter(entity_id=obj.publishable_entity_id).order_by("-pk").first():
+            return _entity_list_detail_link(latest_row.entity_list)
+        return "-"
+
+
+class ContainerVersionInlineForEntityList(admin.TabularInline):
+    """
+    Inline admin view of ContainerVersions which use a given EntityList
+    """
+
+    model = ContainerVersion
+    verbose_name = "Container Version that references this Entity List"
+    verbose_name_plural = "Container Versions that reference this Entity List"
+    ordering = ["-pk"]  # Newest first
+    fields = [
+        "pk",
+        "version_num",
+        "container_key",
+        "title",
+        "created",
+        "created_by",
+    ]
+    readonly_fields = fields  # type: ignore[assignment]
+    extra = 0
+
+    def get_queryset(self, request):
+        return (
+            super()
+            .get_queryset(request)
+            .select_related(
+                "container",
+                "container__publishable_entity",
+                "publishable_entity_version",
+            )
+        )
+
+    def container_key(self, obj: ContainerVersion) -> SafeText:
+        return model_detail_link(obj.container, obj.container.key)
+
+
+class EntityListRowInline(admin.TabularInline):
+    """
+    Table of entity rows in the entitylist admin
+    """
+
+    model = EntityListRow
+    readonly_fields = [
+        "order_num",
+        "pinned_version_num",
+        "entity_models",
+        "container_models",
+        "container_children",
+    ]
+    fields = readonly_fields  # type: ignore[assignment]
+
+    def get_queryset(self, request):
+        return (
+            super()
+            .get_queryset(request)
+            .select_related(
+                "entity",
+                "entity_version",
+            )
+        )
+
+    def pinned_version_num(self, obj: EntityListRow):
+        return str(obj.entity_version.version_num) if obj.entity_version else "(Unpinned)"
+
+    def entity_models(self, obj: EntityListRow):
+        return format_html(
+            "{}<ul>{}</ul>",
+            model_detail_link(obj.entity, obj.entity.key),
+            one_to_one_related_model_html(obj.entity),
+        )
+
+    def container_models(self, obj: EntityListRow) -> SafeText:
+        if not hasattr(obj.entity, "container"):
+            return SafeText("(Not a Container)")
+        return format_html(
+            "{}<ul>{}</ul>",
+            model_detail_link(obj.entity.container, str(obj.entity.container)),
+            one_to_one_related_model_html(obj.entity.container),
+        )
+
+    def container_children(self, obj: EntityListRow) -> SafeText:
+        """
+        If this row holds a Container, then link *its* EntityList, allowing easy hierarchy browsing.
+
+        When determining which ContainerVersion to grab the EntityList from, prefer the pinned
+        version if there is one; otherwise use the Draft version.
+        """
+        if not hasattr(obj.entity, "container"):
+            return SafeText("(Not a Container)")
+        child_container_version: ContainerVersion = (
+            obj.entity_version.containerversion if obj.entity_version else obj.entity.container.versioning.draft
+        )
+        return _entity_list_detail_link(child_container_version.entity_list)
+
+
+@admin.register(EntityList)
+class EntityListAdmin(ReadOnlyModelAdmin):
+    """
+    Django admin configuration for EntityList
+    """
+
+    list_display = [
+        "entity_list",
+        "row_count",
+        "recent_container_version_num",
+        "recent_container",
+        "recent_container_package",
+    ]
+    inlines = [ContainerVersionInlineForEntityList, EntityListRowInline]
+
+    def entity_list(self, obj: EntityList) -> SafeText:
+        return model_detail_link(obj, f"EntityList #{obj.pk}")
+
+    def row_count(self, obj: EntityList) -> int:
+        return obj.entitylistrow_set.count()
+
+    def recent_container_version_num(self, obj: EntityList) -> str:
+        """
+        Number of the newest ContainerVersion that references this EntityList
+        """
+        if latest := _latest_container_version(obj):
+            return f"Version {latest.version_num}"
+        else:
+            return "-"
+
+    def recent_container(self, obj: EntityList) -> SafeText | None:
+        """
+        Link to the Container of the newest ContainerVersion that references this EntityList
+        """
+        if latest := _latest_container_version(obj):
+            return format_html("of: {}", model_detail_link(latest.container, latest.container.key))
+        else:
+            return None
+
+    def recent_container_package(self, obj: EntityList) -> SafeText | None:
+        """
+        Link to the LearningPackage of the newest ContainerVersion that references this EntityList
+        """
+        if latest := _latest_container_version(obj):
+            return format_html(
+                "in: {}",
+                model_detail_link(
+                    latest.container.publishable_entity.learning_package,
+                    latest.container.publishable_entity.learning_package.key,
+                ),
+            )
+        else:
+            return None
+
+    # We'd like it to appear as if these three columns are just a single
+    # nicely-formatted column, so only give the left one a description.
+    recent_container_version_num.short_description = (  # type: ignore[attr-defined]
+        "Most recent container version using this entity list"
+    )
+    recent_container.short_description = ""  # type: ignore[attr-defined]
+    recent_container_package.short_description = ""  # type: ignore[attr-defined]
+
+
+@functools.cache
+def _latest_container_version(obj: EntityList) -> ContainerVersion | None:
+    """
+    Any given EntityList can be used by multiple ContainerVersion (which may even
+    span multiple Containers). We only have space here to show one ContainerVersion
+    easily, so let's show the one that's most likely to be interesting to the Django
+    admin user: the most-recently-created one.
+    """
+    return obj.container_versions.order_by("-pk").first()