/
generator.go
388 lines (342 loc) · 10.9 KB
/
generator.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
package genopenapi
import (
"bytes"
"encoding/json"
"errors"
"fmt"
"path/filepath"
"reflect"
"strings"
"github.com/golang/glog"
anypb "github.com/golang/protobuf/ptypes/any"
"github.com/grpc-ecosystem/grpc-gateway/v2/internal/descriptor"
gen "github.com/grpc-ecosystem/grpc-gateway/v2/internal/generator"
openapi_options "github.com/grpc-ecosystem/grpc-gateway/v2/protoc-gen-openapiv2/options"
statuspb "google.golang.org/genproto/googleapis/rpc/status"
"google.golang.org/protobuf/proto"
"google.golang.org/protobuf/types/descriptorpb"
"google.golang.org/protobuf/types/pluginpb"
//nolint:staticcheck // Known issue, will be replaced when possible
legacydescriptor "github.com/golang/protobuf/descriptor"
)
var errNoTargetService = errors.New("no target service defined in the file")
type generator struct {
reg *descriptor.Registry
format Format
}
type wrapper struct {
fileName string
swagger *openapiSwaggerObject
}
type GeneratorOptions struct {
Registry *descriptor.Registry
RecursiveDepth int
}
// New returns a new generator which generates grpc gateway files.
func New(reg *descriptor.Registry, format Format) gen.Generator {
return &generator{
reg: reg,
format: format,
}
}
// Merge a lot of OpenAPI file (wrapper) to single one OpenAPI file
func mergeTargetFile(targets []*wrapper, mergeFileName string) *wrapper {
var mergedTarget *wrapper
for _, f := range targets {
if mergedTarget == nil {
mergedTarget = &wrapper{
fileName: mergeFileName,
swagger: f.swagger,
}
} else {
for k, v := range f.swagger.Definitions {
mergedTarget.swagger.Definitions[k] = v
}
for k, v := range f.swagger.Paths {
mergedTarget.swagger.Paths[k] = v
}
for k, v := range f.swagger.SecurityDefinitions {
mergedTarget.swagger.SecurityDefinitions[k] = v
}
mergedTarget.swagger.Security = append(mergedTarget.swagger.Security, f.swagger.Security...)
}
}
return mergedTarget
}
// Q: What's up with the alias types here?
// A: We don't want to completely override how these structs are marshaled into
// JSON, we only want to add fields (see below, extensionMarshalJSON).
// An infinite recursion would happen if we'd call json.Marshal on the struct
// that has swaggerObject as an embedded field. To avoid that, we'll create
// type aliases, and those don't have the custom MarshalJSON methods defined
// on them. See http://choly.ca/post/go-json-marshalling/ (or, if it ever
// goes away, use
// https://web.archive.org/web/20190806073003/http://choly.ca/post/go-json-marshalling/.
func (so openapiSwaggerObject) MarshalJSON() ([]byte, error) {
type alias openapiSwaggerObject
return extensionMarshalJSON(alias(so), so.extensions)
}
// MarshalYAML implements yaml.Marshaler interface.
//
// It is required in order to pass extensions inline.
//
// Example:
//
// extensions: {x-key: x-value}
// type: string
//
// It will be rendered as:
//
// x-key: x-value
// type: string
//
// Use generics when the project will be upgraded to go 1.18+.
func (so openapiSwaggerObject) MarshalYAML() (interface{}, error) {
type Alias openapiSwaggerObject
return struct {
Extension map[string]interface{} `yaml:",inline"`
Alias `yaml:",inline"`
}{
Extension: extensionsToMap(so.extensions),
Alias: Alias(so),
}, nil
}
func (so openapiInfoObject) MarshalJSON() ([]byte, error) {
type alias openapiInfoObject
return extensionMarshalJSON(alias(so), so.extensions)
}
func (so openapiInfoObject) MarshalYAML() (interface{}, error) {
type Alias openapiInfoObject
return struct {
Extension map[string]interface{} `yaml:",inline"`
Alias `yaml:",inline"`
}{
Extension: extensionsToMap(so.extensions),
Alias: Alias(so),
}, nil
}
func (so openapiSecuritySchemeObject) MarshalJSON() ([]byte, error) {
type alias openapiSecuritySchemeObject
return extensionMarshalJSON(alias(so), so.extensions)
}
func (so openapiSecuritySchemeObject) MarshalYAML() (interface{}, error) {
type Alias openapiSecuritySchemeObject
return struct {
Extension map[string]interface{} `yaml:",inline"`
Alias `yaml:",inline"`
}{
Extension: extensionsToMap(so.extensions),
Alias: Alias(so),
}, nil
}
func (so openapiOperationObject) MarshalJSON() ([]byte, error) {
type alias openapiOperationObject
return extensionMarshalJSON(alias(so), so.extensions)
}
func (so openapiOperationObject) MarshalYAML() (interface{}, error) {
type Alias openapiOperationObject
return struct {
Extension map[string]interface{} `yaml:",inline"`
Alias `yaml:",inline"`
}{
Extension: extensionsToMap(so.extensions),
Alias: Alias(so),
}, nil
}
func (so openapiResponseObject) MarshalJSON() ([]byte, error) {
type alias openapiResponseObject
return extensionMarshalJSON(alias(so), so.extensions)
}
func (so openapiResponseObject) MarshalYAML() (interface{}, error) {
type Alias openapiResponseObject
return struct {
Extension map[string]interface{} `yaml:",inline"`
Alias `yaml:",inline"`
}{
Extension: extensionsToMap(so.extensions),
Alias: Alias(so),
}, nil
}
func (so openapiSchemaObject) MarshalJSON() ([]byte, error) {
type alias openapiSchemaObject
return extensionMarshalJSON(alias(so), so.extensions)
}
func (so openapiSchemaObject) MarshalYAML() (interface{}, error) {
type Alias openapiSchemaObject
return struct {
Extension map[string]interface{} `yaml:",inline"`
Alias `yaml:",inline"`
}{
Extension: extensionsToMap(so.extensions),
Alias: Alias(so),
}, nil
}
func (so openapiParameterObject) MarshalJSON() ([]byte, error) {
type alias openapiParameterObject
return extensionMarshalJSON(alias(so), so.extensions)
}
func (so openapiParameterObject) MarshalYAML() (interface{}, error) {
type Alias openapiParameterObject
return struct {
Extension map[string]interface{} `yaml:",inline"`
Alias `yaml:",inline"`
}{
Extension: extensionsToMap(so.extensions),
Alias: Alias(so),
}, nil
}
func (so openapiTagObject) MarshalJSON() ([]byte, error) {
type alias openapiTagObject
return extensionMarshalJSON(alias(so), so.extensions)
}
func (so openapiTagObject) MarshalYAML() (interface{}, error) {
type Alias openapiTagObject
return struct {
Extension map[string]interface{} `yaml:",inline"`
Alias `yaml:",inline"`
}{
Extension: extensionsToMap(so.extensions),
Alias: Alias(so),
}, nil
}
func extensionMarshalJSON(so interface{}, extensions []extension) ([]byte, error) {
// To append arbitrary keys to the struct we'll render into json,
// we're creating another struct that embeds the original one, and
// its extra fields:
//
// The struct will look like
// struct {
// *openapiCore
// XGrpcGatewayFoo json.RawMessage `json:"x-grpc-gateway-foo"`
// XGrpcGatewayBar json.RawMessage `json:"x-grpc-gateway-bar"`
// }
// and thus render into what we want -- the JSON of openapiCore with the
// extensions appended.
fields := []reflect.StructField{
{ // embedded
Name: "Embedded",
Type: reflect.TypeOf(so),
Anonymous: true,
},
}
for _, ext := range extensions {
fields = append(fields, reflect.StructField{
Name: fieldName(ext.key),
Type: reflect.TypeOf(ext.value),
Tag: reflect.StructTag(fmt.Sprintf("json:\"%s\"", ext.key)),
})
}
t := reflect.StructOf(fields)
s := reflect.New(t).Elem()
s.Field(0).Set(reflect.ValueOf(so))
for _, ext := range extensions {
s.FieldByName(fieldName(ext.key)).Set(reflect.ValueOf(ext.value))
}
return json.Marshal(s.Interface())
}
// encodeOpenAPI converts OpenAPI file obj to pluginpb.CodeGeneratorResponse_File
func encodeOpenAPI(file *wrapper, format Format) (*descriptor.ResponseFile, error) {
var contentBuf bytes.Buffer
enc, err := format.NewEncoder(&contentBuf)
if err != nil {
return nil, err
}
if err := enc.Encode(*file.swagger); err != nil {
return nil, err
}
name := file.fileName
ext := filepath.Ext(name)
base := strings.TrimSuffix(name, ext)
output := fmt.Sprintf("%s.swagger."+string(format), base)
return &descriptor.ResponseFile{
CodeGeneratorResponse_File: &pluginpb.CodeGeneratorResponse_File{
Name: proto.String(output),
Content: proto.String(contentBuf.String()),
},
}, nil
}
func (g *generator) Generate(targets []*descriptor.File) ([]*descriptor.ResponseFile, error) {
var files []*descriptor.ResponseFile
if g.reg.IsAllowMerge() {
var mergedTarget *descriptor.File
// try to find proto leader
for _, f := range targets {
if proto.HasExtension(f.Options, openapi_options.E_Openapiv2Swagger) {
mergedTarget = f
break
}
}
// merge protos to leader
for _, f := range targets {
if mergedTarget == nil {
mergedTarget = f
} else if mergedTarget != f {
mergedTarget.Enums = append(mergedTarget.Enums, f.Enums...)
mergedTarget.Messages = append(mergedTarget.Messages, f.Messages...)
mergedTarget.Services = append(mergedTarget.Services, f.Services...)
}
}
targets = nil
targets = append(targets, mergedTarget)
}
var openapis []*wrapper
for _, file := range targets {
glog.V(1).Infof("Processing %s", file.GetName())
swagger, err := applyTemplate(param{File: file, reg: g.reg})
if errors.Is(err, errNoTargetService) {
glog.V(1).Infof("%s: %v", file.GetName(), err)
continue
}
if err != nil {
return nil, err
}
openapis = append(openapis, &wrapper{
fileName: file.GetName(),
swagger: swagger,
})
}
if g.reg.IsAllowMerge() {
targetOpenAPI := mergeTargetFile(openapis, g.reg.GetMergeFileName())
f, err := encodeOpenAPI(targetOpenAPI, g.format)
if err != nil {
return nil, fmt.Errorf("failed to encode OpenAPI for %s: %w", g.reg.GetMergeFileName(), err)
}
files = append(files, f)
glog.V(1).Infof("New OpenAPI file will emit")
} else {
for _, file := range openapis {
f, err := encodeOpenAPI(file, g.format)
if err != nil {
return nil, fmt.Errorf("failed to encode OpenAPI for %s: %w", file.fileName, err)
}
files = append(files, f)
glog.V(1).Infof("New OpenAPI file will emit")
}
}
return files, nil
}
// AddErrorDefs Adds google.rpc.Status and google.protobuf.Any
// to registry (used for error-related API responses)
func AddErrorDefs(reg *descriptor.Registry) error {
// load internal protos
any, _ := legacydescriptor.MessageDescriptorProto(&anypb.Any{})
any.SourceCodeInfo = new(descriptorpb.SourceCodeInfo)
status, _ := legacydescriptor.MessageDescriptorProto(&statuspb.Status{})
status.SourceCodeInfo = new(descriptorpb.SourceCodeInfo)
// TODO(johanbrandhorst): Use new conversion later when possible
// any := protodesc.ToFileDescriptorProto((&anypb.Any{}).ProtoReflect().Descriptor().ParentFile())
// status := protodesc.ToFileDescriptorProto((&statuspb.Status{}).ProtoReflect().Descriptor().ParentFile())
return reg.Load(&pluginpb.CodeGeneratorRequest{
ProtoFile: []*descriptorpb.FileDescriptorProto{
any,
status,
},
})
}
func extensionsToMap(extensions []extension) map[string]interface{} {
m := make(map[string]interface{}, len(extensions))
for _, v := range extensions {
m[v.key] = RawExample(v.value)
}
return m
}