Skip to content

Commit

Permalink
Combine R2dbc logic into CloudSqlEnvironmentPostProcessor
Browse files Browse the repository at this point in the history
  • Loading branch information
@mpeddada1
mpeddada1 committed Dec 14, 2021
1 parent 99202b3 commit dee8706
Show file tree
Hide file tree
Showing 8 changed files with 340 additions and 364 deletions.
180 changes: 139 additions & 41 deletions ...main/java/com/google/cloud/spring/autoconfigure/sql/CloudSqlEnvironmentPostProcessor.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -31,15 +31,19 @@
import org.springframework.boot.SpringApplication;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.context.properties.bind.PlaceholdersResolver;
import org.springframework.boot.context.properties.bind.PropertySourcesPlaceholdersResolver;
import org.springframework.boot.context.properties.source.ConfigurationPropertySources;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.io.Resource;
import org.springframework.util.Assert;
import org.springframework.util.ClassUtils;

/**
* Provides Google Cloud SQL instance connectivity through Spring JDBC by providing only a
* Provides Google Cloud SQL instance connectivity through Spring JDBC and R2DBC by providing only a
* database and instance connection name.
*
* @author João André Martins
Expand All @@ -49,8 +53,7 @@
* @author Eddú Meléndez
*/
public class CloudSqlEnvironmentPostProcessor implements EnvironmentPostProcessor {
private static final Log LOGGER =
LogFactory.getLog(CloudSqlEnvironmentPostProcessor.class);
private static final Log LOGGER = LogFactory.getLog(CloudSqlEnvironmentPostProcessor.class);

@Override
public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application) {
Expand All @@ -61,55 +64,116 @@ public void postProcessEnvironment(ConfigurableEnvironment environment, SpringAp
}

DatabaseType databaseType = getEnabledDatabaseType(environment);
R2dbcDatabaseType r2dbcDatabaseType = getEnabledR2dbcDatabaseType(environment);
if (databaseType == null && r2dbcDatabaseType == null) {
return;
}

// Bind properties without resolving Secret Manager placeholders
Binder binder = new Binder(ConfigurationPropertySources.get(environment),
new NonSecretsManagerPropertiesPlaceholdersResolver(environment),
null, null, null);

String cloudSqlPropertiesPrefix = GcpCloudSqlProperties.class.getAnnotation(ConfigurationProperties.class)
.value();
GcpCloudSqlProperties sqlProperties = binder
.bind(cloudSqlPropertiesPrefix, GcpCloudSqlProperties.class)
.orElse(new GcpCloudSqlProperties());
GcpProperties gcpProperties = binder
.bind(cloudSqlPropertiesPrefix, GcpProperties.class)
.orElse(new GcpProperties());

if (databaseType != null) {
if (LOGGER.isInfoEnabled()) {
LOGGER.info("post-processing Cloud SQL properties for + " + databaseType.name());
}

// Bind properties without resolving Secret Manager placeholders
Binder binder = new Binder(ConfigurationPropertySources.get(environment),
new NonSecretsManagerPropertiesPlaceholdersResolver(environment),
null, null, null);

String cloudSqlPropertiesPrefix = GcpCloudSqlProperties.class.getAnnotation(ConfigurationProperties.class).value();
GcpCloudSqlProperties sqlProperties = binder
.bind(cloudSqlPropertiesPrefix, GcpCloudSqlProperties.class)
.orElse(new GcpCloudSqlProperties());
GcpProperties gcpProperties = binder
.bind(cloudSqlPropertiesPrefix, GcpProperties.class)
.orElse(new GcpProperties());

CloudSqlJdbcInfoProvider cloudSqlJdbcInfoProvider = new DefaultCloudSqlJdbcInfoProvider(sqlProperties, databaseType);
applyJdbcSettings(environment, sqlProperties, databaseType);
}
else if (r2dbcDatabaseType != null) {
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Default " + databaseType.name()
+ " JdbcUrl provider. Connecting to "
+ cloudSqlJdbcInfoProvider.getJdbcUrl() + " with driver "
+ cloudSqlJdbcInfoProvider.getJdbcDriverClass());
LOGGER.info("post-processing Cloud SQL properties for + " + r2dbcDatabaseType.name());
}
applyR2dbcSettings(environment, sqlProperties, r2dbcDatabaseType);
}
setCredentials(sqlProperties, gcpProperties);

// support usage metrics
CoreSocketFactory.setApplicationName("spring-cloud-gcp-sql/"
+ this.getClass().getPackage().getImplementationVersion());
}

