feat(bigtable): expose protoToType (#10602)

ron-gal · web-flow · commit 643a8e356632 · 2024-07-29T13:33:03.000-04:00
* feat(bigtable): expose protoToType

* add comment to ProtoToType
diff --git a/bigtable/admin.go b/bigtable/admin.go
@@ -639,7 +639,7 @@ func (ac *AdminClient) TableInfo(ctx context.Context, table string) (*TableInfo,
 			Name:         name,
 			GCPolicy:     GCRuleToString(fam.GcRule),
 			FullGCPolicy: gcRuleToPolicy(fam.GcRule),
-			ValueType:    protoToType(fam.ValueType),
+			ValueType:    ProtoToType(fam.ValueType),
 		})
 	}
 	// we expect DeletionProtection to be in the response because Table_SCHEMA_VIEW is being used in this function
diff --git a/bigtable/type.go b/bigtable/type.go
@@ -198,7 +198,8 @@ func (agg AggregateType) proto() *btapb.Type {
 	return &btapb.Type{Kind: &btapb.Type_AggregateType{AggregateType: protoAgg}}
 }
 
-func protoToType(pb *btapb.Type) Type {
+// ProtoToType converts a protobuf *btapb.Type to an instance of the Type interface, for use of the admin API.
+func ProtoToType(pb *btapb.Type) Type {
 	if pb == nil {
 		return unknown[btapb.Type]{wrapped: nil}
 	}
@@ -254,7 +255,7 @@ func aggregateProtoToType(agg *btapb.Type_Aggregate) Type {
 		return AggregateType{Input: nil, Aggregator: unknownAggregator{wrapped: agg}}
 	}
 
-	it := protoToType(agg.InputType)
+	it := ProtoToType(agg.InputType)
 	var aggregator Aggregator
 	switch agg.Aggregator.(type) {
 	case *btapb.Type_Aggregate_Sum_:
diff --git a/bigtable/type_test.go b/bigtable/type_test.go
@@ -108,7 +108,7 @@ func TestSumAggregateProto(t *testing.T) {
 
 func TestProtoBijection(t *testing.T) {
 	want := aggregateProto()
-	got := protoToType(want).proto()
+	got := ProtoToType(want).proto()
 	if !proto.Equal(got, want) {
 		t.Errorf("got type %v, want: %v", got, want)
 	}
@@ -223,11 +223,11 @@ func TestHllAggregateProto(t *testing.T) {
 }
 
 func TestNilChecks(t *testing.T) {
-	// protoToType
-	if val, ok := protoToType(nil).(unknown[btapb.Type]); !ok {
+	// ProtoToType
+	if val, ok := ProtoToType(nil).(unknown[btapb.Type]); !ok {
 		t.Errorf("got: %T, wanted unknown[btapb.Type]", val)
 	}
-	if val, ok := protoToType(&btapb.Type{}).(unknown[btapb.Type]); !ok {
+	if val, ok := ProtoToType(&btapb.Type{}).(unknown[btapb.Type]); !ok {
 		t.Errorf("got: %T, wanted unknown[btapb.Type]", val)
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -639,7 +639,7 @@ func (ac AdminClient) TableInfo(ctx context.Context, table string) (TableInfo,`
`639`	`639`	`Name: name,`
`640`	`640`	`GCPolicy: GCRuleToString(fam.GcRule),`
`641`	`641`	`FullGCPolicy: gcRuleToPolicy(fam.GcRule),`
`642`		`- ValueType: protoToType(fam.ValueType),`
	`642`	`+ ValueType: ProtoToType(fam.ValueType),`
`643`	`643`	`})`
`644`	`644`	`}`
`645`	`645`	`// we expect DeletionProtection to be in the response because Table_SCHEMA_VIEW is being used in this function`
Original file line number	Diff line number	Diff line change
`@@ -198,7 +198,8 @@ func (agg AggregateType) proto() *btapb.Type {`
`198`	`198`	`return &btapb.Type{Kind: &btapb.Type_AggregateType{AggregateType: protoAgg}}`
`199`	`199`	`}`
`200`	`200`
`201`		`-func protoToType(pb *btapb.Type) Type {`
	`201`	`+// ProtoToType converts a protobuf *btapb.Type to an instance of the Type interface, for use of the admin API.`
	`202`	`+func ProtoToType(pb *btapb.Type) Type {`
`202`	`203`	`if pb == nil {`
`203`	`204`	`return unknown[btapb.Type]{wrapped: nil}`
`204`	`205`	`}`
`@@ -254,7 +255,7 @@ func aggregateProtoToType(agg *btapb.Type_Aggregate) Type {`
`254`	`255`	`return AggregateType{Input: nil, Aggregator: unknownAggregator{wrapped: agg}}`
`255`	`256`	`}`
`256`	`257`
`257`		`- it := protoToType(agg.InputType)`
	`258`	`+ it := ProtoToType(agg.InputType)`
`258`	`259`	`var aggregator Aggregator`
`259`	`260`	`switch agg.Aggregator.(type) {`
`260`	`261`	`case *btapb.Type_Aggregate_Sum_:`
Original file line number	Diff line number	Diff line change
`@@ -108,7 +108,7 @@ func TestSumAggregateProto(t *testing.T) {`
`108`	`108`
`109`	`109`	`func TestProtoBijection(t *testing.T) {`
`110`	`110`	`want := aggregateProto()`
`111`		`- got := protoToType(want).proto()`
	`111`	`+ got := ProtoToType(want).proto()`
`112`	`112`	`if !proto.Equal(got, want) {`
`113`	`113`	`t.Errorf("got type %v, want: %v", got, want)`
`114`	`114`	`}`
`@@ -223,11 +223,11 @@ func TestHllAggregateProto(t *testing.T) {`
`223`	`223`	`}`
`224`	`224`
`225`	`225`	`func TestNilChecks(t *testing.T) {`
`226`		`- // protoToType`
`227`		`- if val, ok := protoToType(nil).(unknown[btapb.Type]); !ok {`
	`226`	`+ // ProtoToType`
	`227`	`+ if val, ok := ProtoToType(nil).(unknown[btapb.Type]); !ok {`
`228`	`228`	`t.Errorf("got: %T, wanted unknown[btapb.Type]", val)`
`229`	`229`	`}`
`230`		`- if val, ok := protoToType(&btapb.Type{}).(unknown[btapb.Type]); !ok {`
	`230`	`+ if val, ok := ProtoToType(&btapb.Type{}).(unknown[btapb.Type]); !ok {`
`231`	`231`	`t.Errorf("got: %T, wanted unknown[btapb.Type]", val)`
`232`	`232`	`}`
`233`	`233`