Skip to content

feat: Only return the grades tab in CCX if gradebook is enabled - #39164

Open
brianjbuck-wgu wants to merge 1 commit into
openedx:masterfrom
WGU-Open-edX:feature/39148-ccx-student-grades-tab-gating
Open

brianjbuck-wgu wants to merge 1 commit into
openedx:masterfrom
WGU-Open-edX:feature/39148-ccx-student-grades-tab-gating

Conversation

@brianjbuck-wgu

@brianjbuck-wgu brianjbuck-wgu commented Sep 29, 2026 •

Copy link
Copy Markdown
Contributor

Description

The CCX Coach v2 metadata endpoint shows the student_grades tab unconditionally. CCX_COACH_TABS in lms/djangoapps/ccx/api/v2/serializers.py was a static tuple, so the tab was returned even when the gradebook it depends on is not available.

The Student Grades experience is backed by the writable gradebook. When either is missing, the Instructor Dashboard MFE still rendered the Student Grades tab that could not work.

Supporting information

Issue: #39148

Testing instructions

Manual:

  1. Enable CUSTOM_COURSES_EDX, set enable_ccx: true on the course, act as the CCX Coach, and create a CCX.
  2. With grades.writable_gradebook disabled, GET /api/ccx_coach/v2/courses/<ccx_id>/metadata → tabs contains enrollments, schedule, grading_policy and not student_grades.
  3. Enable grades.writable_gradebook for the CCX key (ccx-v1:...) and ensure WRITABLE_GRADEBOOK_URL is set → student_grades now appears.
  4. Enable the flag but unset WRITABLE_GRADEBOOK_URL → the tab is absent again.
  5. Confirm the other three tabs and their sort_order values are unchanged in all cases.

Deadline

None

Other information

  • No migrations

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Sep 29, 2026
@openedx-webhooks

openedx-webhooks commented Sep 29, 2026 •

Copy link
Copy Markdown

Thanks for the pull request, @brianjbuck-wgu!

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

@brianjbuck-wgu
brianjbuck-wgu marked this pull request as ready for review September 29, 2026 21:50
@mphilbrick211 mphilbrick211 added mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). needs reviewer assigned PR needs to be (re-)assigned a new reviewer labels Sep 29, 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

mao-onboarding Reviewing this will help onboard devs from an Axim mission-aligned organization (MAO). needs reviewer assigned PR needs to be (re-)assigned a new reviewer open-source-contribution PR author is not from Axim or 2U

Projects

Status: Ready for Review

Development

Successfully merging this pull request may close these issues.

3 participants