Skip to content

Commit 97d21cf

Browse files
authored
cleanup(internal/sidekick/rust): qualify ToProto calls (#7897)
Generated ToProto implementations and gRPC transport callers previously invoked .to_proto() without qualifying the target prost type. When multiple crates in a dependency graph implement gaxi::prost::ToProto<LocalProstT> for the same shared model type (such as google_cloud_rpc::model::Status or google_cloud_type::model::Expr), unqualified .to_proto() calls fail with E0284 type inference ambiguity. Annotate fields and external nested types with their target prost types and emit fully qualified gaxi::prost::ToProto::<ProstT>::to_proto calls across convert-prost and transport templates. For googleapis/google-cloud-rust#7284
1 parent 4fba22d commit 97d21cf

19 files changed

Lines changed: 413 additions & 90 deletions

‎internal/sidekick/api/well_known_types.go‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@ const (
4949
WktDoubleValueID = ".google.protobuf.DoubleValue"
5050
// WktBoolValueID is the well-known type ID for google.protobuf.BoolValue.
5151
WktBoolValueID = ".google.protobuf.BoolValue"
52+
// WktStringValueID is the well-known type ID for google.protobuf.StringValue.
53+
WktStringValueID = ".google.protobuf.StringValue"
5254
)
5355

5456
// LoadWellKnownTypes adds well-known types to `state`.
@@ -124,4 +126,5 @@ var wellKnownMessages = []*Message{
124126
{ID: WktFloatValueID, Name: "FloatValue", Package: "google.protobuf"},
125127
{ID: WktDoubleValueID, Name: "DoubleValue", Package: "google.protobuf"},
126128
{ID: WktBoolValueID, Name: "BoolValue", Package: "google.protobuf"},
129+
{ID: WktStringValueID, Name: "StringValue", Package: "google.protobuf"},
127130
}

‎internal/sidekick/rust/annotate_enum.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,7 @@ func (c *codec) annotateEnum(e *api.Enum, model *api.API, full bool) error {
100100
ModuleName: toSnake(enumName(e)),
101101
QualifiedName: qualifiedName,
102102
RelativeName: relativeName,
103-
ProstRelativeName: prostEnumRelativePath(e),
103+
ProstRelativeName: c.prostTypeName(e.Package, prostEnumRelativePath(e), model.PackageName),
104104
NameInExamples: nameInExamples,
105105
IsWktNullValue: nameInExamples == "wkt::NullValue",
106106
SerializeAsString: c.serializeEnumsAsStrings,

‎internal/sidekick/rust/annotate_field.go‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,10 @@ type fieldAnnotations struct {
4040
DocLines []string
4141
FieldType string
4242
PrimitiveFieldType string
43-
AddQueryParameter string
43+
// The Rust type of this field in the prost-generated message or enum.
44+
// Used in convert-prost templates to qualify `gaxi::prost::ToProto::<ProstType>::to_proto`.
45+
ProstType string
46+
AddQueryParameter string
4447
// For fields that are singular mesaage or list of messages, this is the
4548
// message type.
4649
MessageType *api.Message
@@ -198,6 +201,10 @@ func (c *codec) annotateField(field *api.Field, message *api.Message, model *api
198201
if err != nil {
199202
return nil, err
200203
}
204+
prostType, err := c.prostFieldType(field, model)
205+
if err != nil {
206+
return nil, err
207+
}
201208
fieldName := c.FieldName(field)
202209
ann := &fieldAnnotations{
203210
FieldName: toSnake(fieldName),
@@ -208,6 +215,7 @@ func (c *codec) annotateField(field *api.Field, message *api.Message, model *api
208215
DocLines: docLines,
209216
FieldType: fieldType,
210217
PrimitiveFieldType: primitiveFieldType,
218+
ProstType: prostType,
211219
AddQueryParameter: c.addQueryParameter(field),
212220
SerdeAs: c.primitiveSerdeAs(field),
213221
SkipIfIsDefault: field.Typez != api.TypezString && field.Typez != api.TypezBytes,

‎internal/sidekick/rust/annotate_field_test.go‎

Lines changed: 44 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,7 @@ func TestFieldAnnotations(t *testing.T) {
8888
FQMessageName: "crate::model::TestMessage",
8989
FieldType: "std::string::String",
9090
PrimitiveFieldType: "std::string::String",
91+
ProstType: "std::string::String",
9192
AddQueryParameter: `let builder = builder.query(&[("singularField", &req.singular_field)]);`,
9293
}
9394
if diff := cmp.Diff(wantField, singularField.Codec); diff != "" {
@@ -108,6 +109,7 @@ func TestFieldAnnotations(t *testing.T) {
108109
FQMessageName: "crate::model::TestMessage",
109110
FieldType: "std::vec::Vec<std::string::String>",
110111
PrimitiveFieldType: "std::string::String",
112+
ProstType: "std::string::String",
111113
AddQueryParameter: `let builder = req.repeated_field.iter().fold(builder, |builder, p| builder.query(&[("repeatedField", p)]));`,
112114
}
113115
if diff := cmp.Diff(wantField, repeatedField.Codec); diff != "" {
@@ -155,6 +157,7 @@ func TestFieldAnnotations(t *testing.T) {
155157
FieldType: "std::option::Option<std::boxed::Box<crate::model::TestMessage>>",
156158
MessageType: message,
157159
PrimitiveFieldType: "crate::model::TestMessage",
160+
ProstType: "TestMessage",
158161
AddQueryParameter: `let builder = req.boxed_field.as_ref().map(|p| serde_json::to_value(p).map_err(Error::ser) ).transpose()?.into_iter().fold(builder, |builder, v| { use gaxi::query_parameter::QueryParameter; v.add(builder, "boxedField") });`,
159162
IsBoxed: true,
160163
MapToBoxed: true,
@@ -255,6 +258,7 @@ func TestRecursiveFieldAnnotations(t *testing.T) {
255258
FieldType: "std::boxed::Box<crate::model::TestMessage>",
256259
MessageType: message,
257260
PrimitiveFieldType: "crate::model::TestMessage",
261+
ProstType: "TestMessage",
258262
AddQueryParameter: `let builder = req.oneof_field().map(|p| serde_json::to_value(p).map_err(Error::ser) ).transpose()?.into_iter().fold(builder, |builder, p| { use gaxi::query_parameter::QueryParameter; p.add(builder, "oneofField") });`,
259263
IsBoxed: true,
260264
MapToBoxed: true,
@@ -281,6 +285,7 @@ func TestRecursiveFieldAnnotations(t *testing.T) {
281285
FieldType: "std::vec::Vec<crate::model::TestMessage>",
282286
MessageType: message,
283287
PrimitiveFieldType: "crate::model::TestMessage",
288+
ProstType: "TestMessage",
284289
AddQueryParameter: `let builder = req.repeated_field.as_ref().map(|p| serde_json::to_value(p).map_err(Error::ser) ).transpose()?.into_iter().fold(builder, |builder, v| { use gaxi::query_parameter::QueryParameter; v.add(builder, "repeatedField") });`,
285290
IsBoxed: true,
286291
MapToBoxed: false,
@@ -306,6 +311,7 @@ func TestRecursiveFieldAnnotations(t *testing.T) {
306311
FieldType: "std::boxed::Box<crate::model::TestMessage>",
307312
MessageType: message,
308313
PrimitiveFieldType: "crate::model::TestMessage",
314+
ProstType: "TestMessage",
309315
AddQueryParameter: `let builder = { use gaxi::query_parameter::QueryParameter; serde_json::to_value(&req.message_field).map_err(Error::ser)?.add(builder, "messageField") };`,
310316
IsBoxed: true,
311317
MapToBoxed: true,
@@ -410,6 +416,7 @@ func TestSameTypeNameFieldAnnotations(t *testing.T) {
410416
FieldType: "std::boxed::Box<rusty_test_inner_v1::model::TestMessage>",
411417
MessageType: innerMessage,
412418
PrimitiveFieldType: "rusty_test_inner_v1::model::TestMessage",
419+
ProstType: "crate::test::v1::inner::TestMessage",
413420
AddQueryParameter: `let builder = req.oneof_field().map(|p| serde_json::to_value(p).map_err(Error::ser) ).transpose()?.into_iter().fold(builder, |builder, p| { use gaxi::query_parameter::QueryParameter; p.add(builder, "oneofField") });`,
414421
IsBoxed: true,
415422
MapToBoxed: false,
@@ -436,6 +443,7 @@ func TestSameTypeNameFieldAnnotations(t *testing.T) {
436443
FieldType: "std::vec::Vec<rusty_test_inner_v1::model::TestMessage>",
437444
MessageType: innerMessage,
438445
PrimitiveFieldType: "rusty_test_inner_v1::model::TestMessage",
446+
ProstType: "crate::test::v1::inner::TestMessage",
439447
AddQueryParameter: `let builder = req.repeated_field.as_ref().map(|p| serde_json::to_value(p).map_err(Error::ser) ).transpose()?.into_iter().fold(builder, |builder, v| { use gaxi::query_parameter::QueryParameter; v.add(builder, "repeatedField") });`,
440448
SkipIfIsDefault: true,
441449
AliasInExamples: "RepeatedField",
@@ -459,6 +467,7 @@ func TestSameTypeNameFieldAnnotations(t *testing.T) {
459467
FieldType: "rusty_test_inner_v1::model::TestMessage",
460468
MessageType: innerMessage,
461469
PrimitiveFieldType: "rusty_test_inner_v1::model::TestMessage",
470+
ProstType: "crate::test::v1::inner::TestMessage",
462471
AddQueryParameter: `let builder = { use gaxi::query_parameter::QueryParameter; serde_json::to_value(&req.message_field).map_err(Error::ser)?.add(builder, "messageField") };`,
463472
SkipIfIsDefault: true,
464473
AliasInExamples: "MessageField",
@@ -513,6 +522,7 @@ func TestPrimitiveFieldAnnotations(t *testing.T) {
513522
FQMessageName: "crate::model::TestMessage",
514523
FieldType: test.wantType,
515524
PrimitiveFieldType: test.wantType,
525+
ProstType: test.wantType,
516526
SerdeAs: test.wantSerdeAs,
517527
AddQueryParameter: `let builder = builder.query(&[("singularField", &req.singular_field)]);`,
518528
SkipIfIsDefault: true,
@@ -554,6 +564,7 @@ func TestBytesAnnotations(t *testing.T) {
554564
FQMessageName: "crate::model::TestMessage",
555565
FieldType: test.wantType,
556566
PrimitiveFieldType: test.wantType,
567+
ProstType: test.wantType,
557568
SerdeAs: test.wantSerdeAs,
558569
AddQueryParameter: `let builder = builder.query(&[("singularField", &req.singular_field)]);`,
559570
}
@@ -566,18 +577,21 @@ func TestBytesAnnotations(t *testing.T) {
566577

567578
func TestWrapperFieldAnnotations(t *testing.T) {
568579
for _, test := range []struct {
569-
wantType string
570-
wantSerdeAs string
571-
name string
580+
wantType string
581+
wantProstType string
582+
wantSerdeAs string
583+
name string
572584
}{
573-
{"wkt::BytesValue", "serde_with::base64::Base64", "BytesValue"},
574-
{"wkt::UInt64Value", "wkt::internal::U64", "UInt64Value"},
575-
{"wkt::Int64Value", "wkt::internal::I64", "Int64Value"},
576-
{"wkt::UInt32Value", "wkt::internal::U32", "UInt32Value"},
577-
{"wkt::Int32Value", "wkt::internal::I32", "Int32Value"},
578-
{"wkt::FloatValue", "wkt::internal::F32", "FloatValue"},
579-
{"wkt::DoubleValue", "wkt::internal::F64", "DoubleValue"},
580-
{"wkt::BoolValue", "", "BoolValue"},
585+
{"wkt::BytesValue", "::bytes::Bytes", "serde_with::base64::Base64", "BytesValue"},
586+
{"wkt::UInt64Value", "u64", "wkt::internal::U64", "UInt64Value"},
587+
{"wkt::Int64Value", "i64", "wkt::internal::I64", "Int64Value"},
588+
{"wkt::UInt32Value", "u32", "wkt::internal::U32", "UInt32Value"},
589+
{"wkt::Int32Value", "i32", "wkt::internal::I32", "Int32Value"},
590+
{"wkt::FloatValue", "f32", "wkt::internal::F32", "FloatValue"},
591+
{"wkt::DoubleValue", "f64", "wkt::internal::F64", "DoubleValue"},
592+
{"wkt::BoolValue", "bool", "", "BoolValue"},
593+
{"wkt::StringValue", "std::string::String", "", "StringValue"},
594+
{"wkt::Empty", "gaxi::prost::Empty", "", "Empty"},
581595
} {
582596
t.Run(test.name, func(t *testing.T) {
583597
wkt := api.NewTestMessage(test.name).WithPackage("google.protobuf")
@@ -588,10 +602,14 @@ func TestWrapperFieldAnnotations(t *testing.T) {
588602
WithFields(singularField).
589603
WithDocumentation("A test message.")
590604
model := api.NewTestAPI([]*api.Message{message}, nil, nil)
591-
api.CrossReference(model)
605+
if err := api.CrossReference(model); err != nil {
606+
t.Fatal(err)
607+
}
592608
api.LabelRecursiveFields(model)
593609
codec := createRustCodec()
594-
annotateModel(model, codec)
610+
if _, err := annotateModel(model, codec); err != nil {
611+
t.Fatal(err)
612+
}
595613

596614
wantField := &fieldAnnotations{
597615
FieldName: "singular_field",
@@ -601,6 +619,7 @@ func TestWrapperFieldAnnotations(t *testing.T) {
601619
FQMessageName: "crate::model::TestMessage",
602620
FieldType: fmt.Sprintf("std::option::Option<%s>", test.wantType),
603621
PrimitiveFieldType: test.wantType,
622+
ProstType: test.wantProstType,
604623
SerdeAs: test.wantSerdeAs,
605624
SkipIfIsDefault: true,
606625
}
@@ -677,6 +696,7 @@ func TestEnumFieldAnnotations(t *testing.T) {
677696
FQMessageName: "crate::model::TestMessage",
678697
FieldType: "crate::model::TestEnum",
679698
PrimitiveFieldType: "crate::model::TestEnum",
699+
ProstType: "TestEnum",
680700
AddQueryParameter: `let builder = builder.query(&[("singularField", &req.singular_field)]);`,
681701
SkipIfIsDefault: true,
682702
}
@@ -692,6 +712,7 @@ func TestEnumFieldAnnotations(t *testing.T) {
692712
FQMessageName: "crate::model::TestMessage",
693713
FieldType: "std::vec::Vec<crate::model::TestEnum>",
694714
PrimitiveFieldType: "crate::model::TestEnum",
715+
ProstType: "TestEnum",
695716
AddQueryParameter: `let builder = req.repeated_field.iter().fold(builder, |builder, p| builder.query(&[("repeatedField", p)]));`,
696717
SkipIfIsDefault: true,
697718
}
@@ -707,6 +728,7 @@ func TestEnumFieldAnnotations(t *testing.T) {
707728
FQMessageName: "crate::model::TestMessage",
708729
FieldType: "std::option::Option<crate::model::TestEnum>",
709730
PrimitiveFieldType: "crate::model::TestEnum",
731+
ProstType: "TestEnum",
710732
AddQueryParameter: `let builder = req.optional_field.iter().fold(builder, |builder, p| builder.query(&[("optionalField", p)]));`,
711733
SkipIfIsDefault: true,
712734
}
@@ -724,6 +746,7 @@ func TestEnumFieldAnnotations(t *testing.T) {
724746
FQMessageName: "crate::model::TestMessage",
725747
FieldType: "wkt::NullValue",
726748
PrimitiveFieldType: "wkt::NullValue",
749+
ProstType: "prost_types::NullValue",
727750
AddQueryParameter: `let builder = builder.query(&[("nullValueField", &req.null_value_field)]);`,
728751
SkipIfIsDefault: true,
729752
IsWktNullValue: true,
@@ -848,6 +871,7 @@ func TestJsonNameAnnotations(t *testing.T) {
848871
DocLines: nil,
849872
FieldType: "std::string::String",
850873
PrimitiveFieldType: "std::string::String",
874+
ProstType: "std::string::String",
851875
AddQueryParameter: `let builder = builder.query(&[("parent", &req.parent)]);`,
852876
KeyType: "",
853877
ValueType: "",
@@ -865,6 +889,7 @@ func TestJsonNameAnnotations(t *testing.T) {
865889
DocLines: nil,
866890
FieldType: "std::string::String",
867891
PrimitiveFieldType: "std::string::String",
892+
ProstType: "std::string::String",
868893
AddQueryParameter: `let builder = builder.query(&[("public_key", &req.custom_key)]);`,
869894
KeyType: "",
870895
ValueType: "",
@@ -882,6 +907,7 @@ func TestJsonNameAnnotations(t *testing.T) {
882907
DocLines: nil,
883908
FieldType: "i32",
884909
PrimitiveFieldType: "i32",
910+
ProstType: "i32",
885911
AddQueryParameter: `let builder = builder.query(&[("readTime", &req.read_time)]);`,
886912
SerdeAs: "wkt::internal::I32",
887913
SkipIfIsDefault: true,
@@ -899,6 +925,7 @@ func TestJsonNameAnnotations(t *testing.T) {
899925
DocLines: nil,
900926
FieldType: "std::option::Option<i32>",
901927
PrimitiveFieldType: "i32",
928+
ProstType: "i32",
902929
AddQueryParameter: `let builder = req.optional.iter().fold(builder, |builder, p| builder.query(&[("optional", p)]));`,
903930
SerdeAs: "wkt::internal::I32",
904931
SkipIfIsDefault: true,
@@ -916,6 +943,7 @@ func TestJsonNameAnnotations(t *testing.T) {
916943
DocLines: nil,
917944
FieldType: "std::vec::Vec<i32>",
918945
PrimitiveFieldType: "i32",
946+
ProstType: "i32",
919947
AddQueryParameter: `let builder = req.repeated.iter().fold(builder, |builder, p| builder.query(&[("repeated", p)]));`,
920948
SerdeAs: "wkt::internal::I32",
921949
SkipIfIsDefault: true,
@@ -994,6 +1022,7 @@ func TestAnnotateField_ReservedRawIdentifiers(t *testing.T) {
9941022
FQMessageName: "crate::model::Message",
9951023
FieldType: "bool",
9961024
PrimitiveFieldType: "bool",
1025+
ProstType: "bool",
9971026
AddQueryParameter: `let builder = builder.query(&[("self", &req.self_)]);`,
9981027
SkipIfIsDefault: true,
9991028
}
@@ -1011,6 +1040,7 @@ func TestAnnotateField_ReservedRawIdentifiers(t *testing.T) {
10111040
FQMessageName: "crate::model::Message",
10121041
FieldType: "std::string::String",
10131042
PrimitiveFieldType: "std::string::String",
1043+
ProstType: "std::string::String",
10141044
AddQueryParameter: `let builder = builder.query(&[("crate", &req.crate_)]);`,
10151045
}
10161046
t.Run("crate", func(t *testing.T) {
@@ -1027,6 +1057,7 @@ func TestAnnotateField_ReservedRawIdentifiers(t *testing.T) {
10271057
FQMessageName: "crate::model::Message",
10281058
FieldType: "i32",
10291059
PrimitiveFieldType: "i32",
1060+
ProstType: "i32",
10301061
AddQueryParameter: `let builder = builder.query(&[("super", &req.super_)]);`,
10311062
SerdeAs: "wkt::internal::I32",
10321063
SkipIfIsDefault: true,

‎internal/sidekick/rust/annotate_message.go‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ func (c *codec) annotateMessage(m *api.Message, model *api.API, full bool) error
7979
ModuleName: c.MessageModuleName(m),
8080
QualifiedName: qualifiedName,
8181
RelativeName: relativeName,
82-
ProstRelativeName: prostMessageRelativePath(m),
82+
ProstRelativeName: c.prostTypeName(m.Package, prostMessageRelativePath(m), model.PackageName),
8383
NameInExamples: nameInExamples,
8484
PackageModuleName: packageToModuleName(m.Package),
8585
SourceFQN: strings.TrimPrefix(m.ID, "."),

‎internal/sidekick/rust/annotate_model.go‎

Lines changed: 0 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -276,25 +276,6 @@ func annotateModel(model *api.API, codec *codec) (*modelAnnotations, error) {
276276
}
277277
}
278278

279-
// ExternalEnums (e.g. google.type.Date) and ExternalMessages (e.g. google.api.HttpBody)
280-
// are populated for convert-prost generation in hybrid crates.
281-
// Override ProstRelativeName after all method annotations so ToProto and FromProto
282-
// resolve to crate::prost::<pkg>::<TypeName>.
283-
prostPrefix := "crate::prost::"
284-
if codec.prostPath != "" {
285-
prostPrefix = codec.prostPath + "::"
286-
}
287-
for _, e := range model.ExternalEnums {
288-
if ann, ok := e.Codec.(*enumAnnotation); ok {
289-
ann.ProstRelativeName = prostPrefix + packageToModuleName(e.Package) + "::" + prostEnumRelativePath(e)
290-
}
291-
}
292-
for _, m := range model.ExternalMessages {
293-
if ann, ok := m.Codec.(*messageAnnotation); ok {
294-
ann.ProstRelativeName = prostPrefix + packageToModuleName(m.Package) + "::" + prostMessageRelativePath(m)
295-
}
296-
}
297-
298279
servicesSubset := language.FilterSlice(model.Services, func(s *api.Service) bool {
299280
return slices.ContainsFunc(s.Methods, func(m *api.Method) bool { return codec.generateMethod(m) })
300281
})

0 commit comments

Comments
 (0)