feat: TPC support

Author: sakthivelmanii

google-cloud-spanner/clirr-ignored-differences.xml

@@ -1043,4 +1043,16 @@
     <className>com/google/cloud/spanner/connection/Connection</className>
     <method>com.google.spanner.v1.TransactionOptions$ReadWrite$ReadLockMode getReadLockMode()</method>
   </difference>
+
+  <!-- Removed getMonitoringHost() which was added as part of TPU -->
+  <difference>
+    <differenceType>7002</differenceType>
+    <className>com/google/cloud/spanner/SpannerOptions$SpannerEnvironment</className>
+    <method>java.lang.String getMonitoringHost()</method>
+  </difference>
+  <difference>
+    <differenceType>7002</differenceType>
+    <className>com/google/cloud/spanner/SpannerOptions$Builder</className>
+    <method>com.google.cloud.spanner.SpannerOptions$Builder setMonitoringHost(java.lang.String)</method>
+  </difference>
 </differences>

google-cloud-spanner/src/main/java/com/google/cloud/spanner/BuiltInMetricsProvider.java

@@ -68,12 +68,12 @@ final class BuiltInMetricsProvider {
   private BuiltInMetricsProvider() {}
 
   OpenTelemetry getOrCreateOpenTelemetry(
-      String projectId, @Nullable Credentials credentials, @Nullable String monitoringHost) {
+      String projectId, @Nullable Credentials credentials, String universeDomain) {
     try {
       if (this.openTelemetry == null) {
         SdkMeterProviderBuilder sdkMeterProviderBuilder = SdkMeterProvider.builder();
         BuiltInMetricsView.registerBuiltinMetrics(
-            SpannerCloudMonitoringExporter.create(projectId, credentials, monitoringHost),
+            SpannerCloudMonitoringExporter.create(projectId, credentials, universeDomain),
             sdkMeterProviderBuilder);
         sdkMeterProviderBuilder.setResource(Resource.create(createResourceAttributes(projectId)));
         SdkMeterProvider sdkMeterProvider = sdkMeterProviderBuilder.build();
@@ -95,10 +95,10 @@ void enableGrpcMetrics(
       InstantiatingGrpcChannelProvider.Builder channelProviderBuilder,
       String projectId,
       @Nullable Credentials credentials,
-      @Nullable String monitoringHost) {
+      String universeDomain) {
     GrpcOpenTelemetry grpcOpenTelemetry =
         GrpcOpenTelemetry.newBuilder()
-            .sdk(this.getOrCreateOpenTelemetry(projectId, credentials, monitoringHost))
+            .sdk(this.getOrCreateOpenTelemetry(projectId, credentials, universeDomain))
             .enableMetrics(BuiltInMetricsConstant.GRPC_METRICS_TO_ENABLE)
             // Disable gRPCs default metrics as they are not needed for Spanner.
             .disableMetrics(BuiltInMetricsConstant.GRPC_METRICS_ENABLED_BY_DEFAULT)

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerCloudMonitoringExporter.java

@@ -71,7 +71,7 @@ class SpannerCloudMonitoringExporter implements MetricExporter {
   private final String spannerProjectId;
 
   static SpannerCloudMonitoringExporter create(
-      String projectId, @Nullable Credentials credentials, @Nullable String monitoringHost)
+      String projectId, @Nullable Credentials credentials, String universeDomain)
       throws IOException {
     MetricServiceSettings.Builder settingsBuilder = MetricServiceSettings.newBuilder();
     CredentialsProvider credentialsProvider;
@@ -81,8 +81,8 @@ static SpannerCloudMonitoringExporter create(
       credentialsProvider = FixedCredentialsProvider.create(credentials);
     }
     settingsBuilder.setCredentialsProvider(credentialsProvider);
-    if (monitoringHost != null) {
-      settingsBuilder.setEndpoint(monitoringHost);
+    if (universeDomain != null && !universeDomain.isEmpty()) {
+      settingsBuilder.setUniverseDomain(universeDomain);
     }
 
     Duration timeout = Duration.ofMinutes(1);

google-cloud-spanner/src/main/java/com/google/cloud/spanner/SpannerOptions.java

@@ -120,7 +120,8 @@ public class SpannerOptions extends ServiceOptions<Spanner, SpannerOptions> {
   private static final String PG_ADAPTER_CLIENT_LIB_TOKEN = "pg-adapter";
 
   private static final String API_SHORT_NAME = "Spanner";
-  private static final String DEFAULT_HOST = "https://spanner.googleapis.com";
+  private static final String SPANNER_SERVICE_NAME = "spanner";
+  private static final String GOOGLE_DEFAULT_UNIVERSE = "googleapis.com";
   private static final String EXPERIMENTAL_HOST_PROJECT_ID = "default";
 
   private static final ImmutableSet<String> SCOPES =
@@ -185,7 +186,6 @@ public class SpannerOptions extends ServiceOptions<Spanner, SpannerOptions> {
   private final boolean enableBuiltInMetrics;
   private final boolean enableExtendedTracing;
   private final boolean enableEndToEndTracing;
-  private final String monitoringHost;
   private final TransactionOptions defaultTransactionOptions;
 
   enum TracingFramework {
@@ -780,9 +780,18 @@ protected SpannerOptions(Builder builder) {
     databaseRole = builder.databaseRole;
     sessionLabels = builder.sessionLabels;
     try {
-      spannerStubSettings = builder.spannerStubSettingsBuilder.build();
-      instanceAdminStubSettings = builder.instanceAdminStubSettingsBuilder.build();
-      databaseAdminStubSettings = builder.databaseAdminStubSettingsBuilder.build();
+      spannerStubSettings =
+          builder.spannerStubSettingsBuilder.setUniverseDomain(getResolvedUniverseDomain()).build();
+      instanceAdminStubSettings =
+          builder
+              .instanceAdminStubSettingsBuilder
+              .setUniverseDomain(getResolvedUniverseDomain())
+              .build();
+      databaseAdminStubSettings =
+          builder
+              .databaseAdminStubSettingsBuilder
+              .setUniverseDomain(getResolvedUniverseDomain())
+              .build();
     } catch (IOException e) {
       throw SpannerExceptionFactory.newSpannerException(e);
     }
@@ -820,10 +829,16 @@ protected SpannerOptions(Builder builder) {
       enableBuiltInMetrics = builder.enableBuiltInMetrics;
     }
     enableEndToEndTracing = builder.enableEndToEndTracing;
-    monitoringHost = builder.monitoringHost;
     defaultTransactionOptions = builder.defaultTransactionOptions;
   }
 
+  private String getResolvedUniverseDomain() {
+    String universeDomain = getUniverseDomain();
+    return (universeDomain == null || universeDomain.isEmpty())
+        ? GOOGLE_DEFAULT_UNIVERSE
+        : universeDomain;
+  }
+
   /**
    * The environment to read configuration values from. The default implementation uses environment
    * variables.
@@ -871,10 +886,6 @@ default boolean isEnableEndToEndTracing() {
       return false;
     }
 
-    default String getMonitoringHost() {
-      return null;
-    }
-
     default GoogleCredentials getDefaultExperimentalHostCredentials() {
       return null;
     }
@@ -901,7 +912,6 @@ private static class SpannerEnvironmentImpl implements SpannerEnvironment {
     private static final String SPANNER_DISABLE_BUILTIN_METRICS = "SPANNER_DISABLE_BUILTIN_METRICS";
     private static final String SPANNER_DISABLE_DIRECT_ACCESS_GRPC_BUILTIN_METRICS =
         "SPANNER_DISABLE_DIRECT_ACCESS_GRPC_BUILTIN_METRICS";
-    private static final String SPANNER_MONITORING_HOST = "SPANNER_MONITORING_HOST";
 
     private SpannerEnvironmentImpl() {}
 
@@ -951,11 +961,6 @@ public boolean isEnableEndToEndTracing() {
       return Boolean.parseBoolean(System.getenv(SPANNER_ENABLE_END_TO_END_TRACING));
     }
 
-    @Override
-    public String getMonitoringHost() {
-      return System.getenv(SPANNER_MONITORING_HOST);
-    }
-
     @Override
     public GoogleCredentials getDefaultExperimentalHostCredentials() {
       return getOAuthTokenFromFile(System.getenv(DEFAULT_SPANNER_EXPERIMENTAL_HOST_CREDENTIALS));
@@ -1025,7 +1030,6 @@ public static class Builder
     private boolean enableExtendedTracing = SpannerOptions.environment.isEnableExtendedTracing();
     private boolean enableEndToEndTracing = SpannerOptions.environment.isEnableEndToEndTracing();
     private boolean enableBuiltInMetrics = SpannerOptions.environment.isEnableBuiltInMetrics();
-    private String monitoringHost = SpannerOptions.environment.getMonitoringHost();
     private SslContext mTLSContext = null;
     private boolean isExperimentalHost = false;
     private TransactionOptions defaultTransactionOptions = TransactionOptions.getDefaultInstance();
@@ -1096,7 +1100,6 @@ protected Builder() {
       this.enableExtendedTracing = options.enableExtendedTracing;
       this.enableBuiltInMetrics = options.enableBuiltInMetrics;
       this.enableEndToEndTracing = options.enableEndToEndTracing;
-      this.monitoringHost = options.monitoringHost;
       this.defaultTransactionOptions = options.defaultTransactionOptions;
     }
 
@@ -1664,12 +1667,6 @@ public Builder setBuiltInMetricsEnabled(boolean enableBuiltInMetrics) {
       return this;
     }
 
-    /** Sets the monitoring host to be used for Built-in client side metrics */
-    public Builder setMonitoringHost(String monitoringHost) {
-      this.monitoringHost = monitoringHost;
-      return this;
-    }
-
     /**
      * Sets whether to enable extended OpenTelemetry tracing. Enabling this option will add the
      * following additional attributes to the traces that are generated by the client:
@@ -2035,7 +2032,7 @@ public ApiTracerFactory getApiTracerFactory() {
   public void enablegRPCMetrics(InstantiatingGrpcChannelProvider.Builder channelProviderBuilder) {
     if (SpannerOptions.environment.isEnableGRPCBuiltInMetrics()) {
       this.builtInMetricsProvider.enableGrpcMetrics(
-          channelProviderBuilder, this.getProjectId(), getCredentials(), this.monitoringHost);
+          channelProviderBuilder, this.getProjectId(), getCredentials(), getUniverseDomain());
     }
   }
 
@@ -2081,7 +2078,7 @@ private ApiTracerFactory getDefaultApiTracerFactory() {
   private ApiTracerFactory createMetricsApiTracerFactory() {
     OpenTelemetry openTelemetry =
         this.builtInMetricsProvider.getOrCreateOpenTelemetry(
-            this.getProjectId(), getCredentials(), this.monitoringHost);
+            this.getProjectId(), getCredentials(), getUniverseDomain());
 
     return openTelemetry != null
         ? new BuiltInMetricsTracerFactory(
@@ -2115,11 +2112,6 @@ public boolean isEnableBuiltInMetrics() {
     return enableBuiltInMetrics;
   }
 
-  /** Returns the override metrics Host. */
-  String getMonitoringHost() {
-    return monitoringHost;
-  }
-
   public TransactionOptions getDefaultTransactionOptions() {
     return defaultTransactionOptions;
   }
@@ -2181,7 +2173,11 @@ public static GrpcTransportOptions getDefaultGrpcTransportOptions() {
 
   @Override
   protected String getDefaultHost() {
-    return DEFAULT_HOST;
+    String universeDomain = getUniverseDomain();
+    if (universeDomain == null || universeDomain.isEmpty()) {
+      universeDomain = GOOGLE_DEFAULT_UNIVERSE;
+    }
+    return String.format("https://%s.%s", SPANNER_SERVICE_NAME, universeDomain);
   }
 
   private static class SpannerDefaults implements ServiceDefaults<Spanner, SpannerOptions> {

google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionOptions.java

@@ -49,6 +49,7 @@
 import static com.google.cloud.spanner.connection.ConnectionProperties.TRACING_PREFIX;
 import static com.google.cloud.spanner.connection.ConnectionProperties.TRACK_CONNECTION_LEAKS;
 import static com.google.cloud.spanner.connection.ConnectionProperties.TRACK_SESSION_LEAKS;
+import static com.google.cloud.spanner.connection.ConnectionProperties.UNIVERSE_DOMAIN;
 import static com.google.cloud.spanner.connection.ConnectionProperties.USER_AGENT;
 import static com.google.cloud.spanner.connection.ConnectionProperties.USE_AUTO_SAVEPOINTS_FOR_EMULATOR;
 import static com.google.cloud.spanner.connection.ConnectionProperties.USE_PLAIN_TEXT;
@@ -1086,6 +1087,10 @@ Boolean isEnableDirectAccess() {
     return getInitialConnectionPropertyValue(ENABLE_DIRECT_ACCESS);
   }
 
+  String getUniverseDomain() {
+    return getInitialConnectionPropertyValue(UNIVERSE_DOMAIN);
+  }
+
   String getClientCertificate() {
     return getInitialConnectionPropertyValue(CLIENT_CERTIFICATE);
   }

google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/ConnectionProperties.java

@@ -200,6 +200,14 @@ public class ConnectionProperties {
           BOOLEANS,
           BooleanConverter.INSTANCE,
           Context.STARTUP);
+  static final ConnectionProperty<String> UNIVERSE_DOMAIN =
+      create(
+          "universeDomain",
+          "Configure the connection to try to connect to Spanner using "
+              + "different partner Google Universe other than GDU(googleapis.com).",
+          "googleapis.com",
+          StringValueConverter.INSTANCE,
+          Context.STARTUP);
   static final ConnectionProperty<Boolean> USE_AUTO_SAVEPOINTS_FOR_EMULATOR =
       create(
           "useAutoSavepointsForEmulator",

google-cloud-spanner/src/main/java/com/google/cloud/spanner/connection/SpannerPool.java

@@ -165,6 +165,7 @@ static class SpannerPoolKey {
     private final String clientCertificateKey;
     private final boolean isExperimentalHost;
     private final Boolean enableDirectAccess;
+    private final String universeDomain;
 
     @VisibleForTesting
     static SpannerPoolKey of(ConnectionOptions options) {
@@ -200,6 +201,7 @@ private SpannerPoolKey(ConnectionOptions options) throws IOException {
       this.clientCertificateKey = options.getClientCertificateKey();
       this.isExperimentalHost = options.isExperimentalHost();
       this.enableDirectAccess = options.isEnableDirectAccess();
+      this.universeDomain = options.getUniverseDomain();
     }
 
     @Override
@@ -226,7 +228,8 @@ public boolean equals(Object o) {
           && Objects.equals(this.clientCertificate, other.clientCertificate)
           && Objects.equals(this.clientCertificateKey, other.clientCertificateKey)
           && Objects.equals(this.isExperimentalHost, other.isExperimentalHost)
-          && Objects.equals(this.enableDirectAccess, other.enableDirectAccess);
+          && Objects.equals(this.enableDirectAccess, other.enableDirectAccess)
+          && Objects.equals(this.universeDomain, other.universeDomain);
     }
 
     @Override
@@ -249,7 +252,8 @@ public int hashCode() {
           this.clientCertificate,
           this.clientCertificateKey,
           this.isExperimentalHost,
-          this.enableDirectAccess);
+          this.enableDirectAccess,
+          this.universeDomain);
     }
   }
 
@@ -419,6 +423,9 @@ Spanner createSpanner(SpannerPoolKey key, ConnectionOptions options) {
     if (key.enableDirectAccess != null) {
       builder.setEnableDirectAccess(key.enableDirectAccess);
     }
+    if (key.universeDomain != null) {
+      builder.setUniverseDomain(key.universeDomain);
+    }
     if (options.getConfigurator() != null) {
       options.getConfigurator().configure(builder);
     }

google-cloud-spanner/src/test/java/com/google/cloud/spanner/SpannerOptionsTest.java

@@ -756,19 +756,6 @@ public void testEndToEndTracingEnablement() {
             .isEndToEndTracingEnabled());
   }
 
-  @Test
-  public void testMonitoringHost() {
-    String metricsEndpoint = "test-endpoint:443";
-    assertNull(SpannerOptions.newBuilder().setProjectId("p").build().getMonitoringHost());
-    assertThat(
-            SpannerOptions.newBuilder()
-                .setProjectId("p")
-                .setMonitoringHost(metricsEndpoint)
-                .build()
-                .getMonitoringHost())
-        .isEqualTo(metricsEndpoint);
-  }
-
   @Test
   public void testTransactionOptions() {
     DefaultReadWriteTransactionOptions transactionOptions =

google-cloud-spanner/src/test/java/com/google/cloud/spanner/connection/ConnectionOptionsTest.java

@@ -1329,4 +1329,17 @@ public void testEnableDirectAccess() {
         "spanner://localhost:15000/projects/default/instances/default/databases/singers-db;usePlainText=true;enableDirectAccess=true");
     assertTrue(builderWithDirectPathParam.build().isEnableDirectAccess());
   }
+
+  @Test
+  public void testUniverseDomain() {
+    ConnectionOptions.Builder builderWithNoUniverseDomainParam = ConnectionOptions.newBuilder();
+    builderWithNoUniverseDomainParam.setUri(
+        "spanner://localhost:15000/instances/default/databases/singers-db;usePlainText=true");
+    assertEquals("googleapis.com", builderWithNoUniverseDomainParam.build().getUniverseDomain());
+
+    ConnectionOptions.Builder builderWithUniverseDomainParam = ConnectionOptions.newBuilder();
+    builderWithUniverseDomainParam.setUri(
+        "spanner://localhost:15000/projects/default/instances/default/databases/singers-db;usePlainText=true;universeDomain=abc.goog");
+    assertEquals("abc.goog", builderWithUniverseDomainParam.build().getUniverseDomain());
+  }
 }