-
Notifications
You must be signed in to change notification settings - Fork 28
refactor!: use LibraryCollectionLocator and LibraryContainerLocator in event data structures [FC-0083] #487
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
refactor!: use LibraryCollectionLocator and LibraryContainerLocator in event data structures [FC-0083] #487
Conversation
The library_key can be inferred from the collection_key
|
Thanks for the pull request, @pomegranited! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
The library_key can be inferred from the container_key
5549fe4 to
d8014fe
Compare
rpenido
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
LGTM 👍
Thank you for your work, @pomegranited!
- I tested this using the CI pipeline
- I read through the code
- I checked for accessibility issues
- Includes documentation
|
Hi @mariajgrimaldi :) This PR addresses your comment on #479 (comment) Are you available to review? |
|
Hi @felipemontoya , do you have time to help get this change merged? Thank you! |
navinkarkera
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@pomegranited Looks good! 👍
- I tested this: (Verified tests locally)
- I read through the code
- I checked for accessibility issues
- Includes documentation
Description
Refactors the LibraryCollectionData and LibraryContainerData structures to use LibraryCollectionLocator and LibraryContainerLocator keys, respectively, instead of passing
library_key+ string key representation.We also remove the
library_keyfrom these data structures -- the library_key can be inferred from the opaque key, so it is redundant to pass them separately.This refactoring seems reasonable to do without going through deprecation, given the minimal use of these data structures.
Supporting information
cf #479 (comment)
Blocks: openedx/openedx-platform#36476
Private-ref: FAL-4120
Testing instructions
Code review + CI should be sufficient to verify this change.
Deadline
ASAP -- would like to get this in before Teak
Checklists
Check off if complete or not applicable:
Merge Checklist:
Documentation updated (not only docstrings)N/AFixup commits are squashed awayN/APost Merge:
finished.