feat(bigtable): Support universe domain (#12567)

bhshkh · web-flow · commit fc59e39b63ab · 2025-07-29T14:40:11.000-07:00
diff --git a/bigtable/admin.go b/bigtable/admin.go
@@ -46,7 +46,8 @@ import (
 	"google.golang.org/protobuf/types/known/timestamppb"
 )
 
-const adminAddr = "bigtableadmin.googleapis.com:443"
+// UNIVERSE_DOMAIN placeholder is replaced by the UniverseDomain from DialSettings while creating GRPC connection/dial pool.
+const adminAddr = "bigtableadmin.UNIVERSE_DOMAIN:443"
 const mtlsAdminAddr = "bigtableadmin.mtls.googleapis.com:443"
 
 var (
@@ -1166,7 +1167,8 @@ func (ac *AdminClient) AuthorizedViewIAM(table, authorizedView string) *iam.Hand
 	return iam.InternalNewHandleGRPCClient(ac.tClient, ac.authorizedViewPath(table, authorizedView))
 }
 
-const instanceAdminAddr = "bigtableadmin.googleapis.com:443"
+// UNIVERSE_DOMAIN placeholder is replaced by the UniverseDomain from DialSettings while creating GRPC connection/dial pool.
+const instanceAdminAddr = "bigtableadmin.UNIVERSE_DOMAIN:443"
 const mtlsInstanceAdminAddr = "bigtableadmin.mtls.googleapis.com:443"
 
 // InstanceAdminClient is a client type for performing admin operations on instances.
diff --git a/bigtable/bigtable.go b/bigtable/bigtable.go
@@ -49,7 +49,8 @@ import (
 	"google.golang.org/protobuf/types/known/timestamppb"
 )
 
-const prodAddr = "bigtable.googleapis.com:443"
+// UNIVERSE_DOMAIN placeholder is replaced by the UniverseDomain from DialSettings while creating GRPC connection/dial pool.
+const prodAddr = "bigtable.UNIVERSE_DOMAIN:443"
 const mtlsProdAddr = "bigtable.mtls.googleapis.com:443"
 const featureFlagsHeaderKey = "bigtable-features"
 const queryExpiredViolationType = "PREPARED_QUERY_EXPIRED"
diff --git a/bigtable/export_test.go b/bigtable/export_test.go
@@ -90,6 +90,7 @@ type IntegrationTestConfig struct {
 	Cluster               string
 	Cluster2              string
 	Table                 string
+	ClientOpts            []option.ClientOption
 	AttemptDirectPath     bool
 	DirectPathIPV4Only    bool
 	EmulatedServerOptions []grpc.ServerOption
@@ -129,6 +130,8 @@ func NewIntegrationEnv() (IntegrationEnv, error) {
 	if c.Cluster2 == "" {
 		c.Cluster2 = os.Getenv("GCLOUD_TESTS_BIGTABLE_PRI_PROJ_SEC_CLUSTER")
 	}
+	universeDomain := os.Getenv("GCLOUD_TESTS_BIGTABLE_UNIVERSE_DOMAIN")
+	c.ClientOpts = append(c.ClientOpts, option.WithUniverseDomain(universeDomain))
 
 	if legacyUseProd != "" {
 		fmt.Println("WARNING: using legacy commandline arg -use_prod, please switch to -it.*")
@@ -324,6 +327,7 @@ func (e *ProdEnv) AdminClientOptions() (context.Context, []option.ClientOption,
 	if endpoint := e.config.AdminEndpoint; endpoint != "" {
 		clientOpts = append(clientOpts, option.WithEndpoint(endpoint))
 	}
+	clientOpts = append(clientOpts, e.config.ClientOpts...)
 	return context.Background(), clientOpts, nil
 }
 
@@ -365,5 +369,6 @@ func (e *ProdEnv) newProdClient(config ClientConfig) (*Client, error) {
 		// For DirectPath tests, we need to add an interceptor to check the peer IP.
 		clientOpts = append(clientOpts, option.WithGRPCDialOption(grpc.WithDefaultCallOptions(grpc.Peer(e.peerInfo))))
 	}
+	clientOpts = append(clientOpts, e.config.ClientOpts...)
 	return NewClientWithConfig(context.Background(), e.config.Project, e.config.Instance, config, clientOpts...)
 }
diff --git a/bigtable/integration_test.go b/bigtable/integration_test.go
@@ -153,7 +153,7 @@ func cleanup(c IntegrationTestConfig) error {
 		return nil
 	}
 	ctx := context.Background()
-	iac, err := NewInstanceAdminClient(ctx, c.Project)
+	iac, err := NewInstanceAdminClient(ctx, c.Project, c.ClientOpts...)
 	if err != nil {
 		return err
 	}
@@ -952,7 +952,7 @@ func TestIntegration_ExportBuiltInMetrics(t *testing.T) {
 	// Sleep some more
 	time.Sleep(30 * time.Second)
 
-	monitoringClient, err := monitoring.NewMetricClient(ctx)
+	monitoringClient, err := monitoring.NewMetricClient(ctx, testEnv.Config().ClientOpts...)
 	if err != nil {
 		t.Errorf("Failed to create metric client: %v", err)
 	}
diff --git a/bigtable/internal/option/option.go b/bigtable/internal/option/option.go
@@ -95,6 +95,7 @@ func DefaultClientOptions(endpoint, mtlsEndpoint, scope, userAgent string) ([]op
 		o = []option.ClientOption{
 			internaloption.WithDefaultEndpointTemplate(endpoint),
 			internaloption.WithDefaultMTLSEndpoint(mtlsEndpoint),
+			internaloption.WithDefaultUniverseDomain("googleapis.com"),
 			option.WithScopes(scope),
 			option.WithUserAgent(userAgent),
 		}

Original file line number	Diff line number	Diff line change
`@@ -49,7 +49,8 @@ import (`
`49`	`49`	`"google.golang.org/protobuf/types/known/timestamppb"`
`50`	`50`	`)`
`51`	`51`
`52`		`-const prodAddr = "bigtable.googleapis.com:443"`
	`52`	`+// UNIVERSE_DOMAIN placeholder is replaced by the UniverseDomain from DialSettings while creating GRPC connection/dial pool.`
	`53`	`+const prodAddr = "bigtable.UNIVERSE_DOMAIN:443"`
`53`	`54`	`const mtlsProdAddr = "bigtable.mtls.googleapis.com:443"`
`54`	`55`	`const featureFlagsHeaderKey = "bigtable-features"`
`55`	`56`	`const queryExpiredViolationType = "PREPARED_QUERY_EXPIRED"`
Original file line number	Diff line number	Diff line change
`@@ -90,6 +90,7 @@ type IntegrationTestConfig struct {`
`90`	`90`	`Cluster string`
`91`	`91`	`Cluster2 string`
`92`	`92`	`Table string`
	`93`	`+ ClientOpts []option.ClientOption`
`93`	`94`	`AttemptDirectPath bool`
`94`	`95`	`DirectPathIPV4Only bool`
`95`	`96`	`EmulatedServerOptions []grpc.ServerOption`
`@@ -129,6 +130,8 @@ func NewIntegrationEnv() (IntegrationEnv, error) {`
`129`	`130`	`if c.Cluster2 == "" {`
`130`	`131`	`c.Cluster2 = os.Getenv("GCLOUD_TESTS_BIGTABLE_PRI_PROJ_SEC_CLUSTER")`
`131`	`132`	`}`
	`133`	`+ universeDomain := os.Getenv("GCLOUD_TESTS_BIGTABLE_UNIVERSE_DOMAIN")`
	`134`	`+ c.ClientOpts = append(c.ClientOpts, option.WithUniverseDomain(universeDomain))`
`132`	`135`
`133`	`136`	`if legacyUseProd != "" {`
`134`	`137`	`fmt.Println("WARNING: using legacy commandline arg -use_prod, please switch to -it.*")`
`@@ -324,6 +327,7 @@ func (e *ProdEnv) AdminClientOptions() (context.Context, []option.ClientOption,`
`324`	`327`	`if endpoint := e.config.AdminEndpoint; endpoint != "" {`
`325`	`328`	`clientOpts = append(clientOpts, option.WithEndpoint(endpoint))`
`326`	`329`	`}`
	`330`	`+ clientOpts = append(clientOpts, e.config.ClientOpts...)`
`327`	`331`	`return context.Background(), clientOpts, nil`
`328`	`332`	`}`
`329`	`333`
`@@ -365,5 +369,6 @@ func (e ProdEnv) newProdClient(config ClientConfig) (Client, error) {`
`365`	`369`	`// For DirectPath tests, we need to add an interceptor to check the peer IP.`
`366`	`370`	`clientOpts = append(clientOpts, option.WithGRPCDialOption(grpc.WithDefaultCallOptions(grpc.Peer(e.peerInfo))))`
`367`	`371`	`}`
	`372`	`+ clientOpts = append(clientOpts, e.config.ClientOpts...)`
`368`	`373`	`return NewClientWithConfig(context.Background(), e.config.Project, e.config.Instance, config, clientOpts...)`
`369`	`374`	`}`
Original file line number	Diff line number	Diff line change
`@@ -153,7 +153,7 @@ func cleanup(c IntegrationTestConfig) error {`
`153`	`153`	`return nil`
`154`	`154`	`}`
`155`	`155`	`ctx := context.Background()`
`156`		`- iac, err := NewInstanceAdminClient(ctx, c.Project)`
	`156`	`+ iac, err := NewInstanceAdminClient(ctx, c.Project, c.ClientOpts...)`
`157`	`157`	`if err != nil {`
`158`	`158`	`return err`
`159`	`159`	`}`
`@@ -952,7 +952,7 @@ func TestIntegration_ExportBuiltInMetrics(t *testing.T) {`
`952`	`952`	`// Sleep some more`
`953`	`953`	`time.Sleep(30 * time.Second)`
`954`	`954`
`955`		`- monitoringClient, err := monitoring.NewMetricClient(ctx)`
	`955`	`+ monitoringClient, err := monitoring.NewMetricClient(ctx, testEnv.Config().ClientOpts...)`
`956`	`956`	`if err != nil {`
`957`	`957`	`t.Errorf("Failed to create metric client: %v", err)`
`958`	`958`	`}`
Original file line number	Diff line number	Diff line change
`@@ -95,6 +95,7 @@ func DefaultClientOptions(endpoint, mtlsEndpoint, scope, userAgent string) ([]op`
`95`	`95`	`o = []option.ClientOption{`
`96`	`96`	`internaloption.WithDefaultEndpointTemplate(endpoint),`
`97`	`97`	`internaloption.WithDefaultMTLSEndpoint(mtlsEndpoint),`
	`98`	`+ internaloption.WithDefaultUniverseDomain("googleapis.com"),`
`98`	`99`	`option.WithScopes(scope),`
`99`	`100`	`option.WithUserAgent(userAgent),`
`100`	`101`	`}`