fix: apply library_content transformer to all ItemBankMixin xblocks

[MaferMazu]

Description

This PR adds logic to the library_content transformer to support all xblocks that inherit from ItemBankMixin.

Supporting information

Specific case (The problem)

When creating a Problem Bank component, the structure of the xblock doesn't match (the user can solve 3 problems of 5), in the grade the system evaluates 5 problems when only 3 are solvable for the user.

Screenshot in Studio of a Problem Bank Screenshot in LMS of the Problem Bank Screenshot in Progress inside the LMS, related to the Problem Bank

Inside

The transformer didn't remove the non-selected children from the problem bank (randomized content from a content library v2 - itembankblock in the code), so the structure shows inconsistent information (more questions/grades than the user is available to see/solve)

Solution

Adding the logic to analyze the block_class and check whether it inherits from itembankmixin. I apply the same logic as the legacy library content to all xblocks with randomized content, without removing support for the legacy libraries.

Testing instructions

Pre-requisites:

• Have a tutor environment with a master or a release greater than or equal to teak (cherry-pick the commit from this branch or use this branch if you are using master)
• Have a course, and in Settings > Scheduled & Details, verify the course start date (use an old date, for example, 2020)
• Configure grading Settings > Grading.

Test:

LegacyLibraries

1. Create a Legacy Library (in Studio, click Legacy Libraries, and then +New Library) and add some problems for testing.
2. In a course, add a subsection, and then a unit, and then a "Legacy Library" component. (configure grade to the subsection)
3. Edit the "Legacy Library" component to use the library created, and if you want, you can configure how many problems are going to show to the student.
4. Publish the content.
5. Click view live version.

Things to verify in LMS (with the live version or a student account):

• In the outline, the section shows the correct number of questions.
• In the progress page, in the detailed grades, you should only see the gradable XBlocks available.

ProblemBank

1. Create a Content Library (in Studio, click +New Library) and add some problems for testing.
2. In a course, add a subsection, and then a unit, and then a "Problem Bank" component. (configure grade to the subsection)
3. Add components to the "Problem Bank", and if you want, you can configure how many problems are going to show to the student.
4. Publish the content.
5. Click view live version.

Things to verify in LMS (with the live version or a student account):
The same from the LegacyLibraries

Another Xblock (optional)

1. Install an Xblock that inherits from ItemBankMixin (for example, https://github.com/eduNEXT-collab/xblock-exam-question-bank)
2. Activate the plugin in the course https://github.com/eduNEXT-collab/xblock-exam-question-bank?tab=readme-ov-file#enabling-the-xblock-in-a-course
3. In a course, add a subsection, and then a unit, and then an "Advanced" component, and select the custom XBlock. (configure grade to the subsection)
4. Publish the content.
5. Click view live version.

Things to verify in LMS (with the live version or a student account):
The same from the LegacyLibraries

Screenshots

Base

Problem Bank Configuration (to show 1 of 4 problems)

Before

Problem Bank in LMS (problem: in the sidebar bar, it shows we had four problems available when we have 1)

After

Problem Bank in LMS (It shows we have 1 question) ✅

Progress in LMS (In the grade details, we have the correct information) ✅

[openedx-webhooks]

Thanks for the pull request, @MaferMazu!

This repository is currently maintained by @openedx/wg-maintenance-openedx-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.

[bradenmacdonald]

Thanks for this PR! It seems like an important bug to fix, and I appreciate the clear description and diagnosis. I did some testing just now and can confirm the bugs you're seeing. I haven't tried this fix out yet, but it seems right to me.

[bradenmacdonald]

Is this just temporary code? Do we need it at all? Or is this why READ_VERSION is left at 1? If so, for how long do we need to keep this code in here? (Same question below)

[MaferMazu]

Yes, it is temporary code. I added to keep read_version at 1 (so we can use the old cache if available). If a course has an old cache, that section will execute. I added it to avoid changing the read_version to 2, which, in my understanding, forces the platform to discard all the xblock structure cache (and can cause issues in large instances).

[MaferMazu]

About how long: I found that the cache is regenerated by default every 24h, so if someone migrates to a version with this change in ~1 or 2 weeks, it should be safe to remove the fallback code. In the case of openedx I was thinking of 1 release. I added that fallback code to avoid discarding the entire xblock structure cache at once.

References:

• Cache time out: https://github.com/openedx/openedx-platform/blob/master/openedx/core/djangoapps/content/block_structure/config/models.py#L17
• More about read/write version and transformers: https://github.com/openedx/openedx-platform/blob/master/openedx/core/djangoapps/content/block_structure/transformer.py#L46

[bradenmacdonald]

Same question about this [temporary?] code.

[MaferMazu]

@bradenmacdonald, thanks for reviewing this and for your patience. I just answered your feedback. I'm attentive to further feedback. ✨