Skip to content

fix: error seen when deleting a component used in a container (requires API change) [FC-0117]#38607

Open
bradenmacdonald wants to merge 2 commits into
openedx:masterfrom
open-craft:braden/fix-component-delete
Open

fix: error seen when deleting a component used in a container (requires API change) [FC-0117]#38607
bradenmacdonald wants to merge 2 commits into
openedx:masterfrom
open-craft:braden/fix-component-delete

Conversation

@bradenmacdonald
Copy link
Copy Markdown
Contributor

@bradenmacdonald bradenmacdonald commented May 7, 2026

Description

Fixes openedx/frontend-app-authoring#3051

Deleting the draft version of a published component used in a published container would result in an error when LibraryXBlockMetadata tries to get info about the draft version.

# Event:  LIBRARY_BLOCK_DELETED
2026-05-07 00:18:03,180 INFO 1088 [openedx.core.djangoapps.content.search.tasks:157] - Updating content index documents for container lct:OpenCraftX:MTL3:unit:conclusion in librarylib:OpenCraftX:MTL3
2026-05-07 00:18:03,268 ERROR 1088 [celery_utils.logged_task:48] - failed due to Traceback (most recent call last):
  File "/openedx/edx-platform/openedx/core/djangoapps/content/search/tasks.py", line 159, in update_library_container_index_doc
    api.upsert_library_container_index_doc(container_key)
  File "/openedx/edx-platform/openedx/core/djangoapps/content/search/api.py", line 999, in upsert_library_container_index_doc
    """
        
  File "/openedx/edx-platform/openedx/core/djangoapps/content/search/documents.py", line 675, in searchable_doc_for_container
    published_children = lib_api.get_container_children(
                         ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/content_libraries/api/containers.py", line 214, in get_container_children
    result.append(LibraryXBlockMetadata.from_component(container_key.lib_key, entry.entity.component))
                  ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
  File "/openedx/edx-platform/openedx/core/djangoapps/content_libraries/api/block_metadata.py", line 70, in from_component
    display_name=draft.title,
                 ^^^^^^^^^^^
AttributeError: 'NoneType' object has no attribute 'title'

Testing instructions

  1. Create a component and a unit. Add the component to the unit.
  2. Publish both the unit and the component.
  3. Delete the component.
  4. Without this fix, the component gets deleted but an error occurs when updating the container's search index entry. The traceback shown above will appear in the CMS logs, and the "child component count" on the parent container will be wrong (not decreased).

@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels May 7, 2026
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented May 7, 2026

Thanks for the pull request, @bradenmacdonald!

This repository is currently maintained by @openedx/wg-maintenance-openedx-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 7, 2026
@bradenmacdonald bradenmacdonald marked this pull request as draft May 7, 2026 17:35
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label May 14, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions May 14, 2026
@bradenmacdonald bradenmacdonald force-pushed the braden/fix-component-delete branch 2 times, most recently from 0378279 to 50d3f0e Compare May 21, 2026 00:44
Deleting the draft version of a published component used in a published container would result in an error when LibraryXBlockMetadata tries to get info about the draft version.
@bradenmacdonald bradenmacdonald force-pushed the braden/fix-component-delete branch from f1aa32a to 6116547 Compare May 21, 2026 01:15
@bradenmacdonald bradenmacdonald marked this pull request as ready for review May 21, 2026 01:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Status: Waiting on Author

Development

Successfully merging this pull request may close these issues.

Parent container does not update when deleting a published component

3 participants