Skip to content

feat: Basic CRUD support for sections/subsections as containers [FC-0090] #36762

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
ChrisChV merged 14 commits into from
May 28, 2025
Merged

feat: Basic CRUD support for sections/subsections as containers [FC-0090] #36762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
8b9731d
refactor: Tests on test_containers.py to use setUp
ChrisChV May 21, 2025
3f6c616
feat: CRUD for section/subsections with tests
ChrisChV May 21, 2025
c9300cf
test: test_containers updated
ChrisChV May 22, 2025
d921f53
test: Updates and refactors in test_containers
ChrisChV May 22, 2025
e08f1b1
feat: CRUD support for section and subsection children
ChrisChV May 23, 2025
7c478d3
feat: Basic CRUD and Children CRUD for search index for section and s…
ChrisChV May 24, 2025
8ed07f3
style: Fix broken lint
ChrisChV May 26, 2025
b269d46
style: fix tests
ChrisChV May 26, 2025
539f26c
test: Add/remove containers in collections
ChrisChV May 26, 2025
c1a0c08
style: fix broken tests
ChrisChV May 27, 2025
cbd5c84
refactor: Add type verification to tests
ChrisChV May 28, 2025
02e70f0
refactor: Delete unnecesary checks in update_container_children
ChrisChV May 28, 2025
b55ccc0
style: Fix broken lint
ChrisChV May 28, 2025
edd601f
Merge branch 'master' into chris/FAL-4180-sections-subsections-api
ChrisChV May 28, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions cms/djangoapps/contentstore/rest_api/v2/views/tests/test_downstream_sync_integration.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ def setUp(self):
'<html display_name="Text Content">This is the HTML.</html>'
)
self.upstream_unit = self._create_container(lib_id, "unit", slug="u1", display_name="Unit 1 Title")
self._add_container_components(self.upstream_unit["id"], [
self._add_container_children(self.upstream_unit["id"], [
self.upstream_html1["id"],
self.upstream_problem1["id"],
self.upstream_problem2["id"],
Expand Down Expand Up @@ -362,7 +362,7 @@ def test_unit_sync(self):
upstream_problem3["id"],
'<problem display_name="Problem 3 Display Name" max_attempts="22">single select...</problem>'
)
self._add_container_components(self.upstream_unit["id"], [upstream_problem3["id"]])
self._add_container_children(self.upstream_unit["id"], [upstream_problem3["id"]])
self._remove_container_components(self.upstream_unit["id"], [self.upstream_problem2["id"]])
self._commit_library_changes(self.library["id"]) # publish everything

Expand Down
28 changes: 20 additions & 8 deletions openedx/core/djangoapps/content/search/documents.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -95,6 +95,9 @@ class Fields:
published_content = "content"
published_num_children = "num_children"

# List of children keys
child_usage_keys = "child_usage_keys"

# Note: new fields or values can be added at any time, but if they need to be indexed for filtering or keyword
# search, the index configuration will need to be changed, which is only done as part of the 'reindex_studio'
# command (changing those settings on an large active index is not recommended).
Expand Down Expand Up @@ -656,16 +659,28 @@ def searchable_doc_for_container(
elif container.has_unpublished_changes:
publish_status = PublishStatus.modified

container_type = lib_api.ContainerType(container_key.container_type)

def get_child_keys(children) -> list[str]:
match container_type:
case lib_api.ContainerType.Unit:
return [
str(child.usage_key)
for child in children
]
case lib_api.ContainerType.Subsection | lib_api.ContainerType.Section:
return [
str(child.container_key)
for child in children
]

doc.update({
Fields.display_name: container.display_name,
Fields.created: container.created.timestamp(),
Fields.modified: container.modified.timestamp(),
Fields.num_children: len(draft_children),
Fields.content: {
"child_usage_keys": [
str(child.usage_key)
for child in draft_children
],
Fields.child_usage_keys: get_child_keys(draft_children)
},
Fields.publish_status: publish_status,
Fields.last_published: container.last_published.timestamp() if container.last_published else None,
Expand All @@ -683,10 +698,7 @@ def searchable_doc_for_container(
Fields.published_display_name: container.published_display_name,
Fields.published_num_children: len(published_children),
Fields.published_content: {
"child_usage_keys": [
str(child.usage_key)
for child in published_children
],
Fields.child_usage_keys: get_child_keys(published_children),
},
}

Expand Down
Loading
Loading