Skip to content

Commit

Permalink
Merge pull request #421 from auth0/iss-410
Browse files Browse the repository at this point in the history 
Do not cast error values to String
  • Loading branch information
@jimmyjames
jimmyjames authored Apr 19, 2022
2 parents 3a8e640 + ec24593 commit 01d92b9
Show file tree
Hide file tree
Showing 2 changed files with 106 additions and 14 deletions.
39 changes: 25 additions & 14 deletions src/main/java/com/auth0/exception/APIException.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,13 @@
@SuppressWarnings("WeakerAccess")
public class APIException extends Auth0Exception {

private static final String ERROR_DESCRIPTION = "error_description";
private static final String DESCRIPTION = "description";
private static final String MESSAGE = "message";
private static final String ERROR = "error";
private static final String ERROR_CODE = "errorCode";
private static final String CODE = "code";

private String error;
private final String description;
private final int statusCode;
Expand Down Expand Up @@ -129,11 +136,11 @@ private static String createMessage(String description, int statusCode) {
}

private static String obtainExceptionMessage(Map<String, Object> values) {
if (values.containsKey("error_description")) {
return (String) values.get("error_description");
if (values.containsKey(ERROR_DESCRIPTION)) {
return toStringOrNull(values.get(ERROR_DESCRIPTION));
}
if (values.containsKey("description")) {
Object description = values.get("description");
if (values.containsKey(DESCRIPTION)) {
Object description = values.get(DESCRIPTION);
if (description instanceof String) {
return (String) description;
} else if (description instanceof Map){
Expand All @@ -142,25 +149,29 @@ private static String obtainExceptionMessage(Map<String, Object> values) {
return policy.getDescription();
}
}
if (values.containsKey("message")) {
return (String) values.get("message");
if (values.containsKey(MESSAGE)) {
return toStringOrNull(values.get(MESSAGE));
}
if (values.containsKey("error")) {
return (String) values.get("error");
if (values.containsKey(ERROR)) {
return toStringOrNull(values.get(ERROR));
}
return "Unknown exception";
}

private static String obtainExceptionError(Map<String, Object> values) {
if (values.containsKey("errorCode")) {
return (String) values.get("errorCode");
if (values.containsKey(ERROR_CODE)) {
return toStringOrNull(values.get(ERROR_CODE));
}
if (values.containsKey("error")) {
return (String) values.get("error");
if (values.containsKey(ERROR)) {
return toStringOrNull(values.get(ERROR));
}
if (values.containsKey("code")) {
return (String) values.get("code");
if (values.containsKey(CODE)) {
return toStringOrNull(values.get(CODE));
}
return "Unknown error";
}

private static String toStringOrNull(Object obj) {
return obj != null ? obj.toString() : null;
}
}
81 changes: 81 additions & 0 deletions src/test/java/com/auth0/exception/APIExceptionTest.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
import java.util.Map;

import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.CoreMatchers.nullValue;
import static org.hamcrest.MatcherAssert.assertThat;

public class APIExceptionTest {
Expand Down Expand Up @@ -183,6 +184,86 @@ public void checkErrorTypesShouldHandleNullError() {
assertThat(apiException.isMultifactorEnrollRequired(), is(false));
assertThat(apiException.isMultifactorTokenInvalid(), is(false));
assertThat(apiException.isVerificationRequired(), is(false));
}

// error description non-string and null

@Test
public void shouldHandleNonStringMessageForMessageError() {
Map<String, Object> vals = Collections.singletonMap("error", 42);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getDescription(), is("42"));
}

@Test
public void shouldHandleNonStringMessageForMessageErrorDescription() {
Map<String, Object> vals = Collections.singletonMap("error_description", 42);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getDescription(), is("42"));
}

@Test
public void shouldHandleNonStringMessageForErrorMessageMessage() {
Map<String, Object> vals = Collections.singletonMap("message", 42);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getDescription(), is("42"));
}

@Test
public void shouldHandleNullMessageForMessageErrorDescription() {
Map<String, Object> vals = Collections.singletonMap("error_description", null);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getDescription(), is(nullValue()));
}

@Test
public void shouldHandleNullMessageForMessageVal() {
Map<String, Object> vals = Collections.singletonMap("message", null);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getDescription(), is(nullValue()));
}

@Test
public void shouldHandleNullMessageForErrorVal() {
Map<String, Object> vals = Collections.singletonMap("error", null);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getDescription(), is(nullValue()));
}

// error code non-string and null

@Test
public void shouldHandleNonStringMessageForError() {
Map<String, Object> vals = Collections.singletonMap("errorCode", 42);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getError(), is("42"));
}

@Test
public void shouldHandleNonStringMessageForErrorDescription() {
Map<String, Object> vals = Collections.singletonMap("error", 42);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getError(), is("42"));
}

@Test
public void shouldHandleNonStringMessageForMessage() {
Map<String, Object> vals = Collections.singletonMap("code", 42);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getError(), is("42"));
}

@Test
public void shouldHandleNullMessageForMessage() {
Map<String, Object> vals = Collections.singletonMap("error", null);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getError(), is(nullValue()));
}

@Test
public void shouldHandleNullMessageForError() {
Map<String, Object> vals = Collections.singletonMap("code", null);
APIException apiException = new APIException(vals, ERROR_CODE);
assertThat(apiException.getError(), is(nullValue()));
}
}

0 comments on commit 01d92b9

Please sign in to comment.