feat: add new ContainerType model, refactor Containers implementation

Author: bradenmacdonald

src/openedx_content/admin.py

@@ -8,6 +8,3 @@
 from .applets.components.admin import *
 from .applets.media.admin import *
 from .applets.publishing.admin import *
-from .applets.sections.admin import *
-from .applets.subsections.admin import *
-from .applets.units.admin import *

src/openedx_content/applets/backup_restore/zipper.py

@@ -33,9 +33,9 @@
 from ..components import api as components_api
 from ..media import api as media_api
 from ..publishing import api as publishing_api
-from ..sections import api as sections_api
-from ..subsections import api as subsections_api
-from ..units import api as units_api
+from ..units.models import Unit
+from ..subsections.models import Subsection
+from ..sections.models import Section
 from .serializers import (
     CollectionSerializer,
     ComponentSerializer,
@@ -804,70 +804,70 @@ def _save_components(self, learning_package, components, component_static_files)
                 **valid_published
             )
 
-    def _save_units(self, learning_package, containers):
-        """Save units and published unit versions."""
-        for valid_unit in containers.get("unit", []):
-            entity_key = valid_unit.get("key")
-            unit = units_api.create_unit(learning_package.id, created_by=self.user_id, **valid_unit)
-            self.units_map_by_key[entity_key] = unit
+    def _save_container(
+        self,
+        learning_package,
+        containers,
+        *,
+        container_type: publishing_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(
+                learning_package.id,
+                **data,  # should this be allowed to override any of the following fields?
+                created_by=self.user_id,
+                container_type=container_type,
+            )
+            container_map[entity_key] = container  # e.g. `self.units_map_by_key[entity_key] = unit`
 
-        for valid_published in containers.get("unit_published", []):
+        for valid_published in containers.get(f"{type_code}_published", []):
             entity_key = valid_published.pop("entity_key")
-            children = self._resolve_children(valid_published, self.components_map_by_key)
+            children = self._resolve_children(valid_published, children_map)
             self.all_published_entities_versions.add(
                 (entity_key, valid_published.get('version_num'))
             )  # Track published version
-            units_api.create_next_unit_version(
-                self.units_map_by_key[entity_key],
+            publishing_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),
-                components=children,
+                entities=children,
                 created_by=self.user_id,
-                **valid_published
             )
 
+    def _save_units(self, learning_package, containers):
+        """Save units and published unit versions."""
+        self._save_container(
+            learning_package,
+            containers,
+            container_type=Unit,
+            container_map=self.units_map_by_key,
+            children_map=self.components_map_by_key,
+        )
+
     def _save_subsections(self, learning_package, containers):
         """Save subsections and published subsection versions."""
-        for valid_subsection in containers.get("subsection", []):
-            entity_key = valid_subsection.get("key")
-            subsection = subsections_api.create_subsection(
-                learning_package.id, created_by=self.user_id, **valid_subsection
-            )
-            self.subsections_map_by_key[entity_key] = subsection
-
-        for valid_published in containers.get("subsection_published", []):
-            entity_key = valid_published.pop("entity_key")
-            children = self._resolve_children(valid_published, self.units_map_by_key)
-            self.all_published_entities_versions.add(
-                (entity_key, valid_published.get('version_num'))
-            )  # Track published version
-            subsections_api.create_next_subsection_version(
-                self.subsections_map_by_key[entity_key],
-                units=children,
-                force_version_num=valid_published.pop("version_num", None),
-                created_by=self.user_id,
-                **valid_published
-            )
+        self._save_container(
+            learning_package,
+            containers,
+            container_type=Subsection,
+            container_map=self.subsections_map_by_key,
+            children_map=self.units_map_by_key,
+        )
 
     def _save_sections(self, learning_package, containers):
         """Save sections and published section versions."""
-        for valid_section in containers.get("section", []):
-            entity_key = valid_section.get("key")
-            section = sections_api.create_section(learning_package.id, created_by=self.user_id, **valid_section)
-            self.sections_map_by_key[entity_key] = section
-
-        for valid_published in containers.get("section_published", []):
-            entity_key = valid_published.pop("entity_key")
-            children = self._resolve_children(valid_published, self.subsections_map_by_key)
-            self.all_published_entities_versions.add(
-                (entity_key, valid_published.get('version_num'))
-            )  # Track published version
-            sections_api.create_next_section_version(
-                self.sections_map_by_key[entity_key],
-                subsections=children,
-                force_version_num=valid_published.pop("version_num", None),
-                created_by=self.user_id,
-                **valid_published
-            )
+        self._save_container(
+            learning_package,
+            containers,
+            container_type=Section,
+            container_map=self.sections_map_by_key,
+            children_map=self.subsections_map_by_key,
+        )
 
     def _save_draft_versions(self, components, containers, component_static_files):
         """Save draft versions for all entity types."""
