feat: Update containers in search index on components update/delete [FC-0083] #36432

ChrisChV · 2025-03-22T00:07:00Z

Description

Added publish_status field to Container document in search index.
Created content_libraries/api/dataclass.py and moved API Data classes to this file.
Added get_containers_contains_component in containers API.
Added send_container_updated_events in library context
Call LIBRARY_CONTAINER_UPDATED in
- set_library_block_olx
- delete_library_block
Which edX user roles will this change impact? "Developer".

Supporting information

Depends on Basic CRUD REST Endpoints for units in content libraries [FC-0083] #36371
Github issue: Backend: When a component is edited, all parent Units must show changes frontend-app-authoring#1707
Internal ticket: FAL-4110

Testing instructions

Verify that the test covers the new code.
On cms python shell run this code to create a library, create components, create units and add the components to the units:

from openedx.core.djangoapps.content_libraries import api
from organizations.models import Organization
from opaque_keys.edx.keys import UsageKey
from openedx_learning.api import authoring as authoring_api
from datetime import datetime, timezone
org = Organization.objects.get(name='SampleTaxonomyOrg1')
lib = api.create_library(org, 'lib1', 'Lib 1')
html_block = api.create_library_block(lib.key, 'html', 'html1')
problem_block = api.create_library_block(lib.key, 'problem', 'problem1')
unit1 = api.create_container(lib.key, api.ContainerType.Unit, 'unit-1', 'Unit 1', None)
unit2 = api.create_container(lib.key, api.ContainerType.Unit, 'unit-2', 'Unit 2', None)
api.update_container_children(
    unit1.container_key,
    [problem_block.usage_key, html_block.usage_key],
    None,
)
api.update_container_children(
    unit2.container_key,
    [html_block.usage_key],
    None,
)

Run tutor dev exec cms ./manage.py cms reindex_studio --experimental
Go to http://meilisearch.local.openedx.io:7700/ and verify the num_children of the units.
On cms python shell run: api.delete_library_block(problem_block.usage_key)
Go to meilisearch and verify the num_children of the units.
On cms python shell run: api.set_library_block_olx(html_block.usage_key, "<html><b>Hello world!</b></html>")
Check that there are no errors, as units cannot be published yet, the meilisearch does not change because it has never been published.

Deadline

None

Other information

N/A

openedx-webhooks · 2025-03-22T00:07:05Z

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.

pomegranited

@ChrisChV One suggestion, but this change looks good. 👍

I tested this by ensuring that the added tests cover the expected behaviour.
I read through the code on open-craft#756
~~I checked for accessibility issues~~ N/A
Includes documentation
~~User-facing strings are extracted for translation~~ N/A

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

…tests

…a container

…f container

…en to add components

navinkarkera

@ChrisChV Looks good. 👍

I tested this: (Played with tests)
I read through the code
I checked for accessibility issues
Includes documentation

edx-pipeline-bot · 2025-04-02T14:31:02Z

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

edx-pipeline-bot · 2025-04-02T15:35:37Z

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

edx-pipeline-bot · 2025-04-02T15:35:37Z

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

