feat: REST_API to get MAX_BLOCKS_PER_CONTENT_LIBRARY [FC-0112]

[ChrisChV]

Description

• Adds REST_API to get MAX_BLOCKS_PER_CONTENT_LIBRARY
• Which edX user roles will this change impact? "Developer"

Supporting information

• Github issue: Import analysis + start import button frontend-app-authoring#2525 (comment)
• Used in: refactor: Use preview migration API & feat: Block import when the import would exceed the block limit [FC-0112] frontend-app-authoring#2700
• Internal ticket: FAL-4282

Testing instructions

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

Deadline

"None"

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.

[navinkarkera]

@ChrisChV Looks good. I wonder if there is a way to include MAX_BLOCKS_PER_CONTENT_LIBRARY setting in MFE_CONFIG, then we can directly access it in the frontend without needing another API.

[ChrisChV]

@ChrisChV Looks good. I wonder if there is a way to include MAX_BLOCKS_PER_CONTENT_LIBRARY setting in MFE_CONFIG, then we can directly access it in the frontend without needing another API.

I haven't found a good way to do this. It can be done in tutor-mfe, but it would be very dependent on the tutor plugin. With this REST_API, I wanted to remove any such dependencies.

[bradenmacdonald]

I think I would prefer to add max_blocks to the per-library metadata endpoint, rather than creating a new endpoint. For now, it is always the same limit for every library, but we can still put it there, and it will save a REST API query because that data is usually already loaded on the frontend.

But on the other hand, I would prefer that we don't have this information on the frontend at all. Is it not possible to do some kind of "preview import" REST request with the parameters of the import, and have the backend return warnings/errors if the import is going to fail for some reason like this? (would exceed the block limit, user doesn't have write permissions on that library, etc.)

---

You don't have to refactor it to be this way, but that's what I would have suggested.

[ChrisChV]

Closed in favor of #37818