Skip to content

fix: Include metadata for blocked sequence units to enable proper navigation #36891

Merged
mariajgrimaldi merged 4 commits intoopenedx:release/teakfrom
eduNEXT:KS/Backport/gatedUnits-buttons
Jun 11, 2025
Merged

fix: Include metadata for blocked sequence units to enable proper navigation #36891
mariajgrimaldi merged 4 commits intoopenedx:release/teakfrom
eduNEXT:KS/Backport/gatedUnits-buttons

Conversation

@efortish
Copy link
Contributor

Backport from #36485

Description

The original issue was that when a sequence was locked due to prerequisites, the API returned an empty items array ([]). This prevented the frontend from knowing what units were inside the locked sequence, meaning it couldn't construct the URLs correctly for navigation so the next/previous buttons stop working.

This modification ensured that even when the sequence is locked, basic metadata for each unit is included. This allows the frontend to:

  • Know how many units exist and their IDs

  • Correctly construct URLs for "Previous" and "Next" buttons

  • Still enforce access restrictions (thanks to the is_gated: True flag)

With this change, the Mfe can continue functioning normally without requiring modifications, as it now consistently receives the necessary information, regardless of whether the sequence is locked or not.

This fix can be backported.

Test cases and test instructions

2025-04-04.12-55-52.mp4

Achievements

  • Users can now navigate between sequences correctly, even when some are blocked by prerequisites.
  • The prerequisite system’s security and integrity are maintained—the actual content remains blocked.
  • No frontend modifications were needed, as the solution is compatible with the existing implementation.
  • Significant improvement in user experience, preventing students from getting "stuck" in blocked sequences.

Related issues

#36826
openedx/frontend-app-learning#1546

efortish added 2 commits June 6, 2025 14:43
…igation (openedx#36485)

The original issue was that when a sequence was locked due to prerequisites, the API returned an empty items array ([]). This prevented the frontend from knowing what units were inside the locked sequence, meaning it couldn't construct the URLs correctly for navigation so the next/previous buttons stop working.
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Jun 10, 2025
@openedx-webhooks
Copy link

Thanks for the pull request, @efortish!

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:

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.

@efortish
Copy link
Contributor Author

@mariajgrimaldi FYI!

@efortish efortish force-pushed the KS/Backport/gatedUnits-buttons branch from b4f4e3a to 6753de7 Compare June 11, 2025 18:22
@efortish efortish requested a review from mariajgrimaldi June 11, 2025 18:25
@mariajgrimaldi mariajgrimaldi merged commit 4101615 into openedx:release/teak Jun 11, 2025
47 of 48 checks passed
@github-project-automation github-project-automation bot moved this from Needs Triage to Done in Contributions Jun 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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.

3 participants