fix: Can't delete unit from Library v2 by ChrisChV · Pull Request #38161 · openedx/openedx-platform

ChrisChV · 2026-03-12T18:43:44Z

Description

Fixes the issue described in: https://discuss.openedx.org/t/cant-delete-unit-from-library-v2/18551/4 in two ways:
The error occurs because when copying a unit containing a component with a file, an error is generated midway through the process. However, each item (container/component) is created in the search index after being created in the database. If the operation fails, the database performs a rollback, but the search index does not.
First fix: Send the signals to create an entry in the index after the on commit of the transaction.
Second fix: When the item does not exist in the database, it deletes the record in the search index to keep it synchronized. (To allow deletion of broken items)
Which edX user roles will this change impact? "Course Author".

Supporting information

Issue: https://discuss.openedx.org/t/cant-delete-unit-from-library-v2/18551/4
Internal ticket: https://tasks.opencraft.com/browse/FAL-4340

Testing instructions

Inside a unit, create a text with an image.
Copy the unit.
Edit from Braden: Modify this code to raise an exception so that write_file fails.
Paste the unit in a content library.
Verify that the operations end in error, but an item is created in the library.

Deadline

ASAP

Other information

This same error can occur in other operations if intermediate errors are generated. TODO: Add the same fix to signal calls in openedx/core/djangoapps/content_libraries/api/blocks.py and openedx/core/djangoapps/content_libraries/api/containers.py

There may be cases where entries are created in the search index, but the component/container is not created (an intermediate error occurred). In that case, we added a fix to keep the index updated by removing the entry.

- Only in: set_library_block_olx, _import_staged_block, create_container

openedx-webhooks · 2026-03-12T18:43:51Z

Thanks for the pull request, @ChrisChV!

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.

bradenmacdonald

Nice fix, thanks. I verified that (1) this fixes the bug with pasting components when the image fails to save, and (2) that this allows us to delete failed components.

I do think that we should still raise errors from the API though when trying to delete something that doesn't exist:

bradenmacdonald · 2026-03-24T01:48:59Z

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

+        # (an intermediate error occurred).
+        # In that case, we keep the index updated by removing the entry.
+        send_block_deleted_signal()
+        return


I think we should still raise the Component.DoesNotExist error in this case. It's weird if the "delete" API request always succeeds.

bradenmacdonald · 2026-03-24T01:49:20Z

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

+        # (an intermediate error occurred).
+        # In that case, we keep the index updated by removing the entry.
+        send_container_deleted_signal()
+        return


Same here, I think we should still raise the error.

bradenmacdonald · 2026-03-24T01:50:48Z

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

+    def test_set_library_block_olx_no_signal_on_rollback(self) -> None:
+        """
+        LIBRARY_BLOCK_UPDATED is NOT emitted when set_library_block_olx is called
+        within a transaction that is later rolled back.


ChrisChV added 3 commits March 12, 2026 12:02

fix: Keep sync search index

ab88fc9

There may be cases where entries are created in the search index, but the component/container is not created (an intermediate error occurred). In that case, we added a fix to keep the index updated by removing the entry.

test: Tests added for delete component/contantainer from search index

c98fe31

fix: Create docs in search index on commit transaction

16fedb1

- Only in: set_library_block_olx, _import_staged_block, create_container

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

ChrisChV changed the title ~~Fix: Can't delete unit from Library v2~~ fix: Can't delete unit from Library v2 Mar 12, 2026

openedx-webhooks added this to Contributions Mar 12, 2026

github-project-automation bot moved this to Needs Triage in Contributions Mar 12, 2026

fix: Broken lint

1c54780

mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Mar 12, 2026

mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Mar 12, 2026

ChrisChV requested a review from bradenmacdonald March 13, 2026 18:53

bradenmacdonald requested changes Mar 24, 2026

View reviewed changes

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Can't delete unit from Library v2#38161

fix: Can't delete unit from Library v2#38161
ChrisChV wants to merge 4 commits intoopenedx:masterfrom
open-craft:chris/fix-cannot-delete-unit

ChrisChV commented Mar 12, 2026 •

edited by bradenmacdonald

Loading

Uh oh!

openedx-webhooks commented Mar 12, 2026

Uh oh!

bradenmacdonald left a comment

Uh oh!

bradenmacdonald Mar 24, 2026

Uh oh!

bradenmacdonald Mar 24, 2026

Uh oh!

bradenmacdonald Mar 24, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

Conversation

ChrisChV commented Mar 12, 2026 • edited by bradenmacdonald 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 12, 2026

Uh oh!

bradenmacdonald left a comment

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

bradenmacdonald Mar 24, 2026

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

ChrisChV commented Mar 12, 2026 •

edited by bradenmacdonald

Loading