Add possibility to use custom builder for RestMethodModel

porunov · porunov · commit 68c601769670 · 2022-02-04T00:00:41.000+02:00
Signed-off-by: Oleksandr Porunov &lt;alexandr.porunov@gmail.com&gt;
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/DefaultRestMethodBuilder.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/DefaultRestMethodBuilder.java
@@ -0,0 +1,21 @@
+package cz.habarta.typescript.generator;
+
+import cz.habarta.typescript.generator.parser.MethodParameterModel;
+import cz.habarta.typescript.generator.parser.RestMethodModel;
+import cz.habarta.typescript.generator.parser.RestQueryParam;
+import java.lang.reflect.Method;
+import java.lang.reflect.Type;
+import java.util.List;
+
+public class DefaultRestMethodBuilder implements RestMethodBuilder{
+
+    @Override
+    public RestMethodModel build(Class<?> originClass, String name, Type returnType, Method originalMethod,
+                                 Class<?> rootResource, String httpMethod, String path,
+                                 List<MethodParameterModel> pathParams, List<RestQueryParam> queryParams,
+                                 MethodParameterModel entityParam, List<String> comments) {
+
+        return new RestMethodModel(originClass, name, returnType, originalMethod, rootResource, httpMethod, path,
+                pathParams, queryParams, entityParam, comments);
+    }
+}
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/RestMethodBuilder.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/RestMethodBuilder.java
@@ -0,0 +1,16 @@
+package cz.habarta.typescript.generator;
+
+import cz.habarta.typescript.generator.parser.MethodParameterModel;
+import cz.habarta.typescript.generator.parser.RestMethodModel;
+import cz.habarta.typescript.generator.parser.RestQueryParam;
+import java.lang.reflect.Method;
+import java.lang.reflect.Type;
+import java.util.List;
+
+public interface RestMethodBuilder {
+
+    RestMethodModel build(Class<?> originClass, String name, Type returnType, Method originalMethod,
+                          Class<?> rootResource, String httpMethod, String path, List<MethodParameterModel> pathParams, List<RestQueryParam> queryParams, MethodParameterModel entityParam,
+                          List<String> comments);
+
+}
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Settings.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/Settings.java
@@ -110,6 +110,7 @@ public class Settings {
     public boolean restOptionsTypeIsGeneric;
     private List<RestApplicationParser.Factory> restApplicationParserFactories;
     public TypeProcessor customTypeProcessor = null;
+    public RestMethodBuilder customRestMethodBuilder = null;
     public boolean sortDeclarations = false;
     public boolean sortTypeDeclarations = false;
     public boolean noFileComment = false;
@@ -231,6 +232,12 @@ public void loadCustomTypeProcessor(ClassLoader classLoader, String customTypePr
         }
     }
 
