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

ChrisChV · 2025-05-21T01:43:02Z

Description

Refactor of test_containers.py 8b9731d
Updates the content_libraries/api/containers and content_libraries/rest_api to support:
- Basic CRUD for sections and subsections as containers
- Basic CRUD support for section and subsection children
Updates the content/search to support:
- Basic CRUD for sections and subsections as containers in the search index
- Basic CRUD support for section and subsection children in the search index
Updates the content_libraries/tests/test_containers.py to test the new support
Updates the content/search/tests to test the new support.
I verified that the add/remove to collection works without major changes. Tests updated
Which edX user roles will this change impact? "Developer".

Supporting information

Github issue: Update content libraries REST API and search API to support sections/subsections frontend-app-authoring#2011
Internal ticket: https://tasks.opencraft.com/browse/FAL-4180

Testing instructions

Verify that the tests cover all the new code and the new support of the sections and subsections as containers
Additionally, you can test these changes with https://tasks.opencraft.com/browse/FAL-4170

Deadline

ASAP to unlock more tasks

Other information

To complete a full support it is known that the following is missing:

Update the index to store the subsections in which a unit is contained and the sections in which a subsection is contained. Also call the CONTENT_OBJECT_ASSOCIATIONS_CHANGED
Update the get_containers_contains_component in the API
All related to publish
Call events when delete a subsection/unit to update the affected sections/subsections (or verify if this works).

openedx-webhooks · 2025-05-21T01:43:06Z

Thanks for the pull request, @ChrisChV!

This repository is currently maintained by @openedx/wg-maintenance-edx-platform.

Once you've gone through the following steps feel free to tag them in a comment and let them know that your changes are ready for engineering review.

🔘 Get product approval

If you haven't already, check this list to see if your contribution needs to go through the product review process.

If it does, you'll need to submit a product proposal for your contribution, and have it reviewed by the Product Working Group.
- This process (including the steps you'll need to take) is documented here.
If it doesn't, simply proceed with the next step.

🔘 Provide context

To help your reviewers and other members of the community understand the purpose and larger context of your changes, feel free to add as much of the following information to the PR description as you can:

Dependencies

This PR must be merged before / after / at the same time as ...
Blockers

This PR is waiting for OEP-1234 to be accepted.
Timeline information

This PR must be merged by XX date because ...
Partner information

This is for a course on edx.org.
Supporting documentation
Relevant Open edX discussion forum threads

🔘 Get a green build

If one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green.

Details

Where can I find more information?

If you'd like to get more details on all aspects of the review process for open source pull requests (OSPRs), check out the following resources:

When can I expect my changes to be merged?

Our goal is to get community contributions seen and reviewed as efficiently as possible.

However, the amount of time that it takes to review and merge a PR can vary significantly based on factors such as:

The size and impact of the changes that it introduces
The need for product review
Maintenance status of the parent repository

💡 As a result it may take up to several weeks or months to complete a review and merge your PR.

* Created `test_subsection_permissions` * Created `test_section_permissions` * Rename `test_units_gets_auto_slugs` to `test_containers_gets_auto_slugs` and also test sections and subsections

* feat: `test_restore_units` renamed to `test_restore_containers` to also test restore section and subsections * refactor: Created `test_container_crud` to test all container types using ddt. * refactor: Created `test_container_permissions` to test all container types using ddt. * refactor: Created `test_containers_gets_auto_slugs` to test all container types using ddt

…ubections

navinkarkera

@ChrisChV Nice work 👍

I tested this: (Tested it with frontend from openedx/frontend-app-authoring#2032)
I read through the code
I checked for accessibility issues
Includes documentation

openedx/core/djangoapps/content/search/tests/test_documents.py

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

navinkarkera · 2025-05-28T15:29:50Z

Update the index to store the subsections in which a unit is contained and the sections in which a subsection is contained.

@ChrisChV I actually need this for openedx/frontend-app-authoring#2032 so I went ahead and created this small PR: open-craft#785 with basic implementation. Please take a look and let me know if you want me to make any changes or if you want to take over and merge it here.

bradenmacdonald

Looks great, thanks! Just a few nits. Please take a look at them before you merge.

openedx/core/djangoapps/content/search/documents.py

bradenmacdonald · 2025-05-28T18:22:56Z

openedx/core/djangoapps/content/search/tests/test_api.py

+                None,
+            )
+
+        # TODO verify subsections in units


What's left to do here? This looks similar to the units case above.

It was missing to add to the index the sections and subsections to which it is contained. Navin has advanced this part in #36762 (comment). I'll review it and update the tests.

bradenmacdonald · 2025-05-28T18:23:04Z

openedx/core/djangoapps/content/search/tests/test_api.py

+                None,
+            )
+
+        # TODO verify section in subsections


Same question.

Same of #36762 (comment)

openedx/core/djangoapps/content/search/tests/test_api.py

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

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

* Add `-> None` to tests * Add `-> list[str]` to `get_child_keys`

ChrisChV · 2025-05-28T20:30:59Z

@ChrisChV I actually need this for openedx/frontend-app-authoring#2032 so I went ahead and created this small PR: open-craft#785 with basic implementation. Please take a look and let me know if you want me to make any changes or if you want to take over and merge it here.

