Skip to content

fix: add animation frame for submitting answers after problem reset - #303

Open
bra-i-am wants to merge 2 commits into
openedx:mainfrom
eduNEXT:bc/fix-issue-36824
Open

bra-i-am wants to merge 2 commits into
openedx:mainfrom
eduNEXT:bc/fix-issue-36824

Conversation

@bra-i-am

@bra-i-am bra-i-am commented Sep 17, 2026

Copy link
Copy Markdown

Fixes a timing bug where the Submit button remained enabled after clicking Reset on CAPA problems (SCQ, MCQ, and others).

When reset_internal receives the server response it calls render(response.html), which replaces the problem DOM via jQuery's .html(). The new HTML has no checked inputs, but browsers cache the checked state of form controls by name/id across a DOM replacement — so immediately after the swap :checked still returns true on the fresh inputs before the browser repaints. bind() runs synchronously inside render() and calls submitAnswersAndSubmitButton() right away; that function finds the inputs "checked" (stale cache), sets answered = true, and leaves the Submit button enabled.

The fix wraps a second submitAnswersAndSubmitButton() call in window.requestAnimationFrame, which defers execution until after the browser has painted the new frame. By that point the stale form state is cleared, :checked correctly returns false for all inputs, and the Submit button is disabled as expected.

Closes openedx/openedx-platform#36824

Testing instructions

  1. Start a Tutor environment with this package installed as editable.
  2. Switch the package to this branch
  3. Navigate to a course unit with a Single Choice (SCQ) or Multiple Choice (MCQ) problem.
  4. Submit an incorrect answer — the Submit button becomes enabled.
  5. Click Reset.
  6. Before: Submit button stays enabled and allows submitting with no selection.
  7. After: Submit button is immediately disabled; it only re-enables once the learner selects an option.

Screencast

Before After
Screencast.from.17-09-26.15.39.26.webm
Screencast.from.17-09-26.15.39.02.webm

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

openedx-webhooks commented Sep 17, 2026

Copy link
Copy Markdown

Thanks for the pull request, @bra-i-am!

This repository is currently maintained by @openedx/axim-engineering.

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.

@mphilbrick211 mphilbrick211 moved this from Needs Triage to Ready for Review in Contributions Sep 17, 2026
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: Ready for Review

Development

Successfully merging this pull request may close these issues.

[Test failure] <TC_AUTHOR_50>: <Reset option is not working properly for submit button in common problem components>

3 participants