Add support for required @RequestParam (#441)

RobbinBaauw · vojtechhabarta · commit 92f11bb4a3c9 · 2019-12-07T12:44:29.000+01:00
* Add support for required RequestParam In Spring, RequestParams are required by default, but this wasn't enforced by Typescript-Generator. Now it is. * Added support for defaultValue See required behaviour with defaultValue at https://docs.spring.io/spring/docs/current/javadoc-api/org/springframework/web/bind/annotation/RequestParam.html
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelCompiler.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/compiler/ModelCompiler.java
@@ -669,7 +669,7 @@ private TsMethodModel processRestMethod(TsModel tsModel, SymbolTable symbolTable
                 if (restQueryParam instanceof RestQueryParam.Single) {
                     final MethodParameterModel queryParam = ((RestQueryParam.Single) restQueryParam).getQueryParam();
                     final TsType type = typeFromJava(symbolTable, queryParam.getType(), method.getName(), method.getOriginClass());
-                    currentSingles.add(new TsProperty(queryParam.getName(), new TsType.OptionalType(type)));
+                    currentSingles.add(new TsProperty(queryParam.getName(), restQueryParam.required ? type : new TsType.OptionalType(type)));
                 }
                 if (restQueryParam instanceof RestQueryParam.Bean) {
                     final BeanModel queryBean = ((RestQueryParam.Bean) restQueryParam).getBean();
@@ -695,7 +695,9 @@ private TsMethodModel processRestMethod(TsModel tsModel, SymbolTable symbolTable
                 }
             }
             flushSingles.run();
-            queryParameter = new TsParameterModel("queryParams", new TsType.OptionalType(new TsType.IntersectionType(types)));
+            boolean allQueryParamsOptional = queryParams.stream().noneMatch(queryParam -> queryParam.required);
+            TsType.IntersectionType queryParamType = new TsType.IntersectionType(types);
+            queryParameter = new TsParameterModel("queryParams", allQueryParamsOptional ? new TsType.OptionalType(queryParamType) : queryParamType);
             parameters.add(queryParameter);
         } else {
             queryParameter = null;
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/JaxrsApplicationParser.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/JaxrsApplicationParser.java
@@ -173,7 +173,7 @@ private void parseResourceMethod(Result result, ResourceContext context, Class<?
             for (Parameter param : method.getParameters()) {
                 final QueryParam queryParamAnnotation = param.getAnnotation(QueryParam.class);
                 if (queryParamAnnotation != null) {
-                    queryParams.add(new RestQueryParam.Single(new MethodParameterModel(queryParamAnnotation.value(), param.getParameterizedType())));
+                    queryParams.add(new RestQueryParam.Single(new MethodParameterModel(queryParamAnnotation.value(), param.getParameterizedType()), false));
                     foundType(result, param.getParameterizedType(), resourceClass, method.getName());
                 }
                 final BeanParam beanParamAnnotation = param.getAnnotation(BeanParam.class);
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/RestQueryParam.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/RestQueryParam.java
@@ -4,10 +4,17 @@
 
 public abstract class RestQueryParam {
 
+    public boolean required;
+
+    RestQueryParam(boolean required) {
+        this.required = required;
+    }
+
     public static class Single extends RestQueryParam {
         private final MethodParameterModel queryParam;
 
-        public Single(MethodParameterModel queryParam) {
+        public Single(MethodParameterModel queryParam, boolean required) {
+            super(required);
             this.queryParam = queryParam;
         }
 
@@ -19,7 +26,9 @@ public MethodParameterModel getQueryParam() {
     public static class Bean extends RestQueryParam {
         private final BeanModel bean;
 
+        // Only used in JAX-Rs, so optional
         public Bean(BeanModel bean) {
+            super(false);
             this.bean = bean;
         }
 
diff --git a/typescript-generator-spring/src/main/java/cz/habarta/typescript/generator/spring/SpringApplicationParser.java b/typescript-generator-spring/src/main/java/cz/habarta/typescript/generator/spring/SpringApplicationParser.java
@@ -43,6 +43,7 @@
 import org.springframework.web.bind.annotation.RequestMethod;
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
+import org.springframework.web.bind.annotation.ValueConstants;
 
 public class SpringApplicationParser extends RestApplicationParser {
 
@@ -273,21 +274,24 @@ private void parseControllerMethod(JaxrsApplicationParser.Result result, JaxrsAp
             final List<RestQueryParam> queryParams = new ArrayList<>();
             for (Parameter parameter : method.getParameters()) {
                 if (parameter.getType() == Pageable.class) {
-                    queryParams.add(new RestQueryParam.Single(new MethodParameterModel("page", Long.class)));
+                    queryParams.add(new RestQueryParam.Single(new MethodParameterModel("page", Long.class), false));
                     foundType(result, Long.class, controllerClass, method.getName());
 
-                    queryParams.add(new RestQueryParam.Single(new MethodParameterModel("size", Long.class)));
+                    queryParams.add(new RestQueryParam.Single(new MethodParameterModel("size", Long.class), false));
                     foundType(result, Long.class, controllerClass, method.getName());
 
-                    queryParams.add(new RestQueryParam.Single(new MethodParameterModel("sort", String.class)));
+                    queryParams.add(new RestQueryParam.Single(new MethodParameterModel("sort", String.class), false));
                     foundType(result, String.class, controllerClass, method.getName());
                 } else {
                     final RequestParam requestParamAnnotation = AnnotationUtils.findAnnotation(parameter, RequestParam.class);
                     if (requestParamAnnotation != null) {
+
+                        final boolean isRequired = requestParamAnnotation.required() && requestParamAnnotation.defaultValue().equals(ValueConstants.DEFAULT_NONE);
+
                         queryParams.add(new RestQueryParam.Single(new MethodParameterModel(firstOf(
                             requestParamAnnotation.value(),
                             parameter.getName()
-                        ), parameter.getParameterizedType())));
+                        ), parameter.getParameterizedType()), isRequired));
                         foundType(result, parameter.getParameterizedType(), controllerClass, method.getName());
                     }
                 }
diff --git a/typescript-generator-spring/src/test/java/cz/habarta/typescript/generator/spring/SpringTest.java b/typescript-generator-spring/src/test/java/cz/habarta/typescript/generator/spring/SpringTest.java
@@ -87,7 +87,16 @@ public void testQueryParameters() {
         settings.outputFileType = TypeScriptFileType.implementationFile;
         settings.generateSpringApplicationClient = true;
         final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(Controller2.class));
-        Assert.assertTrue(output.contains("echo(queryParams?: { message?: string; count?: number; }): RestResponse<string>"));
+        Assert.assertTrue(output.contains("echo(queryParams: { message: string; count?: number; optionalRequestParam?: number; }): RestResponse<string>"));
+    }
+
+    @Test
+    public void testAllOptionalQueryParameters() {
+        final Settings settings = TestUtils.settings();
+        settings.outputFileType = TypeScriptFileType.implementationFile;
+        settings.generateSpringApplicationClient = true;
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(Controller7.class));
+        Assert.assertTrue(output.contains("echo(queryParams?: { message?: string; }): RestResponse<string>"));
     }
 
     @Test
@@ -149,7 +158,18 @@ public static class Controller2 {
         @RequestMapping("/echo")
         public String echo(
                 @RequestParam("message") String message,
-                @RequestParam(name = "count", defaultValue = "1") Integer count
+                @RequestParam(name = "count", defaultValue = "1") Integer count,
+                @RequestParam(required = false) Integer optionalRequestParam
+        ) {
+            return message;
+        }
+    }
+
+    @RestController
+    public static class Controller7 {
+        @RequestMapping("/echo2")
+        public String echo(
+                @RequestParam(required = false) String message
         ) {
             return message;
         }

Original file line number	Diff line number	Diff line change
`@@ -669,7 +669,7 @@ private TsMethodModel processRestMethod(TsModel tsModel, SymbolTable symbolTable`
`669`	`669`	`if (restQueryParam instanceof RestQueryParam.Single) {`
`670`	`670`	`final MethodParameterModel queryParam = ((RestQueryParam.Single) restQueryParam).getQueryParam();`
`671`	`671`	`final TsType type = typeFromJava(symbolTable, queryParam.getType(), method.getName(), method.getOriginClass());`
`672`		`- currentSingles.add(new TsProperty(queryParam.getName(), new TsType.OptionalType(type)));`
	`672`	`+ currentSingles.add(new TsProperty(queryParam.getName(), restQueryParam.required ? type : new TsType.OptionalType(type)));`
`673`	`673`	`}`
`674`	`674`	`if (restQueryParam instanceof RestQueryParam.Bean) {`
`675`	`675`	`final BeanModel queryBean = ((RestQueryParam.Bean) restQueryParam).getBean();`
`@@ -695,7 +695,9 @@ private TsMethodModel processRestMethod(TsModel tsModel, SymbolTable symbolTable`
`695`	`695`	`}`
`696`	`696`	`}`
`697`	`697`	`flushSingles.run();`
`698`		`- queryParameter = new TsParameterModel("queryParams", new TsType.OptionalType(new TsType.IntersectionType(types)));`
	`698`	`+ boolean allQueryParamsOptional = queryParams.stream().noneMatch(queryParam -> queryParam.required);`
	`699`	`+ TsType.IntersectionType queryParamType = new TsType.IntersectionType(types);`
	`700`	`+ queryParameter = new TsParameterModel("queryParams", allQueryParamsOptional ? new TsType.OptionalType(queryParamType) : queryParamType);`
`699`	`701`	`parameters.add(queryParameter);`
`700`	`702`	`} else {`
`701`	`703`	`queryParameter = null;`
Original file line number	Diff line number	Diff line change
`@@ -173,7 +173,7 @@ private void parseResourceMethod(Result result, ResourceContext context, Class<?`
`173`	`173`	`for (Parameter param : method.getParameters()) {`
`174`	`174`	`final QueryParam queryParamAnnotation = param.getAnnotation(QueryParam.class);`
`175`	`175`	`if (queryParamAnnotation != null) {`
`176`		`- queryParams.add(new RestQueryParam.Single(new MethodParameterModel(queryParamAnnotation.value(), param.getParameterizedType())));`
	`176`	`+ queryParams.add(new RestQueryParam.Single(new MethodParameterModel(queryParamAnnotation.value(), param.getParameterizedType()), false));`
`177`	`177`	`foundType(result, param.getParameterizedType(), resourceClass, method.getName());`
`178`	`178`	`}`
`179`	`179`	`final BeanParam beanParamAnnotation = param.getAnnotation(BeanParam.class);`