Skip to content

Fix cascading deserialization Spring Data's Page by setting @JsonIgnoreProperties(ignoreUnknown = true) #653

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

Merged
merged 1 commit into from
Jan 14, 2022
Merged

Fix cascading deserialization Spring Data's Page by setting @JsonIgnoreProperties(ignoreUnknown = true) #653

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
10 changes: 6 additions & 4 deletions ...ign-core/src/main/java/org/springframework/cloud/openfeign/support/PageJacksonModule.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,7 @@

import com.fasterxml.jackson.annotation.JsonAlias;
import com.fasterxml.jackson.annotation.JsonIgnore;
import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import com.fasterxml.jackson.annotation.JsonProperty;
import com.fasterxml.jackson.core.Version;
import com.fasterxml.jackson.databind.Module;
Expand Down Expand Up @@ -59,6 +60,7 @@ public void setupModule(SetupContext context) {
}

@JsonDeserialize(as = SimplePageImpl.class)
@JsonIgnoreProperties(ignoreUnknown = true)
private interface PageMixIn {

}
Expand Down Expand Up @@ -86,7 +88,7 @@ static class SimplePageImpl<T> implements Page<T> {
}
}

@JsonIgnore
@JsonProperty
@Override
public int getTotalPages() {
return delegate.getTotalPages();
Expand All @@ -110,7 +112,7 @@ public int getSize() {
return delegate.getSize();
}

@JsonIgnore
@JsonProperty
@Override
public int getNumberOfElements() {
return delegate.getNumberOfElements();
Expand All @@ -134,13 +136,13 @@ public Sort getSort() {
return delegate.getSort();
}

@JsonIgnore
@JsonProperty
@Override
public boolean isFirst() {
return delegate.isFirst();
}

@JsonIgnore
@JsonProperty
@Override
public boolean isLast() {
return delegate.isLast();
Expand Down
61 changes: 57 additions & 4 deletions ...ore/src/test/java/org/springframework/cloud/openfeign/support/PageJacksonModuleTests.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,10 @@ public void serializeAndDeserializeEmpty() throws JsonProcessingException {
@Test
public void serializeAndDeserializeFilledMultiple() throws JsonProcessingException {
// Given
ArrayList<Object> strings0 = new ArrayList<>();
strings0.add("first element");
strings0.add("second element");
PageImpl<Object> objects = new PageImpl<>(strings0, PageRequest.of(6, 2), 100);
ArrayList<Object> pageElements = new ArrayList<>();
pageElements.add("first element");
pageElements.add("second element");
PageImpl<Object> objects = new PageImpl<>(pageElements, PageRequest.of(6, 2), 100);
assertThat(objects.getContent()).hasSize(2);
assertThat(objects.getPageable().getPageSize()).isEqualTo(2);

Expand All @@ -102,4 +102,57 @@ public void serializeAndDeserializeFilledMultiple() throws JsonProcessingExcepti
assertThat(result.getPageable().getPageNumber()).isEqualTo(6);
}

@Test
public void serializeAndDeserializeEmptyCascade() throws JsonProcessingException {
// Given
PageImpl<Object> objects = new PageImpl<>(new ArrayList<>());
String pageJson = objectMapper.writeValueAsString(objects);
// When
Page<?> result = objectMapper.readValue(pageJson, Page.class);
// Then
assertThat(result).isNotNull();
assertThat(result.getTotalElements()).isEqualTo(0);
assertThat(result.getContent()).hasSize(0);

String cascadedPageJson = objectMapper.writeValueAsString(result);
Page<?> cascadedResult = objectMapper.readValue(cascadedPageJson, Page.class);
assertThat(cascadedResult).isNotNull();
assertThat(cascadedResult.getTotalElements()).isEqualTo(0);
assertThat(cascadedResult.getContent()).hasSize(0);
}

@Test
public void serializeAndDeserializeFilledMultipleCascade() throws JsonProcessingException {
// Given
ArrayList<Object> pageElements = new ArrayList<>();
pageElements.add("first element in cascaded serialization");
pageElements.add("second element in cascaded serialization");
PageImpl<Object> objects = new PageImpl<>(pageElements, PageRequest.of(6, 2), 100);
assertThat(objects.getContent()).hasSize(2);
assertThat(objects.getPageable().getPageSize()).isEqualTo(2);

String pageJson = objectMapper.writeValueAsString(objects);
// When
Page<?> result = objectMapper.readValue(pageJson, Page.class);
// Then
assertThat(result).isNotNull();
assertThat(result.getTotalElements()).isEqualTo(100);
assertThat(result.getContent()).hasSize(2);
assertThat(result.getContent().get(0)).isEqualTo("first element in cascaded serialization");
assertThat(result.getContent().get(1)).isEqualTo("second element in cascaded serialization");
assertThat(result.getPageable().getPageSize()).isEqualTo(2);
assertThat(result.getPageable().getPageNumber()).isEqualTo(6);

String cascadedPageJson = objectMapper.writeValueAsString(result);
Page<?> cascadedResult = objectMapper.readValue(cascadedPageJson, Page.class);
// Then
assertThat(cascadedResult).isNotNull();
assertThat(cascadedResult.getTotalElements()).isEqualTo(100);
assertThat(cascadedResult.getContent()).hasSize(2);
assertThat(cascadedResult.getContent().get(0)).isEqualTo("first element in cascaded serialization");
assertThat(cascadedResult.getContent().get(1)).isEqualTo("second element in cascaded serialization");
assertThat(cascadedResult.getPageable().getPageSize()).isEqualTo(2);
assertThat(cascadedResult.getPageable().getPageNumber()).isEqualTo(6);
}

}