client-headers-factory option (#365) (#373)

* client-header-factory option

* client-header-factory fixes

* Update README.md



* Update README.md



* Update README.md



* Update README.md



* Update integration-tests/security/src/test/java/io/quarkiverse/openapi/generator/it/security/OpenWeatherTest.java



* Update integration-tests/security/src/test/java/io/quarkiverse/openapi/generator/it/security/OpenWeatherTest.java



* Update integration-tests/security/src/test/java/io/quarkiverse/openapi/generator/it/security/OpenWeatherTest.java



* client-header-factory readme section fix

* client-header-factory fix loadClass

* client-header-factory fix doc

* client-header-factory fix format

* client-header-factory fix format 2

---------

Co-authored-by: Michal Somora <[email protected]>
Co-authored-by: Helber Belmiro <[email protected]>

Author: 3 people

README.md

@@ -411,6 +411,18 @@ The token propagation can be used with type "oauth2" or "bearer" security scheme
 | `quarkus.openapi-generator.[filename].auth.[security_scheme_name].token-propagation=[true,false]` | `quarkus.openapi-generator.petstore_json.auth.petstore_auth.token-propagation=true`<br/>Enables the token propagation for all the operations that are secured with the `petstore_auth` scheme in the `petstore_json` file.
 | `quarkus.openapi-generator.[filename].auth.[security_scheme_name].header-name=[http_header_name]` | `quarkus.openapi-generator.petstore_json.auth.petstore_auth.header-name=MyHeaderName`<br/>Says that the authorization token to propagate will be read from the HTTP header `MyHeaderName` instead of the standard HTTP `Authorization` header.
 
+## Headers propagation
+Custom headers propagation can be set via MicroProfile configuration `org.eclipse.microprofile.rest.client.propagateHeaders`.
+In order to consider this configuration you must force `@RegisterClientHeaders` to use its default MicroProfile `ClientHeadersFactory` implementation. Therefore there is an option `client-headers-factory` where you can set any implementation of `ClientHeadersFactory`.
+
+| Description  | Property Key                                                               | Example                                                                                                                                                    |
+| -------------|----------------------------------------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------|
+| Bearer Token | `quarkus.openapi-generator.codegen.spec.[fileName].client-headers-factory` | `quarkus.openapi-generator.codegen.spec.open_weather_yaml.client-headers-factory=org.eclipse.microprofile.rest.client.ext.DefaultClientHeadersFactoryImpl` |
+
+If `client-headers-factory` is set to `none` `@RegisterClientHeaders` will use its default implicit implementation as in the example above.
+
+If no option is set then default generated `AuthenticationPropagationHeadersFactory` class is used.
+
 ## Circuit Breaker
 
 You can define the [CircuitBreaker annotation from MicroProfile Fault Tolerance](https://microprofile.io/project/eclipse/microprofile-fault-tolerance/spec/src/main/asciidoc/circuitbreaker.asciidoc)

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/CodegenConfig.java

@@ -34,6 +34,7 @@ public class CodegenConfig {
     private static final String CUSTOM_REGISTER_PROVIDERS_FORMAT = "%s.custom-register-providers";
 
     private static final String RETURN_RESPONSE_PROP_FORMAT = "%s.return-response";
+    private static final String CLIENT_HEADER_FACTORY_PROP_FORMAT = "%s.client-headers-factory";
 
     /**
      * OpenAPI Spec details for codegen configuration.
@@ -113,4 +114,8 @@ public static String getCustomRegisterProvidersFormat(final Path openApiFilePath
     public static String getReturnResponsePropertyName(final Path openApiFilePath) {
         return String.format(RETURN_RESPONSE_PROP_FORMAT, getBuildTimeSpecPropertyPrefix(openApiFilePath));
     }
+
+    public static String getClientHeaderFactoryPropertyName(final Path openApiFilePath) {
+        return String.format(CLIENT_HEADER_FACTORY_PROP_FORMAT, getBuildTimeSpecPropertyPrefix(openApiFilePath));
+    }
 }

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/SpecItemConfig.java

@@ -59,6 +59,17 @@ public class SpecItemConfig {
     @ConfigItem(name = "return-response")
     public Optional<Boolean> returnResponse;
 
+    /**
+     * ClientHeaderFactory class that should be used in @RegisterClientHeaders.
+     * Full class name is expected
+     * If option is not set then AuthenticationPropagationHeadersFactory is generated and used as value
+     * for @RegisterClientHeaders
+     * If set to 'none' then @RegisterClientHeaders will be generated without value and default microprofile implementation will
+     * be used
+     */
+    @ConfigItem(name = "client-headers-factory")
+    public Optional<String> clientHeadersFactory;
+
     /**
      * Defines the normalizer options.
      */

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

@@ -7,6 +7,7 @@
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.VERBOSE_PROPERTY_NAME;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getAdditionalModelTypeAnnotationsPropertyName;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getBasePackagePropertyName;
+import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getClientHeaderFactoryPropertyName;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getCustomRegisterProvidersFormat;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getImportMappingsPropertyName;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getNormalizerPropertyName;
@@ -163,6 +164,10 @@ protected void generate(final Config config, final Path openApiFilePath, final P
         generator.withReturnResponse(config.getOptionalValue(getReturnResponsePropertyName(openApiFilePath), Boolean.class)
                 .orElse(false));
 
+        generator.withClientHeaderFactory(
+                config.getOptionalValue(getClientHeaderFactoryPropertyName(openApiFilePath), String.class)
+                        .orElse("default"));
+
         SmallRyeConfig smallRyeConfig = config.unwrap(SmallRyeConfig.class);
         smallRyeConfig.getOptionalValues(getTypeMappingsPropertyName(openApiFilePath), String.class, String.class)
                 .ifPresent(generator::withTypeMappings);

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

@@ -134,6 +134,11 @@ public OpenApiClientGeneratorWrapper withReturnResponse(Boolean returnResponse)
         return this;
     }
 
+    public OpenApiClientGeneratorWrapper withClientHeaderFactory(String clientHeaderFactory) {
+        configurator.addAdditionalProperty("client-headers-factory", clientHeaderFactory);
+        return this;
+    }
+
     public OpenApiClientGeneratorWrapper withImportMappings(final Map<String, String> typeMappings) {
         typeMappings.forEach(configurator::addImportMapping);
         return this;

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

@@ -59,10 +59,14 @@ private void replaceWithQuarkusTemplateFiles() {
                     new SupportingFile(AUTH_PACKAGE + "/compositeAuthenticationProvider.qute",
                             authFileFolder(),
                             "CompositeAuthenticationProvider.java"));
-            supportingFiles.add(
-                    new SupportingFile("auth/headersFactory.qute",
-                            authFileFolder(),
-                            "AuthenticationPropagationHeadersFactory.java"));
+
+            if (this.additionalProperties.get("client-headers-factory") == null ||
+                    this.additionalProperties.get("client-headers-factory").equals("default")) {
+                supportingFiles.add(
+                        new SupportingFile("auth/headersFactory.qute",
+                                authFileFolder(),
+                                "AuthenticationPropagationHeadersFactory.java"));
+            }
         }
 
         apiTemplateFiles.clear();

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

@@ -11,8 +11,10 @@ import org.eclipse.microprofile.rest.client.annotation.RegisterProvider;
 {#if hasAuthMethods}
 import org.eclipse.microprofile.rest.client.annotation.RegisterClientHeaders;
 import {package}.auth.CompositeAuthenticationProvider;
+{#if client-headers-factory is 'default'}
 import {package}.auth.AuthenticationPropagationHeadersFactory;
 {/if}
+{/if}
 
 import java.io.InputStream;
 import java.io.OutputStream;
@@ -38,7 +40,14 @@ import io.quarkiverse.openapi.generator.annotations.GeneratedParam;
 @GeneratedClass(value="{openapi:parseUri(inputSpec)}", tag = "{baseName}")
 {#if hasAuthMethods}
 @RegisterProvider(CompositeAuthenticationProvider.class)
+{#when client-headers-factory}
+{#is 'default'}
 @RegisterClientHeaders(AuthenticationPropagationHeadersFactory.class)
+{#is 'none'}
+@RegisterClientHeaders
+{#else}
+@RegisterClientHeaders({client-headers-factory}.class)
+{/when}
 {/if}
 {#for crpClassConfig in custom-register-providers.orEmpty}
 @RegisterProvider({crpClassConfig}.class)