Repository navigation
fix: deserialize empty arrays as null for all Map and object fields #442
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.
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
andrii-bodnar
wants to merge
1
commit into
master
Choose a base branch
from
fix/empty-array-coercion
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
This file contains hidden or 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
3 changes: 0 additions & 3 deletions
3
src/main/java/com/crowdin/client/users/model/TranslatorRole.java
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,12 +1,9 @@ | ||
| package com.crowdin.client.users.model; | ||
|
|
||
| import com.crowdin.client.core.http.impl.json.EmptyArrayToNullDeserializer; | ||
| import com.fasterxml.jackson.databind.annotation.JsonDeserialize; | ||
| import lombok.Data; | ||
|
|
||
| @Data | ||
| public class TranslatorRole { | ||
| private TranslatorRoleName name; | ||
| @JsonDeserialize(using = EmptyArrayToNullDeserializer.class) | ||
| private TranslatorRolePermissions permissions; | ||
| } |
3 changes: 0 additions & 3 deletions
3
src/main/java/com/crowdin/client/users/model/TranslatorRolePermissions.java
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,15 +1,12 @@ | ||
| package com.crowdin.client.users.model; | ||
|
|
||
| import com.crowdin.client.core.http.impl.json.EmptyArrayToNullDeserializer; | ||
| import com.crowdin.client.core.model.LanguageAccessRule; | ||
| import com.fasterxml.jackson.databind.annotation.JsonDeserialize; | ||
| import lombok.Data; | ||
|
|
||
| import java.util.Map; | ||
|
|
||
| @Data | ||
| public class TranslatorRolePermissions { | ||
| private boolean allLanguages; | ||
| @JsonDeserialize(using = EmptyArrayToNullDeserializer.class) | ||
| private Map<String, LanguageAccessRule> languagesAccess; | ||
| } |
This file contains hidden or 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
This file contains hidden or 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
100 changes: 100 additions & 0 deletions
100
src/test/java/com/crowdin/client/core/http/impl/json/EmptyArrayCoercionTest.java
This file contains hidden or 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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| package com.crowdin.client.core.http.impl.json; | ||
|
|
||
| import com.crowdin.client.glossaries.model.ConceptResponseObject; | ||
| import com.crowdin.client.glossaries.model.TermResponseObject; | ||
| import com.crowdin.client.projectsgroups.model.Project; | ||
| import com.crowdin.client.projectsgroups.model.ProjectResponseObject; | ||
| import com.crowdin.client.projectsgroups.model.ProjectSettings; | ||
| import com.crowdin.client.sourcestrings.model.SourceStringResponseObject; | ||
| import com.crowdin.client.users.model.UserResponseObject; | ||
| import com.fasterxml.jackson.databind.exc.MismatchedInputException; | ||
| import org.junit.jupiter.api.Test; | ||
|
|
||
| import java.util.Collections; | ||
|
|
||
| import static org.junit.jupiter.api.Assertions.assertEquals; | ||
| import static org.junit.jupiter.api.Assertions.assertInstanceOf; | ||
| import static org.junit.jupiter.api.Assertions.assertNull; | ||
| import static org.junit.jupiter.api.Assertions.assertThrows; | ||
| import static org.junit.jupiter.api.Assertions.assertTrue; | ||
|
|
||
| /** | ||
| * The API sends some empty objects as {@code []}; the shared mapper must read them as {@code null} | ||
| * for every Map and POJO field, without per-field annotations. | ||
| */ | ||
| public class EmptyArrayCoercionTest { | ||
|
|
||
| private final JacksonJsonTransformer transformer = new JacksonJsonTransformer(); | ||
|
|
||
| @Test | ||
| public void projectFieldsEmptyArray() { | ||
| Project project = transformer.parse("{\"data\":{\"id\":1,\"fields\":[]}}", ProjectResponseObject.class).getData(); | ||
|
|
||
| assertEquals(1L, project.getId()); | ||
| assertNull(project.getFields()); | ||
| } | ||
|
|
||
| @Test | ||
| public void projectSettingsFieldsEmptyArray() { | ||
| Project project = transformer.parse("{\"data\":{\"id\":1,\"languageMapping\":[],\"fields\":[]}}", ProjectResponseObject.class).getData(); | ||
|
|
||
| assertInstanceOf(ProjectSettings.class, project); | ||
| assertNull(project.getFields()); | ||
| } | ||
|
|
||
| @Test | ||
| public void projectSettingsObjectsEmptyArray() { | ||
| ProjectSettings settings = (ProjectSettings) transformer.parse("{\"data\":{\"id\":1,\"languageMapping\":[]," | ||
| + "\"assignedTms\":[],\"tmPreTranslate\":[],\"mtPreTranslate\":[],\"aiPreTranslate\":[]}}", ProjectResponseObject.class).getData(); | ||
|
|
||
| assertNull(settings.getAssignedTms()); | ||
| assertNull(settings.getTmPreTranslate()); | ||
| assertNull(settings.getMtPreTranslate()); | ||
| assertNull(settings.getAiPreTranslate()); | ||
| } | ||
|
|
||
| @Test | ||
| public void sourceStringFieldsEmptyArray() { | ||
| assertNull(transformer.parse("{\"data\":{\"id\":1,\"fields\":[]}}", SourceStringResponseObject.class).getData().getFields()); | ||
| } | ||
|
|
||
| @Test | ||
| public void conceptFieldsEmptyArray() { | ||
| assertNull(transformer.parse("{\"data\":{\"id\":1,\"fields\":[]}}", ConceptResponseObject.class).getData().getFields()); | ||
| } | ||
|
|
||
| @Test | ||
| public void termFieldsEmptyArray() { | ||
| assertNull(transformer.parse("{\"data\":{\"id\":1,\"fields\":[]}}", TermResponseObject.class).getData().getFields()); | ||
| } | ||
|
|
||
| @Test | ||
| public void userFieldsEmptyArray() { | ||
| assertNull(transformer.parse("{\"data\":{\"id\":1,\"fields\":[]}}", UserResponseObject.class).getData().getFields()); | ||
| } | ||
|
|
||
| @Test | ||
| public void nestedObjectEmptyArray() { | ||
| assertNull(transformer.parse("{\"data\":{\"id\":1,\"sourceLanguage\":[]}}", ProjectResponseObject.class).getData().getSourceLanguage()); | ||
| } | ||
|
|
||
| @Test | ||
| public void populatedMapStillParses() { | ||
| Project project = transformer.parse("{\"data\":{\"id\":1,\"fields\":{\"slug\":\"value\"}}}", ProjectResponseObject.class).getData(); | ||
|
|
||
| assertEquals(Collections.singletonMap("slug", "value"), project.getFields()); | ||
| } | ||
|
|
||
| @Test | ||
| public void emptyArrayStaysEmptyListForListFields() { | ||
| Project project = transformer.parse("{\"data\":{\"id\":1,\"targetLanguageIds\":[]}}", ProjectResponseObject.class).getData(); | ||
|
|
||
| assertTrue(project.getTargetLanguageIds().isEmpty()); | ||
| } | ||
|
|
||
| @Test | ||
| public void nonEmptyArrayForMapStillFails() { | ||
| assertThrows(MismatchedInputException.class, | ||
| () -> transformer.parse("{\"data\":{\"id\":1,\"fields\":[1]}}", SourceStringResponseObject.class)); | ||
| } | ||
| } |
Oops, something went wrong.
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
do we use it anywhere? can we delete it?