forked from tmc/grpcutil
/
genflowtypes.go
279 lines (248 loc) · 7.45 KB
/
genflowtypes.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
package genflowtypes
import (
"bytes"
"fmt"
"strings"
"text/template"
"github.com/golang/protobuf/proto"
pbdescriptor "github.com/golang/protobuf/protoc-gen-go/descriptor"
"github.com/grpc-ecosystem/grpc-gateway/protoc-gen-grpc-gateway/descriptor"
"github.com/mwitkow/go-proto-validators"
)
// Flower is a flow language type
type Flower interface {
FlowType() string
IsRequired() bool
}
// NamedFlower is a Flower with a name
type NamedFlower interface {
Flower
Name() string
}
func newSimpleType(typeString string, required bool) *simpleType {
return &simpleType{typeString, required}
}
type simpleType struct {
typeString string
required bool
}
func (s simpleType) FlowType() string { return s.typeString }
func (s simpleType) IsRequired() bool { return s.required }
type messageType struct {
*simpleType
}
func newMessageFlowType(typeName string, required bool) *messageType {
s := newSimpleType(typeName, required)
return &messageType{s}
}
type repeatedType struct {
Flower
required bool
}
func newRepeatedFlowType(underlying Flower, required bool) *repeatedType {
return &repeatedType{Flower: underlying, required: required}
}
func (r repeatedType) FlowType() string { return fmt.Sprintf("Array<%s>", r.Flower.FlowType()) }
type namedType struct {
Flower
name string
required bool
}
func (t *namedType) Name() string {
return t.name
}
type objectFlowType struct {
Fields []NamedFlower
Options Options
required bool
}
func (t *objectFlowType) FlowType() string {
fields := []string{}
for _, f := range t.Fields {
optionalIndicator := "?"
if f.IsRequired() {
optionalIndicator = ""
}
fields = append(fields, fmt.Sprintf(" %s%s: %s", f.Name(), optionalIndicator, f.FlowType()))
}
return fmt.Sprintf("{\n%s\n}", strings.Join(fields, ",\n"))
}
func (t *objectFlowType) IsRequired() bool { return t.required }
func (cfg Options) fqmnToType(fqmn string, registry *descriptor.Registry) (Flower, error) {
m, err := registry.LookupMsg("", fqmn)
if err != nil {
return nil, err
}
return cfg.messageToFlowType(m, registry)
}
func (cfg Options) fieldToType(f *descriptor.Field, reg *descriptor.Registry, required bool) (NamedFlower, error) {
// FieldMessage
var fieldType Flower = newSimpleType("any", required)
switch f.GetType() {
case pbdescriptor.FieldDescriptorProto_TYPE_DOUBLE:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_FLOAT:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_INT64:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_UINT64:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_INT32:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_FIXED64:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_FIXED32:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_UINT32:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_SFIXED32:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_SFIXED64:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_SINT32:
fallthrough
case pbdescriptor.FieldDescriptorProto_TYPE_SINT64:
fieldType = newSimpleType("number", required)
case pbdescriptor.FieldDescriptorProto_TYPE_BOOL:
fieldType = newSimpleType("boolean", required)
case pbdescriptor.FieldDescriptorProto_TYPE_STRING:
fieldType = newSimpleType("string", required)
case pbdescriptor.FieldDescriptorProto_TYPE_GROUP:
fieldType = newSimpleType("any", required) // , required?
case pbdescriptor.FieldDescriptorProto_TYPE_MESSAGE:
// TODO: should resolve type name relative to this type
ft, err := reg.LookupMsg("", f.GetTypeName())
if err != nil {
return nil, err
}
fieldType = newMessageFlowType(cfg.messageTypeName(ft), required)
case pbdescriptor.FieldDescriptorProto_TYPE_BYTES:
fieldType = newSimpleType("string", required) // could be more correct
case pbdescriptor.FieldDescriptorProto_TYPE_ENUM:
e, err := reg.LookupEnum("", f.GetTypeName())
if err != nil {
return nil, err
}
if cfg.EmbedEnums {
fieldType, err = cfg.enumToFlowType(e, reg)
if err != nil {
return nil, err
}
} else {
name := cfg.enumTypeName(e)
fieldType = newSimpleType(name, required)
}
}
if f.GetLabel() == pbdescriptor.FieldDescriptorProto_LABEL_REPEATED {
fieldType = newRepeatedFlowType(fieldType, required)
}
return &namedType{Flower: fieldType, name: f.GetName(), required: required}, nil
}
// this is a hack to use the FieldOptions descriptor from golang/proto instead of gogo/proto
var E_Field = &proto.ExtensionDesc{
ExtendedType: (*pbdescriptor.FieldOptions)(nil),
ExtensionType: validator.E_Field.ExtensionType,
Field: validator.E_Field.Field,
Name: validator.E_Field.Name,
Tag: validator.E_Field.Tag,
Filename: validator.E_Field.Filename,
}
func init() {
proto.RegisterType((*validator.FieldValidator)(nil), "validator.FieldValidator")
proto.RegisterExtension(E_Field)
}
func getFieldValidatorIfAny(field *pbdescriptor.FieldDescriptorProto) *validator.FieldValidator {
if field.Options != nil {
v, err := proto.GetExtension(field.Options, E_Field)
if err == nil && v.(*validator.FieldValidator) != nil {
return (v.(*validator.FieldValidator))
}
}
return nil
}
func (cfg Options) messageToFlowType(m *descriptor.Message, reg *descriptor.Registry) (Flower, error) {
t := &objectFlowType{
Fields: []NamedFlower{},
Options: cfg,
}
for _, f := range m.Fields {
required := false
if validatorOptions := getFieldValidatorIfAny(f.FieldDescriptorProto); validatorOptions != nil {
required = *validatorOptions.MsgExists
}
field, err := cfg.fieldToType(f, reg, required)
if err != nil {
return nil, err
}
t.Fields = append(t.Fields, field)
}
return &namedType{Flower: t, name: cfg.messageTypeName(m)}, nil
}
func (cfg Options) enumTypeName(e *descriptor.Enum) string {
name := strings.Replace(e.FQEN(), ".", "", -1)
if !cfg.AlwaysQualifyTypes {
if strings.HasPrefix(name, e.File.GoPkg.Name) {
name = name[len(e.File.GoPkg.Name):]
}
}
return name
}
func (cfg Options) messageTypeName(m *descriptor.Message) string {
name := strings.Replace(m.FQMN(), ".", "", -1)
if !cfg.AlwaysQualifyTypes {
if strings.HasPrefix(name, m.File.GoPkg.Name) {
name = name[len(m.File.GoPkg.Name):]
}
}
return name
}
func (cfg Options) enumToFlowType(e *descriptor.Enum, reg *descriptor.Registry) (Flower, error) {
options := []string{}
for _, v := range e.Value {
if !cfg.EmitEnumZeros && v.GetNumber() == 0 {
continue
}
options = append(options, fmt.Sprintf(`"%s"`, v.GetName()))
}
name := cfg.enumTypeName(e)
return &namedType{
Flower: newSimpleType(strings.Join(options, " | "), false),
name: name,
}, nil
}
func generateFlowTypes(file *descriptor.File, registry *descriptor.Registry, opts Options) (string, error) {
result := []Flower{}
f, err := registry.LookupFile(file.GetName())
if err != nil {
return "", err
}
for _, enum := range f.Enums {
t, err := opts.enumToFlowType(enum, registry)
if err != nil {
return "", err
}
result = append(result, t)
}
for _, message := range f.Messages {
t, err := opts.messageToFlowType(message, registry)
if err != nil {
return "", err
}
result = append(result, t)
}
buf := new(bytes.Buffer)
tmpl, err := template.New("").Parse(`/* @flow */
/* eslint-disable */
// Code generated by protoc-gen-flowtypes DO NOT EDIT.
{{range .}}export type {{.Name}} = {{.FlowType}};
{{end}}
`)
if err != nil {
return "", err
}
err = tmpl.Execute(buf, result)
if err != nil {
return "", err
}
return string(buf.Bytes()), nil
}