feat: return detailed error from proctoring provider - #38925
feat: return detailed error from proctoring provider#38925Anas12091101 wants to merge 2 commits into
Conversation
|
Thanks for the pull request, @Anas12091101! This repository is currently maintained by 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 approvalIf you haven't already, check this list to see if your contribution needs to go through the product review process.
🔘 Provide contextTo 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:
🔘 Get a green buildIf one or more checks are failing, continue working on your changes until this is no longer the case and your build turns green. DetailsWhere 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:
💡 As a result it may take up to several weeks or months to complete a review and merge your PR. |
Description
Resetting a proctored exam attempt from the new instructor dashboard previously failed with a generic 500 when the proctoring provider was slow/unavailable, leaving the attempt "stuck" with no explanation.
This PR updates the Instructor v2 reset endpoint (
SpecialExamResetViewinlms/djangoapps/instructor/views/api_v2.py) to catchProctoredBaseExceptionfromremove_exam_attemptand return the exception's own status + message:Now a provider failure returns a 502 with a clear
detail(e.g. "The proctoring provider is temporarily unavailable… please try again in a few minutes."), which the instructor-dashboard MFE already displays. Same pattern as the existingProctoredBaseExceptionhandling in this file.Impacted roles: Instructor/Course Staff (clear error instead of a 500), Operator (failure is now logged/typed).
Supporting information
openedx/edx-proctoring#1337, which raises the typedBackendProviderCannotRemoveAttempt(502) this view relies on.Testing instructions
Automated:
Manual (needs
edx-proctoring >= 6.1.0):base_urlat an unreachable host (or stubremove_exam_attemptto raise).{"detail": "…temporarily unavailable…"}, the message shown in the UI, attempt still present, error logged.Deadline
None, though it fixes a production-visible bug.
Other information
exceptbranch just won't trigger).