protoprint: fix bug where comments on method options were not include…

…d in output (#492)
jhump · Feb 13, 2022 · 0e352eb · 0e352eb
1 parent 6224817
commit 0e352eb
Show file tree

Hide file tree

Showing 32 changed files with 224 additions and 225 deletions.
diff --git a/desc/protoparse/test-source-info.txt b/desc/protoparse/test-source-info.txt
diff --git a/desc/protoprint/print.go b/desc/protoprint/print.go
@@ -1417,14 +1417,14 @@ func (p *Printer) printMethod(mtd *desc.MethodDescriptor, mf *dynamic.MessageFac
 			elements := elementAddrs{dsc: mtd, opts: opts}
 			elements.addrs = optionsAsElementAddrs(internal.Method_optionsTag, 0, opts)
 			p.sort(elements, sourceInfo, path)
-			path = append(path, internal.Method_optionsTag)
 
-			for i, addr := range elements.addrs {
+			for i, el := range elements.addrs {
 				if i > 0 {
 					p.newLine(w)
 				}
-				o := elements.at(addr).([]option)
-				p.printOptionsLong(o, w, sourceInfo, path, indent)
+				o := elements.at(el).([]option)
+				childPath := append(path, el.elementType, int32(el.elementIndex))
+				p.printOptionsLong(o, w, sourceInfo, childPath, indent)
 			}
 
 			p.indent(w, indent-1)

diff --git a/desc/protoprint/testfiles/desc_test_comments-compact.proto b/desc/protoprint/testfiles/desc_test_comments-compact.proto
@@ -64,6 +64,8 @@ message Request {
   }
   // can be these or those
   oneof xyz {
+    // whoops?
+    option (testprotos.oofubar) = "whoops!";
     string these = 6;
     int32 those = 7;
   }
@@ -92,6 +94,7 @@ service RpcService {
   rpc StreamingRpc ( stream Request ) returns ( Request ); // compact method trailer
   rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
     // trailer for method
+    // this RPC is deprecated!
     option deprecated = true;
     option (testprotos.mtfubar) = 12.340000;
     option (testprotos.mtfubard) = 123.456000;

diff --git a/desc/protoprint/testfiles/desc_test_comments-custom-sort.proto b/desc/protoprint/testfiles/desc_test_comments-custom-sort.proto
@@ -31,6 +31,7 @@ service RpcService {
 
     option (testprotos.mtfubar) = 12.340000;
 
+    // this RPC is deprecated!
     option deprecated = true;
   }
 
@@ -96,6 +97,9 @@ message Request {
     int32 those = 7;
 
     string these = 6;
+
+    // whoops?
+    option (testprotos.oofubar) = "whoops!";
   }
 
   // can be this or that

diff --git a/desc/protoprint/testfiles/desc_test_comments-default.proto b/desc/protoprint/testfiles/desc_test_comments-default.proto
@@ -108,6 +108,9 @@ message Request {
 
   // can be these or those
   oneof xyz {
+    // whoops?
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;
@@ -150,6 +153,7 @@ service RpcService {
   rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
     // trailer for method
 
+    // this RPC is deprecated!
     option deprecated = true;
 
     option (testprotos.mtfubar) = 12.340000;

diff --git a/desc/protoprint/testfiles/desc_test_comments-multiline-style-comments.proto b/desc/protoprint/testfiles/desc_test_comments-multiline-style-comments.proto
@@ -110,6 +110,9 @@ message Request {
 
 	/* can be these or those */
 	oneof xyz {
+		/* whoops? */
+		option (testprotos.oofubar) = "whoops!";
+
 		string these = 6;
 
 		int32 those = 7;
@@ -154,6 +157,7 @@ service RpcService {
 	rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
 		/* trailer for method */
 
+		/* this RPC is deprecated! */
 		option deprecated = true;
 
 		option (testprotos.mtfubar) = 12.340000;

diff --git a/desc/protoprint/testfiles/desc_test_comments-no-trailing-comments.proto b/desc/protoprint/testfiles/desc_test_comments-no-trailing-comments.proto
@@ -102,6 +102,9 @@ message Request {
 
   // can be these or those
   oneof xyz {
+    // whoops?
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;
@@ -137,6 +140,7 @@ service RpcService {
   rpc StreamingRpc ( stream Request ) returns ( Request );
 
   rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
+    // this RPC is deprecated!
     option deprecated = true;
 
     option (testprotos.mtfubar) = 12.340000;

diff --git a/desc/protoprint/testfiles/desc_test_comments-only-doc-comments.proto b/desc/protoprint/testfiles/desc_test_comments-only-doc-comments.proto
@@ -81,6 +81,8 @@ message Request {
 
   // can be these or those
   oneof xyz {
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;

diff --git a/desc/protoprint/testfiles/desc_test_comments-sorted-AND-multiline-style-comments.proto b/desc/protoprint/testfiles/desc_test_comments-sorted-AND-multiline-style-comments.proto
@@ -72,6 +72,9 @@ message Request {
 
   /* can be these or those */
   oneof xyz {
+    /* whoops? */
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;
@@ -142,6 +145,7 @@ service RpcService {
   rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
     /* trailer for method */
 
+    /* this RPC is deprecated! */
     option deprecated = true;
 
     option (testprotos.mtfubar) = 12.340000;

diff --git a/desc/protoprint/testfiles/desc_test_comments-sorted.proto b/desc/protoprint/testfiles/desc_test_comments-sorted.proto
@@ -55,6 +55,9 @@ message Request {
 
    // can be these or those
    oneof xyz {
+      // whoops?
+      option (testprotos.oofubar) = "whoops!";
+
       string these = 6;
 
       int32 those = 7;
@@ -123,6 +126,7 @@ service RpcService {
    rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
       // trailer for method
 
+      // this RPC is deprecated!
       option deprecated = true;
 
       option (testprotos.mtfubar) = 12.340000;

diff --git a/desc/protoprint/testfiles/desc_test_comments-trailing-on-next-line.proto b/desc/protoprint/testfiles/desc_test_comments-trailing-on-next-line.proto
@@ -113,6 +113,9 @@ message Request {
 
   // can be these or those
   oneof xyz {
+    // whoops?
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;
@@ -157,6 +160,7 @@ service RpcService {
   rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
     // trailer for method
 
+    // this RPC is deprecated!
     option deprecated = true;
 
     option (testprotos.mtfubar) = 12.340000;

diff --git a/desc/protoprint/testfiles/test-non-files-compact.txt b/desc/protoprint/testfiles/test-non-files-compact.txt
@@ -30,6 +30,7 @@ message Request {
   }
   // can be these or those
   oneof xyz {
+    option (.testprotos.oofubar) = "whoops!";
     string these = 6;
     int32 those = 7;
   }
@@ -100,6 +101,7 @@ message Request {
   }
   // can be these or those
   oneof xyz {
+    option (.testprotos.oofubar) = "whoops!";
     string these = 6;
     int32 those = 7;
   }
@@ -160,6 +162,7 @@ oneof abc {
 }
 -------- foo.bar.Request.xyz (*desc.OneOfDescriptor) --------
 oneof xyz {
+  option (.testprotos.oofubar) = "whoops!";
   string these = 6;
   int32 those = 7;
 }

diff --git a/desc/protoprint/testfiles/test-non-files-full.txt b/desc/protoprint/testfiles/test-non-files-full.txt
@@ -113,6 +113,9 @@ message /* detached message name */ /* request with a capital R */ Request /* tr
 
   // can be these or those
   oneof xyz {
+    // whoops?
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;
@@ -157,6 +160,7 @@ service /* service name */ RpcService {
   rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
     // trailer for method
 
+    // this RPC is deprecated!
     option deprecated = true;
 
     option (testprotos.mtfubar) = 12.340000;
@@ -260,6 +264,9 @@ message /* detached message name */ /* request with a capital R */ Request /* tr
 
   // can be these or those
   oneof xyz {
+    // whoops?
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;
@@ -320,6 +327,8 @@ oneof abc {
 }
 -------- foo.bar.Request.xyz (*desc.OneOfDescriptor) --------
 oneof xyz {
+  option (testprotos.oofubar) = "whoops!";
+
   string these = 6;
 
   int32 those = 7;
@@ -449,6 +458,7 @@ service /* service name */ RpcService {
   rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
     // trailer for method
 
+    // this RPC is deprecated!
     option deprecated = true;
 
     option (testprotos.mtfubar) = 12.340000;
@@ -463,6 +473,7 @@ rpc /* rpc name */ StreamingRpc /* comment A */ ( /* comment C */ stream Request
 rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
   // trailer for method
 
+  // this RPC is deprecated!
   option deprecated = true;
 
   option (testprotos.mtfubar) = 12.340000;

diff --git a/desc/protoprint/testfiles/test-preserve-comments.proto b/desc/protoprint/testfiles/test-preserve-comments.proto
@@ -112,6 +112,9 @@ message /* detached message name */ /* request with a capital R */ Request /* tr
 
   // can be these or those
   oneof xyz {
+    // whoops?
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;
@@ -156,6 +159,7 @@ service /* service name */ RpcService {
   rpc UnaryRpc ( Request ) returns ( google.protobuf.Empty ) {
     // trailer for method
 
+    // this RPC is deprecated!
     option deprecated = true;
 
     option (testprotos.mtfubar) = 12.340000;

diff --git a/desc/protoprint/testfiles/test-preserve-doc-comments.proto b/desc/protoprint/testfiles/test-preserve-doc-comments.proto
@@ -81,6 +81,8 @@ message Request {
 
   // can be these or those
   oneof xyz {
+    option (testprotos.oofubar) = "whoops!";
+
     string these = 6;
 
     int32 those = 7;

diff --git a/internal/testprotos/desc_test1.pb.go b/internal/testprotos/desc_test1.pb.go
diff --git a/internal/testprotos/desc_test2.pb.go b/internal/testprotos/desc_test2.pb.go