Skip to content
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

Taking into account the @Priority annotation when registering context providers #32942

Merged
merged 1 commit into from
Apr 28, 2023
Merged

Taking into account the @Priority annotation when registering context providers #32942

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
120 changes: 120 additions & 0 deletions .../src/test/java/io/quarkus/rest/client/reactive/provider/ContextProvidersPriorityTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,120 @@
package io.quarkus.rest.client.reactive.provider;

import static io.restassured.RestAssured.given;
import static java.lang.String.format;
import static org.assertj.core.api.Assertions.assertThat;

import java.net.URI;
import java.util.List;
import java.util.Map;

import jakarta.annotation.Priority;
import jakarta.enterprise.context.ApplicationScoped;
import jakarta.ws.rs.GET;
import jakarta.ws.rs.POST;
import jakarta.ws.rs.Path;
import jakarta.ws.rs.Produces;
import jakarta.ws.rs.core.Context;
import jakarta.ws.rs.core.HttpHeaders;
import jakarta.ws.rs.core.MultivaluedHashMap;
import jakarta.ws.rs.core.MultivaluedMap;
import jakarta.ws.rs.ext.ContextResolver;

import org.eclipse.microprofile.rest.client.ext.ClientHeadersFactory;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.extension.RegisterExtension;

import io.quarkus.rest.client.reactive.QuarkusRestClientBuilder;
import io.quarkus.rest.client.reactive.TestJacksonBasicMessageBodyReader;
import io.quarkus.test.QuarkusUnitTest;
import io.quarkus.test.common.http.TestHTTPResource;

