Skip to content

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

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

Jump to bottom
Merged
ChrisChV merged 7 commits into from
Jun 2, 2025
Merged

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

ChrisChV merged 7 commits into from
Jun 2, 2025

Conversation

@ChrisChV
Copy link
Contributor

@ChrisChV ChrisChV commented May 28, 2025 •
edited
Loading

Description

  • Adds the subsections dict in the search index to be used by units
  • Adds the sections dict in the search index to be used by sections.
  • Rename get_containers_contains_component to get_containers_contains_item and add support to subsections/sections
  • Call CONTENT_OBJECT_ASSOCIATIONS_CHANGED for sections and subsections in update_container_children
  • Which edX user roles will this change impact? "Developer".

Supporting information

Testing instructions

  • Verify that the tests cover all changes

Deadline

ASAP to unblock tasks

Other information

N/A

navinkarkera and others added 3 commits May 28, 2025 16:31
@navinkarkera @ChrisChV
feat: add sections-subsections dict to containers object in index
0e3b441
@ChrisChV
feat: Update get_containers_contains_item to support section and subs…
08d2667 
…ections
@ChrisChV
feat: Call CONTENT_OBJECT_ASSOCIATIONS_CHANGED for sections and subse…
c22729e 
…ctions

* Call CONTENT_OBJECT_ASSOCIATIONS_CHANGED for sections and subsections in update_container_children
* Test in search index
* Test in libraries api
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label May 28, 2025
@openedx-webhooks
Copy link

openedx-webhooks commented May 28, 2025 •
edited
Loading

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.

@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions May 28, 2025
@ChrisChV ChrisChV marked this pull request as draft May 28, 2025 23:20
@ChrisChV ChrisChV marked this pull request as ready for review May 28, 2025 23:49
navinkarkera
navinkarkera approved these changes May 29, 2025
View reviewed changes
Copy link
Contributor

@navinkarkera navinkarkera left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ChrisChV Looks good. 👍

  • I tested this: Verified sections, subsections field index
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label May 29, 2025
bradenmacdonald
bradenmacdonald reviewed May 29, 2025
View reviewed changes
@ChrisChV ChrisChV requested a review from bradenmacdonald May 29, 2025 20:00
@ChrisChV ChrisChV mentioned this pull request May 29, 2025
Closed
@ChrisChV ChrisChV force-pushed the chris/FAL-4180-container-data-in-index branch from 4e7885c to e9792da Compare May 30, 2025 00:14
@ChrisChV
Copy link
Contributor Author

ChrisChV commented May 30, 2025

@navinkarkera @bradenmacdonald I added e9792da because I need it in openedx/frontend-app-authoring#1630 to display the children names in the card preview

bradenmacdonald
bradenmacdonald reviewed May 30, 2025
View reviewed changes
@ChrisChV
refactor: containers, tags and collections code in search api and doc…
da8aa4f 
…uments

* Join containers code in `upsert_item_containers_index_docs`
* Join containers code in `searchable_doc_containers`
* Join tags code in `searchable_doc_tags`
* Join tags code in `upsert_content_object_tags_index_doc`
@ChrisChV ChrisChV moved this from Needs Triage to Ready for Review in Contributions May 30, 2025
@ChrisChV ChrisChV requested a review from bradenmacdonald May 30, 2025 20:22
@navinkarkera navinkarkera mentioned this pull request May 31, 2025
Merged
bradenmacdonald
bradenmacdonald approved these changes May 31, 2025
View reviewed changes
Copy link
Contributor

@bradenmacdonald bradenmacdonald left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks! I ran reindex_studio and also used the shell to add a unit to a subsection, and saw that it updated the search index correctly:

Screenshot

@ChrisChV ChrisChV merged commit 2759d15 into openedx:master Jun 2, 2025
49 checks passed
@ChrisChV ChrisChV deleted the chris/FAL-4180-container-data-in-index branch June 2, 2025 17:41
@github-project-automation github-project-automation bot moved this from Ready for Review to Done in Contributions Jun 2, 2025
@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Jun 3, 2025

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

@edx-pipeline-bot
Copy link
Contributor

edx-pipeline-bot commented Jun 3, 2025

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

@pomegranited pomegranited mentioned this pull request Jun 19, 2025
Closed
marlonkeating pushed a commit that referenced this pull request Jul 15, 2025
@ChrisChV @marlonkeating
feat: Support to sections/subsections dict to containers objects in i…
886b1d3 
…ndex [FC-0090] (#36806)

- Adds the subsections dict in the search index to be used by units
- Adds the sections dict in the search index to be used by sections.
- Rename `get_containers_contains_component` to `get_containers_contains_item` and add support to subsections/sections 
- Call `CONTENT_OBJECT_ASSOCIATIONS_CHANGED` for sections and subsections in `update_container_children`
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@bradenmacdonald bradenmacdonald bradenmacdonald approved these changes

@navinkarkera navinkarkera navinkarkera approved these changes

Assignees

No one assigned

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Contributions
Archived in project

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

6 participants

@ChrisChV @openedx-webhooks @edx-pipeline-bot @bradenmacdonald @navinkarkera @mphilbrick211