@navinkarkera Looks good! Thanks for this work! I think it's missing to update this TODOS's:

In update_container_children
In tests

This PR is ready to be merged, I think we should merge it to be able to unblock openedx/frontend-app-authoring#2013. I will create a separed PR with your work and I'm going to continue it 😄

edx-pipeline-bot · 2025-05-28T22:26:18Z

2U Release Notice: This PR has been deployed to the edX staging environment in preparation for a release to production.

edx-pipeline-bot · 2025-05-28T22:43:43Z

2U Release Notice: This PR has been deployed to the edX production environment.

edx-pipeline-bot · 2025-05-28T22:43:44Z

2U Release Notice: This PR has been deployed to the edX production environment.

…090] (#36762) - Refactor of `test_containers.py` 8b9731d - Updates the `content_libraries/api/containers` and `content_libraries/rest_api` to support: - Basic CRUD for sections and subsections as containers - Basic CRUD support for section and subsection children - Updates the `content/search` to support: - Basic CRUD for sections and subsections as containers in the search index - Basic CRUD support for section and subsection children in the search index - Updates the `content_libraries/tests/test_containers.py` to test the new support - Updates the `content/search/tests` to test the new support. - I verified that the add/remove to collection works without major changes. Tests updated

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 21, 2025

openedx-webhooks added this to Contributions May 21, 2025

github-project-automation bot moved this to Needs Triage in Contributions May 21, 2025

ChrisChV marked this pull request as draft May 21, 2025 01:43

ChrisChV added 2 commits May 20, 2025 21:17

refactor: Tests on test_containers.py to use setUp

8b9731d

feat: CRUD for section/subsections with tests

3f6c616

ChrisChV force-pushed the chris/FAL-4180-sections-subsections-api branch from 0fc836c to 3f6c616 Compare May 21, 2025 02:18

ChrisChV added 2 commits May 21, 2025 20:36

test: test_containers updated

c9300cf

* Created `test_subsection_permissions` * Created `test_section_permissions` * Rename `test_units_gets_auto_slugs` to `test_containers_gets_auto_slugs` and also test sections and subsections

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions May 22, 2025

ChrisChV added 4 commits May 22, 2025 20:02

feat: CRUD support for section and subsection children

e08f1b1

feat: Basic CRUD and Children CRUD for search index for section and s…

7c478d3

…ubections

style: Fix broken lint

8ed07f3

style: fix tests

b269d46

ChrisChV changed the title ~~feat: Update content libraries REST API and search API to support sections/subsections~~ feat: Basic CRUD support for sections/subsections as containers May 26, 2025

test: Add/remove containers in collections

539f26c

ChrisChV marked this pull request as ready for review May 26, 2025 23:39

navinkarkera approved these changes May 27, 2025

View reviewed changes

openedx/core/djangoapps/content/search/tests/test_documents.py Outdated Show resolved Hide resolved

openedx/core/djangoapps/content_libraries/api/containers.py Outdated Show resolved Hide resolved

style: fix broken tests

c1a0c08

ChrisChV requested review from bradenmacdonald and pomegranited May 28, 2025 18:28

bradenmacdonald approved these changes May 28, 2025

View reviewed changes

ChrisChV moved this from Waiting on Author to Ready for Review in Contributions May 28, 2025

ChrisChV added 3 commits May 28, 2025 15:00

refactor: Add type verification to tests

cbd5c84

* Add `-> None` to tests * Add `-> list[str]` to `get_child_keys`

refactor: Delete unnecesary checks in update_container_children

02e70f0

style: Fix broken lint

b55ccc0

Merge branch 'master' into chris/FAL-4180-sections-subsections-api

edd601f

ChrisChV changed the title ~~feat: Basic CRUD support for sections/subsections as containers~~ feat: Basic CRUD support for sections/subsections as containers [FC-0090] May 28, 2025

ChrisChV enabled auto-merge (squash) May 28, 2025 20:34

ChrisChV merged commit c2eb913 into openedx:master May 28, 2025
48 checks passed

github-project-automation bot moved this from Ready for Review to Done in Contributions May 28, 2025

ChrisChV mentioned this pull request May 28, 2025

feat: Support to sections/subsections dict to containers objects in index [FC-0090] #36806

Merged

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

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

Uh oh!

Conversation

ChrisChV commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Supporting information

Testing instructions

Deadline

Other information

Uh oh!

openedx-webhooks commented May 21, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

navinkarkera left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

navinkarkera commented May 28, 2025

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

bradenmacdonald May 28, 2025

Choose a reason for hiding this comment

Uh oh!

ChrisChV May 28, 2025

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald May 28, 2025

Choose a reason for hiding this comment

Uh oh!

ChrisChV May 28, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

ChrisChV commented May 28, 2025

Uh oh!

Uh oh!

edx-pipeline-bot commented May 28, 2025

Uh oh!

edx-pipeline-bot commented May 28, 2025

Uh oh!

edx-pipeline-bot commented May 28, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ChrisChV commented May 21, 2025 •

edited

Loading

openedx-webhooks commented May 21, 2025 •

edited

Loading