+    public void loadCustomRestMethodBuilder(ClassLoader classLoader, String customRestMethodBuilder) {
+        if (customRestMethodBuilder != null) {
+            this.customRestMethodBuilder = loadInstance(classLoader, customRestMethodBuilder, RestMethodBuilder.class);
+        }
+    }
+
     public void loadExtensions(ClassLoader classLoader, List<String> extensions, List<Settings.ConfiguredExtension> extensionsWithConfiguration) {
         this.extensions = new ArrayList<>();
         this.extensions.addAll(loadInstances(classLoader, extensions, EmitterExtension.class));
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
@@ -233,7 +233,7 @@ private void parseResourceMethod(Result result, ResourceContext context, Class<?
             // comments
             final List<String> comments = Swagger.getOperationComments(swaggerOperation);
             // create method
-            model.getMethods().add(new RestMethodModel(resourceClass, method.getName(), resolvedModelReturnType, method,
+            model.getMethods().add(restMethodBuilder.build(resourceClass, method.getName(), resolvedModelReturnType, method,
                     context.rootResource, httpMethod.value(), context.path, pathParams, queryParams, entityParameter, comments));
         }
         // JAX-RS specification - 3.4.1 Sub Resources
diff --git a/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/RestApplicationParser.java b/typescript-generator-core/src/main/java/cz/habarta/typescript/generator/parser/RestApplicationParser.java
@@ -1,6 +1,8 @@
 
 package cz.habarta.typescript.generator.parser;
 
+import cz.habarta.typescript.generator.DefaultRestMethodBuilder;
+import cz.habarta.typescript.generator.RestMethodBuilder;
 import cz.habarta.typescript.generator.Settings;
 import cz.habarta.typescript.generator.TypeProcessor;
 import cz.habarta.typescript.generator.util.Utils;
@@ -17,6 +19,7 @@ public abstract class RestApplicationParser {
     protected final Predicate<String> isClassNameExcluded;
     protected final TypeProcessor commonTypeProcessor;
     protected final RestApplicationModel model;
+    protected final RestMethodBuilder restMethodBuilder;
 
     public static abstract class Factory {
 
@@ -33,6 +36,9 @@ public RestApplicationParser(Settings settings, TypeProcessor commonTypeProcesso
         this.isClassNameExcluded = settings.getExcludeFilter();
         this.commonTypeProcessor = commonTypeProcessor;
         this.model = model;
+        this.restMethodBuilder = settings.customRestMethodBuilder == null ?
+                new DefaultRestMethodBuilder() :
+                settings.customRestMethodBuilder;
     }
 
     public RestApplicationModel getModel() {
diff --git a/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/JaxrsApplicationTest.java b/typescript-generator-core/src/test/java/cz/habarta/typescript/generator/JaxrsApplicationTest.java
@@ -5,7 +5,10 @@
 import cz.habarta.typescript.generator.compiler.ModelCompiler;
 import cz.habarta.typescript.generator.parser.BeanModel;
 import cz.habarta.typescript.generator.parser.JaxrsApplicationParser;
+import cz.habarta.typescript.generator.parser.MethodParameterModel;
 import cz.habarta.typescript.generator.parser.Model;
+import cz.habarta.typescript.generator.parser.RestMethodModel;
+import cz.habarta.typescript.generator.parser.RestQueryParam;
 import cz.habarta.typescript.generator.parser.SourceType;
 import cz.habarta.typescript.generator.type.JGenericArrayType;
 import cz.habarta.typescript.generator.type.JTypeWithNullability;
@@ -40,6 +43,7 @@
 import java.io.File;
 import java.io.InputStream;
 import java.io.Reader;
+import java.lang.reflect.Method;
 import java.lang.reflect.Type;
 import java.net.URI;
 import java.util.ArrayList;
@@ -704,6 +708,18 @@ public void testGenericResources() {
         Assertions.assertTrue(output.contains("interface AccountDto"));
     }
 
+    @Test
+    public void testCustomREstMethodBuilder() {
+        final Settings settings = TestUtils.settings();
+        settings.generateJaxrsApplicationClient = true;
+        settings.outputFileType = TypeScriptFileType.implementationFile;
+        settings.customRestMethodBuilder = new CustomRestMethodBuilder();
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(AccountResource.class));
+        Assertions.assertTrue(!output.contains("get(testParam: ID): RestResponse<ENTITY>"));
+        Assertions.assertTrue(output.contains("get(testParam: string): RestResponse<AccountDto>"));
+        Assertions.assertTrue(output.contains("interface AccountDto"));
+    }
+
     public static class AccountDto {
         public Integer id;
         public String name;
@@ -728,4 +744,16 @@ public static void main(String[] args) {
         System.out.println("Jersey started.");
     }
 
+    public class CustomRestMethodBuilder implements RestMethodBuilder{
+
+        @Override
+        public RestMethodModel build(Class<?> originClass, String name, Type returnType,
+                                     Method originalMethod, Class<?> rootResource, String httpMethod,
+                                     String path, List<MethodParameterModel> pathParams, List<RestQueryParam> queryParams,
+                                     MethodParameterModel entityParam, List<String> comments) {
+
+            return new RestMethodModel(originClass, name, returnType, originalMethod, rootResource, httpMethod, path,
+                    Arrays.asList(new MethodParameterModel("testParam", String.class)), queryParams, entityParam, comments);
+        }
+    }
 }
diff --git a/typescript-generator-maven-plugin/src/main/java/cz/habarta/typescript/generator/maven/GenerateMojo.java b/typescript-generator-maven-plugin/src/main/java/cz/habarta/typescript/generator/maven/GenerateMojo.java
@@ -16,6 +16,7 @@
 import cz.habarta.typescript.generator.OptionalProperties;
 import cz.habarta.typescript.generator.OptionalPropertiesDeclaration;
 import cz.habarta.typescript.generator.Output;
+import cz.habarta.typescript.generator.RestMethodBuilder;
 import cz.habarta.typescript.generator.RestNamespacing;
 import cz.habarta.typescript.generator.Settings;
 import cz.habarta.typescript.generator.StringQuotes;
@@ -625,6 +626,15 @@ public class GenerateMojo extends AbstractMojo {
     @Parameter
     private String customTypeProcessor;
 
+    /**
+     * Specifies custom class implementing {@link RestMethodBuilder}.
+     * This allows to customize how Rest methods are mapped to TypeScript.
+     * For example, it is possible to implement RestMethodBuilder to filter or add some query parameters or
+     * change the returned type, etc.
+     */
+    @Parameter
+    private String customRestMethodBuilder;
+
     /**
      * If <code>true</code> TypeScript declarations (interfaces, properties) will be sorted alphabetically.
      */
@@ -949,6 +959,7 @@ private Settings createSettings(URLClassLoader classLoader) {
         settings.restResponseType = restResponseType;
         settings.setRestOptionsType(restOptionsType);
         settings.loadCustomTypeProcessor(classLoader, customTypeProcessor);
+        settings.loadCustomRestMethodBuilder(classLoader, customRestMethodBuilder);
         settings.sortDeclarations = sortDeclarations;
         settings.sortTypeDeclarations = sortTypeDeclarations;
         settings.noFileComment = noFileComment;
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
@@ -348,7 +348,7 @@ private void parseControllerMethod(JaxrsApplicationParser.Result result, JaxrsAp
             final Type modelReturnType = parseReturnType(controllerClass, method);
             foundType(result, modelReturnType, controllerClass, method.getName());
 
-            model.getMethods().add(new RestMethodModel(controllerClass, method.getName(), modelReturnType, method,
+            model.getMethods().add(restMethodBuilder.build(controllerClass, method.getName(), modelReturnType, method,
                 controllerClass, httpMethod.name(), context.path, pathParams, queryParams, entityParameter, null));
         }
     }
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
@@ -2,16 +2,23 @@
 package cz.habarta.typescript.generator.spring;
 
 import cz.habarta.typescript.generator.Input;
+import cz.habarta.typescript.generator.RestMethodBuilder;
 import cz.habarta.typescript.generator.Settings;
 import cz.habarta.typescript.generator.TestUtils;
 import cz.habarta.typescript.generator.TypeScriptFileType;
 import cz.habarta.typescript.generator.TypeScriptGenerator;
+import cz.habarta.typescript.generator.parser.MethodParameterModel;
+import cz.habarta.typescript.generator.parser.RestMethodModel;
+import cz.habarta.typescript.generator.parser.RestQueryParam;
 import cz.habarta.typescript.generator.util.Utils;
 import io.swagger.annotations.ApiOperation;
 import io.swagger.v3.oas.annotations.Operation;
+import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
 import java.lang.reflect.Method;
+import java.lang.reflect.Type;
 import java.util.Arrays;
 import java.util.Collection;
 import java.util.List;
@@ -35,7 +42,6 @@
 import org.springframework.web.bind.annotation.RequestParam;
 import org.springframework.web.bind.annotation.RestController;
 
-
 public class SpringTest {
 
     @Test
@@ -169,6 +175,17 @@ public void testInheritance() {
         Assertions.assertFalse(output.contains("uriEncoding`test/b`"));
     }
 
+    @Test
+    public void testCustomRestMethodBuilder() {
+        final Settings settings = TestUtils.settings();
+        settings.outputFileType = TypeScriptFileType.implementationFile;
+        settings.generateSpringApplicationClient = true;
+        settings.customRestMethodBuilder = new CustomRestMethodBuilder();
+        final String output = new TypeScriptGenerator(settings).generateTypeScript(Input.from(Controller3.class));
+        Assertions.assertTrue(output.contains("testName(data: Data1, queryParams: { testParam1: string; testParam2?: number; }): RestResponse<void>"));
+        Assertions.assertTrue(output.contains("interface Data1"));
+    }
+
     @RestController
     @RequestMapping("/owners/{ownerId}")
     public static class Controller1 {
@@ -488,4 +505,20 @@ public String shouldBeExcluded() {
         }
     }
 
+    public class CustomRestMethodBuilder implements RestMethodBuilder{
+
+        @Override
+        public RestMethodModel build(Class<?> originClass, String name, Type returnType,
+                                     Method originalMethod, Class<?> rootResource, String httpMethod,
+                                     String path, List<MethodParameterModel> pathParams, List<RestQueryParam> queryParams,
+                                     MethodParameterModel entityParam, List<String> comments) {
+
+            RestQueryParam.Single queryParam1 = new RestQueryParam.Single(new MethodParameterModel("testParam1", String.class), true);
+            RestQueryParam.Single queryParam2 = new RestQueryParam.Single(new MethodParameterModel("testParam2", Integer.class), false);
+
+            return new RestMethodModel(originClass, "testName", returnType, originalMethod, rootResource, httpMethod, path,
+                    pathParams, Arrays.asList(queryParam1, queryParam2), entityParam, comments);
+        }
+    }
+
 }

Original file line number	Diff line number	Diff line change
`@@ -233,7 +233,7 @@ private void parseResourceMethod(Result result, ResourceContext context, Class<?`
`233`	`233`	`// comments`
`234`	`234`	`final List<String> comments = Swagger.getOperationComments(swaggerOperation);`
`235`	`235`	`// create method`
`236`		`- model.getMethods().add(new RestMethodModel(resourceClass, method.getName(), resolvedModelReturnType, method,`
	`236`	`+ model.getMethods().add(restMethodBuilder.build(resourceClass, method.getName(), resolvedModelReturnType, method,`
`237`	`237`	`context.rootResource, httpMethod.value(), context.path, pathParams, queryParams, entityParameter, comments));`
`238`	`238`	`}`
`239`	`239`	`// JAX-RS specification - 3.4.1 Sub Resources`
Original file line number	Diff line number	Diff line change
`@@ -348,7 +348,7 @@ private void parseControllerMethod(JaxrsApplicationParser.Result result, JaxrsAp`
`348`	`348`	`final Type modelReturnType = parseReturnType(controllerClass, method);`
`349`	`349`	`foundType(result, modelReturnType, controllerClass, method.getName());`
`350`	`350`
`351`		`- model.getMethods().add(new RestMethodModel(controllerClass, method.getName(), modelReturnType, method,`
	`351`	`+ model.getMethods().add(restMethodBuilder.build(controllerClass, method.getName(), modelReturnType, method,`
`352`	`352`	`controllerClass, httpMethod.name(), context.path, pathParams, queryParams, entityParameter, null));`
`353`	`353`	`}`
`354`	`354`	`}`