protoc-gen-openapiv2: RPC visibility setting transitively applied to …

…messages (#2880) * protoc-gen-openapiv2: RPC visibility setting transitively applied to messages Addresses issue #2691. Skip hidden methods in findServicesMessagesAndEnumerations. * Add submessage and enum visibility tests * fix lint error in visibility proto
grpc-ecosystem · Sep 9, 2022 · c37ecc1 · c37ecc1
1 parent 73e0eb7
commit c37ecc1
Show file tree

Hide file tree

Showing 6 changed files with 419 additions and 110 deletions.
diff --git a/examples/internal/proto/examplepb/visibility_rule_echo_service.pb.go b/examples/internal/proto/examplepb/visibility_rule_echo_service.pb.go
diff --git a/examples/internal/proto/examplepb/visibility_rule_echo_service.proto b/examples/internal/proto/examplepb/visibility_rule_echo_service.proto
@@ -53,6 +53,29 @@ message VisibilityRuleSimpleMessage {
   VisibilityEnum an_enum = 10;
 }
 
+// MessageInPreviewMethod doesn't define its own visibility restrictions,
+// but is only included in a method marked as "PREVIEW", so it will only
+// appear if `visibility_restriction_selectors` include "PREVIEW".
+message VisibilityRuleMessageInPreviewMethod {
+  string id = 1;
+  VisibilityRuleSubMessageInPreviewMethod sub_message = 2;
+  VisibilityRuleEnumInPreviewMethod enum = 3;
+}
+
+// SubMessageInPreviewMethod doesn't define its own visibility restrictions,
+// but is only included in a method marked as "PREVIEW", so it will only
+// appear if `visibility_restriction_selectors` include "PREVIEW".
+message VisibilityRuleSubMessageInPreviewMethod {
+  string id = 1;
+}
+
+// EnumInPreviewMethod doesn't define its own visibility restrictions,
+// but is only included in a method marked as "PREVIEW", so it will only
+// appear if `visibility_restriction_selectors` include "PREVIEW".
+enum VisibilityRuleEnumInPreviewMethod {
+  VISIBILITY_RULE_ENUM_IN_PREVIEW_METHOD_UNSPECIFIED = 0;
+}
+
 // VisibilityRuleEchoService service responds to incoming echo requests.
 // Different services will be available in the swagger documentation depending
 // based on `google.api.VisibilityRule`s and the set `visibility_restriction_selectors`
@@ -75,7 +98,7 @@ service VisibilityRuleEchoService {
   }
   // EchoPreview is a preview API that should only be visible in the OpenAPI spec
   // if `visibility_restriction_selectors` includes "PREVIEW".
-  rpc EchoPreview(VisibilityRuleSimpleMessage) returns (VisibilityRuleSimpleMessage) {
+  rpc EchoPreview(VisibilityRuleSimpleMessage) returns (VisibilityRuleMessageInPreviewMethod) {
     option (google.api.method_visibility).restriction = "PREVIEW";
     option (google.api.http) = {
       get: "/v1/example/echo_preview"

diff --git a/examples/internal/proto/examplepb/visibility_rule_echo_service_grpc.pb.go b/examples/internal/proto/examplepb/visibility_rule_echo_service_grpc.pb.go
diff --git a/...s/internal/proto/examplepb/visibility_rule_preview_and_internal_echo_service.swagger.json b/...s/internal/proto/examplepb/visibility_rule_preview_and_internal_echo_service.swagger.json
@@ -430,7 +430,7 @@
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/examplepbVisibilityRuleSimpleMessage"
+              "$ref": "#/definitions/examplepbVisibilityRuleMessageInPreviewMethod"
             }
           },
           "default": {
@@ -721,6 +721,29 @@
       },
       "description": "Embedded represents a message embedded in SimpleMessage."
     },
+    "examplepbVisibilityRuleEnumInPreviewMethod": {
+      "type": "string",
+      "enum": [
+        "VISIBILITY_RULE_ENUM_IN_PREVIEW_METHOD_UNSPECIFIED"
+      ],
+      "default": "VISIBILITY_RULE_ENUM_IN_PREVIEW_METHOD_UNSPECIFIED",
+      "description": "EnumInPreviewMethod doesn't define its own visibility restrictions,\nbut is only included in a method marked as \"PREVIEW\", so it will only\nappear if `visibility_restriction_selectors` include \"PREVIEW\"."
+    },
+    "examplepbVisibilityRuleMessageInPreviewMethod": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "subMessage": {
+          "$ref": "#/definitions/examplepbVisibilityRuleSubMessageInPreviewMethod"
+        },
+        "enum": {
+          "$ref": "#/definitions/examplepbVisibilityRuleEnumInPreviewMethod"
+        }
+      },
+      "description": "MessageInPreviewMethod doesn't define its own visibility restrictions,\nbut is only included in a method marked as \"PREVIEW\", so it will only\nappear if `visibility_restriction_selectors` include \"PREVIEW\"."
+    },
     "examplepbVisibilityRuleSimpleMessage": {
       "type": "object",
       "properties": {
@@ -761,6 +784,15 @@
       },
       "description": "SimpleMessage represents a simple message sent to the Echo service."
     },