/**
* Sets the DataSource properties such as driver class name and connection url based on
* the Cloud SQL properties specified.
* @param environment environment to post-process
* @param sqlProperties cloud sql properties
* @param databaseType enum containing MySQl and PostgreSQL information (for example, jdbc
* url template and default username)
*/
private void applyJdbcSettings(ConfigurableEnvironment environment, GcpCloudSqlProperties sqlProperties,
DatabaseType databaseType) {
CloudSqlJdbcInfoProvider cloudSqlJdbcInfoProvider = new DefaultCloudSqlJdbcInfoProvider(sqlProperties,
databaseType);
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Default " + databaseType.name()
+ " JdbcUrl provider. Connecting to "
+ cloudSqlJdbcInfoProvider.getJdbcUrl() + " with driver "
+ cloudSqlJdbcInfoProvider.getJdbcDriverClass());
}

// configure default JDBC driver and username as fallback values when not specified
Map<String, Object> fallbackMap = new HashMap<>();
fallbackMap.put("spring.datasource.username", databaseType.getDefaultUsername());
fallbackMap.put("spring.datasource.driver-class-name", cloudSqlJdbcInfoProvider.getJdbcDriverClass());
environment.getPropertySources()
.addLast(new MapPropertySource("CLOUD_SQL_DATA_SOURCE_FALLBACK", fallbackMap));
// Configure default JDBC driver and username as fallback values when not specified
Map<String, Object> fallbackMap = new HashMap<>();
fallbackMap.put("spring.datasource.username", databaseType.getDefaultUsername());
fallbackMap.put("spring.datasource.driver-class-name", cloudSqlJdbcInfoProvider.getJdbcDriverClass());
environment.getPropertySources()
.addLast(new MapPropertySource("CLOUD_SQL_DATA_SOURCE_FALLBACK", fallbackMap));

// always set the spring.datasource.url property in the environment
Map<String, Object> primaryMap = new HashMap<>();
primaryMap.put("spring.datasource.url", cloudSqlJdbcInfoProvider.getJdbcUrl());
environment.getPropertySources()
.addFirst(new MapPropertySource("CLOUD_SQL_DATA_SOURCE_URL", primaryMap));
// Always set the spring.datasource.url property in the environment
Map<String, Object> primaryMap = new HashMap<>();
primaryMap.put("spring.datasource.url", cloudSqlJdbcInfoProvider.getJdbcUrl());
environment.getPropertySources()
.addFirst(new MapPropertySource("CLOUD_SQL_DATA_SOURCE_URL", primaryMap));
}

setCredentials(sqlProperties, gcpProperties);

// support usage metrics
CoreSocketFactory.setApplicationName("spring-cloud-gcp-sql/"
+ this.getClass().getPackage().getImplementationVersion());
/**
* Sets the R2DBC properties such as username and connection url based on the Cloud SQL
* properties specified.
* @param environment environment to post-process
* @param sqlProperties cloud sql properties
* @param r2dbcDatabaseType enum containing MySQl and PostgreSQL information (for example,
* r2dbc url and default username)
*/
private void applyR2dbcSettings(ConfigurableEnvironment environment, GcpCloudSqlProperties sqlProperties,
R2dbcDatabaseType r2dbcDatabaseType) {
String r2dbcUrl = createR2dbcUrl(r2dbcDatabaseType, sqlProperties);
if (LOGGER.isInfoEnabled()) {
LOGGER.info("Default " + r2dbcDatabaseType.name()
+ " R2dbcUrl provider. Connecting to "
+ r2dbcUrl);
}

// Add default username as fallback when not specified
Map<String, Object> fallbackMap = new HashMap<>();
fallbackMap.put("spring.r2dbc.username", r2dbcDatabaseType.getDefaultUsername());
environment.getPropertySources().addLast(new MapPropertySource("CLOUD_SQL_R2DBC_FALLBACK", fallbackMap));

// Always set the spring.r2dbc.url property in the environment
Map<String, Object> primaryMap = new HashMap<>();
primaryMap.put("spring.r2dbc.url", r2dbcUrl);
environment.getPropertySources().addFirst(new MapPropertySource("CLOUD_SQL_R2DBC_URL", primaryMap));
}

