fix: validation and error display for due date extensions in the API #36187

efortish · 2025-01-28T16:54:02Z

Fix validation and error display for due date extensions in the API

Description

This PR addresses the issue where the API did not correctly handle and display error cases where the due_datetime field was empty or incorrectly formatted; also, the API did not correctly handle the student/email field when it does not exist. Additionally, this PR ensures that the error messages returned by the API are clear and relevant to the actual validation error encountered.
This is the fix for this issue

Changes Made

Reordered Validation Checks, moved the validation check for the student before the check of due_date to ensure that the student is validated first. This prevents misleading error messages when both fields are invalid.

Consistent Error Handling:

Ensured that all validation errors are returned using JsonResponse with a clear error key. This makes the error messages consistent and easier for the frontend to handle.

Detailed Error Message:

Added specific error message when due_datetime is empty or incorrectly formatted.
Ensure that the error message is correct when the student/email doesnt exist.
Ensured that the error message for invalid due_datetime is only returned if the student exist.

Objective

The objective of these changes was to improve the user experience by providing clear and accurate error messages when validation fails. This helps users understand what went wrong and how to correct their input.

Achievements

Improved User Feedback: Users now receive specific error messages for each validation issue, making it easier to correct their input.
Consistent Error Handling: All validation errors are handled consistently, making the API more robust and predictable.
Better Code Organization: The validation checks are now logically ordered, improving the readability and maintainability of the code.

Testing

Tested with various inputs to ensure that the correct error messages are returned for each validation failure.
Verified that the frontend correctly displays the error messages returned by the API.

How to test

In the lms, go to the Extensions section in the instructor dashboard and try different inputs, you can:

Leave all fields blank
Put an invalid student/email and the other fields filled out
Put an invalid student/email and other fields blank or some filled out
Put a valid student/email and other fields blank or some filled out
Put a valid student/email, valid graded subsection, but the due_datetime wrong

Note: Please keep in mind that the input "reason" is not required in the serializer, therefore it doesnt matter whether it is filled out or not

Screencast.from.2025-01-28.11-49-33.webm

Related Issues

PR #35392: https://github.com/openedx/edx-platform/pull/35392/files#diff-2e708ec7862cbe8e9fe138f4cde50b224d98e95f958dfc645b5ab76075035d8dR2994-R3008

openedx-webhooks · 2025-01-28T16:54:07Z

Thanks for the pull request, @efortish!

This repository is currently maintained by @openedx/wg-maintenance-edx-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.

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.

efortish · 2025-01-28T16:59:13Z

Hello @mariajgrimaldi , could you help me with the review of this PR? I will also refine the issue with some things I found.

BryanttV

Hi @efortish! Thanks for your contribution. I was testing the changes and everything works fine! I only have a few minor comments.

Remove the trailing spaces in the function. I recommend using trailing spaces extension in VSCode.
Remove the double line break in the function.

As a suggestion, It's possible to add a margin in the error message?

lms/djangoapps/instructor/views/api.py

mariajgrimaldi · 2025-02-10T21:28:45Z

lms/djangoapps/instructor/views/api.py

+        try:
+            due_date = parse_datetime(due_datetime)
+        except DashboardError:
+            return JsonResponse({'error': 'The extension due date and time format is incorrect'}, status=400)


Same suggestion here. Also, some error responses are marked for translation: https://github.com/openedx/edx-platform/blob/c9141f6f8e30c1ffcfce61c2fff1e0f19e491779/lms/djangoapps/instructor/views/api.py#L1356C40-L1356C87. Should we do that here?

Sure I will apply the same here.
About the translations I don't know if we must, I also reviewed other classes and not every single one has the mark for translation, in my opinion we should, but I would like to know your POV first.

Yes, I also think we should :)

lms/djangoapps/instructor/views/api.py

mariajgrimaldi · 2025-02-17T07:31:47Z

@efortish: thank you for addressing all my comments! Can you please review the failing checks? Thank you!

…id username

efortish · 2025-02-17T15:13:32Z

@mariajgrimaldi Hello !, It was about 2 commit with the wrong structure. Fixed

efortish added 3 commits January 27, 2025 17:53

fix: Errors are not displayed correctly in extensions tab

1343c2a

fix: Errors are not displayed correctly in extensions tab

132e742

fix: reorder student validation before due_date validation

e38c004

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

BryanttV reviewed Jan 29, 2025

View reviewed changes

mphilbrick211 added the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Jan 29, 2025

style: trailing spaces and double line break erased

c9141f6

efortish force-pushed the efortish/dev branch from 12e5359 to c9141f6 Compare January 30, 2025 15:08

mariajgrimaldi linked an issue Feb 10, 2025 that may be closed by this pull request

[Test failure] TC_INSTRUCTOR_8: Errors are not displayed correctly in extensions tab openedx/wg-build-test-release#422

Open

mariajgrimaldi mentioned this pull request Feb 10, 2025

[Test failure] TC_INSTRUCTOR_8: Errors are not displayed correctly in extensions tab openedx/wg-build-test-release#422

Open

mariajgrimaldi requested changes Feb 10, 2025

View reviewed changes

mphilbrick211 removed the needs test run Author's first PR to this repository, awaiting test authorization from Axim label Feb 11, 2025

mariajgrimaldi requested changes Feb 13, 2025

View reviewed changes

lms/djangoapps/instructor/views/api.py Outdated Show resolved Hide resolved

lms/djangoapps/instructor/views/api.py Outdated Show resolved Hide resolved

efortish added 4 commits February 17, 2025 10:09

feat: Address PR review comments about error responses

2c65f53

refactor: remove redundant status code from JsonResponseBadRequest

36777ba

style: trailling space eliminated

920410a

test: tests added for blank spaces, invalid due date format and inval…

6cdb8af

…id username

efortish force-pushed the efortish/dev branch from 85dd9d9 to 6cdb8af Compare February 17, 2025 15:10

feat: add translation markers to text strings

546e4c6

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: validation and error display for due date extensions in the API #36187

fix: validation and error display for due date extensions in the API #36187

efortish commented Jan 28, 2025 •

edited

Loading

openedx-webhooks commented Jan 28, 2025 •

edited

Loading

efortish commented Jan 28, 2025

BryanttV left a comment •

edited

Loading

mariajgrimaldi Feb 10, 2025

efortish Feb 12, 2025

mariajgrimaldi Feb 17, 2025

mariajgrimaldi commented Feb 17, 2025

efortish commented Feb 17, 2025 •

edited

Loading

fix: validation and error display for due date extensions in the API #36187

Are you sure you want to change the base?

fix: validation and error display for due date extensions in the API #36187

Conversation

efortish commented Jan 28, 2025 • edited Loading

Fix validation and error display for due date extensions in the API

Description

Objective

Achievements

Testing

How to test

Related Issues

openedx-webhooks commented Jan 28, 2025 • edited Loading

efortish commented Jan 28, 2025

BryanttV left a comment • edited Loading

Choose a reason for hiding this comment

mariajgrimaldi Feb 10, 2025

Choose a reason for hiding this comment

efortish Feb 12, 2025

Choose a reason for hiding this comment

mariajgrimaldi Feb 17, 2025

Choose a reason for hiding this comment

mariajgrimaldi commented Feb 17, 2025

efortish commented Feb 17, 2025 • edited Loading

efortish commented Jan 28, 2025 •

edited

Loading

openedx-webhooks commented Jan 28, 2025 •

edited

Loading

BryanttV left a comment •

edited

Loading

efortish commented Feb 17, 2025 •

edited

Loading