-
Notifications
You must be signed in to change notification settings - Fork 147
/
controller.go
404 lines (360 loc) · 12.8 KB
/
controller.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
package controller
import (
"context"
"encoding/json"
"fmt"
"reflect"
"runtime/debug"
"time"
log "github.com/sirupsen/logrus"
v1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
"k8s.io/apimachinery/pkg/types"
runtimeutil "k8s.io/apimachinery/pkg/util/runtime"
"k8s.io/apimachinery/pkg/util/wait"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/tools/cache"
"k8s.io/client-go/util/workqueue"
"github.com/argoproj/notifications-engine/pkg/api"
"github.com/argoproj/notifications-engine/pkg/services"
"github.com/argoproj/notifications-engine/pkg/subscriptions"
)
// NotificationDelivery represents a notification that was delivered
type NotificationDelivery struct {
// Trigger is the trigger of the notification delivery
Trigger string
// Destination is the destination of the notification delivery
Destination services.Destination
// AlreadyNotified indicates that this notification was already delivered in a previous iteration
AlreadyNotified bool
}
// NotificationEventSequence represents a sequence of events that occurred while
// processing an object for notifications
type NotificationEventSequence struct {
// Key is the resource key. Format is the namespaced name
Key string
// Resource is the resource that was being processed when the event occurred
Resource v1.Object
// Delivered is a list of notifications that were delivered
Delivered []NotificationDelivery
// Errors is a list of errors that occurred during the processing iteration
Errors []error
// Warnings is a list of warnings that occurred during the processing iteration
Warnings []error
}
func (s *NotificationEventSequence) addDelivered(event NotificationDelivery) {
s.Delivered = append(s.Delivered, event)
}
func (s *NotificationEventSequence) addError(err error) {
s.Errors = append(s.Errors, err)
}
func (s *NotificationEventSequence) addWarning(warn error) {
s.Warnings = append(s.Warnings, warn)
}
type NotificationController interface {
Run(threadiness int, stopCh <-chan struct{})
}
type Opts func(ctrl *notificationController)
func WithToUnstructured(f func(obj v1.Object) (*unstructured.Unstructured, error)) Opts {
return func(ctrl *notificationController) {
ctrl.toUnstructured = f
}
}
func WithMetricsRegistry(r *MetricsRegistry) Opts {
return func(ctrl *notificationController) {
ctrl.metricsRegistry = r
}
}
func WithAlterDestinations(f func(obj v1.Object, destinations services.Destinations, cfg api.Config) services.Destinations) Opts {
return func(ctrl *notificationController) {
ctrl.alterDestinations = f
}
}
func WithSkipProcessing(f func(obj v1.Object) (bool, string)) Opts {
return func(ctrl *notificationController) {
ctrl.skipProcessing = f
}
}
// WithEventCallback registers a callback to invoke when an object has been
// processed for notifications.
func WithEventCallback(f func(eventSequence NotificationEventSequence)) Opts {
return func(ctrl *notificationController) {
ctrl.eventCallback = f
}
}
func NewController(
client dynamic.NamespaceableResourceInterface,
informer cache.SharedIndexInformer,
apiFactory api.Factory,
opts ...Opts,
) *notificationController {
queue := workqueue.NewRateLimitingQueue(workqueue.DefaultControllerRateLimiter())
informer.AddEventHandler(
cache.ResourceEventHandlerFuncs{
AddFunc: func(obj interface{}) {
key, err := cache.MetaNamespaceKeyFunc(obj)
if err == nil {
queue.Add(key)
}
},
UpdateFunc: func(old, new interface{}) {
key, err := cache.MetaNamespaceKeyFunc(new)
if err == nil {
queue.Add(key)
}
},
},
)
ctrl := ¬ificationController{
client: client,
informer: informer,
queue: queue,
metricsRegistry: NewMetricsRegistry(""),
apiFactory: apiFactory,
toUnstructured: func(obj v1.Object) (*unstructured.Unstructured, error) {
res, ok := obj.(*unstructured.Unstructured)
if !ok {
return nil, fmt.Errorf("Object must be *unstructured.Unstructured but was: %v", res)
}
return res, nil
},
}
for i := range opts {
opts[i](ctrl)
}
return ctrl
}
// NewControllerWithNamespaceSupport For self-service notification
func NewControllerWithNamespaceSupport(
client dynamic.NamespaceableResourceInterface,
informer cache.SharedIndexInformer,
apiFactory api.Factory,
opts ...Opts,
) *notificationController {
ctrl := NewController(client, informer, apiFactory, opts...)
ctrl.namespaceSupport = true
return ctrl
}
type notificationController struct {
client dynamic.NamespaceableResourceInterface
informer cache.SharedIndexInformer
queue workqueue.RateLimitingInterface
apiFactory api.Factory
metricsRegistry *MetricsRegistry
skipProcessing func(obj v1.Object) (bool, string)
alterDestinations func(obj v1.Object, destinations services.Destinations, cfg api.Config) services.Destinations
toUnstructured func(obj v1.Object) (*unstructured.Unstructured, error)
eventCallback func(eventSequence NotificationEventSequence)
namespaceSupport bool
}
func (c *notificationController) Run(threadiness int, stopCh <-chan struct{}) {
defer runtimeutil.HandleCrash()
defer c.queue.ShutDown()
log.Warn("Controller is running.")
for i := 0; i < threadiness; i++ {
go wait.Until(func() {
for c.processQueueItem() {
}
}, time.Second, stopCh)
}
<-stopCh
log.Warn("Controller has stopped.")
}
// check if an api is a self-service API
func (c *notificationController) isSelfServiceConfigureApi(api api.API) bool {
return c.namespaceSupport && api.GetConfig().IsSelfServiceConfig
}
func (c *notificationController) processResourceWithAPI(api api.API, resource v1.Object, logEntry *log.Entry, eventSequence *NotificationEventSequence) (map[string]string, error) {
apiNamespace := api.GetConfig().Namespace
notificationsState := NewStateFromRes(resource)
destinations := c.getDestinations(resource, api.GetConfig())
if len(destinations) == 0 {
return resource.GetAnnotations(), nil
}
un, err := c.toUnstructured(resource)
if err != nil {
return nil, err
}
for trigger, destinations := range destinations {
res, err := api.RunTrigger(trigger, un.Object)
if err != nil {
logEntry.Debugf("Failed to execute condition of trigger %s: %v using the configuration in namespace %s", trigger, err, apiNamespace)
eventSequence.addWarning(fmt.Errorf("failed to execute condition of trigger %s: %v using the configuration in namespace %s", trigger, err, apiNamespace))
}
logEntry.Infof("Trigger %s result: %v", trigger, res)
for _, cr := range res {
c.metricsRegistry.IncTriggerEvaluationsCounter(trigger, cr.Triggered)
if !cr.Triggered {
for _, to := range destinations {
notificationsState.SetAlreadyNotified(c.isSelfServiceConfigureApi(api), apiNamespace, trigger, cr, to, false)
}
continue
}
for _, to := range destinations {
if changed := notificationsState.SetAlreadyNotified(c.isSelfServiceConfigureApi(api), apiNamespace, trigger, cr, to, true); !changed {
logEntry.Infof("Notification about condition '%s.%s' already sent to '%v' using the configuration in namespace %s", trigger, cr.Key, to, apiNamespace)
eventSequence.addDelivered(NotificationDelivery{
Trigger: trigger,
Destination: to,
AlreadyNotified: true,
})
} else {
logEntry.Infof("Sending notification about condition '%s.%s' to '%v' using the configuration in namespace %s", trigger, cr.Key, to, apiNamespace)
if err := api.Send(un.Object, cr.Templates, to); err != nil {
logEntry.Errorf("Failed to notify recipient %s defined in resource %s/%s: %v using the configuration in namespace %s",
to, resource.GetNamespace(), resource.GetName(), err, apiNamespace)
notificationsState.SetAlreadyNotified(c.isSelfServiceConfigureApi(api), apiNamespace, trigger, cr, to, false)
c.metricsRegistry.IncDeliveriesCounter(trigger, to.Service, false)
eventSequence.addError(fmt.Errorf("failed to deliver notification %s to %s: %v using the configuration in namespace %s", trigger, to, err, apiNamespace))
} else {
logEntry.Debugf("Notification %s was sent using the configuration in namespace %s", to.Recipient, apiNamespace)
c.metricsRegistry.IncDeliveriesCounter(trigger, to.Service, true)
eventSequence.addDelivered(NotificationDelivery{
Trigger: trigger,
Destination: to,
AlreadyNotified: false,
})
}
}
}
}
}
return notificationsState.Persist(resource)
}
func (c *notificationController) getDestinations(resource v1.Object, cfg api.Config) services.Destinations {
res := cfg.GetGlobalDestinations(resource.GetLabels())
res.Merge(subscriptions.NewAnnotations(resource.GetAnnotations()).GetDestinations(cfg.DefaultTriggers, cfg.ServiceDefaultTriggers))
if c.alterDestinations != nil {
res = c.alterDestinations(resource, res, cfg)
}
return res.Dedup()
}
func (c *notificationController) processQueueItem() (processNext bool) {
key, shutdown := c.queue.Get()
if shutdown {
processNext = false
return
}
processNext = true
defer func() {
if r := recover(); r != nil {
log.Errorf("Recovered from panic: %+v\n%s", r, debug.Stack())
}
c.queue.Done(key)
}()
eventSequence := NotificationEventSequence{Key: key.(string)}
defer func() {
if c.eventCallback != nil {
c.eventCallback(eventSequence)
}
}()
obj, exists, err := c.informer.GetIndexer().GetByKey(key.(string))
if err != nil {
log.Errorf("Failed to get resource '%s' from informer index: %+v", key, err)
eventSequence.addError(err)
return
}
if !exists {
// This happens after resource was deleted, but the work queue still had an entry for it.
return
}
resource, ok := obj.(v1.Object)
if !ok {
log.Errorf("Failed to get resource '%s' from informer index: %+v", key, err)
eventSequence.addError(err)
return
}
eventSequence.Resource = resource
logEntry := log.WithField("resource", key)
logEntry.Info("Start processing")
if c.skipProcessing != nil {
if skipProcessing, reason := c.skipProcessing(resource); skipProcessing {
logEntry.Infof("Processing skipped: %s", reason)
return
}
}
if !c.namespaceSupport {
api, err := c.apiFactory.GetAPI()
if err != nil {
logEntry.Errorf("Failed to get api: %v", err)
eventSequence.addError(err)
return
}
c.processResource(api, resource, logEntry, &eventSequence)
} else {
apisWithNamespace, err := c.apiFactory.GetAPIsFromNamespace(resource.GetNamespace())
if err != nil {
logEntry.Errorf("Failed to get api with namespace: %v", err)
eventSequence.addError(err)
}
for _, api := range apisWithNamespace {
c.processResource(api, resource, logEntry, &eventSequence)
//refresh
obj, exists, err := c.informer.GetIndexer().GetByKey(key.(string))
if err != nil {
log.Errorf("Failed to get resource '%s' from informer index: %+v", key, err)
eventSequence.addError(err)
return
}
if !exists {
// This happens after resource was deleted, but the work queue still had an entry for it.
return
}
resource, ok = obj.(v1.Object)
if !ok {
log.Errorf("Failed to get resource '%s' from informer index: %+v", key, err)
eventSequence.addError(err)
return
}
}
}
logEntry.Info("Processing completed")
return
}
func (c *notificationController) processResource(api api.API, resource v1.Object, logEntry *log.Entry, eventSequence *NotificationEventSequence) {
annotations, err := c.processResourceWithAPI(api, resource, logEntry, eventSequence)
if err != nil {
logEntry.Errorf("Failed to process: %v", err)
eventSequence.addError(err)
return
}
if !mapsEqual(resource.GetAnnotations(), annotations) {
annotationsPatch := make(map[string]interface{})
for k, v := range annotations {
annotationsPatch[k] = v
}
for k := range resource.GetAnnotations() {
if _, ok := annotations[k]; !ok {
annotationsPatch[k] = nil
}
}
patchData, err := json.Marshal(map[string]map[string]interface{}{
"metadata": {"annotations": annotationsPatch},
})
if err != nil {
logEntry.Errorf("Failed to marshal resource patch: %v", err)
eventSequence.addWarning(fmt.Errorf("failed to marshal annotations patch %v", err))
return
}
resource, err = c.client.Namespace(resource.GetNamespace()).Patch(context.Background(), resource.GetName(), types.MergePatchType, patchData, v1.PatchOptions{})
if err != nil {
logEntry.Errorf("Failed to patch resource: %v", err)
eventSequence.addWarning(fmt.Errorf("failed to patch resource annotations %v", err))
return
}
if err := c.informer.GetStore().Update(resource); err != nil {
logEntry.Warnf("Failed to store update resource in informer: %v", err)
eventSequence.addWarning(fmt.Errorf("failed to store update resource in informer: %v", err))
return
}
}
}
func mapsEqual(first, second map[string]string) bool {
if first == nil {
first = map[string]string{}
}
if second == nil {
second = map[string]string{}
}
return reflect.DeepEqual(first, second)
}