Fix formatter issue with message literals with any syntax (#2650)

bufbuild · Dec 8, 2023 · b06ab38 · b06ab38
1 parent 44af737
commit b06ab38
Show file tree

Hide file tree

Showing 4 changed files with 28 additions and 0 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -12,6 +12,9 @@
   `use_enum_numbers`. This affects output serialization. Some examples:
   - `buf convert --type foo.Bar --from input.binpb --to output.yaml#use_proto_names=true`
   - `buf convert --type foo.Bar --from input.binpb --to -#format=yaml,use_enum_numbers=true`
+- Fix issue where `buf format` would inadvertently mangle files that used
+  the [expanded `Any` syntax](https://protobuf.com/docs/language-spec#any-messages)
+  in option values.
 
 ## [v1.28.1] - 2023-11-15
 

diff --git a/private/buf/bufformat/formatter.go b/private/buf/bufformat/formatter.go
@@ -707,6 +707,10 @@ func (f *formatter) writeMessageFieldPrefix(messageFieldNode *ast.MessageFieldNo
 	fieldReferenceNode := messageFieldNode.Name
 	if fieldReferenceNode.Open != nil {
 		f.writeStart(fieldReferenceNode.Open)
+		if fieldReferenceNode.URLPrefix != nil {
+			f.writeInline(fieldReferenceNode.URLPrefix)
+			f.writeInline(fieldReferenceNode.Slash)
+		}
 		f.writeInline(fieldReferenceNode.Name)
 	} else {
 		f.writeStart(fieldReferenceNode.Name)

diff --git a/private/buf/bufformat/testdata/proto2/option/v1/option_message_field.golden.proto b/private/buf/bufformat/testdata/proto2/option/v1/option_message_field.golden.proto
@@ -2,6 +2,7 @@ syntax = "proto2";
 
 package foo.bar;
 
+import "google/protobuf/any.proto";
 import "google/protobuf/descriptor.proto";
 
 message Simple {
@@ -26,6 +27,17 @@ message Test {
 
   extensions 249, 300 to 350, 500 to 550, 20000 to max [(label) = "jazz"];
 
+  option (any) = {
+    [type.googleapis.com/foo.bar.Test]: {
+      foo: "abc"
+      array: [
+        1,
+        2,
+        3
+      ]
+    }
+  };
+
   message Nested {
     extend google.protobuf.MessageOptions {
       optional int32 fooblez = 20003;
@@ -70,4 +82,5 @@ message Test {
 extend google.protobuf.MessageOptions {
   repeated Test rept = 20002;
   optional Test.Nested._NestedNested.EEE eee = 20010;
+  optional google.protobuf.Any any = 20300;
 }
diff --git a/private/buf/bufformat/testdata/proto2/option/v1/option_message_field.proto b/private/buf/bufformat/testdata/proto2/option/v1/option_message_field.proto
@@ -2,6 +2,7 @@ syntax = "proto2";
 
 package foo.bar;
 
+import "google/protobuf/any.proto";
 import "google/protobuf/descriptor.proto";
 
 message Simple {
@@ -28,6 +29,12 @@ message Test {
 
 	extensions 249, 300 to 350, 500 to 550, 20000 to max [(label) = "jazz"];
 
+	option (any) = {
+		[ type . googleapis . com/ foo.bar.Test	]: {
+			foo: "abc" array: [1,2,3]
+		}
+	};
+
 	message Nested {
 		extend google.protobuf.MessageOptions {
 			optional int32 fooblez = 20003;
@@ -69,4 +76,5 @@ message Test {
 extend google.protobuf.MessageOptions {
 	repeated Test rept = 20002;
 	optional Test.Nested._NestedNested.EEE eee = 20010;
+	optional google.protobuf.Any any = 20300;
 }