Skip to content
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.

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

Make copied tags editable again after breaking the upstream link to library content [FC-0076] #36228

Draft
wants to merge 26 commits into
base: master
Choose a base branch
from

Conversation

pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Feb 6, 2025

Description

When deleting an upstream library block, ensure that any tags that may have been copied to downstream blocks are made editable again. This is achieved by un-setting the is_copied flag on the downstream tags.

This change affects Content Authors using linked library content.

Supporting information

Part of: openedx/modular-learning#244
Based on: #36111 -- compare changes
Depends on: openedx/openedx-learning#276
Private-ref: FAL-4008

Testing instructions

Note: There's a bug in the Authoring MFE's Course Unit page that prevents the tag drawer from opening. So ensure you have disabled the contentstore.new_studio_mfe.use_new_unit_page waffle flag to use the legacy Studio unit interface during testing.

  1. Run migrations to add new link tables.
  2. Create a block in a content library, and add some tags to it.
  3. Publish the block.
  4. Copy the library block into a course, either using the staged content copy/paste, or by adding a Library Content block, and selecting your published block.
    Should see the tags copied from the library block on the new course block, and they should not be deleteable.
  5. Add some more tags to the new course block.
    These tags should be deletable.
  6. Go back to your content library block, and delete it.
  7. Return to the course block, and re-open the "manage tags" sidebar.
    All the tags should remain, and all are deletable now.

Deadline

None

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Feb 6, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @pomegranited!

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.


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.

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.

@pomegranited Works as expected 💯 Just left a suggestion about using the event to handle the tags, let me know if you disagree.

Comment on lines +1115 to +1118
# Import here to avoid breaking the LMS
from cms.djangoapps.contentstore import helpers as studio_helpers
studio_helpers.make_downstream_tags_editable(usage_key)

Copy link
Contributor

Choose a reason for hiding this comment

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

We can handle inside the LIBRARY_BLOCK_DELETED signal handler (preferably to a celery task) and avoid cms import inside openedx/core. Maybe add the signal handler in cms/djangoapps/contentstore/signals/handlers.py.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
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.

3 participants