+    "examplepbVisibilityRuleSubMessageInPreviewMethod": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        }
+      },
+      "description": "SubMessageInPreviewMethod doesn't define its own visibility restrictions,\nbut is only included in a method marked as \"PREVIEW\", so it will only\nappear if `visibility_restriction_selectors` include \"PREVIEW\"."
+    },
     "protobufAny": {
       "type": "object",
       "properties": {

diff --git a/examples/internal/proto/examplepb/visibility_rule_preview_echo_service.swagger.json b/examples/internal/proto/examplepb/visibility_rule_preview_echo_service.swagger.json
@@ -255,7 +255,7 @@
           "200": {
             "description": "A successful response.",
             "schema": {
-              "$ref": "#/definitions/examplepbVisibilityRuleSimpleMessage"
+              "$ref": "#/definitions/examplepbVisibilityRuleMessageInPreviewMethod"
             }
           },
           "default": {
@@ -389,6 +389,29 @@
       },
       "description": "Embedded represents a message embedded in SimpleMessage."
     },
+    "examplepbVisibilityRuleEnumInPreviewMethod": {
+      "type": "string",
+      "enum": [
+        "VISIBILITY_RULE_ENUM_IN_PREVIEW_METHOD_UNSPECIFIED"
+      ],
+      "default": "VISIBILITY_RULE_ENUM_IN_PREVIEW_METHOD_UNSPECIFIED",
+      "description": "EnumInPreviewMethod doesn't define its own visibility restrictions,\nbut is only included in a method marked as \"PREVIEW\", so it will only\nappear if `visibility_restriction_selectors` include \"PREVIEW\"."
+    },
+    "examplepbVisibilityRuleMessageInPreviewMethod": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        },
+        "subMessage": {
+          "$ref": "#/definitions/examplepbVisibilityRuleSubMessageInPreviewMethod"
+        },
+        "enum": {
+          "$ref": "#/definitions/examplepbVisibilityRuleEnumInPreviewMethod"
+        }
+      },
+      "description": "MessageInPreviewMethod doesn't define its own visibility restrictions,\nbut is only included in a method marked as \"PREVIEW\", so it will only\nappear if `visibility_restriction_selectors` include \"PREVIEW\"."
+    },
     "examplepbVisibilityRuleSimpleMessage": {
       "type": "object",
       "properties": {
@@ -426,6 +449,15 @@
       },
       "description": "SimpleMessage represents a simple message sent to the Echo service."
     },
+    "examplepbVisibilityRuleSubMessageInPreviewMethod": {
+      "type": "object",
+      "properties": {
+        "id": {
+          "type": "string"
+        }
+      },
+      "description": "SubMessageInPreviewMethod doesn't define its own visibility restrictions,\nbut is only included in a method marked as \"PREVIEW\", so it will only\nappear if `visibility_restriction_selectors` include \"PREVIEW\"."
+    },
     "protobufAny": {
       "type": "object",
       "properties": {

diff --git a/protoc-gen-openapiv2/internal/genopenapi/template.go b/protoc-gen-openapiv2/internal/genopenapi/template.go
@@ -367,6 +367,10 @@ func findServicesMessagesAndEnumerations(s []*descriptor.Service, reg *descripto
 		for _, meth := range svc.Methods {
 			// Request may be fully included in query
 			{
+				if !isVisible(getMethodVisibilityOption(meth), reg) {
+					continue
+				}
+
 				swgReqName, ok := fullyQualifiedNameToOpenAPIName(meth.RequestType.FQMN(), reg)
 				if !ok {
 					glog.Errorf("couldn't resolve OpenAPI name for FQMN '%v'", meth.RequestType.FQMN())