fix: Disable file buttons when actions in progress #2319

samuelallan72 · 2025-08-04T08:10:39Z

In the student view "Your Response" section,
there were several race conditions and issues relating to file uploads:

Selecting the file input while multiple file uploads are in progress
results in broken uploaded files ("undefined" description and not actually uploaded to the backend) and inconsistent UI (the upload staging area where you can enter a description gets out of sync with reality).
A file can be deleted after clicking Submit,
while the submission is still processing.
Clicking "Upload files" again after successfully uploading files,
but before selecting more files,
results in an attempt to upload the same files again.

On a high speed network connection,
the race condition issues are not very noticeable,
but on a slower connection,
they are easy to trigger as there is more time
in the UI while processing is happening in the backend.

What changed?

These changes fix the above issues by ensuring that the buttons
and other input fields relating to file uploads
are disabled while actions are in progress
(uploading, deleting, submitting).

screenshots of the disabled UI while actions are processing

Note: I haven't written any new tests; please let me know what level of unit/functional tests are required here.

Developer Checklist

Reviewed the release process
Translations and JS/SASS compiled
Bumped version number in openassessment/__init__.py and package.json

Testing Instructions

Set up a devstack with this branch of ora2, create an ora2 assessment that allows multiple file uploads in a course, and navigate to the student view as a learner.
Use your browser's dev tools to throttle the network speed so you have time while actions are being processed to confirm fields are disabled during processing.
Click the "Browse" or "Choose files" button to select a file.
Don't enter a description, and click the "Upload files" button.
Verify the file does not get uploaded. You should see an error message about a missing description.
Verify that the file input field, the upload files button, and the submit assessment button remain enabled (hereafter referred to as "the fields"). They may be disabled for a moment as the form is being validated - this is expected.
Upload a file: select a file, enter a description, click "Upload files"
While the file is being uploaded (after clicking "Upload files", and before the files display in the uploaded section), verify that the fields are disabled.
Once the upload is complete, verify the fields are enabled again.
Without selecting any other fields first, click the "Upload files" button again.
Verify there is an error message "No files selected for upload.", and that no new files appear below.
Upload multiple files: select multiple files, enter a description for the files, click "Upload files"
While the files are being uploaded, verify the fields are disabled.
Once the upload is complete, verify the fields are enabled again.
Verify the uploaded files all display the description you entered - none should show "undefined".
Click the "Delete" button to delete a file.
While the file is being deleted, verify the fields are disabled.
Once the file is deleted verify the fields are enabled again.
Click the "Submit your response..." button.
Verify the fields are disabled (you can just see through the dimmed background behind the confirmation dialog).
Click the "Cancel" button on the confirmation dialog.
Verify the fields are enabled again.
Click the "Submit your response..." button again.
Click the "OK" button on the confirmation dialog.
Verify the fields remain disabled until the submission completes.

The above steps will help confirm the logic for disabling and re-enabling the form fields are working. However, also feel free to play around with the ui relating to file uploads, trying to break it - check for edge cases I may have missed.

Reviewer Checklist

Collectively, these should be completed by reviewers of this PR:

I've done a visual code review
I've tested the new functionality

FYI: @openedx/content-aurora

Private-ref: https://tasks.opencraft.com/browse/BB-9938

openedx-webhooks · 2025-08-04T08:10:43Z

Thanks for the pull request, @samuelallan72!

This repository is currently maintained by @openedx/2u-aurora.

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.

🔘 Update the status of your PR

Your PR is currently marked as a draft. After completing the steps above, update its status by clicking "Ready for Review", or removing "WIP" from the title, as appropriate.

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 · 2025-08-04T08:25:44Z

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 95.29%. Comparing base (3e4bf88) to head (4f03bc4).
⚠️ Report is 4 commits behind head on master.

Additional details and impacted files

@@            Coverage Diff             @@
##           master    #2319      +/-   ##
==========================================
- Coverage   95.29%   95.29%   -0.01%     
==========================================
  Files         195      195              
  Lines       21664    21663       -1     
  Branches     1509     1509              
==========================================
- Hits        20644    20643       -1     
  Misses        771      771              
  Partials      249      249

