github.com/argoproj/argo-events@v1.9.1/sensors/triggers/custom-trigger/custom-trigger.go

/*
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 customtrigger

import (
	"context"
	"encoding/json"
	"fmt"

	"github.com/ghodss/yaml"
	"go.uber.org/zap"
	"google.golang.org/grpc"
	"google.golang.org/grpc/connectivity"
	"google.golang.org/grpc/credentials"
	"google.golang.org/grpc/credentials/insecure"
	"k8s.io/apimachinery/pkg/util/wait"

	"github.com/argoproj/argo-events/common"
	"github.com/argoproj/argo-events/common/logging"
	apicommon "github.com/argoproj/argo-events/pkg/apis/common"
	"github.com/argoproj/argo-events/pkg/apis/sensor/v1alpha1"
	"github.com/argoproj/argo-events/sensors/triggers"
)

// CustomTrigger implements Trigger interface for custom trigger resource
type CustomTrigger struct {
	// Sensor object
	Sensor *v1alpha1.Sensor
	// Trigger definition
	Trigger *v1alpha1.Trigger
	// logger to log stuff
	Logger *zap.SugaredLogger
	// triggerClient is the gRPC client for the custom trigger server
	triggerClient triggers.TriggerClient
}

// NewCustomTrigger returns a new custom trigger
func NewCustomTrigger(sensor *v1alpha1.Sensor, trigger *v1alpha1.Trigger, logger *zap.SugaredLogger, customTriggerClients common.StringKeyedMap[*grpc.ClientConn]) (*CustomTrigger, error) {
	customTrigger := &CustomTrigger{
		Sensor:  sensor,
		Trigger: trigger,
		Logger:  logger.With(logging.LabelTriggerType, apicommon.CustomTrigger),
	}

	ct := trigger.Template.CustomTrigger

	if conn, ok := customTriggerClients.Load(trigger.Template.Name); ok {
		if conn.GetState() == connectivity.Ready {
			logger.Info("trigger client connection is ready...")
			customTrigger.triggerClient = triggers.NewTriggerClient(conn)
			return customTrigger, nil
		}

		logger.Info("trigger client connection is closed, creating new one...")
		customTriggerClients.Delete(trigger.Template.Name)
	}

	logger.Infow("instantiating trigger client...", zap.Any("server-url", ct.ServerURL))

	opt := []grpc.DialOption{
		grpc.WithBlock(),
		grpc.WithTransportCredentials(insecure.NewCredentials()),
	}

	if ct.Secure {
		var certFilePath string
		var err error
		switch {
		case ct.CertSecret != nil:
			certFilePath, err = common.GetSecretVolumePath(ct.CertSecret)
			if err != nil {
				return nil, err
			}
		default:
			return nil, fmt.Errorf("invalid config, CERT secret not defined")
		}
		creds, err := credentials.NewClientTLSFromFile(certFilePath, ct.ServerNameOverride)
		if err != nil {
			return nil, err
		}
		opt = append(opt, grpc.WithTransportCredentials(creds))
	}

	conn, err := grpc.Dial(
		ct.ServerURL,
		opt...,
	)
	if err != nil {
		return nil, err
	}

	backoff, err := common.Convert2WaitBackoff(&common.DefaultBackoff)
	if err != nil {
		return nil, err
	}

	if err = wait.ExponentialBackoff(*backoff, func() (done bool, err error) {
		if conn.GetState() == connectivity.Ready {
			return true, nil
		}
		return false, nil
	}); err != nil {
		return nil, err
	}

	customTrigger.triggerClient = triggers.NewTriggerClient(conn)
	customTriggerClients.Store(trigger.Template.Name, conn)

	logger.Info("successfully setup the trigger client...")
	return customTrigger, nil
}

// GetTriggerType returns the type of the trigger
func (ct *CustomTrigger) GetTriggerType() apicommon.TriggerType {
	return apicommon.CustomTrigger
}

// FetchResource fetches the trigger resource from external source
func (ct *CustomTrigger) FetchResource(ctx context.Context) (interface{}, error) {
	specBody, err := yaml.Marshal(ct.Trigger.Template.CustomTrigger.Spec)
	if err != nil {
		return nil, fmt.Errorf("failed to parse the custom trigger spec body, %w", err)
	}

	ct.Logger.Debugw("trigger spec body", zap.Any("spec", string(specBody)))

	resource, err := ct.triggerClient.FetchResource(context.Background(), &triggers.FetchResourceRequest{
		Resource: specBody,
	})
	if err != nil {
		return nil, fmt.Errorf("failed to fetch the custom trigger resource for %s, %w", ct.Trigger.Template.Name, err)
	}

	ct.Logger.Debugw("fetched resource", zap.Any("resource", string(resource.Resource)))
	return resource.Resource, nil
}

// ApplyResourceParameters applies parameters to the trigger resource
func (ct *CustomTrigger) ApplyResourceParameters(events map[string]*v1alpha1.Event, resource interface{}) (interface{}, error) {
	obj, ok := resource.([]byte)
	if !ok {
		return nil, fmt.Errorf("failed to interpret the trigger resource for resource parameters application")
	}
	parameters := ct.Trigger.Template.CustomTrigger.Parameters

	if len(parameters) > 0 {
		// only JSON formatted resource body is eligible for parameters
		var temp map[string]interface{}
		if err := json.Unmarshal(obj, &temp); err != nil {
			return nil, fmt.Errorf("fetched resource body is not valid JSON for trigger %s, %w", ct.Trigger.Template.Name, err)
		}

		result, err := triggers.ApplyParams(obj, ct.Trigger.Template.CustomTrigger.Parameters, events)
		if err != nil {
			return nil, fmt.Errorf("failed to apply the parameters to the custom trigger resource for %s, %w", ct.Trigger.Template.Name, err)
		}

		ct.Logger.Debugw("resource after parameterization", zap.Any("resource", string(result)))
		return result, nil
	}

	return resource, nil
}

// Execute executes the trigger
func (ct *CustomTrigger) Execute(ctx context.Context, events map[string]*v1alpha1.Event, resource interface{}) (interface{}, error) {
	obj, ok := resource.([]byte)
	if !ok {
		return nil, fmt.Errorf("failed to interpret the trigger resource for the execution")
	}

	ct.Logger.Debugw("resource to execute", zap.Any("resource", string(obj)))

	trigger := ct.Trigger.Template.CustomTrigger

	var payload []byte
	var err error

	if trigger.Payload != nil {
		payload, err = triggers.ConstructPayload(events, trigger.Payload)
		if err != nil {
			return nil, err
		}

		ct.Logger.Debugw("payload for the trigger execution", zap.Any("payload", string(payload)))
	}

	result, err := ct.triggerClient.Execute(context.Background(), &triggers.ExecuteRequest{
		Resource: obj,
		Payload:  payload,
	})
	if err != nil {
		return nil, fmt.Errorf("failed to execute the custom trigger resource for %s, %w", ct.Trigger.Template.Name, err)
	}

	ct.Logger.Debugw("trigger execution response", zap.Any("response", string(result.Response)))
	return result.Response, nil
}

// ApplyPolicy applies the policy on the trigger
func (ct *CustomTrigger) ApplyPolicy(ctx context.Context, resource interface{}) error {
	obj, ok := resource.([]byte)
	if !ok {
		return fmt.Errorf("failed to interpret the trigger resource for the policy application")
	}

	ct.Logger.Debugw("resource to apply policy on", zap.Any("resource", string(obj)))

	result, err := ct.triggerClient.ApplyPolicy(ctx, &triggers.ApplyPolicyRequest{
		Request: obj,
	})
	if err != nil {
		return fmt.Errorf("failed to apply the policy for the custom trigger resource for %s, %w", ct.Trigger.Template.Name, err)
	}
	ct.Logger.Infow("policy application result", zap.Any("success", result.Success), zap.Any("message", result.Message))
	return err
}