[Java][Vertx] Add option to generate methods that return Futures (#21083)

* [Java][Vertx] Add option to generate methods that return Futures

* run scripts

* update sample config and github workflow

* generate samples

* rerun script

* add vertx-no-nullable to samples workflow

Author: RickyRister

.github/workflows/samples-java-client-jdk11.yaml

@@ -61,6 +61,8 @@ jobs:
           - samples/client/petstore/java/webclient-swagger2
           - samples/client/petstore/java/webclient-useSingleRequestParameter
           - samples/client/petstore/java/vertx
+          - samples/client/petstore/java/vertx-no-nullable
+          - samples/client/petstore/java/vertx-supportVertxFuture
           - samples/client/petstore/java/jersey2-java8-localdatetime
           - samples/client/petstore/java/google-api-client
           - samples/client/petstore/java/rest-assured

bin/configs/java-vertx-supportVertxFuture.yaml

@@ -0,0 +1,10 @@
+generatorName: java
+outputDir: samples/client/petstore/java/vertx-supportVertxFuture
+library: vertx
+inputSpec: modules/openapi-generator/src/test/resources/3_0/petstore-with-fake-endpoints-models-for-testing.yaml
+templateDir: modules/openapi-generator/src/main/resources/Java
+additionalProperties:
+  artifactId: petstore-vertx-supportvertxfuture
+  hideGenerationTimestamp: "true"
+  dateLibrary: java8
+  supportVertxFuture: "true"

docs/generators/java-microprofile.md

@@ -87,6 +87,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sourceFolder|source folder for generated code| |src/main/java|
 |supportStreaming|Support streaming endpoint (beta)| |false|
 |supportUrlQuery|Generate toUrlQueryString in POJO (default to true). Available on `native`, `apache-httpclient` libraries.| |false|
+|supportVertxFuture|Also generate api methods that return a vertx Future instead of taking a callback. Only `vertx` supports this option. Requires vertx 4 or greater.| |false|
 |testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
 |useAbstractionForFiles|Use alternative types instead of java.io.File to allow passing bytes without a file on disk. Available on resttemplate, webclient, restclient, libraries| |false|
 |useBeanValidation|Use BeanValidation API annotations| |false|

docs/generators/java.md

@@ -87,6 +87,7 @@ These options may be applied as additional-properties (cli) or configOptions (pl
 |sourceFolder|source folder for generated code| |src/main/java|
 |supportStreaming|Support streaming endpoint (beta)| |false|
 |supportUrlQuery|Generate toUrlQueryString in POJO (default to true). Available on `native`, `apache-httpclient` libraries.| |false|
+|supportVertxFuture|Also generate api methods that return a vertx Future instead of taking a callback. Only `vertx` supports this option. Requires vertx 4 or greater.| |false|
 |testOutput|Set output folder for models and APIs tests| |${project.build.directory}/generated-test-sources/openapi|
 |useAbstractionForFiles|Use alternative types instead of java.io.File to allow passing bytes without a file on disk. Available on resttemplate, webclient, restclient, libraries| |false|
 |useBeanValidation|Use BeanValidation API annotations| |false|

modules/openapi-generator/src/main/java/org/openapitools/codegen/languages/JavaClientCodegen.java

@@ -101,6 +101,7 @@ public class JavaClientCodegen extends AbstractJavaCodegen
     public static final String WEBCLIENT_BLOCKING_OPERATIONS = "webclientBlockingOperations";
     public static final String USE_ENUM_CASE_INSENSITIVE = "useEnumCaseInsensitive";
     public static final String FAIL_ON_UNKNOWN_PROPERTIES = "failOnUnknownProperties";
+    public static final String SUPPORT_VERTX_FUTURE = "supportVertxFuture";
 
     public static final String SERIALIZATION_LIBRARY_GSON = "gson";
     public static final String SERIALIZATION_LIBRARY_JACKSON = "jackson";
@@ -243,6 +244,7 @@ public JavaClientCodegen() {
         cliOptions.add(CliOption.newBoolean(SUPPORT_URL_QUERY, "Generate toUrlQueryString in POJO (default to true). Available on `native`, `apache-httpclient` libraries."));
         cliOptions.add(CliOption.newBoolean(USE_ENUM_CASE_INSENSITIVE, "Use `equalsIgnoreCase` when String for enum comparison", useEnumCaseInsensitive));
         cliOptions.add(CliOption.newBoolean(FAIL_ON_UNKNOWN_PROPERTIES, "Fail Jackson de-serialization on unknown properties", this.failOnUnknownProperties));
+        cliOptions.add(CliOption.newBoolean(SUPPORT_VERTX_FUTURE, "Also generate api methods that return a vertx Future instead of taking a callback. Only `vertx` supports this option. Requires vertx 4 or greater."));
 
         supportedLibraries.put(JERSEY2, "HTTP client: Jersey client 2.25.1. JSON processing: Jackson 2.17.1");
         supportedLibraries.put(JERSEY3, "HTTP client: Jersey client 3.1.1. JSON processing: Jackson 2.17.1");

modules/openapi-generator/src/main/resources/Java/libraries/vertx/api.mustache

@@ -5,6 +5,10 @@ import {{invokerPackage}}.ApiClient;
 {{/imports}}
 import io.vertx.core.AsyncResult;
 import io.vertx.core.Handler;
+{{#supportVertxFuture}}
+import io.vertx.core.Future;
+import io.vertx.core.Promise;
+{{/supportVertxFuture}}
 import io.vertx.core.json.JsonObject;
 
 import java.util.*;
@@ -18,11 +22,33 @@ public interface {{classname}} {
     {{/isDeprecated}}
     void {{operationId}}({{#allParams}}{{>nullable_var_annotations}} {{{dataType}}} {{paramName}}, {{/allParams}}Handler<AsyncResult<{{{returnType}}}{{^returnType}}Void{{/returnType}}>> handler);
 
+    {{#supportVertxFuture}}
+    {{#isDeprecated}}
+    @Deprecated
+    {{/isDeprecated}}
+    default Future<{{{returnType}}}{{^returnType}}Void{{/returnType}}> {{operationId}}({{#allParams}}{{>nullable_var_annotations}} {{{dataType}}} {{paramName}}{{^-last}}, {{/-last}}{{/allParams}}){
+        Promise<{{{returnType}}}{{^returnType}}Void{{/returnType}}> promise = Promise.promise();
+        {{operationId}}({{#allParams}}{{paramName}}, {{/allParams}}promise);
+        return promise.future();
+    }
+
+    {{/supportVertxFuture}}
     {{#isDeprecated}}
     @Deprecated
     {{/isDeprecated}}
     void {{operationId}}({{#allParams}}{{>nullable_var_annotations}} {{{dataType}}} {{paramName}}, {{/allParams}}ApiClient.AuthInfo authInfo, Handler<AsyncResult<{{{returnType}}}{{^returnType}}Void{{/returnType}}>> handler);
 
+    {{#supportVertxFuture}}
+    {{#isDeprecated}}
+    @Deprecated
+    {{/isDeprecated}}
+    default Future<{{{returnType}}}{{^returnType}}Void{{/returnType}}> {{operationId}}({{#allParams}}{{>nullable_var_annotations}} {{{dataType}}} {{paramName}}, {{/allParams}}ApiClient.AuthInfo authInfo){
+        Promise<{{{returnType}}}{{^returnType}}Void{{/returnType}}> promise = Promise.promise();
+        {{operationId}}({{#allParams}}{{paramName}}, {{/allParams}}authInfo, promise);
+        return promise.future();
+    }
+
+    {{/supportVertxFuture}}
     {{/operation}}
     {{/operations}}
 }

modules/openapi-generator/src/main/resources/Java/libraries/vertx/build.gradle.mustache

@@ -32,7 +32,7 @@ ext {
     swagger_annotations_version = "1.5.21"
     jackson_version = "2.17.1"
     jackson_databind_version = "2.17.1"
-    vertx_version = "3.5.2"
+    vertx_version = "{{#supportVertxFuture}}4.0.0{{/supportVertxFuture}}{{^supportVertxFuture}}3.5.2{{/supportVertxFuture}}"
     junit_version = "5.10.3"
     {{#openApiNullable}}
     jackson_databind_nullable_version = "0.2.6"

modules/openapi-generator/src/main/resources/Java/libraries/vertx/pom.mustache

@@ -299,7 +299,7 @@
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
-        <vertx-version>3.5.2</vertx-version>
+        <vertx-version>{{#supportVertxFuture}}4.0.0{{/supportVertxFuture}}{{^supportVertxFuture}}3.5.2{{/supportVertxFuture}}</vertx-version>
         {{#swagger1AnnotationLibrary}}
         <swagger-annotations-version>1.6.6</swagger-annotations-version>
         {{/swagger1AnnotationLibrary}}

samples/client/petstore/java/vertx-supportVertxFuture/.github/workflows/maven.yml

@@ -0,0 +1,30 @@
+# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
+# For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
+#
+# This file is auto-generated by OpenAPI Generator (https://openapi-generator.tech)
+
+name: Java CI with Maven
+
+on:
+  push:
+    branches: [ main, master ]
+  pull_request:
+    branches: [ main, master ]
+
+jobs:
+  build:
+    name: Build OpenAPI Petstore
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        java: [ 17, 21 ]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up JDK
+      uses: actions/setup-java@v4
+      with:
+        java-version: ${{ matrix.java }}
+        distribution: 'temurin'
+        cache: maven
+    - name: Build with Maven
+      run: mvn -B package --no-transfer-progress --file pom.xml

samples/client/petstore/java/vertx-supportVertxFuture/.gitignore

@@ -0,0 +1,21 @@
+*.class
+
+# Mobile Tools for Java (J2ME)
+.mtj.tmp/
+
+# Package Files #
+*.jar
+*.war
+*.ear
+
+# exclude jar for gradle wrapper
+!gradle/wrapper/*.jar
+
+# virtual machine crash logs, see http://www.java.com/en/download/help/error_hotspot.xml
+hs_err_pid*
+
+# build files
+**/target
+target
+.gradle
+build