public class ContextProvidersPriorityTest {
private static final String HEADER_NAME = "my-header";
private static final String HEADER_VALUE_FROM_LOW_PRIORITY = "low-priority";
private static final String HEADER_VALUE_FROM_HIGH_PRIORITY = "high-priority";

@TestHTTPResource
URI baseUri;

@RegisterExtension
static final QuarkusUnitTest config = new QuarkusUnitTest()
.withApplicationRoot((jar) -> jar.addClasses(Client.class, TestJacksonBasicMessageBodyReader.class));

@Test
void shouldUseTheHighestPriorityContextProvider() {
// @formatter:off
var response =
given()
.body(baseUri.toString())
.when()
.post("/call-client")
.thenReturn();
// @formatter:on
assertThat(response.statusCode()).isEqualTo(200);
assertThat(response.jsonPath().getString(HEADER_NAME)).isEqualTo(format("[%s]", HEADER_VALUE_FROM_HIGH_PRIORITY));
}

@Path("/")
@ApplicationScoped
public static class Resource {

@GET
@Produces("application/json")
public Map<String, List<String>> returnHeaderValues(@Context HttpHeaders headers) {
return headers.getRequestHeaders();
}

@Path("/call-client")
@POST
public Map<String, List<String>> callClient(String uri) {
Client client = QuarkusRestClientBuilder.newBuilder()
.baseUri(URI.create(uri))
.register(LowPriorityClientHeadersProvider.class)
.register(HighPriorityClientHeadersProvider.class)
.register(new TestJacksonBasicMessageBodyReader())
.build(Client.class);
return client.get();
}
}

public interface Client {
@GET
Map<String, List<String>> get();
}

@Priority(2)
public static class LowPriorityClientHeadersProvider implements ContextResolver<ClientHeadersFactory> {

@Override
public ClientHeadersFactory getContext(Class<?> aClass) {
return new CustomClientHeadersFactory(HEADER_VALUE_FROM_LOW_PRIORITY);
}
}

@Priority(1)
public static class HighPriorityClientHeadersProvider implements ContextResolver<ClientHeadersFactory> {

@Override
public ClientHeadersFactory getContext(Class<?> aClass) {
return new CustomClientHeadersFactory(HEADER_VALUE_FROM_HIGH_PRIORITY);
}
}

public static class CustomClientHeadersFactory implements ClientHeadersFactory {

private final String value;

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

@Override
public MultivaluedMap<String, String> update(MultivaluedMap<String, String> multivaluedMap,
MultivaluedMap<String, String> multivaluedMap1) {
MultivaluedHashMap<String, String> newHeaders = new MultivaluedHashMap<>();
newHeaders.add(HEADER_NAME, value);
return newHeaders;
}
}
}
32 changes: 19 additions & 13 deletions ...mon/runtime/src/main/java/org/jboss/resteasy/reactive/common/jaxrs/ConfigurationImpl.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public class ConfigurationImpl implements Configuration {
private final MultivaluedMap<Class<?>, ResourceWriter> resourceWriters;
private final MultivaluedMap<Class<?>, ResourceReader> resourceReaders;
private final MultivaluedMap<Class<?>, RxInvokerProvider<?>> rxInvokerProviders;
private final MultivaluedMap<Class<?>, ContextResolver<?>> contextResolvers;
private final Map<Class<?>, MultivaluedMap<Integer, ContextResolver<?>>> contextResolvers;

public ConfigurationImpl(RuntimeType runtimeType) {
this.runtimeType = runtimeType;
Expand All @@ -69,7 +69,7 @@ public ConfigurationImpl(RuntimeType runtimeType) {
this.resourceReaders = new QuarkusMultivaluedHashMap<>();
this.resourceWriters = new QuarkusMultivaluedHashMap<>();
this.rxInvokerProviders = new QuarkusMultivaluedHashMap<>();
this.contextResolvers = new QuarkusMultivaluedHashMap<>();
this.contextResolvers = new HashMap<>();
}

public ConfigurationImpl(Configuration configuration) {
Expand All @@ -96,7 +96,7 @@ public ConfigurationImpl(Configuration configuration) {
this.resourceWriters.putAll(configurationImpl.resourceWriters);
this.rxInvokerProviders = new QuarkusMultivaluedHashMap<>();
this.rxInvokerProviders.putAll(configurationImpl.rxInvokerProviders);
this.contextResolvers = new QuarkusMultivaluedHashMap<>();
this.contextResolvers = new HashMap<>();
this.contextResolvers.putAll(configurationImpl.contextResolvers);
} else {
this.allInstances = new HashMap<>();
Expand All @@ -111,7 +111,7 @@ public ConfigurationImpl(Configuration configuration) {
this.resourceReaders = new QuarkusMultivaluedHashMap<>();
this.resourceWriters = new QuarkusMultivaluedHashMap<>();
this.rxInvokerProviders = new QuarkusMultivaluedHashMap<>();
this.contextResolvers = new QuarkusMultivaluedHashMap<>();
this.contextResolvers = new HashMap<>();
// this is the best we can do - we don't have any of the metadata associated with the registration
for (Object i : configuration.getInstances()) {
register(i);
Expand Down Expand Up @@ -314,8 +314,10 @@ private void register(Object component, Integer priority) {
added = true;
Class<?> componentClass = component.getClass();
Type[] args = Types.findParameterizedTypes(componentClass, ContextResolver.class);
contextResolvers.add(args != null && args.length == 1 ? Types.getRawType(args[0]) : Object.class,
(ContextResolver<?>) component);
Class<?> key = args != null && args.length == 1 ? Types.getRawType(args[0]) : Object.class;
int effectivePriority = priority != null ? priority : determinePriority(component);
contextResolvers.computeIfAbsent(key, k -> new MultivaluedTreeMap<>())
.add(effectivePriority, (ContextResolver<?>) component);
}
if (added) {
allInstances.put(component.getClass(), component);
Expand Down Expand Up @@ -419,8 +421,10 @@ public void register(Object component, Map<Class<?>, Integer> componentContracts
if (component instanceof ContextResolver) {
added = true;
Type[] args = Types.findParameterizedTypes(componentClass, ContextResolver.class);
contextResolvers.add(args != null && args.length == 1 ? Types.getRawType(args[0]) : Object.class,
(ContextResolver<?>) component);
Class<?> key = args != null && args.length == 1 ? Types.getRawType(args[0]) : Object.class;
int effectivePriority = priority != null ? priority : determinePriority(component);
contextResolvers.computeIfAbsent(key, k -> new MultivaluedTreeMap<>())
.add(effectivePriority, (ContextResolver<?>) component);
}
if (added) {
allInstances.put(componentClass, component);
Expand Down Expand Up @@ -525,14 +529,16 @@ public RxInvokerProvider<?> getRxInvokerProvider(Class<?> wantedClass) {
}

public <T> T getFromContext(Class<T> wantedClass) {
List<ContextResolver<?>> candidates = contextResolvers.get(wantedClass);
MultivaluedMap<Integer, ContextResolver<?>> candidates = contextResolvers.get(wantedClass);
if (candidates == null) {
return null;
}
for (ContextResolver<?> contextResolver : candidates) {
Object instance = contextResolver.getContext(wantedClass);
if (instance != null) {
return (T) instance;
for (List<ContextResolver<?>> contextResolvers : candidates.values()) {
for (ContextResolver<?> contextResolver : contextResolvers) {
Object instance = contextResolver.getContext(wantedClass);
if (instance != null) {
return (T) instance;
}
}
}

Expand Down