github.com/argoproj/argo-events@v1.9.1/eventsources/sources/resource/start.go

/*
Copyright 2018 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 resource

import (
	"context"
	"encoding/json"
	"fmt"
	"os"
	"regexp"
	"strings"
	"time"

	"github.com/tidwall/gjson"
	"go.uber.org/zap"
	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
	"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
	"k8s.io/apimachinery/pkg/labels"
	"k8s.io/apimachinery/pkg/runtime/schema"
	"k8s.io/apimachinery/pkg/selection"
	"k8s.io/client-go/dynamic"
	"k8s.io/client-go/dynamic/dynamicinformer"
	"k8s.io/client-go/tools/cache"

	"github.com/argoproj/argo-events/common"
	"github.com/argoproj/argo-events/common/logging"
	eventsourcecommon "github.com/argoproj/argo-events/eventsources/common"
	"github.com/argoproj/argo-events/eventsources/sources"
	metrics "github.com/argoproj/argo-events/metrics"
	apicommon "github.com/argoproj/argo-events/pkg/apis/common"
	"github.com/argoproj/argo-events/pkg/apis/events"
	"github.com/argoproj/argo-events/pkg/apis/eventsource/v1alpha1"
)

// InformerEvent holds event generated from resource state change
type InformerEvent struct {
	Obj    interface{}
	OldObj interface{}
	Type   v1alpha1.ResourceEventType
}

// EventListener implements Eventing
type EventListener struct {
	EventSourceName     string
	EventName           string
	ResourceEventSource v1alpha1.ResourceEventSource
	Metrics             *metrics.Metrics
}

// GetEventSourceName returns name of event source
func (el *EventListener) GetEventSourceName() string {
	return el.EventSourceName
}

// GetEventName returns name of event
func (el *EventListener) GetEventName() string {
	return el.EventName
}

// GetEventSourceType return type of event server
func (el *EventListener) GetEventSourceType() apicommon.EventSourceType {
	return apicommon.ResourceEvent
}

// StartListening watches resource updates and consume those events
func (el *EventListener) StartListening(ctx context.Context, dispatch func([]byte, ...eventsourcecommon.Option) error) error {
	log := logging.FromContext(ctx).
		With(logging.LabelEventSourceType, el.GetEventSourceType(), logging.LabelEventName, el.GetEventName())
	defer sources.Recover(el.GetEventName())

	log.Info("setting up a K8s client")
	kubeConfig, _ := os.LookupEnv(common.EnvVarKubeConfig)
	restConfig, err := common.GetClientConfig(kubeConfig)
	if err != nil {
		return fmt.Errorf("failed to get a K8s rest config for the event source %s, %w", el.GetEventName(), err)
	}
	client, err := dynamic.NewForConfig(restConfig)
	if err != nil {
		return fmt.Errorf("failed to set up a dynamic K8s client for the event source %s, %w", el.GetEventName(), err)
	}

	resourceEventSource := &el.ResourceEventSource

	gvr := schema.GroupVersionResource{
		Group:    resourceEventSource.Group,
		Version:  resourceEventSource.Version,
		Resource: resourceEventSource.Resource,
	}

	client.Resource(gvr)

	options := &metav1.ListOptions{}

	log.Info("configuring label selectors if filters are selected...")
	if resourceEventSource.Filter != nil && resourceEventSource.Filter.Labels != nil {
		sel, err := LabelSelector(resourceEventSource.Filter.Labels)
		if err != nil {
			return fmt.Errorf("failed to create the label selector for the event source %s, %w", el.GetEventName(), err)
		}
		options.LabelSelector = sel.String()
	}

	tweakListOptions := func(op *metav1.ListOptions) {
		*op = *options
	}

	log.Info("setting up informer factory...")
	factory := dynamicinformer.NewFilteredDynamicSharedInformerFactory(client, 0, resourceEventSource.Namespace, tweakListOptions)

	informer := factory.ForResource(gvr)

	informerEventCh := make(chan *InformerEvent)
	stopCh := make(chan struct{})
	startTime := time.Now()

	processOne := func(event *InformerEvent) error {
		if !passFilters(event, resourceEventSource.Filter, startTime, log) {
			return nil
		}

		defer func(start time.Time) {
			el.Metrics.EventProcessingDuration(el.GetEventSourceName(), el.GetEventName(), float64(time.Since(start)/time.Millisecond))
		}(time.Now())

		objBody, err := json.Marshal(event.Obj)
		if err != nil {
			return fmt.Errorf("failed to marshal the resource, rejecting the event, %w", err)
		}

		var oldObjBody []byte
		if event.OldObj != nil {
			oldObjBody, err = json.Marshal(event.OldObj)
			if err != nil {
				return fmt.Errorf("failed to marshal the resource, rejecting the event, %w", err)
			}
		}

		eventData := &events.ResourceEventData{
			EventType: string(event.Type),
			Body:      (*json.RawMessage)(&objBody),
			OldBody:   (*json.RawMessage)(&oldObjBody),
			Group:     resourceEventSource.Group,
			Version:   resourceEventSource.Version,
			Resource:  resourceEventSource.Resource,
			Metadata:  resourceEventSource.Metadata,
		}

		eventBody, err := json.Marshal(eventData)
		if err != nil {
			return fmt.Errorf("failed to marshal the event. rejecting the event, %w", err)
		}

		if err = dispatch(eventBody); err != nil {
			return fmt.Errorf("failed to dispatch a resource event, %w", err)
		}
		return nil
	}

	go func() {
		log.Info("listening to resource events...")
		for {
			select {
			case event := <-informerEventCh:
				if err := processOne(event); err != nil {
					log.Errorw("failed to process a Resource event", zap.Error(err))
					el.Metrics.EventProcessingFailed(el.GetEventSourceName(), el.GetEventName())
				}
			case <-stopCh:
				return
			}
		}
	}()

	handlerFuncs := cache.ResourceEventHandlerFuncs{}

	for _, eventType := range resourceEventSource.EventTypes {
		switch eventType {
		case v1alpha1.ADD:
			handlerFuncs.AddFunc = func(obj interface{}) {
				log.Info("detected create event")
				informerEventCh <- &InformerEvent{
					Obj:  obj,
					Type: v1alpha1.ADD,
				}
			}
		case v1alpha1.UPDATE:
			handlerFuncs.UpdateFunc = func(oldObj, newObj interface{}) {
				log.Info("detected update event")
				uNewObj := newObj.(*unstructured.Unstructured)
				uOldObj := oldObj.(*unstructured.Unstructured)
				if uNewObj.GetResourceVersion() == uOldObj.GetResourceVersion() {
					log.Infof("rejecting update event with identical resource versions: %s", uNewObj.GetResourceVersion())
					return
				}
				informerEventCh <- &InformerEvent{
					Obj:    newObj,
					OldObj: oldObj,
					Type:   v1alpha1.UPDATE,
				}
			}
		case v1alpha1.DELETE:
			handlerFuncs.DeleteFunc = func(obj interface{}) {
				log.Info("detected delete event")
				informerEventCh <- &InformerEvent{
					Obj:  obj,
					Type: v1alpha1.DELETE,
				}
			}
		default:
			stopCh <- struct{}{}
			return fmt.Errorf("unknown event type: %s", string(eventType))
		}
	}

	sharedInformer := informer.Informer()
	sharedInformer.AddEventHandler(handlerFuncs)

	doneCh := make(chan struct{})

	log.Info("running informer...")
	sharedInformer.Run(doneCh)

	<-ctx.Done()
	doneCh <- struct{}{}
	stopCh <- struct{}{}

	log.Info("event source is stopped")
	close(informerEventCh)

	return nil
}

// LabelReq returns label requirements
func LabelReq(sel v1alpha1.Selector) (*labels.Requirement, error) {
	op := selection.Equals
	if sel.Operation != "" {
		op = selection.Operator(sel.Operation)
	}
	var values []string
	switch {
	case (op == selection.Exists || op == selection.DoesNotExist) && sel.Value == "":
		values = []string{}
	case op == selection.In || op == selection.NotIn:
		values = strings.Split(sel.Value, ",")
	default:
		values = []string{sel.Value}
	}
	req, err := labels.NewRequirement(sel.Key, op, values)
	if err != nil {
		return nil, err
	}
	return req, nil
}

// LabelSelector returns label selector for resource filtering
func LabelSelector(selectors []v1alpha1.Selector) (labels.Selector, error) {
	var labelRequirements []labels.Requirement
	for _, sel := range selectors {
		req, err := LabelReq(sel)
		if err != nil {
			return nil, err
		}
		labelRequirements = append(labelRequirements, *req)
	}
	return labels.NewSelector().Add(labelRequirements...), nil
}

// helper method to check if the object passed the user defined filters
func passFilters(event *InformerEvent, filter *v1alpha1.ResourceFilter, startTime time.Time, log *zap.SugaredLogger) bool {
	// no filters are applied.
	if filter == nil {
		return true
	}
	uObj := event.Obj.(*unstructured.Unstructured)
	if len(filter.Prefix) > 0 && !strings.HasPrefix(uObj.GetName(), filter.Prefix) {
		log.Infof("resource name does not match prefix. resource-name: %s, prefix: %s\n", uObj.GetName(), filter.Prefix)
		return false
	}
	eventTime := getEventTime(uObj, event.Type)
	if filter.AfterStart && eventTime.UTC().Before(startTime.UTC()) {
		log.Infof("Event happened before service start time. event-timestamp: %s, start-timestamp: %s\n", eventTime.UTC().String(), startTime.UTC().String())
		return false
	}
	created := uObj.GetCreationTimestamp()
	if !filter.CreatedBy.IsZero() && created.UTC().After(filter.CreatedBy.UTC()) {
		log.Infof("resource is created after filter time. creation-timestamp: %s, filter-creation-timestamp: %s\n", created.UTC().String(), filter.CreatedBy.UTC().String())
		return false
	}
	if len(filter.Fields) > 0 {
		jsData, err := uObj.MarshalJSON()
		if err != nil {
			log.Errorw("failed to marshal informer event", zap.Error(err))
			return false
		}

		return filterFields(jsData, filter.Fields, log)
	}
	return true
}

func filterFields(jsonData []byte, selectors []v1alpha1.Selector, log *zap.SugaredLogger) bool {
	for _, selector := range selectors {
		res := gjson.GetBytes(jsonData, selector.Key)
		if !res.Exists() {
			return false
		}
		exp, err := regexp.Compile(selector.Value)
		if err != nil {
			log.Errorw("invalid regex", zap.Error(err))
			return false
		}
		match := exp.Match([]byte(res.Str))

		switch selection.Operator(selector.Operation) {
		case selection.Equals, selection.DoubleEquals:
			if !match {
				return false
			}
		case selection.NotEquals:
			if match {
				return false
			}
		default:
			log.Errorf("invalid operator, only %v, %v and %v are supported", selection.Equals, selection.DoubleEquals, selection.NotEquals)
			return false
		}
	}
	return true
}

func getEventTime(obj *unstructured.Unstructured, eventType v1alpha1.ResourceEventType) metav1.Time {
	switch eventType {
	case v1alpha1.ADD:
		return obj.GetCreationTimestamp()
	case v1alpha1.DELETE:
		if obj.GetDeletionTimestamp() != nil {
			return *obj.GetDeletionTimestamp()
		} else {
			return metav1.Now()
		}
	case v1alpha1.UPDATE:
		t := obj.GetCreationTimestamp()
		for _, f := range obj.GetManagedFields() {
			if f.Operation == metav1.ManagedFieldsOperationUpdate && f.Time.UTC().After(t.UTC()) {
				t = *f.Time
			}
		}
		return t
	default:
		return obj.GetCreationTimestamp()
	}
}