Add support to RESTEasy Reactive (#262)

Signed-off-by: Helber Belmiro <[email protected]>

Author: hbelmiro

.github/workflows/build.yml

@@ -24,6 +24,7 @@ on:
 
 jobs:
   build:
+    name: Build - RESTEasy Classic
     runs-on: ${{ matrix.os }}
     strategy:
      matrix:
@@ -43,3 +44,25 @@ jobs:
 
       - name: Build with Maven
         run: mvn '-Dorg.slf4j.simpleLogger.log.org.openapitools=off' -B formatter:validate verify --file pom.xml
+
+  build_reactive:
+    name: Build - RESTEasy Reactive
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest, windows-latest]
+    steps:
+      - name: Prepare git
+        run: git config --global core.autocrlf false
+        if: startsWith(matrix.os, 'windows')
+
+      - uses: actions/checkout@v2
+      - name: Set up JDK 11
+        uses: actions/setup-java@v2
+        with:
+          distribution: temurin
+          java-version: 11
+          cache: 'maven'
+
+      - name: Build with Maven
+        run: mvn -Presteasy-reactive '-Dorg.slf4j.simpleLogger.log.org.openapitools=off' -B verify --file pom.xml

README.md

@@ -122,6 +122,35 @@ public class PetResource {
 
 See the [integration-tests](integration-tests) module for more information of how to use this extension. Please be advised that the extension is on experimental, early development stage.
 
+## RESTEasy Reactive and Classic support
+
+You can use the `quarkus-openapi-generator` with REST Client Classic or REST Client Reactive respectively. To do so add either the classic or reactive jackson dependency to your project's `pom.xml` file:
+
+### RESTEasy Classic
+
+```xml
+<dependency>
+  <groupId>io.quarkus</groupId>
+  <artifactId>quarkus-rest-client-jackson</artifactId>
+</dependency>
+```
+> **⚠️** After Version 1.2.1 / 2.1.1 you need to declare the above dependency explicitly! Even if you stay with the REST Client Classic implementation!
+
+### RESTEasy Reactive
+
+```xml
+<dependency>
+  <groupId>io.quarkus</groupId>
+  <artifactId>quarkus-rest-client-reactive-jackson</artifactId>
+</dependency>
+```
+
+For both implementations, the generated code is always blocking code.
+
+When using RESTEasy Reactive:
+  - The client must not declare multiple MIME-TYPES with `@Consumes`
+  - You might need to implement a `ParamConverter` for each complex type
+
 ## Returning `Response` objects
 
 By default, this extension generates the methods according to their returning models based on the [OpenAPI specification Schema Object](https://spec.openapis.org/oas/v3.1.0#schema-object). If you want to return `javax.ws.rs.core.Response` instead, you can set the `return-response` property to `true`.
@@ -278,14 +307,24 @@ The configuration suffix `quarkus.oidc-client.petstore_auth` is exclusive for th
 
 For this to work you **must** add [Quarkus OIDC Client Filter Extension](https://quarkus.io/guides/security-openid-connect-client#oidc-client-filter) to your project:
 
-````xml
+RESTEasy Classic:
 
+````xml
 <dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-oidc-client-filter</artifactId>
 </dependency>
 ````
 
+RESTEasy Reactive:
+
+```xml
+<dependency>
+  <groupId>io.quarkus</groupId>
+  <artifactId>quarkus-oidc-client-reactive-filter</artifactId>
+</dependency>
+```
+
 See the module [generation-tests](integration-tests/generation-tests) for an example of how to use this feature.
 
 ## Authorization Token Propagation
@@ -499,10 +538,11 @@ See the module [circuit-breaker](integration-tests/circuit-breaker) for an examp
 The rest client also supports request with mime-type multipart/form-data and, if the schema of the request body is known in advance, we can also automatically generate the models of the request
 bodies.
 
-You need to add the following additional dependency to your `pom.xml`:
+> **⚠️** Tip: RESTEasy Reactive supports multipart/form-data [out of the box](https://quarkus.io/guides/rest-client-reactive#multipart). Thus, no additional dependency is required.
 
-```xml
+If you're using RESTEasy Classic, you need to add the following additional dependency to your `pom.xml`:
 
+```xml
 <dependency>
   <groupId>io.quarkus</groupId>
   <artifactId>quarkus-resteasy-multipart</artifactId>
@@ -512,8 +552,8 @@ You need to add the following additional dependency to your `pom.xml`:
 For any multipart/form-data operation a model for the request body will be generated. Each part of the multipart is a field in this model that is annotated with the following annotations:
 
 - `javax.ws.rs.FormParam`, where the value parameter denotes the part name,
-- `org.jboss.resteasy.annotations.providers.multipart.PartType`, where the parameter is the jax-rs MediaType of the part (see below for details),
-- and, if the part contains a file, `org.jboss.resteasy.annotations.providers.multipart.PartFilename`, with a generated default parameter that will be passed as the fileName sub-header in the
+- `PartType`, where the parameter is the jax-rs MediaType of the part (see below for details),
+- and, if the part contains a file, `PartFilename`, with a generated default parameter that will be passed as the fileName sub-header in the
   Content-Disposition header of the part.
 
 For example, the model for a request that requires a file, a string and some complex object will look like this:
@@ -536,7 +576,7 @@ public class MultipartBody {
 }
 ```
 
-Then in the client the `org.jboss.resteasy.annotations.providers.multipart.MultipartForm` annotation is added in front of the multipart parameter:
+Then in the client, when using RESTEasy Classic, the `org.jboss.resteasy.annotations.providers.multipart.MultipartForm` annotation is added in front of the multipart parameter:
 
 ```java
 @Path("/echo")
@@ -551,9 +591,26 @@ public interface MultipartService {
 }
 ```
 
+When using RESTEasy Reactive, the `javax.ws.rs.BeanParam` annotation is added in front of the multipart parameter:
+
+```java
+@Path("/echo")
+@RegisterRestClient(baseUri="http://my.endpoint.com/api/v1", configKey="multipart-requests_yml")
+public interface MultipartService {
+
+  @POST
+  @Consumes(MediaType.MULTIPART_FORM_DATA)
+  @Produces(MediaType.TEXT_PLAIN)
+  String sendMultipartData(@javax.ws.rs.BeanParam MultipartBody data);
+
+}
+```
+
 See [Quarkus - Using the REST Client with Multipart](https://quarkus.io/guides/rest-client-multipart) and
 the [RESTEasy JAX-RS specifications](https://docs.jboss.org/resteasy/docs/4.7.5.Final/userguide/html_single/index.html) for more details.
 
+> **⚠️** `MultipartForm`  is deprecated when using RESTEasy Reactive.
+
 `baseURI` value of `RegisterRestClient` annotation is extracted from the `servers` section of the file, if present. If not, it will be left empty and it is expected you set up the uri to be used in your configuration.
 
 Importantly, if some multipart request bodies contain complex objects (i.e. non-primitives) you need to explicitly tell the Open API generator to create models for these objects by setting
@@ -669,7 +726,6 @@ See the module [type-mapping](integration-tests/type-mapping) for an example of
 
 These are the known limitations of this pre-release version:
 
-- No reactive support
 - Only Jackson support
 
 We will work in the next few releases to address these use cases, until there please provide feedback for the current state of this extension. We also love contributions :heart:

deployment/pom.xml

@@ -21,10 +21,6 @@
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-core-deployment</artifactId>
     </dependency>
-    <dependency>
-      <groupId>io.quarkus</groupId>
-      <artifactId>quarkus-rest-client-jackson-deployment</artifactId>
-    </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-devtools-utilities</artifactId>

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/OpenApiGeneratorCodeGenBase.java

@@ -26,10 +26,14 @@
 import io.quarkiverse.openapi.generator.OpenApiGeneratorException;
 import io.quarkiverse.openapi.generator.deployment.CodegenConfig;
 import io.quarkiverse.openapi.generator.deployment.circuitbreaker.CircuitBreakerConfigurationParser;
+import io.quarkiverse.openapi.generator.deployment.wrapper.OpenApiClassicClientGeneratorWrapper;
 import io.quarkiverse.openapi.generator.deployment.wrapper.OpenApiClientGeneratorWrapper;
+import io.quarkiverse.openapi.generator.deployment.wrapper.OpenApiReactiveClientGeneratorWrapper;
 import io.quarkus.bootstrap.prebuild.CodeGenException;
+import io.quarkus.deployment.Capability;
 import io.quarkus.deployment.CodeGenContext;
 import io.quarkus.deployment.CodeGenProvider;
+import io.quarkus.maven.dependency.ResolvedDependency;
 import io.smallrye.config.SmallRyeConfig;
 
 /**
@@ -70,6 +74,12 @@ public boolean shouldRun(Path sourceDir, Config config) {
         return inputBaseDir != null || Files.isDirectory(sourceDir);
     }
 
+    protected boolean isRestEasyReactive(CodeGenContext context) {
+        return context.applicationModel().getExtensionCapabilities().stream()
+                .flatMap(extensionCapability -> extensionCapability.getProvidesCapabilities().stream())
+                .anyMatch(Capability.REST_CLIENT_REACTIVE::equals);
+    }
+
     @Override
     public boolean trigger(CodeGenContext context) throws CodeGenException {
         final Path outDir = context.outDir();
@@ -79,6 +89,17 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
         final List<String> filesToExclude = context.config().getOptionalValues(EXCLUDE_FILES, String.class).orElse(List.of());
 
         if (Files.isDirectory(openApiDir)) {
+            final boolean isRestEasyReactive = isRestEasyReactive(context);
+
+            if (isRestEasyReactive) {
+                if (!isJacksonReactiveClientPresent(context)) {
+                    throw new CodeGenException(
+                            "You need to add io.quarkus:quarkus-rest-client-reactive-jackson to your dependencies.");
+                }
+            } else if (!isJacksonClassicClientPresent(context)) {
+                throw new CodeGenException("You need to add io.quarkus:quarkus-rest-client-jackson to your dependencies.");
+            }
+
             try (Stream<Path> openApiFilesPaths = Files.walk(openApiDir)) {
                 openApiFilesPaths
                         .filter(Files::isRegularFile)
@@ -88,7 +109,7 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
                                     && !filesToExclude.contains(fileName)
                                     && (filesToInclude.isEmpty() || filesToInclude.contains(fileName));
                         })
-                        .forEach(openApiFilePath -> generate(context.config(), openApiFilePath, outDir));
+                        .forEach(openApiFilePath -> generate(context.config(), openApiFilePath, outDir, isRestEasyReactive));
             } catch (IOException e) {
                 throw new CodeGenException("Failed to generate java files from OpenApi files in " + openApiDir.toAbsolutePath(),
                         e);
@@ -98,20 +119,34 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
         return false;
     }
 
+    private boolean isJacksonReactiveClientPresent(CodeGenContext context) {
+        return context.applicationModel().getDependencies().stream()
+                .anyMatch(this::isJacksonReactiveClient);
+    }
+
+    private boolean isJacksonClassicClientPresent(CodeGenContext context) {
+        return context.applicationModel().getExtensionCapabilities().stream()
+                .flatMap(extensionCapability -> extensionCapability.getProvidesCapabilities().stream())
+                .anyMatch(Capability.RESTEASY_JSON_JACKSON_CLIENT::equals);
+    }
+
+    private boolean isJacksonReactiveClient(ResolvedDependency resolvedDependency) {
+        return "quarkus-rest-client-reactive-jackson".equals(resolvedDependency.getArtifactId())
+                && "io.quarkus".equals(resolvedDependency.getGroupId());
+    }
+
     // TODO: do not generate if the output dir has generated files and the openapi file has the same checksum of the previous run
-    protected void generate(final Config config, final Path openApiFilePath, final Path outDir) {
+    protected void generate(final Config config, final Path openApiFilePath, final Path outDir, boolean isRestEasyReactive) {
         final String basePackage = getBasePackage(config, openApiFilePath);
         final Boolean verbose = config.getOptionalValue(VERBOSE_PROPERTY_NAME, Boolean.class).orElse(false);
         final Boolean validateSpec = config.getOptionalValue(VALIDATE_SPEC_PROPERTY_NAME, Boolean.class).orElse(true);
         GlobalSettings.setProperty(OpenApiClientGeneratorWrapper.DEFAULT_SECURITY_SCHEME,
                 config.getOptionalValue(CodegenConfig.DEFAULT_SECURITY_SCHEME, String.class).orElse(""));
 
-        final OpenApiClientGeneratorWrapper generator = new OpenApiClientGeneratorWrapper(
-                openApiFilePath.normalize(),
-                outDir,
-                verbose,
-                validateSpec)
-                .withClassesCodeGenConfig(ClassCodegenConfigParser.parse(config, basePackage))
+        final OpenApiClientGeneratorWrapper generator = createGeneratorWrapper(openApiFilePath, outDir, isRestEasyReactive,
+                verbose, validateSpec);
+
+        generator.withClassesCodeGenConfig(ClassCodegenConfigParser.parse(config, basePackage))
                 .withCircuitBreakerConfig(CircuitBreakerConfigurationParser.parse(
                         config));
 
@@ -137,6 +172,23 @@ protected void generate(final Config config, final Path openApiFilePath, final P
         generator.generate(basePackage);
     }
 
+    private static OpenApiClientGeneratorWrapper createGeneratorWrapper(Path openApiFilePath, Path outDir,
+            boolean isRestEasyReactive, Boolean verbose, Boolean validateSpec) {
+        if (isRestEasyReactive) {
+            return new OpenApiReactiveClientGeneratorWrapper(
+                    openApiFilePath.normalize(),
+                    outDir,
+                    verbose,
+                    validateSpec);
+        } else {
+            return new OpenApiClassicClientGeneratorWrapper(
+                    openApiFilePath.normalize(),
+                    outDir,
+                    verbose,
+                    validateSpec);
+        }
+    }
+
     private String getBasePackage(final Config config, final Path openApiFilePath) {
         return config
                 .getOptionalValue(getBasePackagePropertyName(openApiFilePath), String.class)

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/codegen/OpenApiGeneratorStreamCodeGen.java

@@ -58,6 +58,8 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
 
         boolean generated = false;
 
+        boolean isRestEasyReactive = isRestEasyReactive(context);
+
         for (final OpenApiSpecInputProvider provider : this.providers) {
             for (SpecInputModel inputModel : provider.read(context)) {
                 LOGGER.debug("Processing OpenAPI spec input model {}", inputModel);
@@ -72,7 +74,7 @@ public boolean trigger(CodeGenContext context) throws CodeGenException {
                                     StandardOpenOption.CREATE)) {
                         outChannel.transferFrom(inChannel, 0, Integer.MAX_VALUE);
                         LOGGER.debug("Saved OpenAPI spec input model in {}", openApiFilePath);
-                        this.generate(this.mergeConfig(context, inputModel), openApiFilePath, outDir);
+                        this.generate(this.mergeConfig(context, inputModel), openApiFilePath, outDir, isRestEasyReactive);
                         generated = true;
                     }
                 } catch (IOException e) {

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClassicClientGeneratorWrapper.java

@@ -0,0 +1,16 @@
+package io.quarkiverse.openapi.generator.deployment.wrapper;
+
+import java.nio.file.Path;
+
+public class OpenApiClassicClientGeneratorWrapper extends OpenApiClientGeneratorWrapper {
+
+    public OpenApiClassicClientGeneratorWrapper(Path specFilePath, Path outputDir, boolean verbose, boolean validateSpec) {
+        super(createConfigurator(), specFilePath, outputDir, verbose, validateSpec);
+    }
+
+    private static QuarkusCodegenConfigurator createConfigurator() {
+        QuarkusCodegenConfigurator configurator = new QuarkusCodegenConfigurator();
+        configurator.addAdditionalProperty("is-resteasy-reactive", false);
+        return configurator;
+    }
+}

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiClientGeneratorWrapper.java

@@ -26,7 +26,7 @@
  *
  * @see <a href="https://openapi-generator.tech/docs/generators/java">OpenAPI Generator Client for Java</a>
  */
-public class OpenApiClientGeneratorWrapper {
+public abstract class OpenApiClientGeneratorWrapper {
 
     public static final String VERBOSE = "verbose";
     private static final String ONCE_LOGGER = "org.openapitools.codegen.utils.oncelogger.enabled";
@@ -47,7 +47,8 @@ public class OpenApiClientGeneratorWrapper {
     private String apiPackage = "";
     private String modelPackage = "";
 
-    public OpenApiClientGeneratorWrapper(final Path specFilePath, final Path outputDir, final boolean verbose,
+    OpenApiClientGeneratorWrapper(final QuarkusCodegenConfigurator configurator, final Path specFilePath, final Path outputDir,
+            final boolean verbose,
             final boolean validateSpec) {
         // do not generate docs nor tests
         GlobalSettings.setProperty(CodegenConstants.API_DOCS, FALSE.toString());
@@ -62,7 +63,7 @@ public OpenApiClientGeneratorWrapper(final Path specFilePath, final Path outputD
         GlobalSettings.setProperty(VERBOSE, String.valueOf(verbose));
         GlobalSettings.setProperty(ONCE_LOGGER, verbose ? FALSE.toString() : TRUE.toString());
 
-        this.configurator = new QuarkusCodegenConfigurator();
+        this.configurator = configurator;
         this.configurator.setInputSpec(specFilePath.toString());
         this.configurator.setOutputDir(outputDir.toString());
         this.configurator.addAdditionalProperty(QUARKUS_GENERATOR_NAME,

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/wrapper/OpenApiReactiveClientGeneratorWrapper.java

@@ -0,0 +1,16 @@
+package io.quarkiverse.openapi.generator.deployment.wrapper;
+
+import java.nio.file.Path;
+
+public class OpenApiReactiveClientGeneratorWrapper extends OpenApiClientGeneratorWrapper {
+
+    public OpenApiReactiveClientGeneratorWrapper(Path specFilePath, Path outputDir, boolean verbose, boolean validateSpec) {
+        super(createConfigurator(), specFilePath, outputDir, verbose, validateSpec);
+    }
+
+    private static QuarkusCodegenConfigurator createConfigurator() {
+        QuarkusCodegenConfigurator configurator = new QuarkusCodegenConfigurator();
+        configurator.addAdditionalProperty("is-resteasy-reactive", true);
+        return configurator;
+    }
+}

deployment/src/main/resources/templates/api.qute

@@ -80,11 +80,19 @@ public interface {classname} {
     public {#if op.returnType}{op.returnType}{#else}void{/if} {op.nickname}(
         {/if}
         {#if op.hasFormParams}
+        {#if is-resteasy-reactive}
+        @javax.ws.rs.BeanParam {op.operationIdCamelCase}MultipartForm multipartForm{#if op.hasPathParams},{/if}{!
+        !}{#for p in op.pathParams}{#include pathParams.qute param=p/}{#if p_hasNext}, {/if}{/for}{#if op.hasQueryParams},{/if}{!
+        !}{#for p in op.queryParams}{#include queryParams.qute param=p/}{#if p_hasNext}, {/if}{/for}{#if op.hasBodyParams},{/if}{!
+        !}{#for p in op.bodyParams}{#include bodyParams.qute param=p/}{#if p_hasNext}, {/if}{/for}{#if op.hasHeaderParams},{/if}{!
+        !}{#for p in op.headerParams}{#include headerParams.qute param=p/}{#if p_hasNext}, {/if}{/for}
+        {#else}
         @org.jboss.resteasy.annotations.providers.multipart.MultipartForm {op.operationIdCamelCase}MultipartForm multipartForm{#if op.hasPathParams},{/if}{!
         !}{#for p in op.pathParams}{#include pathParams.qute param=p/}{#if p_hasNext}, {/if}{/for}{#if op.hasQueryParams},{/if}{!
         !}{#for p in op.queryParams}{#include queryParams.qute param=p/}{#if p_hasNext}, {/if}{/for}{#if op.hasBodyParams},{/if}{!
         !}{#for p in op.bodyParams}{#include bodyParams.qute param=p/}{#if p_hasNext}, {/if}{/for}{#if op.hasHeaderParams},{/if}{!
         !}{#for p in op.headerParams}{#include headerParams.qute param=p/}{#if p_hasNext}, {/if}{/for}
+        {/if}
         {#else}
         {#for p in op.allParams}
         {#include pathParams.qute param=p/}{#include queryParams.qute param=p/}{#include bodyParams.qute param=p/}{#include headerParams.qute param=p/}{#if p_hasNext}, {/if}