From c5f6c24bb86ca43dadb7afb2927fb0d08d1df347 Mon Sep 17 00:00:00 2001 From: Sergio del Amo Date: Mon, 10 Jul 2023 16:37:27 +0200 Subject: [PATCH] imp: MethodRoute stringValues behave as getValues --- .../io/micronaut/core/util/ArrayUtils.java | 5 + .../AnnotationMetadataHierarchy.java | 17 ++- .../version/MethodRouteStringValuesTest.java | 120 ++++++++++++++++++ 3 files changed, 135 insertions(+), 7 deletions(-) create mode 100644 test-suite/src/test/java/io/micronaut/docs/web/router/version/MethodRouteStringValuesTest.java diff --git a/core/src/main/java/io/micronaut/core/util/ArrayUtils.java b/core/src/main/java/io/micronaut/core/util/ArrayUtils.java index a085eddb353..a8d3f4e6d4a 100644 --- a/core/src/main/java/io/micronaut/core/util/ArrayUtils.java +++ b/core/src/main/java/io/micronaut/core/util/ArrayUtils.java @@ -43,6 +43,11 @@ public final class ArrayUtils { @UsedByGeneratedCode public static final Object[] EMPTY_OBJECT_ARRAY = new Object[0]; + /** + * An empty String array. + */ + public static final String[] EMPTY_STRING_ARRAY = new String[0]; + /** * An empty boolean array. */ diff --git a/inject/src/main/java/io/micronaut/inject/annotation/AnnotationMetadataHierarchy.java b/inject/src/main/java/io/micronaut/inject/annotation/AnnotationMetadataHierarchy.java index e9b46f6a28c..1059420aa5d 100644 --- a/inject/src/main/java/io/micronaut/inject/annotation/AnnotationMetadataHierarchy.java +++ b/inject/src/main/java/io/micronaut/inject/annotation/AnnotationMetadataHierarchy.java @@ -322,15 +322,18 @@ public String[] stringValues(@NonNull Class annotation, @N @NonNull @Override public String[] stringValues(@NonNull String annotation, @NonNull String member) { - String[] values = hierarchy[0].stringValues(annotation, member); - for (int i = 1; i < hierarchy.length; i++) { - AnnotationMetadata annotationMetadata = hierarchy[i]; - final String[] moreValues = annotationMetadata.stringValues(annotation, member); - if (ArrayUtils.isNotEmpty(moreValues)) { - values = ArrayUtils.concat(values, moreValues); + return firstNotEmptyStringValuesInHierarchy(annotation, member); + } + + @NonNull + private String[] firstNotEmptyStringValuesInHierarchy(@NonNull String annotation, @NonNull String member) { + for (AnnotationMetadata annotationMetadata : hierarchy) { + String[] values = annotationMetadata.stringValues(annotation, member); + if (ArrayUtils.isNotEmpty(values)) { + return values; } } - return values; + return ArrayUtils.EMPTY_STRING_ARRAY; } @Override diff --git a/test-suite/src/test/java/io/micronaut/docs/web/router/version/MethodRouteStringValuesTest.java b/test-suite/src/test/java/io/micronaut/docs/web/router/version/MethodRouteStringValuesTest.java new file mode 100644 index 00000000000..27ec6d9e401 --- /dev/null +++ b/test-suite/src/test/java/io/micronaut/docs/web/router/version/MethodRouteStringValuesTest.java @@ -0,0 +1,120 @@ +package io.micronaut.docs.web.router.version; + +import com.fasterxml.jackson.annotation.JsonInclude; +import io.micronaut.context.annotation.Property; +import io.micronaut.core.annotation.Introspected; +import io.micronaut.http.HttpAttributes; +import io.micronaut.http.HttpRequest; +import io.micronaut.http.HttpResponse; +import io.micronaut.http.annotation.Controller; +import io.micronaut.http.annotation.Get; +import io.micronaut.http.client.BlockingHttpClient; +import io.micronaut.http.client.HttpClient; +import io.micronaut.http.client.annotation.Client; +import io.micronaut.http.uri.UriBuilder; +import io.micronaut.test.extensions.junit5.annotation.MicronautTest; +import io.micronaut.web.router.MethodBasedRouteMatch; +import io.micronaut.web.router.RouteMatch; +import jakarta.annotation.security.RolesAllowed; +import org.junit.jupiter.api.Test; + +import java.net.URI; +import java.util.*; + +import static org.junit.jupiter.api.Assertions.*; + +@Property(name = "spec.name", value = "MethodRouteStringValuesTest") +@MicronautTest +class MethodRouteStringValuesTest { + + @Test + void methodRouteStringValuesMatchesGetValue(@Client("/") HttpClient httpClient) { + BlockingHttpClient client = httpClient.toBlocking(); + assertScenario(client, UriBuilder.of("/example").path("user").build(), Collections.singletonList("isAuthenticated()")); + assertScenario(client, UriBuilder.of("/example").path("admin").build(), Arrays.asList("ROLE_ADMIN", "ROLE_X")); + assertScenario(client, UriBuilder.of("/foobarxxx").path("admin").build(), Collections.singletonList("ROLE_X")); + assertScenario(client, UriBuilder.of("/foobarxxx").path("user").build(), Collections.emptyList()); // RolesAllowed is not inherited + } + + private void assertScenario(BlockingHttpClient client, URI uri, List expectedList) { + HttpResponse response = client.exchange(HttpRequest.GET(uri), + StringValuesAndGetValues.class); + StringValuesAndGetValues m = response.getBody().orElse(null); + assertNotNull(m); + assertNotNull(m.getValueString); + assertNotNull(m.stringValue); + assertEquals(expectedList.size(), m.getValueString.size()); + assertEquals(expectedList.size(), m.stringValue.size()); + for (String expected : expectedList) { + assertTrue(m.getValueString.contains(expected)); + assertTrue(m.stringValue.contains(expected)); + } + } + + @Property(name = "spec.name", value = "MethodRouteStringValuesTest") + @Controller("/example") + @RolesAllowed("isAuthenticated()") + static class ExampleController { + + @Get("/admin") + @RolesAllowed({"ROLE_ADMIN", "ROLE_X"}) + StringValuesAndGetValues admin(HttpRequest request) { + return stringValuesAndGetValues(request); + } + + @Get("/user") + StringValuesAndGetValues user(HttpRequest request) { + return stringValuesAndGetValues(request); + } + } + + interface ExampleInterface { + @Get("/admin") + @RolesAllowed("ROLE_ADMIN") + StringValuesAndGetValues admin(HttpRequest request); + + @Get("/user") + @RolesAllowed("ROLE_USER") + StringValuesAndGetValues user(HttpRequest request); + } + + @Controller("/foobarxxx") + @Property(name = "spec.name", value = "MethodRouteStringValuesTest") + static class ExampleControllerWithInterface implements ExampleInterface { + @RolesAllowed("ROLE_X") + @Override + public StringValuesAndGetValues admin(HttpRequest request) { + return stringValuesAndGetValues(request); + } + + @Override + public StringValuesAndGetValues user(HttpRequest request) { + return stringValuesAndGetValues(request); + } + } + + private static StringValuesAndGetValues stringValuesAndGetValues(HttpRequest request) { + StringValuesAndGetValues defaultResult = new StringValuesAndGetValues(Collections.emptyList(), Collections.emptyList()); + return methodBasedRouteMatch(request).map(methodRoute -> + new StringValuesAndGetValues(methodRoute.getValue(RolesAllowed.class, String[].class).map(Arrays::asList).orElse(Collections.emptyList()), + Arrays.asList(methodRoute.stringValues(RolesAllowed.class)))) + .orElse(defaultResult); + } + + private static Optional methodBasedRouteMatch(HttpRequest request) { + RouteMatch routeMatch = request.getAttribute(HttpAttributes.ROUTE_MATCH, RouteMatch.class).orElse(null); + if (routeMatch == null) { + return Optional.empty(); + } + if (routeMatch instanceof MethodBasedRouteMatch methodRoute) { + return Optional.of(methodRoute); + } + + return Optional.empty(); + } + + @JsonInclude + @Introspected + record StringValuesAndGetValues(List getValueString, List stringValue) { + } +}