Skip to content

Fix JAX-RS generator: missing MediaType import + illegal throws widening #101

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

Closed
Syvlain wants to merge 1 commit into from
Closed

Fix JAX-RS generator: missing MediaType import + illegal throws widening #101

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
25 changes: 22 additions & 3 deletions unknow-server-maven/src/main/java/unknow/server/maven/jaxrs/JaxRsServletBuilder.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,7 @@
import com.github.javaparser.ast.expr.BooleanLiteralExpr;
import com.github.javaparser.ast.expr.ClassExpr;
import com.github.javaparser.ast.expr.Expression;
import com.github.javaparser.ast.expr.FieldAccessExpr;
import com.github.javaparser.ast.expr.IntegerLiteralExpr;
import com.github.javaparser.ast.expr.LongLiteralExpr;
import com.github.javaparser.ast.expr.MethodCallExpr;
Expand Down Expand Up @@ -321,6 +322,10 @@
*/
private void buildMethod(String name, List<JaxrsMapping> list) throws MojoFailureException {

// do<Method>/$call may surface arbitrary checked exceptions from the user resource method.
// Both dispatch paths wrap the chain in try/catch(Throwable) -> JaxrsContext.sendError

Check warning on line 326 in unknow-server-maven/src/main/java/unknow/server/maven/jaxrs/JaxRsServletBuilder.java

View check run for this annotation

SonarQubeCloud / SonarCloud Code Analysis

This block of commented-out lines of code should be removed. 


See more on https://sonarcloud.io/project/issues?id=Unknow0_unknow-server&issues=AZ5zQeCh_3ELC_tVP_b4&open=AZ5zQeCh_3ELC_tVP_b4&pullRequest=101
// (PatternService.buildService and SimpleService.build), so 'throws Exception' is safe and
// service(...) never has to widen its own throws clause.
BlockStmt b = cl.addMethod(name, CodeGenUtils.PRIVATE).addParameter(types.getClass(JaxrsReq.class), "req")
.addParameter(types.getClass(HttpServletResponse.class), "res").addThrownException(Exception.class).createBody();

Expand Down Expand Up @@ -382,8 +387,13 @@
}
}

MethodCallExpr accept = new MethodCallExpr(new NameExpr("req"), "getAccepted",
CodeGenUtils.list(mt.predicate(produce.keySet()), mt.type(produce.keySet().iterator().next())));
// mt.type(..) returns either MediaType.XXX (well-known type -> needs the MediaType import on
// this CU) or MediaTypes.XXX (custom static field -> no MediaType import needed). Register the
// import only when the inlined expression actually references MediaType.
Expression type = mt.type(produce.keySet().iterator().next());
if (type instanceof FieldAccessExpr && "MediaType".equals(((FieldAccessExpr) type).getScope().toString()))
types.getClass(MediaType.class);
MethodCallExpr accept = new MethodCallExpr(new NameExpr("req"), "getAccepted", CodeGenUtils.list(mt.predicate(produce.keySet()), type));

JaxrsMapping def = produce.remove("*/*");
Statement stmt = new ThrowStmt(new ObjectCreationExpr(null, types.getClass(NotAcceptableException.class), CodeGenUtils.list()));
Expand Down Expand Up @@ -476,10 +486,19 @@
i = new IfStmt(new MethodCallExpr(CodeGenUtils.text(method), "equals", CodeGenUtils.list(m)),
new ExpressionStmt(new MethodCallExpr("do" + method.charAt(0) + method.substring(1).toLowerCase(), p)), i);

// dispatch may throw anything bubbling up from the user resource method; route it through
// JaxrsContext.sendError just like PatternService does, so service(...) only ever throws
// IOException/ServletException and do<Method>/$call stay free to 'throws Exception'.
BlockStmt dispatch = new BlockStmt().addStatement(CodeGenUtils.assign(types.getClass(String.class), "m", new MethodCallExpr(new NameExpr("req"), "getMethod")))
.addStatement(i);
cl.addMethod("service", CodeGenUtils.PUBLIC).addMarkerAnnotation(Override.class).addParameter(types.getClass(HttpServletRequest.class), "req")
.addParameter(types.getClass(HttpServletResponse.class), "res").addThrownException(IOException.class).addThrownException(ServletException.class).getBody()
.get().addStatement(CodeGenUtils.create(types.getClass(JaxrsReq.class), "r", CodeGenUtils.list(new NameExpr("req"), new NullLiteralExpr())))
.addStatement(CodeGenUtils.assign(types.getClass(String.class), "m", new MethodCallExpr(new NameExpr("req"), "getMethod"))).addStatement(i);
.addStatement(new TryStmt(dispatch,
CodeGenUtils.list(new CatchClause(new com.github.javaparser.ast.body.Parameter(types.getClass(Throwable.class), "e"),
new BlockStmt().addStatement(new MethodCallExpr(new TypeExpr(types.getClass(JaxrsContext.class)), "sendError",
CodeGenUtils.list(new NameExpr("r"), new NameExpr("e"), new NameExpr("res")))))),
null));

if (!methods.containsKey("OPTIONS"))
buildOptions("doOptions", methods.keySet());
Expand Down