Skip to content

fix: update container key field usage #36679

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

Merged
merged 2 commits into from
May 12, 2025

Conversation

navinkarkera
Copy link
Contributor

@navinkarkera navinkarkera commented May 8, 2025

Description

A minor fix that updates field name usage of ContainerLink model in tasks.

The upstream_usage_key field was renamed to upstream_container_key for ContainerLink model.

Deadline

ASAP.

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

Thanks for the pull request, @navinkarkera!

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.


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.

@@ -1507,6 +1507,6 @@ def handle_unlink_upstream_block(upstream_usage_key_string: str) -> None:
):
make_copied_tags_editable(str(link.downstream_usage_key))
for link in ContainerLink.objects.filter(
upstream_usage_key=upstream_usage_key,
upstream_container_key=upstream_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.

@navinkarkera Sorry, could I get some more context for this change? What's the issue it fixes?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pomegranited Updated the description, the field was renamed to upstream_container_key.

Copy link
Contributor

Choose a reason for hiding this comment

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

Sorry @navinkarkera , I still don't understand.. Upstream container keys aren't UsageKeys, so won't we get a InvalidKeyError above if this function is called with a container key?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

@pomegranited You are completely right! Moved this part to its own task when containers are deleted.

Copy link
Contributor

@pomegranited pomegranited left a comment

Choose a reason for hiding this comment

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

👍 Thanks for this fix @navinkarkera :)

  • I tested this on my tutor dev stack with latest master Authoring MFE:
    • created a new library unit, added tags, and published.
    • added the library unit to a course -- tags were copied over and marked read-only
    • deleted the library unit
    • verified via shell that the copied tags are now editable
  • I read through the code
  • I checked for accessibility issues by using my keyboard to navigate N/A
  • Includes documentation
  • User-facing strings are extracted for translation N/A

@navinkarkera navinkarkera merged commit d664f0e into openedx:master May 12, 2025
49 checks passed
@navinkarkera navinkarkera deleted the navin/minor-fix branch May 12, 2025 06:58
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions May 12, 2025
@edx-pipeline-bot
Copy link
Contributor

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

@edx-pipeline-bot
Copy link
Contributor

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

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: Done
Development

Successfully merging this pull request may close these issues.

4 participants