Skip to content

Commit

Permalink
refactor: additional Vert.x clean up and increase scenario coverage
Browse files Browse the repository at this point in the history 
Signed-off-by: Michael Edgar <[email protected]>
  • Loading branch information
@MikeEdgar
MikeEdgar committed Dec 20, 2024
1 parent 5789434 commit b1091af
Show file tree
Hide file tree
Showing 7 changed files with 80 additions and 77 deletions.
14 changes: 6 additions & 8 deletions extension-vertx/src/main/java/io/smallrye/openapi/vertx/VertxAnnotationScanner.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.LinkedHashSet;
import java.util.List;
import java.util.Objects;
Expand Down Expand Up @@ -150,14 +151,11 @@ private OpenAPI processRouteClass(ClassInfo routeClass) {
context.getResolverStack().push(resolver);

// Get the @RouteBase info and save it for later
AnnotationInstance routeBaseAnnotation = context.annotations().getAnnotation(routeClass,
VertxConstants.ROUTE_BASE);

if (routeBaseAnnotation != null) {
this.currentAppPath = routeBaseAnnotation.value("path").asString(); // TODO: Check if there and check for :
} else {
this.currentAppPath = "/";
}
this.currentAppPath = context.annotations().getAnnotationValue(
routeClass,
Collections.singletonList(VertxConstants.ROUTE_BASE),
"path",
"/");

// Process @OpenAPIDefinition annotation
OpenAPI openApi = processDefinitionAnnotation(context, routeClass);
Expand Down
84 changes: 23 additions & 61 deletions extension-vertx/src/main/java/io/smallrye/openapi/vertx/VertxParameterProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@

import java.util.ArrayList;
import java.util.Arrays;
import java.util.Collections;
import java.util.HashMap;
import java.util.List;
import java.util.function.Function;
Expand All @@ -14,8 +15,6 @@
import org.eclipse.microprofile.openapi.models.parameters.Parameter.Style;
import org.jboss.jandex.AnnotationInstance;
import org.jboss.jandex.AnnotationTarget;
import org.jboss.jandex.AnnotationTarget.Kind;
import org.jboss.jandex.AnnotationValue;
import org.jboss.jandex.ClassInfo;
import org.jboss.jandex.DotName;
import org.jboss.jandex.MethodInfo;
Expand Down Expand Up @@ -92,46 +91,29 @@ protected void readAnnotatedType(AnnotationInstance annotation, AnnotationInstan

if (isReadableParameterAnnotation(name)) {
readParameterAnnotation(annotation, overriddenParametersOnly);
} else if (VertxConstants.PARAM.equals(name) && annotation.value() != null) {
String parameterName = annotation.value().asString();
String path = getMethodRoutePath(annotation);

if (path != null && path.contains(":" + parameterName)) {
} else if (VertxConstants.PARAM.equals(name)) {
// @Param only targets method parameters
MethodInfo resourceMethod = annotation.target().asMethodParameter().method();
String parameterName = paramName(annotation);
String path = scannerContext.annotations().getAnnotationValue(
resourceMethod,
Collections.singletonList(VertxConstants.ROUTE),
"path",
resourceMethod.name());

if (path.contains(":" + parameterName)) {
FrameworkParameter vertxParameter = VertxParameter.PATH_PARAM.parameter;
readAnnotatedType(vertxParameter, annotation, beanParamAnnotation, overriddenParametersOnly);
} else {
FrameworkParameter vertxParameter = VertxParameter.QUERY_PARAM.parameter;
readAnnotatedType(vertxParameter, annotation, beanParamAnnotation, overriddenParametersOnly);
}
} else if (VertxConstants.HEADER_PARAM.equals(name) && annotation.value() != null) {
} else if (VertxConstants.HEADER_PARAM.equals(name)) {
FrameworkParameter vertxParameter = VertxParameter.HEADER_PARAM.parameter;
readAnnotatedType(vertxParameter, annotation, beanParamAnnotation, overriddenParametersOnly);
}
}

private String getMethodRoutePath(AnnotationInstance annotation) {
String path = null;
MethodInfo resourceMethod = null;

if (annotation.target().kind() == METHOD) {
resourceMethod = annotation.target().asMethod();
} else if (annotation.target().kind() == Kind.METHOD_PARAMETER) {
resourceMethod = annotation.target().asMethodParameter().method();
}

if (resourceMethod != null) {
AnnotationInstance routeAnnotation = resourceMethod.annotation(VertxConstants.ROUTE);
AnnotationValue pathValue = routeAnnotation.value("path");
path = resourceMethod.name(); // default to methodName

if (pathValue != null) {
path = pathValue.asString();
}
}

return path;
}

private void readAnnotatedType(FrameworkParameter frameworkParam, AnnotationInstance annotation,
AnnotationInstance beanParamAnnotation, boolean overriddenParametersOnly) {
if (frameworkParam != null) {
Expand Down Expand Up @@ -167,27 +149,21 @@ private void readAnnotatedType(FrameworkParameter frameworkParam, AnnotationInst

@Override
protected String pathOf(AnnotationTarget target) {
AnnotationInstance path = null;
String defaultPathValue = null;
String pathValue = null;

if (target.kind().equals(CLASS)) {
DotName possiblePath = VertxConstants.ROUTE_BASE;
AnnotationInstance classAnnotation = scannerContext.annotations().getAnnotation(target, possiblePath);
if (classAnnotation != null && classAnnotation.value("path") != null) {
path = classAnnotation;
}
pathValue = scannerContext.annotations().getAnnotationValue(
target,
Collections.singletonList(VertxConstants.ROUTE_BASE),
"path");
} else if (target.kind().equals(METHOD)) {
defaultPathValue = target.asMethod().name();
DotName possiblePath = VertxConstants.ROUTE;
path = target.asMethod().annotation(possiblePath);
pathValue = scannerContext.annotations().getAnnotationValue(
target,
Collections.singletonList(VertxConstants.ROUTE),
"path",
target.asMethod().name());
}

if (path == null) {
return "";
}

String pathValue = routePathValuesToPath(path, defaultPathValue);

if (pathValue == null) {
return "";
}
Expand Down Expand Up @@ -216,20 +192,6 @@ protected String pathOf(AnnotationTarget target) {
return pathValue;
}

/**
* Creates a String path from the Route path value
*
* @param routeAnnotation
* @return
*/
static String routePathValuesToPath(AnnotationInstance routeAnnotation, String defaultValue) {
AnnotationValue value = routeAnnotation.value("path");
if (value != null) {
return value.asString();
}
return defaultValue;
}

@Override
protected boolean isSubResourceLocator(MethodInfo method) {
return false;
Expand Down
8 changes: 5 additions & 3 deletions ...tx/src/test/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingGetRoute.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
import org.eclipse.microprofile.openapi.annotations.Operation;
import org.eclipse.microprofile.openapi.annotations.media.Content;
import org.eclipse.microprofile.openapi.annotations.media.Schema;
import org.eclipse.microprofile.openapi.annotations.parameters.Parameter;
import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;

import io.quarkus.vertx.web.Param;
Expand Down Expand Up @@ -44,15 +45,16 @@ public List<Greeting> hellosPathVariable(RoutingExchange routingExchange, @Param
return Arrays.asList(new Greeting("Hello " + name));
}

// 3) Basic path var with Optional test
// 3) Basic path var with Optional test, name of parameter taken from argument name
@Route(path = "/helloOptional/:name", methods = HttpMethod.GET)
public Optional<Greeting> helloOptional(HttpServerRequest httpServerRequest, @Param("name") String name) {
public Optional<Greeting> helloOptional(HttpServerRequest httpServerRequest, @Param String name) {
return Optional.of(new Greeting("Hello " + name));
}

// 4) Basic request param test
@Route(path = "/helloRequestParam", methods = HttpMethod.GET)
public Greeting helloRequestParam(HttpServerResponse httpServerResponse, @Param("name") String name) {
public Greeting helloRequestParam(HttpServerResponse httpServerResponse,
@Parameter(description = "The name") @Param("name") String name) {
return new Greeting("Hello " + name);
}

Expand Down
8 changes: 7 additions & 1 deletion ...x/src/test/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPostRoute.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
import org.eclipse.microprofile.openapi.annotations.responses.APIResponse;

import io.quarkus.vertx.web.Body;
import io.quarkus.vertx.web.Header;
import io.quarkus.vertx.web.Route;
import io.quarkus.vertx.web.Route.HttpMethod;
import io.quarkus.vertx.web.RouteBase;
Expand All @@ -20,7 +21,7 @@
* @author Phillip Kruger ([email protected])
*/
@ApplicationScoped
@RouteBase(path = "greeting", consumes = "application/json", produces = "application/json")
@RouteBase(path = "greeting/", consumes = "application/json", produces = "application/json")
public class GreetingPostRoute {

// 1) Basic path var test
Expand All @@ -36,4 +37,9 @@ public void greetWithResponse(@Body Greeting greeting) {
//
}

// 3) Header parameter
@Route(path = "/greetWithHeader", methods = HttpMethod.POST)
public Greeting greetWithResponse(@Body Greeting greeting, @Header String language) {
return greeting;
}
}
7 changes: 4 additions & 3 deletions ...tx/src/test/java/test/io/smallrye/openapi/runtime/scanner/resources/GreetingPutRoute.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,17 +21,18 @@
* @author Phillip Kruger ([email protected])
*/
@ApplicationScoped
@RouteBase(path = "greeting", consumes = "application/json", produces = "application/json")
// `path` not specified on @RouteBase
@RouteBase(consumes = "application/json", produces = "application/json")
public class GreetingPutRoute {

// 1) Basic path var test
@Route(path = "/greet/:id", methods = HttpMethod.PUT)
@Route(path = "/greeting/greet/:id", methods = HttpMethod.PUT)
public Greeting greet(@Body Greeting greeting, @Param("id") String id) {
return greeting;
}

// 2) Void, so without a type specified
@Route(path = "/greetWithResponse/:id", methods = HttpMethod.PUT)
@Route(path = "/greeting/greetWithResponse/:id", methods = HttpMethod.PUT)
@APIResponse(responseCode = "200", description = "OK", content = @Content(schema = @Schema(ref = "#/components/schemas/Greeting")))
public void greetWithResponse(@Body Greeting greeting, @Param("id") String id) {
//
Expand Down
3 changes: 2 additions & 1 deletion ...ces/io/smallrye/openapi/runtime/scanner/resource.testBasicRouteGetDefinitionScanning.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -452,7 +452,8 @@
"in" : "query",
"schema" : {
"type" : "string"
}
},
"description" : "The name"
} ],
"responses" : {
"200" : {
Expand Down
33 changes: 33 additions & 0 deletions ...es/io/smallrye/openapi/runtime/scanner/resource.testBasicRoutePostDefinitionScanning.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -52,6 +52,39 @@
}
}
}
},
"/greeting/greetWithHeader": {
"post": {
"parameters": [{
"name": "language",
"in": "header",
"schema": {
"type": "string"
}
}],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Greeting"
}
}
}
},
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Greeting"
}
}
}
}
}
}
}
},
"components": {
Expand Down

0 comments on commit b1091af

Please sign in to comment.