Skip to content

fix: grading settings save button stuck in pending state#2614

Merged
bradenmacdonald merged 1 commit intoopenedx:masterfrom
mitodl:anas/fix-grading-setting-save
Nov 14, 2025
Merged

fix: grading settings save button stuck in pending state#2614
bradenmacdonald merged 1 commit intoopenedx:masterfrom
mitodl:anas/fix-grading-setting-save

Conversation

@Anas12091101
Copy link
Copy Markdown
Contributor

@Anas12091101 Anas12091101 commented Nov 11, 2025

Description

The save button on the Grading Settings page stayed in its loading state after a successful save. The effect was toggling state using stale values and watched savePending instead of savingStatus. Updated the effect to depend on savingStatus and set the UI flags explicitly (show success, hide save prompt, clear pending).

Useful information to include:

  • Which user roles will this change impact? "Course Author"
  • Include screenshots for changes to the UI (ideally, both "before" and "after" screenshots, if applicable).

Before

Screen.Recording.2025-11-11.at.8.31.29.PM.mov

After

Screen.Recording.2025-11-11.at.8.29.30.PM.mov

Supporting information

Link to other information about the change, such as GitHub issues, or Discourse discussions.
Be sure to check they are publicly readable, or if not, repeat the information here.

Testing instructions

  • On the master branch, try to update the grading page.
  • The page will keep showing the save button even after the response from the backend is received.
  • Check out this branch and verify that the page states are updated properly after the response from the backend is received.

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'

@openedx-webhooks openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Nov 11, 2025
@openedx-webhooks
Copy link
Copy Markdown

Thanks for the pull request, @Anas12091101!

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 11, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 94.84%. Comparing base (13c51ce) to head (05e9252).
⚠️ Report is 7 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master    #2614      +/-   ##
==========================================
+ Coverage   94.83%   94.84%   +0.01%     
==========================================
  Files        1231     1231              
  Lines       27627    27629       +2     
  Branches     6220     6221       +1     
==========================================
+ Hits        26199    26204       +5     
+ Misses       1357     1354       -3     
  Partials       71       71              

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

@Anas12091101 Anas12091101 moved this from Needs Triage to Ready for Review in Contributions Nov 12, 2025
} = useCourseSettings(courseId);
const {
mutate: updateGradingSettings,
isLoading: savePending,
Copy link
Copy Markdown
Contributor

@bradenmacdonald bradenmacdonald Nov 13, 2025

Choose a reason for hiding this comment

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

There is a simpler fix here.

You just need to change this line to

    isPending: savePending,

and it will work. The reason is the new version of React Query uses isPending instead of isLoading, so isLoading is actually undefined.

If you put // @ts-check on the first line, you'll see that right away:

Image

@Anas12091101 Anas12091101 force-pushed the anas/fix-grading-setting-save branch from de801f2 to 05e9252 Compare November 14, 2025 10:51
@bradenmacdonald bradenmacdonald merged commit 7cf01de into openedx:master Nov 14, 2025
7 checks passed
@github-project-automation github-project-automation Bot moved this from Ready for Review to Done in Contributions Nov 14, 2025
@bradenmacdonald
Copy link
Copy Markdown
Contributor

Thanks!

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