-
Notifications
You must be signed in to change notification settings - Fork 329
/
events.go
298 lines (239 loc) · 6.59 KB
/
events.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
package codegen
import (
"fmt"
"os"
"path"
"strings"
"text/template"
"github.com/cortezaproject/corteza/server/pkg/slice"
"gopkg.in/yaml.v3"
)
type (
// definitions are in one file
eventsDef struct {
Package string
App string
Source string
outputDir string
// List of imports
// Used only by generated file and not pre-generated-user-file
Imports []string
Resources evResourceDefMap
}
evResourceDefMap map[string]*evResourceDef
evResourceDef struct {
// used as string
ResourceString string
// used as (go) ident
ResourceIdent string
// used for filename
ResourceFile string
On []string `yaml:"on"`
BeforeAfter []string `yaml:"ba"`
Properties []*eventProps `yaml:"props"`
Constraints []*eventConstraint `yaml:"constraints"`
Result string `yaml:"result"`
}
eventProps struct {
Name string
Type string
ExprType string
// Import path for prop type, use package's type by default (see importTypePathTpl)
Import string
// Set property internally only, not via constructor
Internal bool
// Do not allow change of the variable through
Immutable bool
}
eventConstraint struct {
Name string
}
)
func procEvents(mm ...string) (dd []*eventsDef, err error) {
// <app>/service/event/events.yaml
const (
importTypePathTpl = "github.com/cortezaproject/corteza/server/%s/types"
importAutoPathTpl = "github.com/cortezaproject/corteza/server/%s/automation"
importAuthPath = "github.com/cortezaproject/corteza/server/pkg/auth"
)
dd = make([]*eventsDef, 0)
for _, m := range mm {
f, err := os.Open(m)
if err != nil {
return nil, fmt.Errorf("%s read failed: %w", m, err)
}
defer f.Close()
var (
e = evResourceDefMap{}
d = &eventsDef{
Package: "event",
Source: m,
App: m[:strings.Index(m, "/")],
outputDir: path.Dir(m),
Resources: map[string]*evResourceDef{},
}
)
if err := yaml.NewDecoder(f).Decode(e); err != nil {
return nil, err
}
for resName, evDef := range e {
d.Imports = []string{
fmt.Sprintf(importTypePathTpl, d.App),
}
if d.App != "messaging" {
d.Imports = append(d.Imports, fmt.Sprintf(importAutoPathTpl, d.App))
}
evDef.ResourceString = resName
if l := strings.Index(resName, ":"); l > 0 {
evDef.ResourceIdent = resName[l+1:]
} else {
evDef.ResourceIdent = resName
}
// make filename
evDef.ResourceFile = strings.ReplaceAll(evDef.ResourceIdent, ":", "_")
evDef.ResourceFile = strings.ReplaceAll(evDef.ResourceFile, "-", "_")
// make identifier (string that will be used for struct name)
evDef.ResourceIdent = camelCase(strings.Split(evDef.ResourceFile, "_")...)
// Prepare the data
// no default ("result") result set, use first one from properties
if evDef.Result == "" && len(evDef.Properties) > 0 {
evDef.Result = evDef.Properties[0].Name
}
// Invoker - user that invoked (triggered) the event
evDef.Properties = append(evDef.Properties, &eventProps{
Name: "invoker",
Type: "auth.Identifiable",
Import: importAuthPath,
Immutable: false,
Internal: true,
})
// Ensure all imports are checked
for _, p := range evDef.Properties {
if p.Import == "" {
if strings.HasPrefix(p.Type, "*types.") || strings.HasPrefix(p.Type, "types.") {
p.Import = fmt.Sprintf(importTypePathTpl, d.App)
}
}
if p.Import != "" && !slice.HasString(d.Imports, p.Import) {
d.Imports = append(d.Imports, p.Import)
}
p.Import = ""
}
d.Resources[resName] = evDef
}
dd = append(dd, d)
}
return dd, nil
}
func expandEventTypes(ee []*eventsDef, tt []*exprTypesDef) {
// index of all known types
expTypes := make(map[string]*exprTypeDef)
goTypes := make(map[string]string)
for _, t := range tt {
for typ, d := range t.Types {
expTypes[typ] = d
goTypes[d.As] = typ
}
}
for _, e := range ee {
for _, r := range e.Resources {
for _, p := range r.Properties {
if p.ExprType != "" && expTypes[p.ExprType] == nil {
fmt.Printf("unknown type %q used for param %q for events on resource %s\n", p.ExprType, p.Name, r.ResourceString)
}
if p.ExprType == "" && goTypes[p.Type] != "" {
p.ExprType = goTypes[p.Type]
}
}
}
}
}
func genEvents(tpl *template.Template, dd ...*eventsDef) (err error) {
var (
// Will only be generated if file does not exist previously
tplEvents = tpl.Lookup("events.go.tpl")
// Always regenerated
tplEventsGen = tpl.Lookup("events.gen.go.tpl")
// List of event-type definitions for automation REST endpoint
tplAutomationRestDefGen = tpl.Lookup("events_rest_def.gen.go.tpl")
dst string
)
for _, d := range dd {
// Generic code, all events go into one file (per app)
err = goTemplate(path.Join(d.outputDir, "events.gen.go"), tplEventsGen, d)
if err != nil {
return
}
for _, r := range d.Resources {
dst = path.Join(d.outputDir, r.ResourceFile+".go")
_, err = os.Stat(dst)
if os.IsNotExist(err) {
err = goTemplate(dst, tplEvents, map[string]interface{}{
"Package": d.Package,
"ResourceIdent": r.ResourceIdent,
})
}
if err != nil {
return
}
}
}
// Remove messaging
var msgIndex = -1
for i := range dd {
if dd[i].App == "messaging" {
msgIndex = i
}
}
if msgIndex > -1 {
dd = append(dd[:msgIndex], dd[msgIndex+1:]...)
}
err = goTemplate(
path.Join("automation", "rest", "eventTypes.gen.go"),
tplAutomationRestDefGen,
map[string]interface{}{
"Definitions": dd,
"Imports": collectEventDefImports("", dd...),
})
if err != nil {
return
}
return nil
}
// Merge on/before/after events
func (def evResourceDef) Events() []string {
return append(
makeEventGroup("on", def.On),
append(
makeEventGroup("before", def.BeforeAfter),
makeEventGroup("after", def.BeforeAfter)...,
)...,
)
}
func makeEventGroup(pfix string, ee []string) (out []string) {
for _, e := range ee {
out = append(out, pfix+strings.ToUpper(e[:1])+e[1:])
}
return
}
func genEventsDocs(tpl *template.Template, docsPath string, dd ...*eventsDef) (err error) {
var (
tplEventsAdoc = tpl.Lookup("events.gen.adoc.tpl")
dst string
)
dst = path.Join(docsPath, "resource-events.gen.adoc")
return plainTemplate(dst, tplEventsAdoc, map[string]interface{}{
"Definitions": dd,
})
}
func collectEventDefImports(basePkg string, dd ...*eventsDef) []string {
ii := make([]string, 0, len(dd))
for _, d := range dd {
for _, i := range d.Imports {
if !slice.HasString(ii, i) && (basePkg == "" || !strings.HasSuffix(i, basePkg)) {
ii = append(ii, i)
}
}
}
return ii
}