feat: improve error responses #719
Open
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
ricellis
force-pushed
the
s1004-error-augmentation
branch
from
1030b70
to
622e14b
Compare
Create _error_response_hook function to augment error messages. Add hook to the client requests session. Unit tests for the hook.
ricellis
force-pushed
the
s1004-error-augmentation
branch
from
622e14b
to
72970cd
Compare
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.
PR summary
Add event hook for error response augmentation
Fixes: s1004
Note: An existing issue is required before opening a PR.
PR Checklist
Please make sure that your PR fulfills the following requirements:
Angular Commit Message Guidelines.
PR Type
What is the current behavior?
Cloudant/CouchDB error models are handled by the core with only the
errorfield being processed. Obtaining e.g. thereasonfield requires additional user code.What is the new behavior?
The error response is augmented with
errorsandtraceproperties.This improves the way the core handles the error response and enhances the user facing exception string to include the
reason.The
traceis the CouchDB request ID which can be used to correlate with logs.Does this PR introduce a breaking change?
The existing error model fields are retained, the new fields are backwards compatible.
Exception strings will be different, but the types remain the same.
Other information
Create _error_response_hook function to augment
error messages.
Add hook to the client requests session.
Unit tests for the hook.