fix: error seen when deleting a component used in a container (requires API change) [FC-0117] by bradenmacdonald · Pull Request #38607 · openedx/openedx-platform · GitHub

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

Create a component and a unit. Add the component to the unit.
Publish both the unit and the component.
Delete the component.
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).

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.

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.

Adding a new API method here is not strictly necessary for this fix, but because this new get_container_children_list API method is much simpler and faster than get_container, it makes the search index update both faster and more robust, so I think it's the best fix.

(get_container does a lot more work / fetches a lot more data per child, hence is slower and it potentially more fragile.)

@ormsbee Thanks for all the reviews. Could you please take a look at this one too? It's the last fix needed.

Ouch. 😞

Sorry, I thought I had gotten them all. Thank you!

…8607)

* fix: ValidationError when trying to add components to a collection (#38579) * fix: don't sleep for a half second every time we update meilisearch (#38576) * fix: various issues with modulestore migrator and content library events (#38508) * fix: update modulestore migrator to not publish in draft context * fix: use correct date/user info for modulestore migrator * fix: allow our event handling tasks to call subtasks * fix: better handling of deletion/un-deletion using openedx-core fixes * fix: exception raised when mass-deleting all items in a content library (ContentLibraryBlockNotFound was being raised and not caught, propagating up to celery task error) * fix: don't update the 'collections' field of deleted entities when modifying a collection * fix: keep collection "# of entities" count updated when entities deleted * refactor: use LIBRARY_COLLECTION_UPDATED event to update collections on entity (un)delete * fix: unable to delete "ghost" component in library if it exists but has no draft * fix: error when deleting lib component used in a container (#38607) * fix: bump openedx-core to v1.0.2 --------- Co-authored-by: Claude <noreply@anthropic.com>

…8607)

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 added this to Contributions May 7, 2026

github-project-automation Bot moved this to Needs Triage in Contributions May 7, 2026

bradenmacdonald mentioned this pull request May 7, 2026

Parent container does not update when deleting a published component openedx/frontend-app-authoring#3051

Closed

bradenmacdonald marked this pull request as draft May 7, 2026 17:35

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label May 14, 2026

mphilbrick211 moved this from Needs Triage to Waiting on Author in Contributions May 14, 2026

bradenmacdonald force-pushed the braden/fix-component-delete branch 3 times, most recently from f1aa32a to 6116547 Compare May 21, 2026 01:15

bradenmacdonald marked this pull request as ready for review May 21, 2026 01:27

bradenmacdonald requested review from kdmccormick and ormsbee May 21, 2026 01:27

mphilbrick211 moved this from Waiting on Author to Ready for Review in Contributions Jun 1, 2026

bradenmacdonald added 2 commits June 3, 2026 15:40

fix: error seen when deleting a component used in a container

b873378

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.

fix: set_library_block_olx needs to set 'created_by'

6a8e688

bradenmacdonald force-pushed the braden/fix-component-delete branch from 6116547 to 6a8e688 Compare June 3, 2026 07:45

bradenmacdonald commented Jun 3, 2026

View reviewed changes

bradenmacdonald mentioned this pull request Jun 3, 2026

Backport library fixes to Verawood #38695

Merged

ormsbee approved these changes Jun 3, 2026

View reviewed changes

bradenmacdonald merged commit ff0690f into openedx:master Jun 5, 2026
42 checks passed

bradenmacdonald deleted the braden/fix-component-delete branch June 5, 2026 13:03

github-project-automation Bot moved this from Ready for Review to Done in Contributions Jun 5, 2026

bradenmacdonald added a commit to open-craft/openedx-platform that referenced this pull request Jun 5, 2026

fix: error when deleting lib component used in a container (openedx#3…

4a7e849

…8607)

bradenmacdonald added a commit to open-craft/openedx-platform that referenced this pull request Jun 5, 2026

fix: error when deleting lib component used in a container (openedx#3…

f60de5a

…8607)

bradenmacdonald added a commit to open-craft/openedx-platform that referenced this pull request Jun 5, 2026

fix: error when deleting lib component used in a container (openedx#3…

3e03a59

…8607)

blarghmatey pushed a commit to mitodl/edx-platform that referenced this pull request Sep 17, 2026

fix: error when deleting lib component used in a container (openedx#3…

bf27161

…8607)

+              def get_container_children_list(
+                  container_key: LibraryContainerLocator, *,
+                  published: bool,
+              ) -> list[ContainerChildMetadata]:
+                  """
+                  [ 🛑 UNSTABLE ] Get the entities contained in the given container (e.g. the
+                  components/xblocks in a unit, units in a subsection, subsections in a section)
+                  Returns a list of ``ContainerChildMetadata`` objects (which give only each
+                  child's display name and opaque key, though the opaque key also includes
+                  information on what "type" of component/container it is).
+                  """

+                      empty_unit_key = LibraryContainerLocator.from_string(self.unit["id"])
+                      unit_with_children_key = LibraryContainerLocator.from_string(self.unit_with_components["id"])
+                      EMPTY_QUERIES = 6
+                      PER_CHILD_QUERIES = 10  # There's room to optimize here.

fix: error seen when deleting a component used in a container (requires API change) [FC-0117] by bradenmacdonald · Pull Request #38607 · openedx/openedx-platform · GitHub

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

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

bradenmacdonald commented May 7, 2026 •
edited
Loading

Uh oh!

Uh oh!

openedx-webhooks commented May 7, 2026 •
edited
Loading

Uh oh!

Uh oh!

bradenmacdonald Jun 3, 2026

Uh oh!

bradenmacdonald commented Jun 3, 2026

Uh oh!

ormsbee Jun 3, 2026

Uh oh!

ormsbee commented Jun 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

fix: error seen when deleting a component used in a container (requires API change) [FC-0117] by bradenmacdonald · Pull Request #38607 · openedx/openedx-platform · GitHub

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

Conversation

bradenmacdonald commented May 7, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Testing instructions

Uh oh!

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

Uh oh!

Uh oh!

bradenmacdonald Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald commented Jun 3, 2026

Uh oh!

ormsbee Jun 3, 2026

Choose a reason for hiding this comment

Uh oh!

ormsbee commented Jun 3, 2026

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

bradenmacdonald commented May 7, 2026 •
edited
Loading

openedx-webhooks commented May 7, 2026 •
edited
Loading