Expose error response json in case extra parameters are given. #885
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
joshfriend
reviewed
Oct 27, 2022
Codecov Report
@@ Coverage Diff @@
## master #885 +/- ##
=========================================
Coverage 82.92% 82.93%
Complexity 532 532
=========================================
Files 46 46
Lines 2642 2643 +1
Branches 264 264
=========================================
+ Hits 2191 2192 +1
Misses 351 351
Partials 100 100
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
SgS1312
approved these changes
Dec 4, 2022
| @@ -464,22 +464,22 @@ public static AuthorizationException byString(String error) { | |||
|
|
|||
| private static AuthorizationException generalEx(int code, @Nullable String errorDescription) { | |||
| return new AuthorizationException( | |||
| TYPE_GENERAL_ERROR, code, null, errorDescription, null, null); | |||
| TYPE_GENERAL_ERROR, code, null, errorDescription, null, null, null); | |||
| @@ -464,22 +464,22 @@ public static AuthorizationException byString(String error) { | |||
|
|
|||
| private static AuthorizationException generalEx(int code, @Nullable String errorDescription) { | |||
| return new AuthorizationException( | |||
| TYPE_GENERAL_ERROR, code, null, errorDescription, null, null); | |||
| TYPE_GENERAL_ERROR, code, null, errorDescription, null, null, null); | |||
| @@ -464,22 +464,22 @@ public static AuthorizationException byString(String error) { | |||
|
|
|||
| private static AuthorizationException generalEx(int code, @Nullable String errorDescription) { | |||
| return new AuthorizationException( | |||
| TYPE_GENERAL_ERROR, code, null, errorDescription, null, null); | |||
| TYPE_GENERAL_ERROR, code, null, errorDescription, null, null, null); | |||
| @@ -464,22 +464,22 @@ public static AuthorizationException byString(String error) { | |||
|
|
|||
| private static AuthorizationException generalEx(int code, @Nullable String errorDescription) { | |||
| return new AuthorizationException( | |||
| TYPE_GENERAL_ERROR, code, null, errorDescription, null, null); | |||
| TYPE_GENERAL_ERROR, code, null, errorDescription, null, null, null); | |||
|
Very interested in this as well. In this case, due to a Keycloak custom Authenticator returning additional non-standard fields for some error cases, which there is no way to access with the current implementation of |
pcuriel
approved these changes
Feb 8, 2024
pablo-curiel
suggested changes
Feb 8, 2024
| */ | ||
| @Nullable | ||
| public final JSONObject responseJson; | ||
|
|
||
| /** |
There was a problem hiding this comment.
Add corresponding field for serialization
// Line 142
@VisibleForTesting
static final String KEY_RESPONSE_JSON = "responseJson";| @@ -559,6 +563,7 @@ public static AuthorizationException fromJson(@NonNull JSONObject json) throws J | |||
| JsonUtil.getStringIfDefined(json, KEY_ERROR), | |||
| JsonUtil.getStringIfDefined(json, KEY_ERROR_DESCRIPTION), | |||
| JsonUtil.getUriIfDefined(json, KEY_ERROR_URI), | |||
| json, | |||
There was a problem hiding this comment.
Suggested change
| json, | |
| JsonUtil.getJsonObjectIfDefined(json, KEY_RESPONSE_JSON), |
And toJson is missing the reponseJson field serialization:
// Line 663
JsonUtil.putIfNotNull(json, KEY_ERROR_URI, errorUri);
JsonUtil.putIfNotNull(json, KEY_RESPONSE_JSON, responseJson);
return json;
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.
Checklist
Motivation and Context
We have found that some servers will return non-standard parameters along with the standard ones in their error responses, and we see a need for getting access to those parameters. To facilitate this, we would like to pass back the full original error response
JSONObjectalong in the token request callback in theAuthorizationException.Description
We held onto the original error response
JSONObjectand added it as an optional field in theAuthorizationExceptionthat is passed to the token request callback.