@@ -888,47 +888,29 @@ def _save_draft_versions(self, components, containers, component_static_files):
                 **valid_draft
             )
 
-        for valid_draft in containers.get("unit_drafts", []):
-            entity_key = valid_draft.pop("entity_key")
-            version_num = valid_draft["version_num"]  # Should exist, validated earlier
-            if self._is_version_already_exists(entity_key, version_num):
-                continue
-            children = self._resolve_children(valid_draft, self.components_map_by_key)
-            units_api.create_next_unit_version(
-                self.units_map_by_key[entity_key],
-                components=children,
-                force_version_num=valid_draft.pop("version_num", None),
-                created_by=self.user_id,
-                **valid_draft
-            )
-
-        for valid_draft in containers.get("subsection_drafts", []):
-            entity_key = valid_draft.pop("entity_key")
-            version_num = valid_draft["version_num"]  # Should exist, validated earlier
-            if self._is_version_already_exists(entity_key, version_num):
-                continue
-            children = self._resolve_children(valid_draft, self.units_map_by_key)
-            subsections_api.create_next_subsection_version(
-                self.subsections_map_by_key[entity_key],
-                units=children,
-                force_version_num=valid_draft.pop("version_num", None),
-                created_by=self.user_id,
-                **valid_draft
-            )
+        def _process_draft_containers(
+            container_type: publishing_api.ContainerType,
+            container_map: dict,
+            children_map: dict,
+        ):
+            for valid_draft in containers.get(f"{container_type.type_code}_drafts", []):
+                entity_key = valid_draft.pop("entity_key")
+                version_num = valid_draft["version_num"]  # Should exist, validated earlier
+                if self._is_version_already_exists(entity_key, version_num):
+                    continue
+                children = self._resolve_children(valid_draft, children_map)
+                del valid_draft["version_num"]
+                publishing_api.create_next_container_version(
+                    container_map[entity_key],
+                    **valid_draft,  # should this be allowed to override any of the following fields?
+                    entities=children,
+                    force_version_num=version_num,
+                    created_by=self.user_id,
+                )
 
-        for valid_draft in containers.get("section_drafts", []):
-            entity_key = valid_draft.pop("entity_key")
-            version_num = valid_draft["version_num"]  # Should exist, validated earlier
-            if self._is_version_already_exists(entity_key, version_num):
-                continue
-            children = self._resolve_children(valid_draft, self.subsections_map_by_key)
-            sections_api.create_next_section_version(
-                self.sections_map_by_key[entity_key],
-                subsections=children,
-                force_version_num=valid_draft.pop("version_num", None),
-                created_by=self.user_id,
-                **valid_draft
-            )
+        _process_draft_containers(Unit, self.units_map_by_key, children_map=self.components_map_by_key)
+        _process_draft_containers(Subsection, self.subsections_map_by_key, children_map=self.units_map_by_key)
+        _process_draft_containers(Section, self.sections_map_by_key, children_map=self.subsections_map_by_key)
 
     # --------------------------
     # Utilities

src/openedx_content/applets/collections/api.py

@@ -9,7 +9,7 @@
 from django.db.models import QuerySet
 
 from ..publishing import api as publishing_api
-from ..publishing.models import PublishableEntity
+from ..publishing.models import Container, PublishableEntity
 from .models import Collection, CollectionPublishableEntity
 
 # The public API that will be re-exported by openedx_content.api
@@ -24,6 +24,7 @@
     "get_collection",
     "get_collections",
     "get_entity_collections",
+    "get_collection_containers",
     "remove_from_collection",
     "restore_collection",
     "update_collection",
@@ -195,6 +196,18 @@ def get_entity_collections(learning_package_id: int, entity_key: str) -> QuerySe
     return entity.collections.filter(enabled=True).order_by("pk")
 
 
+def get_collection_containers(learning_package_id: int, collection_key: str) -> QuerySet[Container]:
+    """
+    Returns a QuerySet of Containers relating to the PublishableEntities in a Collection.
+
+    Containers have a one-to-one relationship with PublishableEntity, but the reverse may not always be true.
+    """
+    return Container.objects.filter(
+        publishable_entity__learning_package_id=learning_package_id,
+        publishable_entity__collections__key=collection_key,
+    ).order_by("pk")
+
+
 def get_collections(learning_package_id: int, enabled: bool | None = True) -> QuerySet[Collection]:
     """
     Get all collections for a given learning package