From dd1f2081994e900db3a85d3c7114ff0a745e4fd6 Mon Sep 17 00:00:00 2001
From: monteri <lansevermore>
Date: Thu, 25 Jan 2024 19:32:33 +0200
Subject: [PATCH] feat: add sequence_ids to container response

---
 .../rest_api/v1/serializers/vertical_block.py |  1 +
 .../rest_api/v1/views/vertical_block.py       |  5 ++++
 cms/djangoapps/contentstore/utils.py          | 29 +++++++++++++++++++
 3 files changed, 35 insertions(+)

diff --git a/cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py b/cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py
index 0900ba39d2b3..809ebf22bd5d 100644
--- a/cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py
+++ b/cms/djangoapps/contentstore/rest_api/v1/serializers/vertical_block.py
@@ -78,6 +78,7 @@ class ContainerHandlerSerializer(serializers.Serializer):
     assets_url = serializers.SerializerMethodField()
     unit_block_id = serializers.CharField(source="unit.location.block_id")
     subsection_location = serializers.CharField(source="subsection.location")
+    sequence_ids = serializers.ListField(child=serializers.CharField())
 
     def get_assets_url(self, obj):
         """
diff --git a/cms/djangoapps/contentstore/rest_api/v1/views/vertical_block.py b/cms/djangoapps/contentstore/rest_api/v1/views/vertical_block.py
index a11380a08a66..84505998e6d8 100644
--- a/cms/djangoapps/contentstore/rest_api/v1/views/vertical_block.py
+++ b/cms/djangoapps/contentstore/rest_api/v1/views/vertical_block.py
@@ -117,6 +117,11 @@ def get(self, request: Request, usage_key_string: str):
             "assets_url": "/assets/course-v1:edX+DemoX+Demo_Course/",
             "unit_block_id": "d6cee45205a449369d7ef8f159b22bdf",
             "subsection_location": "block-v1:edX+DemoX+Demo_Course+type@sequential+block@graded_simulations"
+            "sequence_ids": [
+                "block-v1:edX+DemoX+Demo_Course+type@sequential+block@graded_simulations",
+                "block-v1:edX+DemoX+Demo_Course+type@sequential+block@something_else",
+                ...
+            ],
         }
         ```
         """
diff --git a/cms/djangoapps/contentstore/utils.py b/cms/djangoapps/contentstore/utils.py
index 748e6a85a0d4..cd6fda9c3b3a 100644
--- a/cms/djangoapps/contentstore/utils.py
+++ b/cms/djangoapps/contentstore/utils.py
@@ -632,6 +632,31 @@ def ancestor_has_staff_lock(xblock, parent_xblock=None):
     return parent_xblock.visible_to_staff_only
 
 
+def get_sequence_usage_keys(course_structure):
+    """
+    Recursively searches through a nested course_structure,
+    extracting and returning a list of usage_keys where the 'category'
+    key is set to 'sequential'
+    """
+    ids = []
+
+    def check_category_and_children(child_info):
+        if child_info.get('category') == 'sequential':
+            ids.extend([c.get('id') for c in child_info.get('children', [])])
+            return
+
+        # Recursively check children if they exist
+        for child in child_info.get('children', []):
+            if 'child_info' in child:
+                check_category_and_children(child['child_info'])
+
+    if 'child_info' in course_structure:
+        check_category_and_children(course_structure['child_info'])
+
+    return ids
+
+
+
 def reverse_url(handler_name, key_name=None, key_value=None, kwargs=None):
     """
     Creates the URL for the given handler.
@@ -1847,7 +1872,10 @@ def get_container_handler_context(request, usage_key, course, xblock):  # pylint
         create_xblock_info,
     )
     from openedx.core.djangoapps.content_staging import api as content_staging_api
+    from cms.djangoapps.contentstore.views.course import _course_outline_json
 
+    course_structure = _course_outline_json(request, course)
+    sequence_ids = get_sequence_usage_keys(course_structure)
     component_templates = get_component_templates(course)
     ancestor_xblocks = []
     parent = get_parent_xblock(xblock)
@@ -1948,6 +1976,7 @@ def get_container_handler_context(request, usage_key, course, xblock):  # pylint
         # Status of the user's clipboard, exactly as would be returned from the "GET clipboard" REST API.
         'user_clipboard': user_clipboard,
         'is_fullwidth_content': is_library_xblock,
+        'sequence_ids': sequence_ids,
     }
     return context