…FC-0083] (#36432) * feat: Added get_containers_contains_component in containers api with tests * feat: Add publish_status to containers search document * feat: Add LIBRARY_CONTAINER_UPDATED whend deleted a component inside a container * feat: Send LIBRARY_CONTAINER_UPDATED signal when updating component of container * fix: Bugs sending LIBRARY_CONTAINER_UPDATED signal * feat: Add publish_status of container as PublishStatus.Never by default * refactor: ContentLibraryContainersTest to use update_container_children to add components * style: Clean code after fix conflicts * fix: Broken lint * fix: lint

…FC-0083] (openedx#36432) * feat: Added get_containers_contains_component in containers api with tests * feat: Add publish_status to containers search document * feat: Add LIBRARY_CONTAINER_UPDATED whend deleted a component inside a container * feat: Send LIBRARY_CONTAINER_UPDATED signal when updating component of container * fix: Bugs sending LIBRARY_CONTAINER_UPDATED signal * feat: Add publish_status of container as PublishStatus.Never by default * refactor: ContentLibraryContainersTest to use update_container_children to add components * style: Clean code after fix conflicts * fix: Broken lint * fix: lint

…FC-0083] (#36432) * feat: Added get_containers_contains_component in containers api with tests * feat: Add publish_status to containers search document * feat: Add LIBRARY_CONTAINER_UPDATED whend deleted a component inside a container * feat: Send LIBRARY_CONTAINER_UPDATED signal when updating component of container * fix: Bugs sending LIBRARY_CONTAINER_UPDATED signal * feat: Add publish_status of container as PublishStatus.Never by default * refactor: ContentLibraryContainersTest to use update_container_children to add components * style: Clean code after fix conflicts * fix: Broken lint * fix: lint

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

ChrisChV marked this pull request as draft March 22, 2025 00:07

openedx-webhooks added this to Contributions Mar 22, 2025

github-project-automation bot moved this to Needs Triage in Contributions Mar 22, 2025

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions Mar 24, 2025

ChrisChV mentioned this pull request Mar 26, 2025

TEMP: feat: Update containers in search index on components update/delete open-craft/edx-platform#756

Closed

pomegranited approved these changes Mar 26, 2025

View reviewed changes

openedx/core/djangoapps/content/search/documents.py Show resolved Hide resolved

ChrisChV added 7 commits April 1, 2025 17:39

feat: Added get_containers_contains_component in containers api with …

e548585

…tests

feat: Add publish_status to containers search document

5f01638

feat: Add LIBRARY_CONTAINER_UPDATED whend deleted a component inside …

3b49af3

…a container

feat: Send LIBRARY_CONTAINER_UPDATED signal when updating component o…

1d94788

…f container

fix: Bugs sending LIBRARY_CONTAINER_UPDATED signal

da9f510

feat: Add publish_status of container as PublishStatus.Never by default

6c12709

refactor: ContentLibraryContainersTest to use update_container_childr…

a5bcc11

…en to add components

ChrisChV force-pushed the chris/FAL-4110-unit-component-changes branch from c3406d8 to a5bcc11 Compare April 1, 2025 23:26

ChrisChV changed the title ~~feat: Update containers in search index on components update/delete~~ feat: Update containers in search index on components update/delete [FC-0083] Apr 1, 2025

ChrisChV added 2 commits April 1, 2025 18:32

style: Clean code after fix conflicts

74d11a0

fix: Broken lint

7176b20

ChrisChV marked this pull request as ready for review April 1, 2025 23:44

fix: lint

9f7a121

navinkarkera approved these changes Apr 2, 2025

View reviewed changes

navinkarkera merged commit 1c14c3a into openedx:master Apr 2, 2025
49 checks passed

navinkarkera deleted the chris/FAL-4110-unit-component-changes branch April 2, 2025 13:16

github-project-automation bot moved this from Waiting on Author to Done in Contributions Apr 2, 2025

navinkarkera mentioned this pull request Apr 9, 2025

feat: library unit page skeleton [FC-0083] openedx/frontend-app-authoring#1779

Merged

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label May 12, 2025

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

feat: Update containers in search index on components update/delete [FC-0083] #36432

feat: Update containers in search index on components update/delete [FC-0083] #36432

Uh oh!

ChrisChV commented Mar 22, 2025 •

edited

Loading

Uh oh!

openedx-webhooks commented Mar 22, 2025 •

edited

Loading

Uh oh!

pomegranited left a comment

Uh oh!

Uh oh!

navinkarkera left a comment

Uh oh!

Uh oh!

edx-pipeline-bot commented Apr 2, 2025

Uh oh!

edx-pipeline-bot commented Apr 2, 2025

Uh oh!

edx-pipeline-bot commented Apr 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

feat: Update containers in search index on components update/delete [FC-0083] #36432

feat: Update containers in search index on components update/delete [FC-0083] #36432

Uh oh!

Conversation

ChrisChV commented Mar 22, 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 Mar 22, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pomegranited left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

navinkarkera left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

edx-pipeline-bot commented Apr 2, 2025

Uh oh!

edx-pipeline-bot commented Apr 2, 2025

Uh oh!

edx-pipeline-bot commented Apr 2, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

ChrisChV commented Mar 22, 2025 •

edited

Loading

openedx-webhooks commented Mar 22, 2025 •

edited

Loading