Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

genswagger: don't emit default response if there's no Error definition #1166

Merged
merged 5 commits into from
Mar 11, 2020
Merged

genswagger: don't emit default response if there's no Error definition #1166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
9875f76
genswagger: test-covered #1162(unset default error ref)
utrack Mar 10, 2020
50d3a95
genswagger: no default response when Error is unset
utrack Mar 10, 2020
f106bcd
genswagger: emit errors if swagger name can't be resolved
utrack Mar 11, 2020
3b67a6e
genswagger: fixed tests
utrack Mar 11, 2020
08d4b36
Merge remote-tracking branch 'upstream/master' into genswagger-unset-…
utrack Mar 11, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
142 changes: 101 additions & 41 deletions protoc-gen-swagger/genswagger/template.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -221,28 +221,40 @@ func findServicesMessagesAndEnumerations(s []*descriptor.Service, reg *descripto
for _, svc := range s {
for _, meth := range svc.Methods {
// Request may be fully included in query
if _, ok := refs[fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(meth.RequestType.FQMN(), reg))]; ok {
if !skipRenderingRef(meth.RequestType.FQMN()) {
m[fullyQualifiedNameToSwaggerName(meth.RequestType.FQMN(), reg)] = meth.RequestType
{
swgReqName, ok := fullyQualifiedNameToSwaggerName(meth.RequestType.FQMN(), reg)
if !ok {
glog.Errorf("couldn't resolve swagger name for FQMN '%v'", meth.RequestType.FQMN())
continue
}
if _, ok := refs[fmt.Sprintf("#/definitions/%s", swgReqName)]; ok {
if !skipRenderingRef(meth.RequestType.FQMN()) {
m[swgReqName] = meth.RequestType
}
}
}

swgRspName, ok := fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg)
if !ok && !skipRenderingRef(meth.ResponseType.FQMN()) {
glog.Errorf("couldn't resolve swagger name for FQMN '%v'", meth.ResponseType.FQMN())
continue
}

findNestedMessagesAndEnumerations(meth.RequestType, reg, m, e)

if !skipRenderingRef(meth.ResponseType.FQMN()) {
m[fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg)] = meth.ResponseType
m[swgRspName] = meth.ResponseType
if meth.GetServerStreaming() {
runtimeStreamError := fullyQualifiedNameToSwaggerName(".grpc.gateway.runtime.StreamError", reg)
glog.V(1).Infof("StreamError FQMN: %s", runtimeStreamError)
streamError, err := reg.LookupMsg(".grpc.gateway.runtime", "StreamError")
if err == nil {
streamError, runtimeStreamError, err := lookupMsgAndSwaggerName(".grpc.gateway.runtime", "StreamError", reg)
if err != nil {
glog.Error(err)
} else {
glog.V(1).Infof("StreamError: %v", streamError)
glog.V(1).Infof("StreamError FQMN: %s", runtimeStreamError)
m[runtimeStreamError] = streamError
findNestedMessagesAndEnumerations(streamError, reg, m, e)
} else {
//just in case there is an error looking up StreamError
glog.Error(err)
}
ms[fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg)] = meth.ResponseType
ms[swgRspName] = meth.ResponseType
}
}
findNestedMessagesAndEnumerations(meth.ResponseType, reg, m, e)
Expand Down Expand Up @@ -281,6 +293,10 @@ func skipRenderingRef(refName string) bool {

func renderMessagesAsDefinition(messages messageMap, d swaggerDefinitionsObject, reg *descriptor.Registry, customRefs refMap) {
for name, msg := range messages {
swgName, ok := fullyQualifiedNameToSwaggerName(msg.FQMN(), reg)
if !ok {
panic(fmt.Sprintf("can't resolve swagger name from '%v'", msg.FQMN()))
}
if skipRenderingRef(name) {
continue
}
Expand Down Expand Up @@ -354,7 +370,7 @@ func renderMessagesAsDefinition(messages messageMap, d swaggerDefinitionsObject,
}
*schema.Properties = append(*schema.Properties, kv)
}
d[fullyQualifiedNameToSwaggerName(msg.FQMN(), reg)] = schema
d[swgName] = schema
}
}

Expand Down Expand Up @@ -392,12 +408,15 @@ func schemaOfField(f *descriptor.Field, reg *descriptor.Registry, refs refMap) s
props = &swaggerSchemaObjectProperties{}
}
} else {
swgRef, ok := fullyQualifiedNameToSwaggerName(fd.GetTypeName(), reg)
if !ok {
panic(fmt.Sprintf("can't resolve swagger ref from typename '%v'", fd.GetTypeName()))
}
core = schemaCore{
Ref: "#/definitions/" + fullyQualifiedNameToSwaggerName(fd.GetTypeName(), reg),
Ref: "#/definitions/" + swgRef,
}
if refs != nil {
refs[fd.GetTypeName()] = struct{}{}

}
}
default:
Expand Down Expand Up @@ -492,6 +511,10 @@ func primitiveSchema(t pbdescriptor.FieldDescriptorProto_Type) (ftype, format st
// renderEnumerationsAsDefinition inserts enums into the definitions object.
func renderEnumerationsAsDefinition(enums enumMap, d swaggerDefinitionsObject, reg *descriptor.Registry) {
for _, enum := range enums {
swgName, ok := fullyQualifiedNameToSwaggerName(enum.FQEN(), reg)
if !ok {
panic(fmt.Sprintf("can't resolve swagger name from FQEN '%v'", enum.FQEN()))
}
enumComments := protoComments(reg, enum.File, enum.Outers, "EnumType", int32(enum.Index))

// it may be necessary to sort the result of the GetValue function.
Expand All @@ -512,20 +535,37 @@ func renderEnumerationsAsDefinition(enums enumMap, d swaggerDefinitionsObject, r
panic(err)
}

d[fullyQualifiedNameToSwaggerName(enum.FQEN(), reg)] = enumSchemaObject
d[swgName] = enumSchemaObject
}
}

// Take in a FQMN or FQEN and return a swagger safe version of the FQMN
func fullyQualifiedNameToSwaggerName(fqn string, reg *descriptor.Registry) string {
// Take in a FQMN or FQEN and return a swagger safe version of the FQMN and
// a boolean indicating if FQMN was properly resolved.
func fullyQualifiedNameToSwaggerName(fqn string, reg *descriptor.Registry) (string, bool) {
registriesSeenMutex.Lock()
defer registriesSeenMutex.Unlock()
if mapping, present := registriesSeen[reg]; present {
return mapping[fqn]
ret, ok := mapping[fqn]
return ret, ok
}
mapping := resolveFullyQualifiedNameToSwaggerNames(append(reg.GetAllFQMNs(), reg.GetAllFQENs()...), reg.GetUseFQNForSwaggerName())
registriesSeen[reg] = mapping
return mapping[fqn]
ret, ok := mapping[fqn]
return ret, ok
}

// Lookup message type by location.name and return a swagger-safe version
// of its FQMN.
func lookupMsgAndSwaggerName(location, name string, reg *descriptor.Registry) (*descriptor.Message, string, error) {
msg, err := reg.LookupMsg(location, name)
if err != nil {
return nil, "", err
}
swgName, ok := fullyQualifiedNameToSwaggerName(msg.FQMN(), reg)
if !ok {
return nil, "", fmt.Errorf("can't map swagger name from FQMN '%v'", msg.FQMN())
}
return msg, swgName, nil
}

// registriesSeen is used to memoise calls to resolveFullyQualifiedNameToSwaggerNames so
Expand Down Expand Up @@ -768,7 +808,10 @@ func renderServices(services []*descriptor.Service, paths swaggerPathsObject, re

wknSchemaCore, isWkn := wktSchemas[meth.RequestType.FQMN()]
if !isWkn {
schema.Ref = fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(meth.RequestType.FQMN(), reg))
err := schema.setRefFromFQN(meth.RequestType.FQMN(), reg)
if err != nil {
return err
}
} else {
schema.schemaCore = wknSchemaCore

Expand Down Expand Up @@ -826,7 +869,10 @@ func renderServices(services []*descriptor.Service, paths swaggerPathsObject, re
// well, without a definition
wknSchemaCore, isWkn := wktSchemas[meth.ResponseType.FQMN()]
if !isWkn {
responseSchema.Ref = fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg))
err := responseSchema.setRefFromFQN(meth.ResponseType.FQMN(), reg)
if err != nil {
return err
}
} else {
responseSchema.schemaCore = wknSchemaCore

Expand All @@ -848,8 +894,10 @@ func renderServices(services []*descriptor.Service, paths swaggerPathsObject, re
if meth.GetServerStreaming() {
desc += "(streaming responses)"
responseSchema.Type = "object"
responseSchema.Title = fmt.Sprintf("Stream result of %s", fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg))
responseSchema.Properties = &swaggerSchemaObjectProperties{
swgRef, _ := fullyQualifiedNameToSwaggerName(meth.ResponseType.FQMN(), reg)
responseSchema.Title = "Stream result of " + swgRef

props := swaggerSchemaObjectProperties{
keyVal{
Key: "result",
Value: swaggerSchemaObject{
Expand All @@ -858,14 +906,18 @@ func renderServices(services []*descriptor.Service, paths swaggerPathsObject, re
},
},
},
keyVal{
}
streamErrDef, hasStreamError := fullyQualifiedNameToSwaggerName(".grpc.gateway.runtime.StreamError", reg)
if hasStreamError {
props = append(props, keyVal{
Key: "error",
Value: swaggerSchemaObject{
schemaCore: schemaCore{
Ref: fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(".grpc.gateway.runtime.StreamError", reg))},
Ref: fmt.Sprintf("#/definitions/%s", streamErrDef)},
},
},
})
}
responseSchema.Properties = &props
responseSchema.Ref = ""
}

Expand All @@ -885,14 +937,17 @@ func renderServices(services []*descriptor.Service, paths swaggerPathsObject, re
},
}
if !reg.GetDisableDefaultErrors() {
// https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responses-object
operationObject.Responses["default"] = swaggerResponseObject{
Description: "An unexpected error response",
Schema: swaggerSchemaObject{
schemaCore: schemaCore{
Ref: fmt.Sprintf("#/definitions/%s", fullyQualifiedNameToSwaggerName(".grpc.gateway.runtime.Error", reg)),
errDef, hasErrDef := fullyQualifiedNameToSwaggerName(".grpc.gateway.runtime.Error", reg)
if hasErrDef {
// https://github.com/OAI/OpenAPI-Specification/blob/3.0.0/versions/2.0.md#responses-object
operationObject.Responses["default"] = swaggerResponseObject{
Description: "An unexpected error response",
Schema: swaggerSchemaObject{
schemaCore: schemaCore{
Ref: fmt.Sprintf("#/definitions/%s", errDef),
},
},
},
}
}
}
if bIdx == 0 {
Expand Down Expand Up @@ -1056,9 +1111,9 @@ func applyTemplate(p param) (*swaggerObject, error) {

if !p.reg.GetDisableDefaultErrors() {
// Add the error type to the message map
runtimeError, err := p.reg.LookupMsg(".grpc.gateway.runtime", "Error")
runtimeError, swgRef, err := lookupMsgAndSwaggerName(".grpc.gateway.runtime", "Error", p.reg)
if err == nil {
messages[fullyQualifiedNameToSwaggerName(".grpc.gateway.runtime.Error", p.reg)] = runtimeError
messages[swgRef] = runtimeError
} else {
// just in case there is an error looking up runtimeError
glog.Error(err)
Expand Down Expand Up @@ -1683,8 +1738,8 @@ func protoJSONSchemaToSwaggerSchemaCore(j *swagger_options.JSONSchema, reg *desc
ret := schemaCore{}

if j.GetRef() != "" {
swaggerName := fullyQualifiedNameToSwaggerName(j.GetRef(), reg)
if swaggerName != "" {
swaggerName, ok := fullyQualifiedNameToSwaggerName(j.GetRef(), reg)
if ok {
ret.Ref = "#/definitions/" + swaggerName
if refs != nil {
refs[j.GetRef()] = struct{}{}
Expand Down Expand Up @@ -1820,19 +1875,24 @@ func addCustomRefs(d swaggerDefinitionsObject, reg *descriptor.Registry, refs re
msgMap := make(messageMap)
enumMap := make(enumMap)
for ref := range refs {
if _, ok := d[fullyQualifiedNameToSwaggerName(ref, reg)]; ok {
swgName, swgOk := fullyQualifiedNameToSwaggerName(ref, reg)
if !swgOk {
glog.Errorf("can't resolve swagger name from CustomRef '%v'", ref)
continue
}
if _, ok := d[swgName]; ok {
// Skip already existing definitions
delete(refs, ref)
continue
}
msg, err := reg.LookupMsg("", ref)
if err == nil {
msgMap[fullyQualifiedNameToSwaggerName(ref, reg)] = msg
msgMap[swgName] = msg
continue
}
enum, err := reg.LookupEnum("", ref)
if err == nil {
enumMap[fullyQualifiedNameToSwaggerName(ref, reg)] = enum
enumMap[swgName] = enum
continue
}

Expand Down
Loading