chore: Use domain name from JDBC URL for SQL Server, Part of #2043. (#2101)

Enables Sql Server users to set the domain name in the JDBC URL. Users simply replace the instance connection
name with the domain name.

Due to limitations of the SQL Server driver, users cannot use the JDBC URL's host field.

Part of #2043

Author: hessjcg

core/src/main/java/com/google/cloud/sql/core/CloudSqlInstanceName.java

@@ -24,8 +24,10 @@
 /**
  * This class parses the different parts of a Cloud SQL Connection Name to allow users to easily
  * fetch the projectId, regionId, and instanceId.
+ *
+ * <p>INTERNAL USE ONLY! This API may change without notice.
  */
-class CloudSqlInstanceName {
+public class CloudSqlInstanceName {
 
   // Unique identifier for each Cloud SQL instance in the format "PROJECT:REGION:INSTANCE"
   // Some legacy project ids are domain-scoped (e.g. "example.com:PROJECT:REGION:INSTANCE")
@@ -68,6 +70,17 @@ public static boolean isValidDomain(String domain) {
     return matcher.matches();
   }
 
+  /**
+   * Checks if a string is a well-formed instance name.
+   *
+   * @param connectionName the value to check
+   * @return true if it is a well-formed instance name.
+   */
+  public static boolean isValidInstanceName(String connectionName) {
+    Matcher matcher = CONNECTION_NAME.matcher(connectionName);
+    return matcher.matches();
+  }
+
   /**
    * Initializes a new CloudSqlInstanceName class.
    *

jdbc/sqlserver/src/main/java/com/google/cloud/sql/sqlserver/SocketFactory.java

@@ -16,6 +16,7 @@
 
 package com.google.cloud.sql.sqlserver;
 
+import com.google.cloud.sql.core.CloudSqlInstanceName;
 import com.google.cloud.sql.core.ConnectionConfig;
 import com.google.cloud.sql.core.InternalConnectorRegistry;
 import com.google.common.annotations.VisibleForTesting;
@@ -25,7 +26,6 @@
 import java.net.InetAddress;
 import java.net.Socket;
 import java.net.URLDecoder;
-import java.nio.charset.StandardCharsets;
 import java.util.List;
 import java.util.Properties;
 
@@ -43,14 +43,20 @@ public class SocketFactory extends javax.net.SocketFactory {
 
   // props are protected, not private, so that they can be accessed from unit tests
   @VisibleForTesting protected Properties props = new Properties();
+  @VisibleForTesting protected String domainName;
 
   /**
    * Implements the {@link SocketFactory} constructor, which can be used to create authenticated
    * connections to a Cloud SQL instance.
    */
   public SocketFactory(String socketFactoryConstructorArg) throws UnsupportedEncodingException {
     List<String> s = Splitter.on('?').splitToList(socketFactoryConstructorArg);
-    this.props.setProperty(ConnectionConfig.CLOUD_SQL_INSTANCE_PROPERTY, s.get(0));
+    final String instanceOrDomainName = s.get(0);
+    if (CloudSqlInstanceName.isValidInstanceName(instanceOrDomainName)) {
+      this.props.setProperty(ConnectionConfig.CLOUD_SQL_INSTANCE_PROPERTY, instanceOrDomainName);
+    } else {
+      domainName = instanceOrDomainName;
+    }
     if (s.size() == 2 && s.get(1).length() > 0) {
       Iterable<String> queryParams = Splitter.on('&').split(s.get(1));
       for (String param : queryParams) {
@@ -62,8 +68,8 @@ public SocketFactory(String socketFactoryConstructorArg) throws UnsupportedEncod
               String.format("Malformed query param in socketFactoryConstructorArg : %s", param));
         }
         this.props.setProperty(
-            URLDecoder.decode(splitParam.get(0), StandardCharsets.UTF_8.name()),
-            URLDecoder.decode(splitParam.get(1), StandardCharsets.UTF_8.name()));
+            URLDecoder.decode(splitParam.get(0), "utf-8"),
+            URLDecoder.decode(splitParam.get(1), "utf-8"));
       }
     } else if (s.size() > 2) {
       throw new IllegalArgumentException(
@@ -75,7 +81,7 @@ public SocketFactory(String socketFactoryConstructorArg) throws UnsupportedEncod
   public Socket createSocket() throws IOException {
     try {
       return InternalConnectorRegistry.getInstance()
-          .connect(ConnectionConfig.fromConnectionProperties(props));
+          .connect(ConnectionConfig.fromConnectionProperties(props, domainName));
     } catch (InterruptedException e) {
       throw new RuntimeException(e);
     }

jdbc/sqlserver/src/test/java/com/google/cloud/sql/sqlserver/JdbcSqlServerIntegrationTests.java

@@ -74,7 +74,9 @@ public void setUpPool() throws SQLException {
         "socketFactoryClass", "com.google.cloud.sql.sqlserver.SocketFactory");
     config.addDataSourceProperty("socketFactoryConstructorArg", CONNECTION_NAME);
     config.addDataSourceProperty("encrypt", "false");
-    config.setConnectionTimeout(10000); // 10s
+    config.setConnectionTimeout(30000); // 30s
+    config.setInitializationFailTimeout(10000);
+    config.setValidationTimeout(10000);
 
     this.connectionPool = new HikariDataSource(config);
   }

jdbc/sqlserver/src/test/java/com/google/cloud/sql/sqlserver/JdbcSqlServerUnitTests.java

@@ -28,6 +28,7 @@
 public class JdbcSqlServerUnitTests {
 
   private static final String CONNECTION_NAME = "my-project:my-region:my-instance";
+  private static final String DOMAIN_NAME = "mydatabase.example.com";
 
   @Test
   public void checkConnectionStringNoQueryParams() throws UnsupportedEncodingException {
@@ -46,6 +47,23 @@ public void checkConnectionStringWithQueryParam() throws UnsupportedEncodingExce
     assertThat(socketFactory.props.get("ipTypes")).isEqualTo("PRIVATE");
   }
 
+  @Test
+  public void checkConnectionStringDomainNameNoQueryParams() throws UnsupportedEncodingException {
+    SocketFactory socketFactory = new SocketFactory(DOMAIN_NAME);
+    assertThat(socketFactory.props.get(ConnectionConfig.CLOUD_SQL_INSTANCE_PROPERTY)).isNull();
+    assertThat(socketFactory.domainName).isEqualTo(DOMAIN_NAME);
+  }
+
+  @Test
+  public void checkConnectionStringDomainNameWithQueryParam() throws UnsupportedEncodingException {
+    String socketFactoryConstructorArg =
+        String.format("%s?%s=%s", DOMAIN_NAME, "ipTypes", "PRIVATE");
+    SocketFactory socketFactory = new SocketFactory(socketFactoryConstructorArg);
+    assertThat(socketFactory.props.get(ConnectionConfig.CLOUD_SQL_INSTANCE_PROPERTY)).isNull();
+    assertThat(socketFactory.domainName).isEqualTo(DOMAIN_NAME);
+    assertThat(socketFactory.props.get("ipTypes")).isEqualTo("PRIVATE");
+  }
+
   @Test
   public void checkConnectionStringWithEmptyQueryParam() throws UnsupportedEncodingException {
     String socketFactoryConstructorArg = String.format("%s?", CONNECTION_NAME);