Skip to content

Conversation

@pomegranited
Copy link
Contributor

@pomegranited pomegranited commented Apr 4, 2025

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_key from 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:

  • All reviewers approved
  • Reviewer tested the code following the testing instructions
  • CI build is green
  • Version bumped
  • Changelog record added with short description of the change and current date
  • Documentation updated (not only docstrings) N/A
  • Integration with other services reviewed
  • Fixup commits are squashed away N/A
  • Unit tests added/updated
  • Noted any: Concerns, dependencies, migration issues, deadlines, tickets

Post Merge:

  • Create a tag
  • Create a release on GitHub
  • Check new version is pushed to PyPI after tag-triggered build is
    finished.
  • Delete working branch (if not needed anymore)
  • Upgrade the package in the Open edX platform requirements (if applicable)

The library_key can be inferred from the collection_key
@openedx-webhooks
Copy link

openedx-webhooks commented Apr 4, 2025

Thanks for the pull request, @pomegranited!

This repository is currently maintained by @openedx/hooks-extension-framework.

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.

@pomegranited pomegranited force-pushed the jill/container-collection-keys branch from 5549fe4 to d8014fe Compare April 4, 2025 03:56
@pomegranited pomegranited marked this pull request as ready for review April 4, 2025 03:58
@pomegranited pomegranited requested review from a team and rpenido April 4, 2025 03:59
Copy link
Contributor

@rpenido rpenido left a 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

@mphilbrick211 mphilbrick211 moved this from Needs Triage to In Eng Review in Contributions Apr 7, 2025
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Apr 7, 2025
@pomegranited
Copy link
Contributor Author

Hi @mariajgrimaldi :) This PR addresses your comment on #479 (comment)

Are you available to review?

@pomegranited
Copy link
Contributor Author

Hi @felipemontoya , do you have time to help get this change merged? Thank you!

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 Looks good! 👍

  • I tested this: (Verified tests locally)
  • I read through the code
  • I checked for accessibility issues
  • Includes documentation

@navinkarkera navinkarkera merged commit 7bcc56b into openedx:main Apr 11, 2025
11 checks passed
@github-project-automation github-project-automation bot moved this from In Eng Review to Done in Contributions Apr 11, 2025
@pomegranited pomegranited deleted the jill/container-collection-keys branch April 11, 2025 07:55
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

5 participants