fix: Unfinished migration on fail in one legacy library [FC-0107]

[ChrisChV]

Description

• Fix the issue described in Studio Libraries v2 view: add legacy migration info banner frontend-app-authoring#2169 (comment)
• Adds is_failed field to migrations.
• Adds the logic of partial migration: If the import of a library fails, then mark it as failed and continue with the next library.
• Which edX user roles will this change impact? "Course Author".

Supporting information

• The use of a general transaction was avoided, as it had previously been ruled out as a potential memory hazard.
• Used in feat: Add error messages for partial migration [FC-0107] frontend-app-authoring#2555
• Github issue: Studio Libraries v2 view: add legacy migration info banner frontend-app-authoring#2169 (comment)
• Internal ticket: FAL-4262

Testing instructions

Follow the testing instructions in openedx/frontend-app-authoring#2555

Deadline

ASAP

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 openedx/frontend-app-authoring/pull/2555
• I read through the code
• I checked for accessibility issues
• Includes documentation

This is working as expected, but can't we just use the task_status field with UserTaskStatus.FAILED instead of creating a new is_failed field?

[ChrisChV]

This is working as expected, but can't we just use the task_status field with UserTaskStatus.FAILED instead of creating a new is_failed field?

The UserTaskStatus represents the status of the entire bulk migration; a FAILED status means that the entire bulk migration has failed. Each ModulestoreMigration saves the data of the migration of each legacy library. I added is_failed to keep track a failed legacy library (like the large keys), but allow continuing with the migration of the rest of the libraries.

I did the above to fix the error where items from other libraries were being created, but the migration was cut off when the error occurred with the library with a long key, and it didn't finish creating/organizing the data into collections.

The other option was full migration regression, but using a transaction was something that was ruled out, and doing a manual regression would be very complex to do.

[bradenmacdonald]

The UserTaskStatus represents the status of the entire bulk migration; a FAILED status means that the entire bulk migration has failed. Each ModulestoreMigration saves the data of the migration of each legacy library. I added is_failed to keep track a failed legacy library (like the large keys), but allow continuing with the migration of the rest of the libraries.

@ChrisChV Could you please include this information/explanation as a comment near the new is_failed field?

Conditional approval if you add an explanation into the code itself :)