-
Notifications
You must be signed in to change notification settings - Fork 48
/
generator.go
440 lines (396 loc) · 11.4 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
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
package generator
import (
"bytes"
"errors"
"fmt"
"io"
"os"
"sort"
"go/format"
"text/template"
// nolint: staticcheck
"github.com/golang/protobuf/proto"
descriptor "github.com/golang/protobuf/protoc-gen-go/descriptor"
plugin "github.com/golang/protobuf/protoc-gen-go/plugin"
"github.com/ysugimoto/grpc-graphql-gateway/graphql"
"github.com/ysugimoto/grpc-graphql-gateway/protoc-gen-graphql/spec"
)
type Template struct {
RootPackage *spec.Package
Packages []*spec.Package
Types []*spec.Message
Interfaces []*spec.Message
Enums []*spec.Enum
Inputs []*spec.Message
Services []*spec.Service
}
// Generator is struct for analyzing protobuf definition
// and factory graphql definition in protobuf to generate.
type Generator struct {
files []*spec.File
args *spec.Params
messages map[string]*spec.Message
enums map[string]*spec.Enum
logger *Logger
}
func New(files []*spec.File, args *spec.Params) *Generator {
messages := make(map[string]*spec.Message)
enums := make(map[string]*spec.Enum)
for _, f := range files {
for _, m := range f.Messages() {
messages[m.FullPath()] = m
}
for _, e := range f.Enums() {
enums[e.FullPath()] = e
}
}
w := io.Discard
if args.Verbose {
w = os.Stderr
}
return &Generator{
files: files,
args: args,
messages: messages,
enums: enums,
logger: NewLogger(w),
}
}
func (g *Generator) Generate(tmpl string, fs []string) ([]*plugin.CodeGeneratorResponse_File, error) {
services, err := g.analyzeServices()
if err != nil {
return nil, err
}
var outFiles []*plugin.CodeGeneratorResponse_File
for _, f := range g.files {
for _, v := range fs {
if f.Filename() != v {
continue
}
s, ok := services[f.Package()]
if !ok {
continue
}
// mark as same package definition in file
g.analyzeEnum(f)
if err := g.analyzeMessage(f); err != nil {
return nil, err
}
file, err := g.generateFile(f, tmpl, s)
if err != nil {
return nil, err
}
outFiles = append(outFiles, file)
}
}
return outFiles, nil
}
func isDependedGoogleEmptyMessage(m *spec.Message, pkg string) bool {
return m.IsDepended(spec.DependTypeMessage, pkg) && spec.IsGooglePackage(m) && m.Name() == "Empty"
}
// nolint: gocognit, funlen, gocyclo
func (g *Generator) generateFile(file *spec.File, tmpl string, services []*spec.Service) (
*plugin.CodeGeneratorResponse_File,
error,
) {
var types, inputs, interfaces []*spec.Message
var enums []*spec.Enum
var packages []*spec.Package
for _, m := range g.messages {
// skip empty field message, otherwise graphql-go raise error
if len(m.Fields()) == 0 {
// although true, Google's empty message has no fields,
// ptypes package define a dummy field, that way no errors raised
if isDependedGoogleEmptyMessage(m, file.Package()) {
packages = append(packages, spec.NewGooglePackage(m))
}
continue
}
if m.IsDepended(spec.DependTypeMessage, file.Package()) {
switch {
case file.Package() == m.Package():
types = append(types, m)
case spec.IsGooglePackage(m):
packages = append(packages, spec.NewGooglePackage(m))
default:
packages = append(packages, spec.NewPackage(m))
}
}
if m.IsDepended(spec.DependTypeInput, file.Package()) {
if !spec.IsGooglePackage(m) {
inputs = append(inputs, m)
}
}
if m.IsDepended(spec.DependTypeInterface, file.Package()) {
interfaces = append(interfaces, m)
}
}
for _, s := range services {
for _, q := range s.Queries {
input, output := q.Input, q.Output
if input.Package() != file.Package() {
if spec.IsGooglePackage(input) {
packages = append(packages, spec.NewGooglePackage(input))
} else {
packages = append(packages, spec.NewPackage(input))
}
}
if output.Package() != file.Package() {
if spec.IsGooglePackage(output) {
packages = append(packages, spec.NewGooglePackage(output))
} else {
packages = append(packages, spec.NewPackage(output))
}
}
}
for _, m := range s.Mutations {
input, output := m.Input, m.Output
if input.Package() != file.Package() {
if spec.IsGooglePackage(input) {
packages = append(packages, spec.NewGooglePackage(input))
} else {
packages = append(packages, spec.NewPackage(input))
}
}
if output.Package() != file.Package() {
if spec.IsGooglePackage(output) {
packages = append(packages, spec.NewGooglePackage(output))
} else {
packages = append(packages, spec.NewPackage(output))
}
}
}
}
for _, e := range g.enums {
// skip empty values enum, otherwise graphql-go raise error
if len(e.Values()) == 0 {
continue
}
if e.IsDepended(spec.DependTypeEnum, file.Package()) {
if file.Package() == e.Package() || spec.IsGooglePackage(e) {
enums = append(enums, e)
} else {
packages = append(packages, spec.NewPackage(e))
}
}
}
// drop duplicate packages
uniquePackages := make([]*spec.Package, 0)
stack := make(map[string]struct{})
for _, p := range packages {
if _, ok := stack[p.Path]; ok {
continue
}
uniquePackages = append(uniquePackages, p)
stack[p.Path] = struct{}{}
}
// Sort by name to avoid to appear some diff on each generation
sort.Slice(uniquePackages, func(i, j int) bool {
return uniquePackages[i].Name > uniquePackages[j].Name
})
sort.Slice(types, func(i, j int) bool {
return types[i].Name() > types[j].Name()
})
sort.Slice(enums, func(i, j int) bool {
return enums[i].Name() > enums[j].Name()
})
sort.Slice(inputs, func(i, j int) bool {
return inputs[i].Name() > inputs[j].Name()
})
sort.Slice(interfaces, func(i, j int) bool {
return interfaces[i].Name() > interfaces[j].Name()
})
sort.Slice(services, func(i, j int) bool {
return services[i].Name() > services[j].Name()
})
root := spec.NewPackage(file)
t := &Template{
RootPackage: root,
Packages: uniquePackages,
Types: types,
Enums: enums,
Inputs: inputs,
Interfaces: interfaces,
Services: services,
}
buf := new(bytes.Buffer)
if tmpl, err := template.New("go").Parse(tmpl); err != nil {
return nil, err
} else if err := tmpl.Execute(buf, t); err != nil {
return nil, err
}
out, err := format.Source(buf.Bytes())
if err != nil {
os.WriteFile("/tmp/"+root.Name+".go", buf.Bytes(), 0o666) // nolint: gomnd,errcheck
return nil, err
}
// If paths=source_relative option is provided, put generated file relatively
if g.args.IsSourceRelative() {
return &plugin.CodeGeneratorResponse_File{
Name: proto.String(fmt.Sprintf("%s.graphql.go", root.GeneratedFilenamePrefix)),
Content: proto.String(string(out)),
}, nil
}
return &plugin.CodeGeneratorResponse_File{
Name: proto.String(fmt.Sprintf("%s/%s.graphql.go", root.Path, root.FileName)),
Content: proto.String(string(out)),
}, nil
}
func (g *Generator) getMessage(name string) *spec.Message {
if v, ok := g.messages[name]; ok {
return v
} else if v, ok := g.messages["."+name]; ok {
return v
}
return nil
}
func (g *Generator) getEnum(name string) *spec.Enum {
if v, ok := g.enums[name]; ok {
return v
} else if v, ok := g.enums["."+name]; ok {
return v
}
return nil
}
// nolint: interfacer
func (g *Generator) analyzeMessage(file *spec.File) error {
for _, m := range g.messages {
if m.Package() != file.Package() {
continue
}
m.Depend(spec.DependTypeMessage, file.Package())
m.Depend(spec.DependTypeInput, file.Package())
if err := g.analyzeFields(file.Package(), m, m.Fields(), false, false); err != nil {
return err
}
}
return nil
}
// nolint: interfacer
func (g *Generator) analyzeEnum(file *spec.File) {
for _, e := range g.enums {
if e.Package() != file.Package() {
continue
}
e.Depend(spec.DependTypeEnum, file.Package())
}
}
func (g *Generator) analyzeServices() (map[string][]*spec.Service, error) {
services := make(map[string][]*spec.Service)
for _, f := range g.files {
services[f.Package()] = []*spec.Service{}
for _, s := range f.Services() {
if err := g.analyzeService(f, s); err != nil {
return nil, err
}
if len(s.Queries) > 0 || len(s.Mutations) > 0 {
services[f.Package()] = append(services[f.Package()], s)
}
}
}
return services, nil
}
func (g *Generator) analyzeService(f *spec.File, s *spec.Service) error {
for _, m := range s.Methods() {
if m.Schema == nil {
continue
}
var input, output *spec.Message
if input = g.getMessage(m.Input()); input == nil {
return errors.New("failed to resolve input message: " + m.Input())
}
if output = g.getMessage(m.Output()); output == nil {
return errors.New("failed to resolve output message: " + m.Output())
}
switch m.Schema.GetType() {
case graphql.GraphqlType_QUERY, graphql.GraphqlType_RESOLVER:
q := spec.NewQuery(m, input, output, g.args.FieldCamelCase)
if err := g.analyzeQuery(f, q); err != nil {
return err
}
s.Queries = append(s.Queries, q)
case graphql.GraphqlType_MUTATION:
mu := spec.NewMutation(m, input, output, g.args.FieldCamelCase)
if err := g.analyzeMutation(f, mu); err != nil {
return err
}
s.Mutations = append(s.Mutations, mu)
}
}
return nil
}
// nolint: interfacer
func (g *Generator) analyzeQuery(f *spec.File, q *spec.Query) error {
g.logger.Write("package %s depends on query request %s", f.Package(), q.Input.FullPath())
q.Input.Depend(spec.DependTypeMessage, f.Package())
if err := g.analyzeFields(f.Package(), q.Input, q.PluckRequest(), false, false); err != nil {
return err
}
q.Output.Depend(spec.DependTypeMessage, f.Package())
if err := g.analyzeFields(f.Package(), q.Output, q.PluckResponse(), false, false); err != nil {
return err
}
return nil
}
// nolint: interfacer
func (g *Generator) analyzeMutation(f *spec.File, m *spec.Mutation) error {
g.logger.Write("package %s depends on mutation request %s", f.Package(), m.Input.FullPath())
m.Input.Depend(spec.DependTypeInput, f.Package())
if err := g.analyzeFields(f.Package(), m.Input, m.PluckRequest(), true, false); err != nil {
return err
}
m.Output.Depend(spec.DependTypeMessage, f.Package())
if err := g.analyzeFields(f.Package(), m.Output, m.PluckResponse(), false, false); err != nil {
return err
}
return nil
}
func (g *Generator) analyzeFields(
rootPkg string,
orig *spec.Message,
fields []*spec.Field,
asInput,
recursive bool,
) error {
for _, f := range fields {
switch f.Type() {
case descriptor.FieldDescriptorProto_TYPE_MESSAGE:
m := g.getMessage(f.TypeName())
if m == nil {
return errors.New("failed to resolve field message type: " + f.TypeName())
}
f.DependType = m
if asInput {
g.logger.Write("package %s depends on input %s", rootPkg, m.FullPath())
m.Depend(spec.DependTypeInput, rootPkg)
} else {
g.logger.Write("package %s depends on message %s", rootPkg, m.FullPath())
switch {
case m == orig:
g.logger.Write("%s has cyclic dependencies of field %s\n", m.Name(), f.Name())
f.IsCyclic = true
m.Depend(spec.DependTypeInterface, rootPkg)
case !recursive:
m.Depend(spec.DependTypeMessage, rootPkg)
default:
return nil
}
}
// Guard from recursive with infinite loop
if m != orig {
if err := g.analyzeFields(rootPkg, m, m.Fields(), asInput, true); err != nil {
return err
}
}
case descriptor.FieldDescriptorProto_TYPE_ENUM:
e := g.getEnum(f.TypeName())
if e == nil {
return errors.New("failed to resolve field enum name: " + f.TypeName())
}
f.DependType = e
g.logger.Write("package %s depends on enum %s", rootPkg, e.FullPath())
e.Depend(spec.DependTypeEnum, rootPkg)
}
}
return nil
}