Skip to content

fix: adjust gradebook URL to correct value#38479

Open
dwong2708 wants to merge 4 commits intoopenedx:masterfrom
WGU-Open-edX:dwong2708/fix-grading-url
Open

fix: adjust gradebook URL to correct value#38479
dwong2708 wants to merge 4 commits intoopenedx:masterfrom
WGU-Open-edX:dwong2708/fix-grading-url

Conversation

@dwong2708
Copy link
Copy Markdown
Contributor

@dwong2708 dwong2708 commented Apr 29, 2026

Description

The get_gradebook_url method in CourseInformationSerializerV2 was building the gradebook URL incorrectly in two ways:

  1. It was appending a hardcoded /gradebook/ path segment, but the WRITABLE_GRADEBOOK_URL setting is already expected to include that path. The correct URL should be {WRITABLE_GRADEBOOK_URL}/{course_key}.

  2. It was reading WRITABLE_GRADEBOOK_URL directly from settings instead of going through configuration_helpers.get_value, which meant site-level configuration overrides were being ignored.

Testing instructions

  1. Set WRITABLE_GRADEBOOK_URL to the full gradebook MFE base URL including the path (e.g. http://localhost:1994/gradebook).
  2. Enable the writable gradebook waffle flag for a course.
  3. Call the CourseMetadataView API endpoint for that course.
  4. Verify the gradebook_url in the response is http://localhost:1994/gradebook/<course_key>.

Deadline

Verawood

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

openedx-webhooks commented Apr 29, 2026

Thanks for the pull request, @dwong2708!

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:

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.

@github-project-automation github-project-automation Bot moved this to Needs Triage in Contributions Apr 29, 2026
@dwong2708 dwong2708 marked this pull request as ready for review April 30, 2026 01:57
@dwong2708 dwong2708 requested a review from Copilot April 30, 2026 01:57
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR fixes how the Instructor API v2 exposes the writable Gradebook MFE URL for a course, aligning it with the expected WRITABLE_GRADEBOOK_URL format and ensuring SiteConfiguration overrides are respected.

Changes:

  • Update WRITABLE_GRADEBOOK_URL usage to stop appending a hardcoded /gradebook/ segment and instead append only /<course_key>.
  • Retrieve WRITABLE_GRADEBOOK_URL via configuration_helpers.get_value to honor site-level overrides.
  • Adjust devstack default and extend API v2 tests to validate the returned gradebook_url.

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.

File Description
lms/envs/devstack.py Updates devstack WRITABLE_GRADEBOOK_URL to include the /gradebook path segment.
lms/djangoapps/instructor/views/serializers_v2.py Fixes Gradebook URL construction and switches to SiteConfiguration-aware lookup.
lms/djangoapps/instructor/tests/test_api_v2.py Adds assertions/decorators to validate gradebook_url in course metadata response.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread lms/djangoapps/instructor/views/serializers_v2.py
Comment thread lms/djangoapps/instructor/tests/test_api_v2.py Outdated
Comment thread lms/djangoapps/instructor/views/serializers_v2.py
@dwong2708 dwong2708 force-pushed the dwong2708/fix-grading-url branch from 68d1441 to 5b0404c Compare April 30, 2026 02:35
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 Triage

Development

Successfully merging this pull request may close these issues.

3 participants