/
service.go
241 lines (211 loc) · 7.86 KB
/
service.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
package plugin
import (
"errors"
"fmt"
"sort"
"github.com/alta/protopatch/lint"
"github.com/alta/protopatch/patch/gopb"
temporalv1 "github.com/cludden/protoc-gen-go-temporal/gen/temporal/v1"
"github.com/iancoleman/strcase"
"google.golang.org/protobuf/compiler/protogen"
"google.golang.org/protobuf/proto"
)
// Service describes a temporal protobuf service definition
type Service struct {
*protogen.Plugin
*protogen.Service
*protogen.File
cfg *Config
opts *temporalv1.ServiceOptions
activitiesOrdered []string
activities map[string]*temporalv1.ActivityOptions
commands map[string]*temporalv1.CommandOptions
methods map[string]*protogen.Method
queriesOrdered []string
queries map[string]*temporalv1.QueryOptions
signalsOrdered []string
signals map[string]*temporalv1.SignalOptions
updatesOrdered []string
updates map[string]*temporalv1.UpdateOptions
workflowsOrdered []string
workflows map[string]*temporalv1.WorkflowOptions
}
// parseService extracts a Service from a protogen.Service value
func parseService(p *protogen.Plugin, cfg *Config, file *protogen.File, service *protogen.Service) (*Service, error) {
svc := Service{
Plugin: p,
cfg: cfg,
Service: service,
File: file,
activities: make(map[string]*temporalv1.ActivityOptions),
commands: make(map[string]*temporalv1.CommandOptions),
methods: make(map[string]*protogen.Method),
queries: make(map[string]*temporalv1.QueryOptions),
signals: make(map[string]*temporalv1.SignalOptions),
updates: make(map[string]*temporalv1.UpdateOptions),
workflows: make(map[string]*temporalv1.WorkflowOptions),
}
if opts, ok := proto.GetExtension(service.Desc.Options(), temporalv1.E_Service).(*temporalv1.ServiceOptions); ok && opts != nil {
svc.opts = opts
}
for _, method := range service.Methods {
name := strcase.ToCamel(method.GoName)
svc.methods[name] = method
var mode int
if opts, ok := proto.GetExtension(method.Desc.Options(), temporalv1.E_Workflow).(*temporalv1.WorkflowOptions); ok && opts != nil {
svc.workflows[name] = opts
svc.workflowsOrdered = append(svc.workflowsOrdered, name)
mode |= modeWorkflow
}
if opts, ok := proto.GetExtension(method.Desc.Options(), temporalv1.E_Activity).(*temporalv1.ActivityOptions); ok && opts != nil {
svc.activities[name] = opts
svc.activitiesOrdered = append(svc.activitiesOrdered, name)
mode |= modeActivity
}
if opts, ok := proto.GetExtension(method.Desc.Options(), temporalv1.E_Query).(*temporalv1.QueryOptions); ok && opts != nil {
svc.queries[name] = opts
svc.queriesOrdered = append(svc.queriesOrdered, name)
mode |= modeQuery
}
if opts, ok := proto.GetExtension(method.Desc.Options(), temporalv1.E_Signal).(*temporalv1.SignalOptions); ok && opts != nil {
svc.signals[name] = opts
svc.signalsOrdered = append(svc.signalsOrdered, name)
mode |= modeSignal
}
if opts, ok := proto.GetExtension(method.Desc.Options(), temporalv1.E_Update).(*temporalv1.UpdateOptions); ok && opts != nil {
if !svc.cfg.WorkflowUpdateEnabled {
return nil, fmt.Errorf("method %q includes an update configuration, but workflow updates are not enabled: enable them with \"workflow-update-enabled=true\" plugin option", name)
}
svc.updates[name] = opts
svc.updatesOrdered = append(svc.updatesOrdered, name)
mode |= modeUpdate
}
if opts, ok := proto.GetExtension(method.Desc.Options(), temporalv1.E_Command).(*temporalv1.CommandOptions); ok && opts != nil {
svc.commands[name] = opts
}
switch mode {
case 0:
case modeActivity:
case modeQuery:
case modeSignal, modeSignal | modeActivity:
case modeUpdate, modeUpdate | modeActivity:
case modeWorkflow, modeWorkflow | modeActivity:
default:
p.Error(fmt.Errorf("invalid method options for method %q", method.Desc.FullName()))
}
}
sort.Strings(svc.activitiesOrdered)
sort.Strings(svc.queriesOrdered)
sort.Strings(svc.signalsOrdered)
sort.Strings(svc.updatesOrdered)
sort.Strings(svc.workflowsOrdered)
var errs error
for _, workflow := range svc.workflowsOrdered {
opts := svc.workflows[workflow]
// ensure workflow queries are defined
for _, queryOpts := range opts.GetQuery() {
query := queryOpts.GetRef()
if _, ok := svc.queries[query]; !ok {
errs = errors.Join(errs, fmt.Errorf("workflow %q references undefined query: %q", workflow, query))
}
}
// ensure workflow signals are defined
for _, signalOpts := range opts.GetSignal() {
signal := signalOpts.GetRef()
if _, ok := svc.signals[signal]; !ok {
errs = errors.Join(errs, fmt.Errorf("workflow %q references undefined signal: %q", workflow, signal))
}
}
// ensure workflow updates are defined
for _, updateOpts := range opts.GetUpdate() {
update := updateOpts.GetRef()
if _, ok := svc.updates[update]; !ok {
errs = errors.Join(errs, fmt.Errorf("workflow %q references undefined update: %q", workflow, update))
}
}
}
// ensure that signals return no value, unless signal method is also an activity, query, and/or workflow
for _, signal := range svc.signalsOrdered {
handler := svc.methods[signal]
_, isActivity := svc.activities[signal]
_, isQuery := svc.queries[signal]
_, isUpdate := svc.updates[signal]
_, isWorkflow := svc.workflows[signal]
if !isActivity && !isQuery && !isUpdate && !isWorkflow && !isEmpty(handler.Output) {
errs = errors.Join(errs, fmt.Errorf("expected signal %q output to be google.protobuf.Empty, got: %s", signal, handler.Output.GoIdent.GoName))
}
}
return &svc, errs
}
func (svc *Service) fqnForActivity(activity string) string {
if fqn := svc.activities[activity].GetName(); fqn != "" {
return fqn
}
return string(svc.methods[activity].Desc.FullName())
}
func (svc *Service) fqnForQuery(query string) string {
if fqn := svc.activities[query].GetName(); fqn != "" {
return fqn
}
return string(svc.methods[query].Desc.FullName())
}
func (svc *Service) fqnForSignal(signal string) string {
if fqn := svc.activities[signal].GetName(); fqn != "" {
return fqn
}
return string(svc.methods[signal].Desc.FullName())
}
func (svc *Service) fqnForUpdate(update string) string {
if fqn := svc.activities[update].GetName(); fqn != "" {
return fqn
}
return string(svc.methods[update].Desc.FullName())
}
func (svc *Service) fqnForWorkflow(workflow string) string {
if fqn := svc.activities[workflow].GetName(); fqn != "" {
return fqn
}
return string(svc.methods[workflow].Desc.FullName())
}
// getFieldName returns the name of the go field associated with the field
func (svc *Service) getFieldName(field *protogen.Field) string {
var lintOpts *gopb.LintOptions
if opts, ok := proto.GetExtension(field.Desc.ParentFile().Options(), gopb.E_Lint).(*gopb.LintOptions); ok && opts != nil {
lintOpts = opts
}
var fieldOpts *gopb.Options
if opts, ok := proto.GetExtension(field.Desc.Options(), gopb.E_Field).(*gopb.Options); ok && opts != nil {
fieldOpts = opts
}
goName := field.GoName
if svc.cfg.EnablePatchSupport {
if n := fieldOpts.GetName(); n != "" {
goName = n
}
if lintOpts.GetAll() || lintOpts.GetFields() {
goName = lint.Name(goName, lintOpts.InitialismsMap())
}
}
return goName
}
// getMessageName returns the name of the go type associated with the message
func (svc *Service) getMessageName(msg *protogen.Message) string {
var lintOpts *gopb.LintOptions
if opts, ok := proto.GetExtension(msg.Desc.ParentFile().Options(), gopb.E_Lint).(*gopb.LintOptions); ok && opts != nil {
lintOpts = opts
}
var msgOpts *gopb.Options
if opts, ok := proto.GetExtension(msg.Desc.Options(), gopb.E_Message).(*gopb.Options); ok && opts != nil {
msgOpts = opts
}
name := msg.GoIdent.GoName
if svc.cfg.EnablePatchSupport {
if n := msgOpts.GetName(); n != "" {
name = n
}
if lintOpts.GetAll() || lintOpts.GetMessages() {
name = lint.Name(name, lintOpts.InitialismsMap())
}
}
return name
}