Skip to content

Preserve instance URIs in the Gson adapter #564

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: main
Choose a base branch
from
Open

Preserve instance URIs in the Gson adapter #564

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: 3 additions & 3 deletions problem-gson/src/main/java/org/zalando/problem/gson/DefaultProblemAdapter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ final class DefaultProblemAdapter extends TypeAdapter<ThrowableProblem> {
gson,
stackTraces,
gson.getAdapter(String.class),
URITypeAdapter.TYPE,
gson.getAdapter(URI.class),
gson.getAdapter(new TypeToken<Map<String, Object>>() {
// nothing to do here
}),
Expand All @@ -48,7 +48,7 @@ final class DefaultProblemAdapter extends TypeAdapter<ThrowableProblem> {
public void write(final JsonWriter out, final ThrowableProblem problem) throws IOException {
final JsonObject object = new JsonObject();

object.add("type", uriAdapter.toJsonTree(problem.getType()));
object.add("type", URITypeAdapter.TYPE.toJsonTree(problem.getType()));
object.add("title", stringAdapter.toJsonTree(problem.getTitle()));
object.add("status", status.toJsonTree(problem.getStatus()));
object.add("detail", stringAdapter.toJsonTree(problem.getDetail()));
Expand Down Expand Up @@ -78,7 +78,7 @@ public ThrowableProblem read(final JsonReader in) throws IOException {
final String name = in.nextName();
switch (name) {
case "type":
builder.withType(uriAdapter.read(in));
builder.withType(URITypeAdapter.TYPE.read(in));
break;
case "title":
builder.withTitle(stringAdapter.read(in));
Expand Down
46 changes: 46 additions & 0 deletions problem-gson/src/test/java/org/zalando/problem/gson/GsonProblemTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,52 @@ void shouldSerializeCustomProperties() {
.assertThat("$.product", is("B00027Y5QG"));
}

@Test
void shouldPreserveNullInstance() {
final Problem problem = gson.fromJson("{\"instance\":null}", Problem.class);

assertThat(problem.getInstance(), is(nullValue()));
assertThat(problem.getType(), is(Problem.DEFAULT_TYPE));
}

@Test
void shouldRoundTripNullInstance() {
final Gson gson = new GsonBuilder()
.registerTypeAdapterFactory(new ProblemAdapterFactory())
.serializeNulls()
.create();
final Problem problem = Problem.valueOf(BAD_REQUEST);

final Problem copy = gson.fromJson(gson.toJson(problem), Problem.class);

assertThat(copy.getInstance(), is(nullValue()));
assertThat(copy.getType(), is(Problem.DEFAULT_TYPE));
}

@Test
void shouldPreserveAboutBlankInstance() {
final Problem problem = Problem.builder()
.withInstance(URI.create("about:blank"))
.build();

final String json = gson.toJson(problem);

with(json).assertThat("$.instance", is("about:blank"));
assertThat(gson.fromJson(json, Problem.class).getInstance(), is(problem.getInstance()));
}

@Test
void shouldRoundTripRelativeInstance() {
final Problem problem = Problem.builder()
.withInstance(URI.create("/problems/123"))
.build();

final String json = gson.toJson(problem);

with(json).assertThat("$.instance", is("/problems/123"));
assertThat(gson.fromJson(json, Problem.class).getInstance(), is(problem.getInstance()));
}

@Test
void shouldSerializeCustomProblem() {
final int balance = 10;
Expand Down