-
Notifications
You must be signed in to change notification settings - Fork 20
/
flow.go
390 lines (325 loc) · 11.8 KB
/
flow.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
package definition
import (
"encoding/json"
"github.com/nyaruka/gocommon/jsonx"
"github.com/nyaruka/gocommon/uuids"
"github.com/nyaruka/goflow/assets"
"github.com/nyaruka/goflow/envs"
"github.com/nyaruka/goflow/excellent/types"
"github.com/nyaruka/goflow/flows"
"github.com/nyaruka/goflow/flows/definition/migrations"
"github.com/nyaruka/goflow/flows/inspect"
"github.com/nyaruka/goflow/flows/inspect/issues"
"github.com/nyaruka/goflow/utils"
"github.com/Masterminds/semver"
"github.com/pkg/errors"
)
// CurrentSpecVersion is the flow spec version supported by this library
var CurrentSpecVersion = semver.MustParse("13.2.0")
// IsVersionSupported checks the given version is supported
func IsVersionSupported(v *semver.Version) bool {
// can't do anything with a pre-11 flow or a newer major version
return v.Major() >= 11 && v.Major() <= CurrentSpecVersion.Major()
}
type flow struct {
// spec properties
uuid assets.FlowUUID
name string
specVersion *semver.Version
language envs.Language
flowType flows.FlowType
revision int
expireAfterMinutes int
localization flows.Localization
nodes []flows.Node
// optional properties not used by engine itself
ui json.RawMessage
// flows can be loaded from a assets or just a definition
asset assets.Flow
// internal state
nodeMap map[flows.NodeUUID]flows.Node
}
// NewFlow creates a new flow
func NewFlow(uuid assets.FlowUUID, name string, language envs.Language, flowType flows.FlowType, revision int, expireAfterMinutes int, localization flows.Localization, nodes []flows.Node, ui json.RawMessage, a assets.Flow) (flows.Flow, error) {
f := &flow{
uuid: uuid,
name: name,
specVersion: CurrentSpecVersion,
language: language,
flowType: flowType,
revision: revision,
expireAfterMinutes: expireAfterMinutes,
localization: localization,
nodes: nodes,
nodeMap: make(map[flows.NodeUUID]flows.Node, len(nodes)),
ui: ui,
asset: a,
}
for _, node := range f.nodes {
f.nodeMap[node.UUID()] = node
}
if err := f.validate(); err != nil {
return nil, err
}
return f, nil
}
func (f *flow) UUID() assets.FlowUUID { return f.uuid }
func (f *flow) Name() string { return f.name }
func (f *flow) SpecVersion() *semver.Version { return f.specVersion }
func (f *flow) Revision() int { return f.revision }
func (f *flow) Language() envs.Language { return f.language }
func (f *flow) Type() flows.FlowType { return f.flowType }
func (f *flow) ExpireAfterMinutes() int { return f.expireAfterMinutes }
func (f *flow) Nodes() []flows.Node { return f.nodes }
func (f *flow) Localization() flows.Localization { return f.localization }
func (f *flow) UI() json.RawMessage { return f.ui }
func (f *flow) GetNode(uuid flows.NodeUUID) flows.Node { return f.nodeMap[uuid] }
func (f *flow) validate() error {
// track UUIDs used by nodes and actions to ensure that they are unique
seenUUIDs := make(map[uuids.UUID]bool)
for _, node := range f.nodes {
uuidAlreadySeen := seenUUIDs[uuids.UUID(node.UUID())]
if uuidAlreadySeen {
return errors.Errorf("node UUID %s isn't unique", node.UUID())
}
seenUUIDs[uuids.UUID(node.UUID())] = true
if err := node.Validate(f, seenUUIDs); err != nil {
return errors.Wrapf(err, "invalid node[uuid=%s]", node.UUID())
}
}
return nil
}
// Inspect enumerates dependencies, results etc
func (f *flow) Inspect(sa flows.SessionAssets) *flows.Inspection {
templates, assetRefs, parentRefs := f.extract()
return &flows.Inspection{
Dependencies: inspect.NewDependencies(assetRefs, sa),
Results: flows.NewResultSpecs(f.extractResults()),
WaitingExits: f.extractExitsFromWaits(),
ParentRefs: parentRefs,
Issues: issues.Check(sa, f, templates, assetRefs),
}
}
// Context returns the properties available in expressions
//
// __default__:text -> the name
// uuid:text -> the UUID of the flow
// name:text -> the name of the flow
// revision:text -> the revision number of the flow
//
// @context flow
func (f *flow) Context(env envs.Environment) map[string]types.XValue {
return map[string]types.XValue{
"__default__": types.NewXText(f.name),
"uuid": types.NewXText(string(f.UUID())),
"name": types.NewXText(f.name),
"revision": types.NewXNumberFromInt(f.revision),
}
}
// Reference returns a reference to this flow asset
func (f *flow) Reference(withRevision bool) *assets.FlowReference {
if f == nil {
return nil
}
if withRevision {
return assets.NewFlowReferenceWithRevision(f.uuid, f.name, f.revision)
}
return assets.NewFlowReference(f.uuid, f.name)
}
// ExtractTemplates extracts all non-empty templates
func (f *flow) ExtractTemplates() []string {
templates := make([]string, 0)
include := func(a flows.Action, r flows.Router, l envs.Language, t string) {
if t != "" {
templates = append(templates, t)
}
}
for _, n := range f.nodes {
n.EnumerateTemplates(f.Localization(), include)
}
return templates
}
// ExtractLocalizables extracts all localizable text
func (f *flow) ExtractLocalizables() []string {
texts := make([]string, 0)
include := func(uuid uuids.UUID, property string, ts []string, w func([]string)) {
for _, t := range ts {
if t != "" {
texts = append(texts, t)
}
}
}
for _, n := range f.nodes {
n.EnumerateLocalizables(include)
}
return texts
}
// ChangeLanguage changes the language of the flow saving the current flow text as a translation and replacing it with
// the specified translation. It returns an error if there are missing translations.
func (f *flow) ChangeLanguage(lang envs.Language) (flows.Flow, error) {
// make a copy of the flow
copy, err := f.copy()
if err != nil {
return nil, err
}
ll := copy.localization.(localization)
outTranslation := make(languageTranslation) // current flow text extracted out as a translation
inTranslation := ll[lang] // translation being imported in as new flow text
if inTranslation == nil {
inTranslation = languageTranslation{}
}
include := func(uuid uuids.UUID, property string, oldValues []string, w func([]string)) {
// save current flow text into a translation
if len(oldValues) > 0 {
outTranslation.setTextArray(uuid, property, oldValues)
}
newValues := inTranslation.getTextArray(uuid, property)
// if we have a translation, update flow text in the definition, if not then leave it as is
if len(newValues) > 0 {
w(newValues)
}
}
for _, n := range copy.nodes {
n.EnumerateLocalizables(include)
}
ll[copy.language] = outTranslation
delete(ll, lang)
copy.language = lang
return copy, nil
}
// makes a copy of this flow which this differs from cloning as UUIDs are preserved
func (f *flow) copy() (*flow, error) {
// by marshaling and unmarshaling...
marshaled, err := jsonx.Marshal(f)
if err != nil {
return nil, err
}
cp, err := ReadFlow(marshaled, nil)
if err != nil {
return nil, err
}
return cp.(*flow), nil
}
// extracts all templates, asset dependencies and parent result references
func (f *flow) extract() ([]flows.ExtractedTemplate, []flows.ExtractedReference, []string) {
templates := make([]flows.ExtractedTemplate, 0)
assetRefs := make([]flows.ExtractedReference, 0)
parentRefs := make(map[string]bool)
recordAssetRef := func(n flows.Node, a flows.Action, r flows.Router, l envs.Language, ref assets.Reference) {
if ref != nil && !ref.Variable() {
er := flows.NewExtractedReference(n, a, r, l, ref)
assetRefs = append(assetRefs, er)
}
}
for _, n := range f.nodes {
n.EnumerateTemplates(f.Localization(), func(a flows.Action, r flows.Router, l envs.Language, t string) {
templates = append(templates, flows.NewExtractedTemplate(n, a, r, l, t))
ars, prs := inspect.ExtractFromTemplate(t)
for _, ref := range ars {
recordAssetRef(n, a, r, l, ref)
}
for _, r := range prs {
parentRefs[r] = true
}
})
n.EnumerateDependencies(f.Localization(), func(a flows.Action, r flows.Router, l envs.Language, ref assets.Reference) {
recordAssetRef(n, a, r, l, ref)
})
}
return templates, assetRefs, utils.SortedKeys(parentRefs)
}
// extracts all result specs
func (f *flow) extractResults() []flows.ExtractedResult {
results := make([]flows.ExtractedResult, 0)
for _, n := range f.nodes {
n.EnumerateResults(func(a flows.Action, r flows.Router, i *flows.ResultInfo) {
results = append(results, flows.ExtractedResult{Node: n, Action: a, Router: r, Info: i})
})
}
return results
}
// extracts all exits coming from nodes with waits
func (f *flow) extractExitsFromWaits() []flows.ExitUUID {
exitUUIDs := make([]flows.ExitUUID, 0)
include := func(e flows.ExitUUID) { exitUUIDs = append(exitUUIDs, e) }
for _, n := range f.nodes {
if n.Router() != nil && n.Router().Wait() != nil {
for _, e := range n.Exits() {
include(e.UUID())
}
}
}
return exitUUIDs
}
// Asset returns the asset from which this flow was created if there was one
func (f *flow) Asset() assets.Flow { return f.asset }
var _ flows.Flow = (*flow)(nil)
//------------------------------------------------------------------------------------------
// JSON Encoding / Decoding
//------------------------------------------------------------------------------------------
type flowEnvelope struct {
migrations.Header13
Language envs.Language `json:"language" validate:"required,language"`
Type flows.FlowType `json:"type" validate:"required,flow_type"`
Revision int `json:"revision"`
ExpireAfterMinutes int `json:"expire_after_minutes"`
Localization localization `json:"localization"`
Nodes []*node `json:"nodes"`
UI json.RawMessage `json:"_ui,omitempty"`
}
// ReadFlow reads a flow definition from the passed in byte array, migrating it to the spec version of the engine if necessary
func ReadFlow(data json.RawMessage, mc *migrations.Config) (flows.Flow, error) {
return readFlow(data, mc, nil)
}
// ReadAsset reads a flow definition from the passed in flow asset, migrating it to the spec version of the engine if necessary
func ReadAsset(a assets.Flow, mc *migrations.Config) (flows.Flow, error) {
return readFlow(a.Definition(), mc, a)
}
func readFlow(data json.RawMessage, mc *migrations.Config, a assets.Flow) (flows.Flow, error) {
if mc == nil {
mc = migrations.DefaultConfig
}
var err error
data, err = migrations.MigrateToLatest(data, mc)
if err != nil {
return nil, err
}
header := &migrations.Header13{}
jsonx.Unmarshal(data, header)
if !IsVersionSupported(header.SpecVersion) {
return nil, errors.Errorf("spec version %s is newer than this library (%s)", header.SpecVersion, CurrentSpecVersion)
}
e := &flowEnvelope{}
if err := utils.UnmarshalAndValidate(data, e); err != nil {
return nil, err
}
nodes := make([]flows.Node, len(e.Nodes))
for i := range e.Nodes {
nodes[i] = e.Nodes[i]
}
if e.Localization == nil {
e.Localization = make(localization)
}
return NewFlow(e.UUID, e.Name, e.Language, e.Type, e.Revision, e.ExpireAfterMinutes, e.Localization, nodes, e.UI, a)
}
// MarshalJSON marshals this flow into JSON
func (f *flow) MarshalJSON() ([]byte, error) {
e := &flowEnvelope{
Header13: migrations.Header13{
UUID: f.uuid,
Name: f.name,
SpecVersion: f.specVersion,
},
Language: f.language,
Type: f.flowType,
Revision: f.revision,
ExpireAfterMinutes: f.expireAfterMinutes,
Localization: f.localization.(localization),
Nodes: make([]*node, len(f.nodes)),
UI: f.ui,
}
for i := range f.nodes {
e.Nodes[i] = f.nodes[i].(*node)
}
return jsonx.Marshal(e)
}