issue-237 OAuth2AuthenticationProvider is now managed by CDI (#239) (#244)

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

Author: hbelmiro

deployment/src/main/java/io/quarkiverse/openapi/generator/deployment/template/QuteTemplatingEngineAdapter.java

@@ -28,6 +28,7 @@ public class QuteTemplatingEngineAdapter extends AbstractTemplatingEngineAdapter
             "queryParams.qute",
             "auth/compositeAuthenticationProvider.qute",
             "auth/headersFactory.qute",
+            "auth/oauth2AuthenticationProvider.qute",
             "multipartFormdataPojo.qute"
     };
     public final Engine engine;

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

@@ -3,6 +3,7 @@
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.getSanitizedFileName;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.resolveApiPackage;
 import static io.quarkiverse.openapi.generator.deployment.CodegenConfig.resolveModelPackage;
+import static io.quarkiverse.openapi.generator.deployment.wrapper.QuarkusJavaClientCodegen.QUARKUS_GENERATOR_NAME;
 import static java.lang.Boolean.FALSE;
 import static java.lang.Boolean.TRUE;
 import static java.util.Objects.requireNonNull;
@@ -64,7 +65,7 @@ public OpenApiClientGeneratorWrapper(final Path specFilePath, final Path outputD
         this.configurator = new QuarkusCodegenConfigurator();
         this.configurator.setInputSpec(specFilePath.toString());
         this.configurator.setOutputDir(outputDir.toString());
-        this.configurator.addAdditionalProperty("quarkus-generator",
+        this.configurator.addAdditionalProperty(QUARKUS_GENERATOR_NAME,
                 Collections.singletonMap("openApiSpecId", getSanitizedFileName(specFilePath)));
         this.configurator.addAdditionalProperty("openApiNullable", false);
         this.configurator.setValidateSpec(validateSpec);

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

@@ -17,6 +17,8 @@
 
 public class QuarkusJavaClientCodegen extends JavaClientCodegen {
 
+    public static final String QUARKUS_GENERATOR_NAME = "quarkus-generator";
+
     private static final String AUTH_PACKAGE = "auth";
     /*
      * Default server URL (the first one in the OpenAPI spec file servers definition.
@@ -62,6 +64,18 @@ private void replaceWithQuarkusTemplateFiles() {
                             authFileFolder(),
                             "AuthenticationPropagationHeadersFactory.java"));
 
+            Object quarkusGeneratorProperties = additionalProperties.get(QUARKUS_GENERATOR_NAME);
+
+            if (!(quarkusGeneratorProperties instanceof Map)) {
+                throw new IllegalStateException("Quarkus generator properties not found.");
+            }
+
+            Object openApiSpecId = ((Map<?, ?>) quarkusGeneratorProperties).get("openApiSpecId");
+
+            supportingFiles.add(
+                    new SupportingFile("auth/oauth2AuthenticationProvider.qute",
+                            authFileFolder(),
+                            openApiSpecId + "OAuth2AuthenticationProvider.java"));
         }
 
         apiTemplateFiles.clear();

deployment/src/main/resources/templates/auth/compositeAuthenticationProvider.qute

@@ -18,18 +18,20 @@ import io.quarkiverse.openapi.generator.providers.ApiKeyIn;
 {#if hasHttpBearerMethods}
 import io.quarkiverse.openapi.generator.providers.BearerAuthenticationProvider;
 {/if}
-{#if hasOAuthMethods}
-import io.quarkiverse.openapi.generator.providers.OAuth2AuthenticationProvider;
-{/if}
 import io.quarkiverse.openapi.generator.providers.AbstractCompositeAuthenticationProvider;
 import io.quarkiverse.openapi.generator.providers.OperationAuthInfo;
 
 @Priority(Priorities.AUTHENTICATION)
 public class CompositeAuthenticationProvider extends AbstractCompositeAuthenticationProvider {
 
-    @Inject
+    @jakarta.inject.Inject
     OpenApiGeneratorConfig generatorConfig;
 
+    {#for auth in oauthMethods.orEmpty}
+    @jakarta.inject.Inject
+    {quarkus-generator.openApiSpecId}OAuth2AuthenticationProvider oAuth2Provider{auth_index};
+    {/for}
+
     @PostConstruct
     public void init() {
         {#for auth in httpBasicMethods.orEmpty}
@@ -58,7 +60,6 @@ public class CompositeAuthenticationProvider extends AbstractCompositeAuthentica
         {/for}
         {/for}
         {#for auth in oauthMethods.orEmpty}
-        OAuth2AuthenticationProvider oAuth2Provider{auth_index} = new OAuth2AuthenticationProvider("{quarkus-generator.openApiSpecId}", sanitizeAuthName("{auth.name}"), generatorConfig);
         this.addAuthenticationProvider(oAuth2Provider{auth_index});
         {#for api in apiInfo.apis}
         {#for op in api.operations.operation}

runtime/src/main/java/io/quarkiverse/openapi/generator/providers/OAuth2AuthenticationProvider.java renamed to deployment/src/main/resources/templates/auth/oauth2AuthenticationProvider.qute

@@ -1,4 +1,4 @@
-package io.quarkiverse.openapi.generator.providers;
+package {apiPackage}.auth;
 
 import static io.quarkiverse.openapi.generator.AuthConfig.TOKEN_PROPAGATION;
 
@@ -12,21 +12,30 @@
 import org.slf4j.LoggerFactory;
 
 import io.quarkiverse.openapi.generator.OpenApiGeneratorConfig;
+import io.quarkiverse.openapi.generator.providers.AbstractAuthProvider;
 import io.quarkus.oidc.client.filter.OidcClientRequestFilter;
 import io.quarkus.oidc.common.runtime.OidcConstants;
 
-public class OAuth2AuthenticationProvider extends AbstractAuthProvider {
+@io.quarkus.arc.Priority(jakarta.ws.rs.Priorities.AUTHENTICATION)
+@jakarta.enterprise.context.ApplicationScoped
+public class {quarkus-generator.openApiSpecId}OAuth2AuthenticationProvider extends AbstractAuthProvider {
 
-    private static final Logger LOGGER = LoggerFactory.getLogger(OAuth2AuthenticationProvider.class);
+    private static final Logger LOGGER = LoggerFactory.getLogger({quarkus-generator.openApiSpecId}OAuth2AuthenticationProvider.class);
 
-    private final OidcClientRequestFilter delegate;
+    private static final String SCHEMA_NAME = "oauth";
 
-    public OAuth2AuthenticationProvider(final String openApiSpecId, final String name,
-            final OpenApiGeneratorConfig generatorConfig) {
-        super(openApiSpecId, name, generatorConfig);
-        this.delegate = createDelegate();
-        // it's fine calling it here since this class will be created on `init()` method of the generated CompositeAuthenticationProvider
-        delegate.init();
+    private final OidcClientRequestFilterDelegate delegate;
+
+    {quarkus-generator.openApiSpecId}OAuth2AuthenticationProvider() {
+        // Required by CDI. Not supposed to be used.
+        delegate = null;
+    }
+
+    @jakarta.inject.Inject
+    public {quarkus-generator.openApiSpecId}OAuth2AuthenticationProvider(
+            final OpenApiGeneratorConfig generatorConfig, final OidcClientRequestFilterDelegate delegate) {
+        super("{quarkus-generator.openApiSpecId}", SCHEMA_NAME, generatorConfig);
+        this.delegate = delegate;
         validateConfig();
     }
 
@@ -49,21 +58,12 @@ private void validateConfig() {
         }
     }
 
-    OidcClientRequestFilterDelegate createDelegate() {
-        return new OidcClientRequestFilterDelegate(getName());
-    }
-
+    @jakarta.enterprise.context.ApplicationScoped
     static class OidcClientRequestFilterDelegate extends OidcClientRequestFilter {
 
-        private final String clientId;
-
-        public OidcClientRequestFilterDelegate(String clientId) {
-            this.clientId = clientId;
-        }
-
         @Override
         protected Optional<String> clientId() {
-            return Optional.of(this.clientId);
+            return Optional.of(SCHEMA_NAME);
         }
     }
 }

integration-tests/register-provider/pom.xml

@@ -15,6 +15,10 @@
       <groupId>io.quarkiverse.openapi.generator</groupId>
       <artifactId>quarkus-openapi-generator</artifactId>
     </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-oidc-client-filter</artifactId>
+    </dependency>
   </dependencies>
 
   <build>

integration-tests/security/pom.xml

@@ -16,6 +16,10 @@
       <groupId>io.quarkiverse.openapi.generator</groupId>
       <artifactId>quarkus-openapi-generator</artifactId>
     </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-oidc-client-filter</artifactId>
+    </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-junit5</artifactId>

integration-tests/skip-validation/pom.xml

@@ -16,6 +16,11 @@
       <groupId>io.quarkiverse.openapi.generator</groupId>
       <artifactId>quarkus-openapi-generator</artifactId>
     </dependency>
+    <dependency>
+      <groupId>io.quarkus</groupId>
+      <artifactId>quarkus-oidc-client-filter</artifactId>
+      <scope>provided</scope>
+    </dependency>
     <dependency>
       <groupId>io.quarkus</groupId>
       <artifactId>quarkus-junit5</artifactId>

runtime/src/main/java/io/quarkiverse/openapi/generator/providers/AbstractAuthProvider.java

@@ -28,6 +28,13 @@ public abstract class AbstractAuthProvider implements AuthProvider {
     private AuthConfig authConfig;
     private final List<OperationAuthInfo> applyToOperations = new ArrayList<>();
 
+    protected AbstractAuthProvider() {
+        // Required by CDI. Not supposed to be used.
+        openApiSpecId = null;
+        name = null;
+        generatorConfig = null;
+    }
+
     protected AbstractAuthProvider(String openApiSpecId, String name, OpenApiGeneratorConfig generatorConfig) {
         this.openApiSpecId = openApiSpecId;
         this.name = name;