Skip to content

Commit

Permalink
Fix resolving custom ObjectMapper at deserialization in Resteasy Reac…
Browse files Browse the repository at this point in the history 
…tive

Fix quarkusio#34008
  • Loading branch information
@Sgitario
Sgitario committed Jun 14, 2023
1 parent 210b2a3 commit 3457b35
Show file tree
Hide file tree
Showing 4 changed files with 222 additions and 18 deletions.
99 changes: 99 additions & 0 deletions ...est/java/io/quarkus/resteasy/reactive/jackson/deployment/test/CustomObjectMapperTest.java
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,99 @@
package io.quarkus.resteasy.reactive.jackson.deployment.test;

import static io.restassured.RestAssured.given;
import static org.hamcrest.CoreMatchers.equalTo;

import java.util.Objects;

import jakarta.ws.rs.Consumes;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.ext.ContextResolver;
import jakarta.ws.rs.ext.Provider;

import org.apache.http.HttpStatus;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import com.fasterxml.jackson.databind.DeserializationFeature;
import com.fasterxml.jackson.databind.ObjectMapper;

import io.quarkus.arc.Unremovable;
import io.quarkus.test.QuarkusUnitTest;
import io.restassured.http.ContentType;

public class CustomObjectMapperTest {
@RegisterExtension
static final QuarkusUnitTest TEST = new QuarkusUnitTest().withEmptyApplication();

/**
* Because we have configured the server Object Mapper instance with:
* `objectMapper.enable(SerializationFeature.WRAP_ROOT_VALUE);`
*/
@Test
void serverShouldUnwrapRootElement() {
given().body("{\"Request\":{\"value\":\"good\"}}")
.contentType(ContentType.JSON)
.post("/server")
.then()
.statusCode(HttpStatus.SC_OK)
.body(equalTo("good"));
}

@Path("/server")
public static class MyResource {
@POST
@Consumes(MediaType.APPLICATION_JSON)
public String post(Request request) {
return request.value;
}
}

public static class Request {
private String value;

public Request() {

}

public Request(String value) {
this.value = value;
}

public String getValue() {
return value;
}

public void setValue(String value) {
this.value = value;
}

@Override
public boolean equals(Object o) {
if (this == o)
return true;
if (o == null || getClass() != o.getClass())
return false;
Request request = (Request) o;
return Objects.equals(value, request.value);
}

@Override
public int hashCode() {
return Objects.hash(value);
}
}

@Provider
@Unremovable
public static class CustomObjectMapperContextResolver implements ContextResolver<ObjectMapper> {

@Override
public ObjectMapper getContext(final Class<?> type) {
final ObjectMapper objectMapper = new ObjectMapper();
objectMapper.enable(DeserializationFeature.UNWRAP_ROOT_VALUE);
return objectMapper;
}
}
}
37 changes: 35 additions & 2 deletions ...est/java/io/quarkus/resteasy/reactive/jackson/deployment/test/MessageBodyReaderTests.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.nio.charset.StandardCharsets;
import java.util.ArrayList;
import java.util.List;
Expand All @@ -17,6 +19,11 @@
import jakarta.ws.rs.container.ConnectionCallback;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.ext.ContextResolver;
import jakarta.ws.rs.ext.ExceptionMapper;
import jakarta.ws.rs.ext.MessageBodyReader;
import jakarta.ws.rs.ext.MessageBodyWriter;
import jakarta.ws.rs.ext.Providers;

