refactor: Use preview migration API & feat: Block import when the import would exceed the block limit [FC-0112]

[ChrisChV]

Description

• Use the new preview migration API implemented in feat: Preview migration api [FC-0114] edx-platform#37818
• Clean the code for the preview.
• Implements the commented in Import analysis + start import button #2525 (comment)
• Which user roles will this change impact? "Course Author"

Supporting information

• Github issue: Import analysis + start import button #2525 (comment)
• Depends on: feat: Preview migration api [FC-0114] edx-platform#37818
• Internal ticket: FAL-4282

Testing instructions

Refactor

• Use this edx-platform branch: feat: Preview migration api [FC-0114] edx-platform#37818
• Go to a library home of a library
• Go to the Import meny
• Import a course without unsupported blocks. Verify the preview summary
• Import a course with unsupported blocks. Verify the preview summary.
• Import a course with unsupported blocks with children. Verify the preview summary, and verify that the unsupported children are not included in the summary.

Blocks limit

• Use this edx-platform branch: feat: Preview migration api [FC-0114] edx-platform#37818
• Update the settings MAX_BLOCKS_PER_CONTENT_LIBRARY to a lower value, like 20
• Create a course with a Unit with more blocks that the limit.
• Go to a library home of a library
• Go to the Import menu
• Import the new created course
• In the summary step verify that the import is blocked

Other information

N/A

Best Practices Checklist

We're trying to move away from some deprecated patterns in this codebase. Please
check if your PR meets these recommendations before asking for a review:

• Any new files are using TypeScript (.ts, .tsx).
• Avoid propTypes and defaultProps in any new or modified code.
• Tests should use the helpers in src/testUtils.tsx (specifically initializeMocks)
• Do not add new fields to the Redux state/store. Use React Context to share state among multiple components.
• Use React Query to load data from REST APIs. See any apiHooks.ts in this repo for examples.
• All new i18n messages in messages.ts files have a description for translators to use.
• Avoid using ../ in import paths. To import from parent folders, use @src, e.g. import { initializeMocks } from '@src/testUtils'; instead of from '../../../../testUtils'

[openedx-webhooks]

Thanks for the pull request, @ChrisChV!

This repository is currently maintained by @bradenmacdonald.

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.

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.95%. Comparing base (38dfb68) to head (445d538).

Additional details and impacted files

@@           Coverage Diff           @@
##           master    #2700   +/-   ##
=======================================
  Coverage   94.95%   94.95%           
=======================================
  Files        1245     1245           
  Lines       28637    28648   +11     
  Branches     6511     6520    +9     
=======================================
+ Hits        27193    27204   +11     
  Misses       1373     1373           
  Partials       71       71           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
• 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

[navinkarkera]

@ChrisChV The limit is applicable to the whole number of blocks in the library, so we need to consider: the current number of blocks in the library + total number of blocks in the imported course (Including the sections, subsections & units). And then exclude the number from Total Blocks section as we don't know if the components will be excluded or the containers. Maybe also include a line in the alert above saying something like the library being close to limit of total number of blocks and the import will be stopped when it is crossed.

[ChrisChV]

The limit is applicable to the whole number of blocks in the library, so we need to consider: the current number of blocks in the library + total number of blocks in the imported course (Including the sections, subsections & units)

@navinkarkera Yes, you are right. I was confused to see that MAX_BLOCKS_PER_CONTENT_LIBRARY was not checked when creating containers. I created #2707 to fix that.

The limit is applicable to the whole number of blocks in the library, so we need to consider: the current number of blocks in the library + total number of blocks in the imported course (Including the sections, subsections & units). And then exclude the number from Total Blocks section as we don't know if the components will be excluded or the containers. Maybe also include a line in the alert above saying something like the library being close to limit of total number of blocks and the import will be stopped when it is crossed.

@edschema @sdaitzman Reaching the item limit in the library has become a special case, so before we continue, I'd like to ask you what it should look like. In summary, the following changes are proposed:

• Exclude the number of items that will not be imported from the Total Blocks count. We won't know if they are containers or components until after the migration.
  • Q: After the migration, we know if they are containers or components. How should the summary in the import details page look when a container is not imported?
• A text in the alert explaining this case.

Another option that occurred to me while writing the above is to completely block the import if the limit is reached, because: (1) how complex this case can become, (2) after that import, it will not be possible to create or make other imports in the library. What do you think?

[ChrisChV]

Hi @edschema @sdaitzman, friendly reminder for this question #2700 (comment)

[edschema]

Thanks for the ping @ChrisChV, I'll look this over and check in with the team..!

[edschema]

Hi @ChrisChV, if the import will cause the library to reach the limit, we should block the import and message accordingly. We will have to add documentation at a later point that describes content support (which blocks are supported vs not) and limitations to content libraries.

[ChrisChV]

I updated this mock in this way because an issue that renders the component twice

[navinkarkera]

@ChrisChV Nice work! 👍

• I tested this: Verified limits locally.
• I read through the code
• I checked for accessibility issues
• Includes documentation