private DatabaseType getEnabledDatabaseType(ConfigurableEnvironment environment) {
String createR2dbcUrl(R2dbcDatabaseType databaseType, GcpCloudSqlProperties sqlProperties) {
Assert.hasText(sqlProperties.getDatabaseName(), "A database name must be provided.");
Assert.hasText(sqlProperties.getInstanceConnectionName(),
"An instance connection name must be provided in the format <PROJECT_ID>:<REGION>:<INSTANCE_ID>.");

return String.format(databaseType.getUrlTemplate(),
sqlProperties.getInstanceConnectionName(), sqlProperties.getDatabaseName());
}

DatabaseType getEnabledDatabaseType(ConfigurableEnvironment environment) {
if (Boolean.parseBoolean(environment.getProperty("spring.cloud.gcp.sql.enabled", "true"))
&& isOnClasspath("javax.sql.DataSource")
&& isOnClasspath("org.springframework.jdbc.datasource.embedded.EmbeddedDatabaseType")
Expand All @@ -126,22 +190,39 @@ && isOnClasspath("org.postgresql.Driver")) {
return null;
}

R2dbcDatabaseType getEnabledR2dbcDatabaseType(ConfigurableEnvironment environment) {
if (Boolean.parseBoolean(environment.getProperty("spring.cloud.gcp.sql.enabled", "true"))
&& isOnClasspath("com.google.cloud.sql.CredentialFactory")) {
if (isOnClasspath("com.google.cloud.sql.core.GcpConnectionFactoryProviderMysql") &&
isOnClasspath("dev.miku.r2dbc.mysql.MySqlConnectionFactoryProvider")) {
return R2dbcDatabaseType.MYSQL;
}
else if (isOnClasspath("com.google.cloud.sql.core.GcpConnectionFactoryProviderPostgres")
&& isOnClasspath("io.r2dbc.postgresql.PostgresqlConnectionFactoryProvider")) {
return R2dbcDatabaseType.POSTGRESQL;
}
}
return null;
}

private boolean isOnClasspath(String className) {
return ClassUtils.isPresent(className, null);
}

/**
* Set credentials to be used by the Google Cloud SQL socket factory.
*
* <p>The only way to pass a {@link CredentialFactory} to the socket factory is by passing a
* <p>
* The only way to pass a {@link CredentialFactory} to the socket factory is by passing a
* class name through a system property. The socket factory creates an instance of
* {@link CredentialFactory} using reflection without any arguments. Because of that, the
* credential location needs to be stored somewhere where the class can read it without
* any context. It could be possible to pass in a Spring context to
* {@link SqlCredentialFactory}, but this is a tricky solution that needs some thinking
* about.
*
* <p>If user didn't specify credentials, the socket factory already does the right thing by
* <p>
* If user didn't specify credentials, the socket factory already does the right thing by
* using the application default credentials by default. So we don't need to do anything.
*/
private void setCredentials(GcpCloudSqlProperties sqlProperties, GcpProperties gcpProperties) {
Expand Down Expand Up @@ -173,7 +254,6 @@ private void setCredentialsEncodedKeyProperty(String encodedKey) {
SqlCredentialFactory.class.getName());
}


private void setCredentialsFileProperty(Resource credentialsLocation) {
try {
// A resource might not be in the filesystem, but the Cloud SQL credential must.
Expand All @@ -190,4 +270,22 @@ private void setCredentialsFileProperty(Resource credentialsLocation) {
LOGGER.info("Error reading Cloud SQL credentials file.", ioe);
}
}

private static class NonSecretsManagerPropertiesPlaceholdersResolver implements PlaceholdersResolver {
private PlaceholdersResolver resolver;

NonSecretsManagerPropertiesPlaceholdersResolver(Environment environment) {
this.resolver = new PropertySourcesPlaceholdersResolver(environment);
}

@Override
public Object resolvePlaceholders(Object value) {
if (value.toString().contains("sm://")) {
return value;
}
else {
return resolver.resolvePlaceholders(value);
}
}
}
}
2 changes: 1 addition & 1 deletion ...p-autoconfigure/src/main/java/com/google/cloud/spring/autoconfigure/sql/DatabaseType.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
package com.google.cloud.spring.autoconfigure.sql;

/**
* Enum class containing MySQL and Postgresql constants.
* Enum class for JDBC workflow containing MySQL and Postgresql constants.
*
* @author João André Martins
* @author Chengyuan Zhao
Expand Down
39 changes: 0 additions & 39 deletions ...oogle/cloud/spring/autoconfigure/sql/NonSecretsManagerPropertiesPlaceholdersResolver.java
View file

This file was deleted.

Loading

0 comments on commit dee8706

Please sign in to comment.