Merge pull request #9608 from vsevel/credentials_rename_field

Rename credentials-provider-type into credentials-provider-name

Author: gsmet

docs/src/main/asciidoc/credentials-provider.adoc

@@ -175,12 +175,12 @@ First, you need to name it to avoid collisions in case multiple credentials prov
 public class MyCredentialsProvider implements CredentialsProvider {
 ----
 
-It is the responsibility of the consumer to allow a `credentials-provider-type` property:
+It is the responsibility of the consumer to allow a `credentials-provider-name` property:
 
 [source, properties]
 ----
 quarkus.datasource.credentials-provider = custom
-quarkus.datasource.credentials-provider-type = my-credentials-provider
+quarkus.datasource.credentials-provider-name = my-credentials-provider
 ----
 
 The extension should allow runtime config, such as the `CredentialsProviderConfig` from the `vault` extension

extensions/agroal/runtime/src/main/java/io/quarkus/agroal/runtime/DataSources.java

@@ -38,7 +38,6 @@
 import io.quarkus.agroal.runtime.DataSourcesJdbcRuntimeConfig.DataSourceJdbcOuterNamedRuntimeConfig;
 import io.quarkus.agroal.runtime.JdbcDriver.JdbcDriverLiteral;
 import io.quarkus.arc.Arc;
-import io.quarkus.arc.ArcContainer;
 import io.quarkus.arc.InstanceHandle;
 import io.quarkus.credentials.CredentialsProvider;
 import io.quarkus.credentials.runtime.CredentialsProviderFinder;
@@ -53,7 +52,7 @@
 
 /**
  * This class is sort of a producer for {@link AgroalDataSource}.
- *
+ * <p>
  * It isn't a CDI producer in the literal sense, but it created a synthetic bean
  * from {@code AgroalProcessor}
  * The {@code createDataSource} method is called at runtime (see
@@ -105,11 +104,11 @@ public DataSources(DataSourcesBuildTimeConfig dataSourcesBuildTimeConfig,
      * Meant to be used from recorders that create synthetic beans that need access to {@code Datasource}.
      * In such using {@code Arc.container.instance(DataSource.class)} is not possible because
      * {@code Datasource} is itself a synthetic bean.
-     *
+     * <p>
      * This method relies on the fact that {@code DataSources} should - given the same input -
      * always return the same {@code AgroalDataSource} no matter how many times it is invoked
      * (which makes sense because {@code DataSource} is a {@code Singleton} bean).
-     *
+     * <p>
      * This method is thread-safe
      */
     public static AgroalDataSource fromName(String dataSourceName) {
@@ -266,8 +265,8 @@ private void applyNewConfiguration(AgroalDataSourceConfigurationSupplier dataSou
 
         // credentials provider
         if (dataSourceRuntimeConfig.credentialsProvider.isPresent()) {
-            String type = dataSourceRuntimeConfig.credentialsProviderType.orElse(null);
-            CredentialsProvider credentialsProvider = CredentialsProviderFinder.find(type);
+            String beanName = dataSourceRuntimeConfig.credentialsProviderName.orElse(null);
+            CredentialsProvider credentialsProvider = CredentialsProviderFinder.find(beanName);
             String name = dataSourceRuntimeConfig.credentialsProvider.get();
             connectionFactoryConfiguration
                     .credential(new AgroalVaultCredentialsProviderPassword(name, credentialsProvider));
@@ -361,17 +360,10 @@ private void applyLegacyConfiguration(AgroalDataSourceConfigurationSupplier data
                     .credential(new SimplePassword(dataSourceRuntimeConfig.password.get()));
         }
 
-        // Vault credentials provider
+        // credentials provider
         if (dataSourceRuntimeConfig.credentialsProvider.isPresent()) {
-            ArcContainer container = Arc.container();
-            String type = dataSourceRuntimeConfig.credentialsProviderType.orElse(null);
-            CredentialsProvider credentialsProvider = type != null
-                    ? (CredentialsProvider) container.instance(type).get()
-                    : container.instance(CredentialsProvider.class).get();
-
-            if (credentialsProvider == null) {
-                throw new RuntimeException("unable to find credentials provider of type " + (type == null ? "default" : type));
-            }
+            String beanName = dataSourceRuntimeConfig.credentialsProviderName.orElse(null);
+            CredentialsProvider credentialsProvider = CredentialsProviderFinder.find(beanName);
 
             String name = dataSourceRuntimeConfig.credentialsProvider.get();
             connectionFactoryConfiguration

extensions/datasource/runtime/src/main/java/io/quarkus/datasource/runtime/DataSourceRuntimeConfig.java

@@ -27,13 +27,13 @@ public class DataSourceRuntimeConfig {
     public Optional<String> credentialsProvider = Optional.empty();
 
     /**
-     * The credentials provider type.
+     * The credentials provider bean name.
      * <p>
      * It is the {@code &#64;Named} value of the credentials provider bean. It is used to discriminate if multiple
      * CredentialsProvider beans are available.
      * <p>
      * For Vault it is: vault-credentials-provider. Not necessary if there is only one credentials provider available.
      */
     @ConfigItem
-    public Optional<String> credentialsProviderType = Optional.empty();
+    public Optional<String> credentialsProviderName = Optional.empty();
 }

extensions/reactive-mysql-client/runtime/src/main/java/io/quarkus/reactive/mysql/client/runtime/MySQLPoolRecorder.java

@@ -98,8 +98,8 @@ private MySQLConnectOptions toMySQLConnectOptions(DataSourceRuntimeConfig dataSo
 
         // credentials provider
         if (dataSourceRuntimeConfig.credentialsProvider.isPresent()) {
-            String type = dataSourceRuntimeConfig.credentialsProviderType.orElse(null);
-            CredentialsProvider credentialsProvider = CredentialsProviderFinder.find(type);
+            String beanName = dataSourceRuntimeConfig.credentialsProviderName.orElse(null);
+            CredentialsProvider credentialsProvider = CredentialsProviderFinder.find(beanName);
             String name = dataSourceRuntimeConfig.credentialsProvider.get();
             Map<String, String> credentials = credentialsProvider.getCredentials(name);
             String user = credentials.get(USER_PROPERTY_NAME);

extensions/reactive-pg-client/runtime/src/main/java/io/quarkus/reactive/pg/client/runtime/PgPoolRecorder.java

@@ -100,8 +100,8 @@ private PgConnectOptions toPgConnectOptions(DataSourceRuntimeConfig dataSourceRu
 
         // credentials provider
         if (dataSourceRuntimeConfig.credentialsProvider.isPresent()) {
-            String type = dataSourceRuntimeConfig.credentialsProviderType.orElse(null);
-            CredentialsProvider credentialsProvider = CredentialsProviderFinder.find(type);
+            String beanName = dataSourceRuntimeConfig.credentialsProviderName.orElse(null);
+            CredentialsProvider credentialsProvider = CredentialsProviderFinder.find(beanName);
             String name = dataSourceRuntimeConfig.credentialsProvider.get();
             Map<String, String> credentials = credentialsProvider.getCredentials(name);
             String user = credentials.get(USER_PROPERTY_NAME);

integration-tests/vault-agroal/src/test/resources/application-vault-datasource.properties

@@ -19,7 +19,7 @@ quarkus.datasource.staticDS.jdbc.url=jdbc:postgresql://localhost:6543/mydb
 quarkus.datasource.dynamicDS.db-kind=postgresql
 quarkus.datasource.dynamicDS.username=postgres
 quarkus.datasource.dynamicDS.credentials-provider=dynamic-ds
-quarkus.datasource.dynamicDS.credentials-provider-type=vault-credentials-provider
+quarkus.datasource.dynamicDS.credentials-provider-name=vault-credentials-provider
 quarkus.datasource.dynamicDS.jdbc.url=jdbc:postgresql://localhost:6543/mydb
 
 quarkus.log.category."io.quarkus.vault".level=DEBUG