Skip to content

(minor) Remove usage of deprecated key types / params in libraries code [FC-0083] #36563

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

Conversation

bradenmacdonald
Copy link
Contributor

@bradenmacdonald bradenmacdonald commented Apr 21, 2025

Description

The opaque key type BundleDefinitionLocator has been deprecated for some time, with a target removal of Redwood. This PR just removes the last mention of it from edx-platform so that we can safely delete it from opaque-keys anytime after this PR has merged.

Also, we realized that the very new LibraryContainerLocator and LibraryCollectionLocator key types use library_key for the library key instead of lib_key as the (more established) LibraryUsageLocatorV2 key type does. This PR ensures that the code in edx-platform will work either way, so that we can rename the field in the new key types to lib_key for consistency.

Supporting information

As discovered in 24ec901#r155569458

Testing instructions

Ensuring that tests are passing should be enough here.

Deadline

Teak (Thursday)

Private ref: FAL-4147

@openedx-webhooks
Copy link

Thanks for the pull request, @bradenmacdonald!

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.

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Apr 21, 2025
@github-project-automation github-project-automation bot moved this to Needs Triage in Contributions Apr 21, 2025
@bradenmacdonald bradenmacdonald changed the title (minor) Remove usage of deprecated key types / params in libraries code (minor) Remove usage of deprecated key types / params in libraries code [FC-0083] Apr 21, 2025
@bradenmacdonald
Copy link
Contributor Author

@ormsbee @kdmccormick Would one of you be able to review this tiny PR and openedx/opaque-keys#377 ? It's minor but I'd like to make these key types consistent before Teak is cut.

CC @navinkarkera

@ormsbee
Copy link
Contributor

ormsbee commented Apr 22, 2025 via email

@bradenmacdonald bradenmacdonald merged commit 1ac6de2 into openedx:master Apr 22, 2025
49 checks passed
@bradenmacdonald bradenmacdonald deleted the braden/prepare-opaque-keys branch April 22, 2025 01:47
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Apr 22, 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.

1 similar comment
@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