Skip to content

Handle missing array indexes in Jackson tree providers #1090

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
PHJ2000 wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Handle missing array indexes in Jackson tree providers #1090

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 5 additions & 1 deletion json-path/src/main/java/com/jayway/jsonpath/spi/json/Jackson3JsonNodeJsonProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,11 @@ public boolean isArray(Object obj) {

@Override
public Object getArrayIndex(Object obj, int idx) {
return toJsonArray(obj).get(idx);
JsonNode value = toJsonArray(obj).get(idx);
if (value == null) {
throw new IndexOutOfBoundsException("Index: " + idx);
}
return value;
}

@Override
Expand Down
6 changes: 5 additions & 1 deletion json-path/src/main/java/com/jayway/jsonpath/spi/json/JacksonJsonNodeJsonProvider.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -135,7 +135,11 @@ public boolean isArray(Object obj) {

@Override
public Object getArrayIndex(Object obj, int idx) {
return toJsonArray(obj).get(idx);
JsonNode value = toJsonArray(obj).get(idx);
if (value == null) {
throw new IndexOutOfBoundsException("Index: " + idx);
}
return value;
}

@Override
Expand Down
42 changes: 42 additions & 0 deletions json-path/src/test/java/com/jayway/jsonpath/Jackson3JsonNodeJsonProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,48 @@ public class Jackson3JsonNodeJsonProviderTest extends BaseTest {
"}" +
"]";

@Test
public void missing_array_indexes_are_not_found() {
DocumentContext context = using(JACKSON3_JSON_NODE_CONFIGURATION).parse("[1, null]");
Assertions.assertThrows(PathNotFoundException.class, () -> context.read("$[2]"));
Assertions.assertThrows(PathNotFoundException.class, () -> context.read("$[-3]"));

DocumentContext empty = using(JACKSON3_JSON_NODE_CONFIGURATION).parse("[]");
Assertions.assertThrows(PathNotFoundException.class, () -> empty.read("$[0]"));
Assertions.assertThrows(PathNotFoundException.class, () -> empty.read("$[-1]"));
}

@Test
public void existing_array_values_are_preserved() {
DocumentContext context = using(JACKSON3_JSON_NODE_CONFIGURATION).parse("[1, null]");
assertThat(context.<JsonNode>read("$[0]").intValue()).isEqualTo(1);
assertThat(context.<JsonNode>read("$[-2]").intValue()).isEqualTo(1);
assertThat(context.<JsonNode>read("$[1]").isNull()).isTrue();
assertThat(context.<JsonNode>read("$[-1]").isNull()).isTrue();
}

@Test
public void missing_array_indexes_can_be_suppressed() {
DocumentContext context = using(JACKSON3_JSON_NODE_CONFIGURATION.addOptions(Option.SUPPRESS_EXCEPTIONS))
.parse("[null]");
assertThat(context.<JsonNode>read("$[1]")).isNull();
assertThat(context.<JsonNode>read("$[0]").isNull()).isTrue();
}

@Test
public void missing_array_indexes_are_excluded_from_result_lists() {
DocumentContext context = using(JACKSON3_JSON_NODE_CONFIGURATION.addOptions(
Option.SUPPRESS_EXCEPTIONS, Option.ALWAYS_RETURN_LIST)).parse("[null]");
assertThat(context.<ArrayNode>read("$[1]").size()).isZero();
ArrayNode existing = context.read("$[0]");
assertThat(existing.size()).isEqualTo(1);
assertThat(existing.get(0).isNull()).isTrue();

ArrayNode results = using(JACKSON3_JSON_NODE_CONFIGURATION).parse("[[1], [2, null]]").read("$[*][1]");
assertThat(results.size()).isEqualTo(1);
assertThat(results.get(0).isNull()).isTrue();
}

@Test
public void json_can_be_parsed() {
ObjectNode node = using(JACKSON3_JSON_NODE_CONFIGURATION).parse(JSON_DOCUMENT).read("$");
Expand Down
42 changes: 42 additions & 0 deletions json-path/src/test/java/com/jayway/jsonpath/JacksonJsonNodeJsonProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -50,6 +50,48 @@ public class JacksonJsonNodeJsonProviderTest extends BaseTest {
"}" +
"]";

@Test
public void missing_array_indexes_are_not_found() {
DocumentContext context = using(JACKSON_JSON_NODE_CONFIGURATION).parse("[1, null]");
Assertions.assertThrows(PathNotFoundException.class, () -> context.read("$[2]"));
Assertions.assertThrows(PathNotFoundException.class, () -> context.read("$[-3]"));

DocumentContext empty = using(JACKSON_JSON_NODE_CONFIGURATION).parse("[]");
Assertions.assertThrows(PathNotFoundException.class, () -> empty.read("$[0]"));
Assertions.assertThrows(PathNotFoundException.class, () -> empty.read("$[-1]"));
}

@Test
public void existing_array_values_are_preserved() {
DocumentContext context = using(JACKSON_JSON_NODE_CONFIGURATION).parse("[1, null]");
assertThat(context.<JsonNode>read("$[0]").intValue()).isEqualTo(1);
assertThat(context.<JsonNode>read("$[-2]").intValue()).isEqualTo(1);
assertThat(context.<JsonNode>read("$[1]").isNull()).isTrue();
assertThat(context.<JsonNode>read("$[-1]").isNull()).isTrue();
}

@Test
public void missing_array_indexes_can_be_suppressed() {
DocumentContext context = using(JACKSON_JSON_NODE_CONFIGURATION.addOptions(Option.SUPPRESS_EXCEPTIONS))
.parse("[null]");
assertThat(context.<JsonNode>read("$[1]")).isNull();
assertThat(context.<JsonNode>read("$[0]").isNull()).isTrue();
}

@Test
public void missing_array_indexes_are_excluded_from_result_lists() {
DocumentContext context = using(JACKSON_JSON_NODE_CONFIGURATION.addOptions(
Option.SUPPRESS_EXCEPTIONS, Option.ALWAYS_RETURN_LIST)).parse("[null]");
assertThat(context.<ArrayNode>read("$[1]").size()).isZero();
ArrayNode existing = context.read("$[0]");
assertThat(existing.size()).isEqualTo(1);
assertThat(existing.get(0).isNull()).isTrue();

ArrayNode results = using(JACKSON_JSON_NODE_CONFIGURATION).parse("[[1], [2, null]]").read("$[*][1]");
assertThat(results.size()).isEqualTo(1);
assertThat(results.get(0).isNull()).isTrue();
}

@Test
public void json_can_be_parsed() {
ObjectNode node = using(JACKSON_JSON_NODE_CONFIGURATION).parse(JSON_DOCUMENT).read("$");
Expand Down