Flag	Coverage Δ
unittests	`95.29% <100.00%> (-0.01%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

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

In the student view "Your Response" section, there were several race conditions and issues relating to file uploads: - Selecting the file input while multiple file uploads are in progress results in broken uploaded files and inconsistent UI. - A file can be deleted after clicking Submit, while the submission is still processing. - Clicking "Upload files" again after successfully uploading files, but before selecting more files, results in an attempt to upload the same files again. On a high speed network connection, the race condition issues are not very noticeable, but on a slower connection, they are easy to trigger as there is more time in the UI while processing is happening in the backend. These changes fix the above issues by ensuring that the buttons and other input fields relating to file uploads are disabled while actions are in progress (uploading, deleting, submitting). Private-ref: https://tasks.opencraft.com/browse/BB-9938

kaustavb12

@samuelallan72

I think we should add a few tests here, to make sure the buttons are disabled when they should be.

openassessment/xblock/static/js/src/lms/oa_response.js

openassessment/xblock/static/js/src/lms/oa_staff_area.js

samuelallan72 · 2025-08-13T00:40:48Z

openassessment/xblock/static/js/spec/lms/oa_response.js

+      expect(view.baseView.buttonEnabled('.step--response__submit')).toBe(expectedEnabled);
+      expect(view.baseView.buttonEnabled('.step--response .file__upload')).toBe(expectedEnabled);
+      expect(view.baseView.buttonEnabled('.step--response .delete__uploaded__file')).toBe(expectedEnabled);
+      expect(view.baseView.buttonEnabled('.step--response .submission__answer__upload')).toBe(expectedEnabled);


@kaustavb12 this is a bit brittle because it repeats logic from the actual code. I'm not sure how to improve the test for this though.

I'm also not sure how to add more tests to cover the case where a file deletion is processing or image upload is processing. 🤔

I see some test cases already present, which deal with uploads and deletes. You can perhaps use those as reference.

Unfortunately these weren't helpful in the end - they are directly calling upload functions and such. I've spent some time today trying to figure out some tests, but haven't got far. 😞

Do you know of ways to help with writing tests? Are there ways to live-debug, or view the UI in a headed browser while the tests are running?

Ok, I've figured some things out and making progress now. :)

I've added a WIP test. Any feedback appreciated. :) I'll plan to keep working on tests tomorrow; I should make quicker progress now that I've figured out my environment and a workflow for running and debugging the tests.

@kaustavb12 I've added tests that should somewhat cover the changed behaviour here. Ready for review again. :)

so that all the tests run

itsjeyd · 2025-10-08T08:14:46Z

@samuelallan72 Since this work is currently paused, could you mark the PR as draft please?

samuelallan72 · 2025-10-08T08:50:24Z

@itsjeyd sure, can do 👍

openedx-webhooks added the open-source-contribution PR author is not from Axim or 2U label Aug 4, 2025

openedx-webhooks added this to Contributions Aug 4, 2025

github-project-automation bot moved this to Needs Triage in Contributions Aug 4, 2025

samuelallan72 force-pushed the fix-upload-races branch from 9d02ecd to 9ee35b9 Compare August 5, 2025 06:25

samuelallan72 changed the title ~~WIP: fix: disable file buttons while upload in progress~~ fix: Disable file buttons when actions in progress Aug 5, 2025

samuelallan72 force-pushed the fix-upload-races branch from 9ee35b9 to e35ba27 Compare August 5, 2025 06:54

samuelallan72 force-pushed the fix-upload-races branch from e35ba27 to c8e47f1 Compare August 5, 2025 06:56

samuelallan72 marked this pull request as ready for review August 5, 2025 07:19

itsjeyd requested a review from kaustavb12 August 8, 2025 08:48

itsjeyd moved this from Needs Triage to Waiting on Author in Contributions Aug 8, 2025

kaustavb12 suggested changes Aug 12, 2025

View reviewed changes

openassessment/xblock/static/js/src/lms/oa_response.js Outdated Show resolved Hide resolved

openassessment/xblock/static/js/src/lms/oa_staff_area.js Show resolved Hide resolved

refactor: switch to existing buttonEnabled helper

bd717ac

samuelallan72 force-pushed the fix-upload-races branch from abd05fe to bd717ac Compare August 13, 2025 00:39

samuelallan72 commented Aug 13, 2025

View reviewed changes

samuelallan72 added 7 commits August 13, 2025 11:14

temp: debug failing test

4bf4777

temp: debug failing test

dcb0b93

fix: fix broken test

684fe13

test: add test for disabling form fields

4ef7c95

test: add more tests

c40ebb5

chore: rebuild

15157cc

test: unfocus the new tests

4f03bc4

so that all the tests run

samuelallan72 self-assigned this Sep 9, 2025

samuelallan72 marked this pull request as draft October 8, 2025 08:50

samuelallan72 mentioned this pull request Nov 4, 2025

fix: ignore deleted files in submissions openedx/frontend-app-ora-grading#457

Draft

fix: Disable file buttons when actions in progress #2319

Are you sure you want to change the base?

fix: Disable file buttons when actions in progress #2319

Uh oh!

Conversation

samuelallan72 commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

openedx-webhooks commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

codecov bot commented Aug 4, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Codecov Report

Uh oh!

kaustavb12 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

samuelallan72 Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

samuelallan72 Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

kaustavb12 Aug 13, 2025

Choose a reason for hiding this comment

Uh oh!

samuelallan72 Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

samuelallan72 Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

samuelallan72 Aug 14, 2025

Choose a reason for hiding this comment

Uh oh!

samuelallan72 Aug 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

itsjeyd commented Oct 8, 2025

Uh oh!

samuelallan72 commented Oct 8, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

4 participants

samuelallan72 commented Aug 4, 2025 •

edited

Loading

openedx-webhooks commented Aug 4, 2025 •

edited

Loading

codecov bot commented Aug 4, 2025 •

edited

Loading

samuelallan72 Aug 15, 2025 •

edited

Loading