/
listener.go
503 lines (453 loc) · 16.6 KB
/
listener.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
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
/*
Copyright 2020 BlackRock, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/
package sensors
import (
"context"
"fmt"
"strings"
"sync"
"sync/atomic"
"time"
"github.com/Knetic/govaluate"
"github.com/antonmedv/expr"
"github.com/argoproj/argo-events/common"
"github.com/argoproj/argo-events/common/leaderelection"
"github.com/argoproj/argo-events/common/logging"
"github.com/argoproj/argo-events/eventbus"
eventbuscommon "github.com/argoproj/argo-events/eventbus/common"
apicommon "github.com/argoproj/argo-events/pkg/apis/common"
"github.com/argoproj/argo-events/pkg/apis/sensor/v1alpha1"
sensordependencies "github.com/argoproj/argo-events/sensors/dependencies"
sensortriggers "github.com/argoproj/argo-events/sensors/triggers"
cloudevents "github.com/cloudevents/sdk-go/v2"
"github.com/pkg/errors"
cronlib "github.com/robfig/cron/v3"
"go.uber.org/ratelimit"
"go.uber.org/zap"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)
var rateLimiters = make(map[string]ratelimit.Limiter)
func subscribeOnce(subLock *uint32, subscribe func()) {
// acquire subLock if not already held
if !atomic.CompareAndSwapUint32(subLock, 0, 1) {
return
}
subscribe()
}
func (sensorCtx *SensorContext) Start(ctx context.Context) error {
log := logging.FromContext(ctx)
custerName := fmt.Sprintf("%s-sensor-%s", sensorCtx.sensor.Namespace, sensorCtx.sensor.Name)
elector, err := leaderelection.NewEventBusElector(ctx, *sensorCtx.eventBusConfig, custerName, int(sensorCtx.sensor.Spec.GetReplicas()))
if err != nil {
log.Errorw("failed to get an elector", zap.Error(err))
return err
}
elector.RunOrDie(ctx, leaderelection.LeaderCallbacks{
OnStartedLeading: func(ctx context.Context) {
if err := sensorCtx.listenEvents(ctx); err != nil {
log.Fatalw("failed to start", zap.Error(err))
}
},
OnStoppedLeading: func() {
log.Fatalf("leader lost: %s", sensorCtx.hostname)
},
})
return nil
}
func initRateLimiter(trigger v1alpha1.Trigger) {
duration := time.Second
if trigger.RateLimit != nil {
switch trigger.RateLimit.Unit {
case v1alpha1.Minute:
duration = time.Minute
case v1alpha1.Hour:
duration = time.Hour
}
rateLimiters[trigger.Template.Name] = ratelimit.New(int(trigger.RateLimit.RequestsPerUnit), ratelimit.Per(duration))
} else {
rateLimiters[trigger.Template.Name] = ratelimit.NewUnlimited()
}
}
// listenEvents watches and handles events received from the gateway.
func (sensorCtx *SensorContext) listenEvents(ctx context.Context) error {
logger := logging.FromContext(ctx)
sensor := sensorCtx.sensor
depMapping := make(map[string]v1alpha1.EventDependency)
for _, d := range sensor.Spec.Dependencies {
depMapping[d.Name] = d
}
ctx, cancel := context.WithCancel(ctx)
defer cancel()
ebDriver, err := eventbus.GetSensorDriver(logging.WithLogger(ctx, logger), *sensorCtx.eventBusConfig, sensorCtx.sensor)
if err != nil {
return err
}
err = common.Connect(&common.DefaultBackoff, func() error {
return ebDriver.Initialize()
})
if err != nil {
return err
}
wg := &sync.WaitGroup{}
for _, t := range sensor.Spec.Triggers {
initRateLimiter(t)
wg.Add(1)
go func(trigger v1alpha1.Trigger) {
triggerLogger := logger.With(logging.LabelTriggerName, trigger.Template.Name)
defer wg.Done()
depExpression, err := sensorCtx.getDependencyExpression(ctx, trigger)
if err != nil {
triggerLogger.Errorw("failed to get dependency expression", zap.Error(err))
return
}
// Calculate dependencies of each of the triggers.
de := strings.ReplaceAll(depExpression, "-", "\\-")
expr, err := govaluate.NewEvaluableExpression(de)
if err != nil {
triggerLogger.Errorw("failed to get new evaluable expression", zap.Error(err))
return
}
depNames := unique(expr.Vars())
deps := []eventbuscommon.Dependency{}
for _, depName := range depNames {
dep, ok := depMapping[depName]
if !ok {
triggerLogger.Errorf("Dependency expression and dependency list do not match, %s is not found", depName)
return
}
d := eventbuscommon.Dependency{
Name: dep.Name,
EventSourceName: dep.EventSourceName,
EventName: dep.EventName,
}
deps = append(deps, d)
}
var conn eventbuscommon.TriggerConnection
err = common.Connect(&common.DefaultBackoff, func() error {
var err error
conn, err = ebDriver.Connect(trigger.Template.Name, depExpression, deps)
triggerLogger.Debugf("just created connection %v, %+v", &conn, conn)
return err
})
if err != nil {
triggerLogger.Fatalw("failed to connect to event bus", zap.Error(err))
return
}
defer conn.Close()
transformFunc := func(depName string, event cloudevents.Event) (*cloudevents.Event, error) {
dep, ok := depMapping[depName]
if !ok {
return nil, fmt.Errorf("dependency %s not found", dep.Name)
}
if dep.Transform == nil {
return &event, nil
}
return sensordependencies.ApplyTransform(&event, dep.Transform)
}
filterFunc := func(depName string, cloudEvent cloudevents.Event) bool {
dep, ok := depMapping[depName]
if !ok {
return false
}
if dep.Filters == nil {
return true
}
argoEvent := convertEvent(cloudEvent)
result, err := sensordependencies.Filter(argoEvent, dep.Filters, dep.FiltersLogicalOperator)
if err != nil {
if !result {
triggerLogger.Warnf("Event [%s] discarded due to filtering error: %s",
eventToString(argoEvent), err.Error())
} else {
triggerLogger.Warnf("Event [%s] passed but with filtering error: %s",
eventToString(argoEvent), err.Error())
}
} else {
if !result {
triggerLogger.Warnf("Event [%s] discarded due to filtering", eventToString(argoEvent))
}
}
return result
}
actionFunc := func(events map[string]cloudevents.Event) {
if err := sensorCtx.triggerActions(ctx, sensor, events, trigger); err != nil {
triggerLogger.Errorw("failed to trigger actions", zap.Error(err))
}
}
var subLock uint32
wg1 := &sync.WaitGroup{}
closeSubCh := make(chan struct{})
resetConditionsCh := make(chan struct{})
var lastResetTime time.Time
if len(trigger.Template.ConditionsReset) > 0 {
for _, c := range trigger.Template.ConditionsReset {
if c.ByTime == nil {
continue
}
cronParser := cronlib.NewParser(cronlib.Minute | cronlib.Hour | cronlib.Dom | cronlib.Month | cronlib.Dow)
opts := []cronlib.Option{
cronlib.WithParser(cronParser),
cronlib.WithChain(cronlib.Recover(cronlib.DefaultLogger)),
}
nowTime := time.Now()
if c.ByTime.Timezone != "" {
location, err := time.LoadLocation(c.ByTime.Timezone)
if err != nil {
triggerLogger.Errorw("failed to load timezone", zap.Error(err))
continue
}
opts = append(opts, cronlib.WithLocation(location))
nowTime = nowTime.In(location)
}
cr := cronlib.New(opts...)
_, err = cr.AddFunc(c.ByTime.Cron, func() {
resetConditionsCh <- struct{}{}
})
if err != nil {
triggerLogger.Errorw("failed to add cron schedule", zap.Error(err))
continue
}
cr.Start()
triggerLogger.Debugf("just started cron job; entries=%v", cr.Entries())
// set lastResetTime (the last time this would've been triggered)
if len(cr.Entries()) > 0 {
prevTriggerTime, err := common.PrevCronTime(c.ByTime.Cron, cronParser, nowTime)
if err != nil {
triggerLogger.Errorw("couldn't get previous cron trigger time", zap.Error(err))
continue
}
triggerLogger.Infof("previous trigger time: %v", prevTriggerTime)
if prevTriggerTime.After(lastResetTime) {
lastResetTime = prevTriggerTime
}
}
}
}
subscribeFunc := func() {
wg1.Add(1)
go func() {
defer wg1.Done()
// release the lock when goroutine exits
defer atomic.StoreUint32(&subLock, 0)
triggerLogger.Infof("started subscribing to events for trigger %s with client connection %s", trigger.Template.Name, conn)
subject := &sensorCtx.eventBusSubject
err = conn.Subscribe(ctx, closeSubCh, resetConditionsCh, lastResetTime, transformFunc, filterFunc, actionFunc, subject)
if err != nil {
triggerLogger.Errorw("failed to subscribe to eventbus", zap.Any("connection", conn), zap.Error(err))
return
}
triggerLogger.Debugf("exiting subscribe goroutine, conn=%+v", conn)
}()
}
subscribeOnce(&subLock, subscribeFunc)
triggerLogger.Infof("starting eventbus connection daemon for client %s...", conn)
ticker := time.NewTicker(5 * time.Second)
defer ticker.Stop()
for {
select {
case <-ctx.Done():
triggerLogger.Infof("exiting eventbus connection daemon for client %s...", conn)
wg1.Wait()
return
case <-ticker.C:
if conn == nil || conn.IsClosed() {
triggerLogger.Info("NATS connection lost, reconnecting...")
conn, err = ebDriver.Connect(trigger.Template.Name, depExpression, deps)
if err != nil {
triggerLogger.Errorw("failed to reconnect to eventbus", zap.Any("connection", conn), zap.Error(err))
continue
}
triggerLogger.Infow("reconnected to NATS server.", zap.Any("connection", conn))
if atomic.LoadUint32(&subLock) == 1 {
triggerLogger.Debug("acquired sublock, instructing trigger to shutdown subscription")
closeSubCh <- struct{}{}
// give subscription time to close
time.Sleep(2 * time.Second)
} else {
triggerLogger.Debug("sublock not acquired")
}
}
// create subscription if conn is alive and no subscription is currently held
if conn != nil && !conn.IsClosed() {
subscribeOnce(&subLock, subscribeFunc)
}
}
}
}(t)
}
logger.Info("Sensor started.")
<-ctx.Done()
logger.Info("Shutting down...")
cancel()
wg.Wait()
return nil
}
func (sensorCtx *SensorContext) triggerActions(ctx context.Context, sensor *v1alpha1.Sensor, events map[string]cloudevents.Event, trigger v1alpha1.Trigger) error {
eventsMapping := make(map[string]*v1alpha1.Event)
depNames := make([]string, 0, len(events))
eventIDs := make([]string, 0, len(events))
for k, v := range events {
eventsMapping[k] = convertEvent(v)
depNames = append(depNames, k)
eventIDs = append(eventIDs, v.ID())
}
go sensorCtx.triggerWithRateLimit(ctx, sensor, trigger, eventsMapping, depNames, eventIDs)
return nil
}
func (sensorCtx *SensorContext) triggerWithRateLimit(ctx context.Context, sensor *v1alpha1.Sensor, trigger v1alpha1.Trigger, eventsMapping map[string]*v1alpha1.Event, depNames, eventIDs []string) {
if rl, ok := rateLimiters[trigger.Template.Name]; ok {
rl.Take()
}
log := logging.FromContext(ctx)
if err := sensorCtx.triggerOne(ctx, sensor, trigger, eventsMapping, depNames, eventIDs, log); err != nil {
// Log the error, and let it continue
log.Errorw("failed to execute a trigger", zap.Error(err), zap.String(logging.LabelTriggerName, trigger.Template.Name),
zap.Any("triggeredBy", depNames), zap.Any("triggeredByEvents", eventIDs))
sensorCtx.metrics.ActionFailed(sensor.Name, trigger.Template.Name)
} else {
sensorCtx.metrics.ActionTriggered(sensor.Name, trigger.Template.Name)
}
}
func (sensorCtx *SensorContext) triggerOne(ctx context.Context, sensor *v1alpha1.Sensor, trigger v1alpha1.Trigger, eventsMapping map[string]*v1alpha1.Event, depNames, eventIDs []string, log *zap.SugaredLogger) error {
defer func(start time.Time) {
sensorCtx.metrics.ActionDuration(sensor.Name, trigger.Template.Name, float64(time.Since(start)/time.Millisecond))
}(time.Now())
if err := sensortriggers.ApplyTemplateParameters(eventsMapping, &trigger); err != nil {
log.Errorf("failed to apply template parameters, %v", err)
return err
}
logger := log.With(logging.LabelTriggerName, trigger.Template.Name)
logger.Debugw("resolving the trigger implementation")
triggerImpl := sensorCtx.GetTrigger(ctx, &trigger)
if triggerImpl == nil {
return errors.Errorf("invalid trigger %s, could not find an implementation", trigger.Template.Name)
}
logger = logger.With(logging.LabelTriggerType, triggerImpl.GetTriggerType())
log.Debug("fetching trigger resource if any")
obj, err := triggerImpl.FetchResource(ctx)
if err != nil {
return err
}
if obj == nil {
return errors.Errorf("invalid trigger %s, could not fetch the trigger resource", trigger.Template.Name)
}
logger.Debug("applying resource parameters if any")
updatedObj, err := triggerImpl.ApplyResourceParameters(eventsMapping, obj)
if err != nil {
return err
}
logger.Debug("executing the trigger resource")
retryStrategy := trigger.RetryStrategy
if retryStrategy == nil {
retryStrategy = &apicommon.Backoff{Steps: 1}
}
var newObj interface{}
if err := common.Connect(retryStrategy, func() error {
var e error
newObj, e = triggerImpl.Execute(ctx, eventsMapping, updatedObj)
return e
}); err != nil {
return errors.Wrap(err, "failed to execute trigger")
}
logger.Debug("trigger resource successfully executed")
logger.Debug("applying trigger policy")
if err := triggerImpl.ApplyPolicy(ctx, newObj); err != nil {
return err
}
logger.Infow(fmt.Sprintf("successfully processed trigger '%s'", trigger.Template.Name),
zap.Any("triggeredBy", depNames), zap.Any("triggeredByEvents", eventIDs))
return nil
}
func (sensorCtx *SensorContext) getDependencyExpression(ctx context.Context, trigger v1alpha1.Trigger) (string, error) {
logger := logging.FromContext(ctx)
// Translate original expression which might contain group names
// to an expression only contains dependency names
translate := func(originalExpr string, parameters map[string]string) (string, error) {
originalExpr = strings.ReplaceAll(originalExpr, "&&", " + \"&&\" + ")
originalExpr = strings.ReplaceAll(originalExpr, "||", " + \"||\" + ")
originalExpr = strings.ReplaceAll(originalExpr, "-", "_")
originalExpr = strings.ReplaceAll(originalExpr, "(", "\"(\"+")
originalExpr = strings.ReplaceAll(originalExpr, ")", "+\")\"")
program, err := expr.Compile(originalExpr, expr.Env(parameters))
if err != nil {
logger.Errorw("Failed to compile original dependency expression", zap.Error(err))
return "", err
}
result, err := expr.Run(program, parameters)
if err != nil {
logger.Errorw("Failed to parse original dependency expression", zap.Error(err))
return "", err
}
newExpr := fmt.Sprintf("%v", result)
newExpr = strings.ReplaceAll(newExpr, "\"(\"", "(")
newExpr = strings.ReplaceAll(newExpr, "\")\"", ")")
return newExpr, nil
}
sensor := sensorCtx.sensor
var depExpression string
var err error
switch {
case trigger.Template.Conditions != "":
conditions := trigger.Template.Conditions
// Add all the dependency and dependency group to the parameter mappings
depGroupMapping := make(map[string]string)
for _, dep := range sensor.Spec.Dependencies {
key := strings.ReplaceAll(dep.Name, "-", "_")
depGroupMapping[key] = dep.Name
}
depExpression, err = translate(conditions, depGroupMapping)
if err != nil {
return "", err
}
default:
deps := []string{}
for _, dep := range sensor.Spec.Dependencies {
deps = append(deps, dep.Name)
}
depExpression = strings.Join(deps, "&&")
}
logger.Infof("Dependency expression for trigger %s: %s", trigger.Template.Name, depExpression)
return depExpression, nil
}
func eventToString(event *v1alpha1.Event) string {
return fmt.Sprintf("ID '%s', Source '%s', Time '%s', Data '%s'",
event.Context.ID, event.Context.Source, event.Context.Time.Time.Format(time.RFC3339), string(event.Data))
}
func convertEvent(event cloudevents.Event) *v1alpha1.Event {
return &v1alpha1.Event{
Context: &v1alpha1.EventContext{
DataContentType: event.Context.GetDataContentType(),
Source: event.Context.GetSource(),
SpecVersion: event.Context.GetSpecVersion(),
Type: event.Context.GetType(),
Time: metav1.Time{Time: event.Context.GetTime()},
ID: event.Context.GetID(),
Subject: event.Context.GetSubject(),
},
Data: event.Data(),
}
}
func unique(stringSlice []string) []string {
if len(stringSlice) == 0 {
return stringSlice
}
keys := make(map[string]bool)
list := []string{}
for _, entry := range stringSlice {
if _, value := keys[entry]; !value {
keys[entry] = true
list = append(list, entry)
}
}
return list
}