Simplify default error message #1662
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## master #1662 +/- ##
============================================
- Coverage 70.32% 70.32% -0.01%
Complexity 2017 2017
============================================
Files 254 254
Lines 7920 7919 -1
Branches 746 746
============================================
- Hits 5570 5569 -1
Misses 2070 2070
Partials 280 280 ☔ View full report in Codecov by Sentry. |
|
I certainly don't have all of the context here, so @shubham1g5 if you or you know of anyone else who has thoughts on this, feel free to ping them. It seems ideal to make a change like this. |
shubham1g5
reviewed
Jan 21, 2025
| @@ -268,8 +268,7 @@ private SubmitResponseBean processFormXml(FormSubmissionContext context) throws | |||
| } catch (HttpClientErrorException e) { | |||
| return getErrorResponse( | |||
| context.getHttpRequest(), Constants.SUBMIT_RESPONSE_ERROR, | |||
| String.format("Form submission failed with error response: %s, %s, %s", | |||
| e.getMessage(), e.getResponseBodyAsString(), e.getResponseHeaders()), | |||
| String.format("Form submission failed with error response: %s", e.getResponseBodyAsString()), | |||
There was a problem hiding this comment.
agree that it will be helpful to have response code here when the reponse body is empty.
There was a problem hiding this comment.
Cool updated to use getMessage which appears to include the status code in testing.
shubham1g5
approved these changes
Jan 21, 2025
shubham1g5
approved these changes
Jan 23, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Product Description
This results in the following difference:
vs
Technical Summary
The first example doesn't seem ideal to display to users. I believe
getResponseBodyAsStringshould be sufficient to display the error to the user with enough information to take action or get help.Safety Assurance
Safety story
This only impacts general errors on form submissions. I would assume that if a typical user comes across an error like this, they would be overwhelmed and potentially not even see the useful part of the message.
The risk is that we return errors with empty messages, in which case it will render like this:
Perhaps including the http status code at the very least would be helpful in the event the user receives an empty error message and reports it to us.
Automated test coverage
QA Plan
Special deploy instructions
Rollback instructions
Review