fix: Issue when migrating legacy libraries with large keys [FC-0107]

[ChrisChV]

Description

• Fixes Legacy libraries w/ long keys cause migration failures frontend-app-authoring#2557
• The length of purpose in StagedContent is 64 (ref). The previous code used the legacy content key. So if the library had a very long key, an error occurred. The new code uses the pk instead of the key
• Which edX user roles will this change impact? "Course Author"

Supporting information

• Github issue: Studio Libraries v2 view: add legacy migration info banner frontend-app-authoring#2169 (comment)
• This PR doesn't add the regression. That will be implemented in another PR.
• Internal ticket: FAL-4262

Testing instructions

• Create a legacy library with a large key, like: library-v1:LibraryOrganizationField_NOSPACES+LibraryCodeField_NOSPACESALLOWED
• Follow the migration flow to migrate that library
• Verify that the migration finished successfully.

Deadline

Before Ulmo Cut

Other information

N/A

[openedx-webhooks]

Thanks for the pull request, @ChrisChV!

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.

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:

• Overview of Review Process for Community Contributions
• Pull Request Status Guide
• Making changes to your pull request

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.

[rpenido]

LGTM 👍
Thank you for your work, @ChrisChV !

• I tested this using the instructions from the PR
• I read through the code
• I checked for accessibility issues
• Includes documentation

PS: I had to use a commit before 7c8020d to be able to access the page to create a new legacy library

[edschema]

Linking bug tracking issue for this work: openedx/frontend-app-authoring#2557

[bradenmacdonald]

Code looks fine, but why was the code that was there before causing the bug?

[ChrisChV]

Code looks fine, but why was the code that was there before causing the bug?

The length of purpose in StagedContent is 64 (ref). The previous code used the legacy content key. So if the library had a very long key, an error occurred. The new code uses the pk instead of the key

[bradenmacdonald]

Ah, that makes sense.