Skip to content

fix: handle missing learning sequences outline in course navigation API - #39268

Open
BhargavBhalodiya04 wants to merge 2 commits into
openedx:masterfrom
BhargavBhalodiya04:fix/course-home-navigation-500-fallback
Open

BhargavBhalodiya04 wants to merge 2 commits into
openedx:masterfrom
BhargavBhalodiya04:fix/course-home-navigation-500-fallback

Conversation

@BhargavBhalodiya04

Copy link
Copy Markdown

Description

Fixes an unhandled CourseOutlineData.DoesNotExist (or LearningContext.DoesNotExist) exception in CourseNavigationBlocksView.filter_inaccessible_blocks() which causes GET /api/course_home/v1/navigation/<course_key> to respond with an HTTP 500 server error during the window between a course publish and when the CMS worker finishes writing the learning sequences outline to the database.

When the learning sequences outline is not yet available, this change catches CourseOutlineData.DoesNotExist and gracefully returns the course blocks without filtering rather than failing with a 500 error, mirroring the fallback behavior used by OutlineTabView.

Fixes #39116

Supporting information

Testing instructions

  1. Call GET /api/course_home/v1/navigation/<course_key> for a course where the learning sequences outline does not exist in the database (e.g. immediately after a publish before the CMS worker task runs).
  2. Verify that the endpoint returns HTTP 200 with the course navigation block tree (unfiltered) instead of HTTP 500.

Deadline

None

AI Disclosure

This PR was prepared with AI assistance (Claude Code) and reviewed and verified by the contributor.

🤖 Generated with Claude Code

Co-Authored-By: Claude Code <noreply@anthropic.com>
Signed-off-by: Bhargav Bhalodiya <bhargav@example.com>
@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Oct 21, 2026
@openedx-webhooks

Copy link
Copy Markdown

Thanks for the pull request, @BhargavBhalodiya04!

This repository is currently maintained by @openedx/wg-maintenance-openedx-platform-oncall.

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
🔘 Submit a signed contributor agreement (CLA)

⚠️ We ask all contributors to the Open edX project to submit a signed contributor agreement or indicate their institutional affiliation.
Please see the CONTRIBUTING file for more information.

If you've signed an agreement in the past, you may need to re-sign.
See The New Home of the Open edX Codebase for details.

Once you've signed the CLA, please allow 1 business day for it to be processed.
After this time, you can re-run the CLA check by adding a comment below that you have signed it.
If the CLA check continues to fail, you can tag the @openedx/cla-problems team in a comment for further assistance.

🔘 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.

@mphilbrick211

Copy link
Copy Markdown

Hi and welcome, @BhargavBhalodiya04! In order for your CLA check to turn green, you'll need to submit a CLA form. If you are contributing as an individual, please fill out the individual CLA form here.

If you are contributing on behalf of an organization, please have your manager reach out to oscm@axim.org so you may be added to your org's existing entity agreement.

Please let me know if you have any questions. Thanks!

@mphilbrick211 mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Oct 22, 2026
@mphilbrick211 mphilbrick211 moved this from Needs Triage to Needs Tests Run or CLA Signed in Contributions Oct 22, 2026
@mphilbrick211 mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Oct 27, 2026

This branch has not been deployed

No deployments
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

Status: Needs Tests Run or CLA Signed

Development

Successfully merging this pull request may close these issues.

Bug: course_home/v1/navigation 500s until the CMS worker rewrites the learning_sequences outline

4 participants