import org.jboss.resteasy.reactive.common.providers.serialisers.AbstractJsonMessageBodyReader;
import org.jboss.resteasy.reactive.server.jackson.JacksonBasicMessageBodyReader;
Expand Down Expand Up @@ -116,7 +123,8 @@ void shouldThrowInvalidDefinitionException() {
@Nested
@DisplayName("ServerJacksonMessageBodyReader")
class ServerJacksonMessageBodyReaderTests {
private final CommonReaderTests tests = new CommonReaderTests(new ServerJacksonMessageBodyReader(new ObjectMapper()));
private final CommonReaderTests tests = new CommonReaderTests(
new ServerJacksonMessageBodyReader(new ObjectMapper(), new MockProviders()));

@Test
void shouldThrowWebExceptionWithStreamReadExceptionCause() {
Expand All @@ -143,7 +151,7 @@ void shouldThrowInvalidDefinitionException() {

@Test
void shouldThrowWebExceptionWithValueInstantiationExceptionCauseUsingServerRequestContext() throws IOException {
var reader = new ServerJacksonMessageBodyReader(new ObjectMapper());
var reader = new ServerJacksonMessageBodyReader(new ObjectMapper(), new MockProviders());
// missing non-nullable property
var stream = new ByteArrayInputStream("{\"cost\": 2}".getBytes(StandardCharsets.UTF_8));
var context = new MockServerRequestContext(stream);
Expand Down Expand Up @@ -271,4 +279,29 @@ public void abortWith(Response response) {

}
}

private static class MockProviders implements Providers {

@Override
public <T> MessageBodyReader<T> getMessageBodyReader(Class<T> aClass, Type type, Annotation[] annotations,
MediaType mediaType) {
return null;
}

@Override
public <T> MessageBodyWriter<T> getMessageBodyWriter(Class<T> aClass, Type type, Annotation[] annotations,
MediaType mediaType) {
return null;
}

@Override
public <T extends Throwable> ExceptionMapper<T> getExceptionMapper(Class<T> aClass) {
return null;
}

@Override
public <T> ContextResolver<T> getContextResolver(Class<T> aClass, MediaType mediaType) {
return null;
}
}
}
50 changes: 46 additions & 4 deletions ...quarkus/resteasy/reactive/jackson/runtime/serialisers/ServerJacksonMessageBodyReader.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,17 @@
import java.io.InputStream;
import java.lang.annotation.Annotation;
import java.lang.reflect.Type;
import java.util.concurrent.ConcurrentHashMap;
import java.util.concurrent.ConcurrentMap;
import java.util.function.Function;

import jakarta.inject.Inject;
import jakarta.ws.rs.WebApplicationException;
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.ext.ContextResolver;
import jakarta.ws.rs.ext.Providers;

import org.jboss.resteasy.reactive.common.util.StreamUtil;
import org.jboss.resteasy.reactive.server.jackson.JacksonBasicMessageBodyReader;
Expand All @@ -26,16 +31,20 @@

public class ServerJacksonMessageBodyReader extends JacksonBasicMessageBodyReader implements ServerMessageBodyReader<Object> {

private final Providers providers;
private final ConcurrentMap<ObjectMapper, ObjectReader> contextResolverMap = new ConcurrentHashMap<>();

@Inject
public ServerJacksonMessageBodyReader(ObjectMapper mapper) {
public ServerJacksonMessageBodyReader(ObjectMapper mapper, Providers providers) {
super(mapper);
this.providers = providers;
}

@Override
public Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType,
MultivaluedMap<String, String> httpHeaders, InputStream entityStream) throws IOException, WebApplicationException {
try {
return doReadFrom(type, genericType, entityStream);
return doReadFrom(type, genericType, mediaType, entityStream);
} catch (MismatchedInputException | InvalidDefinitionException e) {
/*
* To extract additional details when running in dev mode or test mode, Quarkus previously offered the
Expand Down Expand Up @@ -77,12 +86,13 @@ public Object readFrom(Class<Object> type, Type genericType, MediaType mediaType
return readFrom(type, genericType, null, mediaType, null, context.getInputStream());
}

private Object doReadFrom(Class<Object> type, Type genericType, InputStream entityStream) throws IOException {
private Object doReadFrom(Class<Object> type, Type genericType, MediaType responseMediaType, InputStream entityStream)
throws IOException {
if (StreamUtil.isEmpty(entityStream)) {
return null;
}
try {
ObjectReader reader = getEffectiveReader();
ObjectReader reader = getEffectiveReader(type, responseMediaType);
return reader.forType(reader.getTypeFactory().constructType(genericType != null ? genericType : type))
.readValue(entityStream);
} catch (MismatchedInputException e) {
Expand All @@ -97,4 +107,36 @@ private boolean isEmptyInputException(MismatchedInputException e) {
// this isn't great, but Jackson doesn't have a specific exception for empty input...
return e.getMessage().startsWith("No content");
}

private ObjectReader getEffectiveReader(Class<Object> type, MediaType responseMediaType) {
ObjectMapper effectiveMapper = getObjectMapperFromContext(type, responseMediaType);
if (effectiveMapper == null) {
return getEffectiveReader();
}

return contextResolverMap.computeIfAbsent(effectiveMapper, new Function<>() {
@Override
public ObjectReader apply(ObjectMapper objectMapper) {
return objectMapper.reader();
}
});
}

private ObjectMapper getObjectMapperFromContext(Class<Object> type, MediaType responseMediaType) {
if (providers == null) {
return null;
}

ContextResolver<ObjectMapper> contextResolver = providers.getContextResolver(ObjectMapper.class,
responseMediaType);
if (contextResolver == null) {
// TODO: not sure if this is correct, but Jackson does this as well...
contextResolver = providers.getContextResolver(ObjectMapper.class, null);
}
if (contextResolver != null) {
return contextResolver.getContext(type);
}

return null;
}
}
54 changes: 42 additions & 12 deletions ...rkus/rest/client/reactive/jackson/runtime/serialisers/ClientJacksonMessageBodyReader.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -13,11 +13,14 @@
import jakarta.ws.rs.core.MediaType;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.core.Response;
import jakarta.ws.rs.ext.ContextResolver;
import jakarta.ws.rs.ext.Providers;

import org.jboss.logging.Logger;
import org.jboss.resteasy.reactive.ClientWebApplicationException;
import org.jboss.resteasy.reactive.client.impl.RestClientRequestContext;
import org.jboss.resteasy.reactive.client.spi.ClientRestHandler;
import org.jboss.resteasy.reactive.common.util.EmptyInputStream;
import org.jboss.resteasy.reactive.server.jackson.JacksonBasicMessageBodyReader;

import com.fasterxml.jackson.core.JsonParseException;
Expand All @@ -42,7 +45,13 @@ public ClientJacksonMessageBodyReader(ObjectMapper mapper) {
public Object readFrom(Class<Object> type, Type genericType, Annotation[] annotations, MediaType mediaType,
MultivaluedMap<String, String> httpHeaders, InputStream entityStream) throws IOException, WebApplicationException {
try {
return super.readFrom(type, genericType, annotations, mediaType, httpHeaders, entityStream);
if (entityStream instanceof EmptyInputStream) {
return null;
}
ObjectReader reader = getEffectiveReader(type, mediaType);
return reader.forType(reader.getTypeFactory().constructType(genericType != null ? genericType : type))
.readValue(entityStream);

} catch (JsonParseException e) {
log.debug("Server returned invalid json data", e);
throw new ClientWebApplicationException(e, Response.Status.OK);
Expand All @@ -56,23 +65,44 @@ public void handle(RestClientRequestContext requestContext) {
this.context = requestContext;
}

@Override
protected ObjectReader getEffectiveReader() {
if (context == null) {
// no context injected when reader is not running within a rest client context
return super.getEffectiveReader();
}

ObjectMapper objectMapper = context.getConfiguration().getFromContext(ObjectMapper.class);
if (objectMapper == null) {
return super.getEffectiveReader();
private ObjectReader getEffectiveReader(Class<Object> type, MediaType responseMediaType) {
ObjectMapper effectiveMapper = getObjectMapperFromContext(type, responseMediaType);
if (effectiveMapper == null) {
return getEffectiveReader();
}

return contextResolverMap.computeIfAbsent(objectMapper, new Function<>() {
return contextResolverMap.computeIfAbsent(effectiveMapper, new Function<>() {
@Override
public ObjectReader apply(ObjectMapper objectMapper) {
return objectMapper.reader();
}
});
}

private ObjectMapper getObjectMapperFromContext(Class<Object> type, MediaType responseMediaType) {
Providers providers = getProviders();
if (providers == null) {
return null;
}

ContextResolver<ObjectMapper> contextResolver = providers.getContextResolver(ObjectMapper.class,
responseMediaType);
if (contextResolver == null) {
// TODO: not sure if this is correct, but Jackson does this as well...
contextResolver = providers.getContextResolver(ObjectMapper.class, null);
}
if (contextResolver != null) {
return contextResolver.getContext(type);
}

return null;
}

private Providers getProviders() {
if (context != null && context.getClientRequestContext() != null) {
return context.getClientRequestContext().getProviders();
}

return null;
}
}

0 comments on commit 3457b35

Please sign in to comment.