Skip to content

fix: consider children blocks of unsupported blocks while analyzing course import#2684

Merged
ChrisChV merged 8 commits intoopenedx:masterfrom
open-craft:navin/fal-4267/fix-unsupported-children-analysis
Nov 25, 2025
Merged

fix: consider children blocks of unsupported blocks while analyzing course import#2684
ChrisChV merged 8 commits intoopenedx:masterfrom
open-craft:navin/fal-4267/fix-unsupported-children-analysis

Conversation

@navinkarkera
Copy link
Copy Markdown
Contributor

Description

Currently, components with children are not supported by libraries v2.

The analysis step before importing a course considers the parent block while counting unsupported blocks but does not include children in the unsupported count.

We fetch usage_keys of all unsupported blocks and fetch the children blocks that contain these usage_keys in their breadcrumb field i.e., they are part of the unsupported blocks.

Supporting information

Testing instructions

  • Create a course with some blocks and one legacy library content block that points to a library with some blocks.
  • Open any library, click on Tools > Import navbar menu item.
  • Click Import Course button.
  • Select the course and click Next.
  • Verify the course details like number of blocks etc.
  • Verify the total blocks and components count section, it should exclude the parent library_content and its children blocks as unsupported.

Other information

Include anything else that will help reviewers and consumers understand the change.

  • Does this change depend on other changes elsewhere?
  • Any special concerns or limitations? For example: deprecations, migrations, security, or accessibility.

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'

Currently, components with children are not supported by libraries v2.
The analysis step before importing a course considers the parent block
while counting unsupported blocks but does not include children in the
unsupported count.

We fetch usage_keys of all unsupported blocks and fetch the children
blocks that contain these usage_keys in their breadcrumb field i.e.,
they are part of the unsupported blocks.
@openedx-webhooks openedx-webhooks added open-source-contribution PR author is not from Axim or 2U core contributor PR author is a Core Contributor (who may or may not have write access to this repo). labels Nov 20, 2025
@openedx-webhooks
Copy link
Copy Markdown

openedx-webhooks commented Nov 20, 2025

Thanks for the pull request, @navinkarkera!

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:

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
Copy link
Copy Markdown

codecov Bot commented Nov 20, 2025

Codecov Report

❌ Patch coverage is 97.61905% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 94.85%. Comparing base (2215fc5) to head (cba454b).
⚠️ Report is 4 commits behind head on master.

Files with missing lines Patch % Lines
src/search-manager/data/apiHooks.ts 92.30% 1 Missing ⚠️
Additional details and impacted files
@@           Coverage Diff           @@
##           master    #2684   +/-   ##
=======================================
  Coverage   94.85%   94.85%           
=======================================
  Files        1232     1232           
  Lines       27863    27899   +36     
  Branches     6129     6137    +8     
=======================================
+ Hits        26429    26464   +35     
- Misses       1376     1377    +1     
  Partials       58       58           

☔ 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 navinkarkera marked this pull request as ready for review November 20, 2025 17:23
@mphilbrick211 mphilbrick211 added the FC Relates to an Axim Funded Contribution project label Nov 25, 2025
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Nov 25, 2025
@ChrisChV
Copy link
Copy Markdown
Contributor

@navinkarkera I added itembank in the unsupported blocks list here cba454b

This is to match the results of the import:

image

Copy link
Copy Markdown
Contributor

@ChrisChV ChrisChV left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good!

👍

  • I tested this: I followed the testing instructions using a course with legacy libraries and itembanks
  • I read through the code and considered the security, stability and performance implications of the changes.
  • I tested that the UI can be used with a keyboard only (tab order, keyboard controls).
  • Includes tests for bugfixes and/or features added.
  • Includes documentation

@ChrisChV ChrisChV merged commit ef36156 into openedx:master Nov 25, 2025
7 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Nov 25, 2025
@ChrisChV ChrisChV deleted the navin/fal-4267/fix-unsupported-children-analysis branch November 25, 2025 21:24
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

core contributor PR author is a Core Contributor (who may or may not have write access to this repo). FC Relates to an Axim Funded Contribution project open-source-contribution PR author is not from Axim or 2U

Projects

Archived in project

Development

Successfully merging this pull request may close these issues.

4 participants