processor.go

/*
Copyright 2022 The Flux authors

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 summarize

import (
	"context"

	corev1 "k8s.io/api/core/v1"
	kuberecorder "k8s.io/client-go/tools/record"
	ctrl "sigs.k8s.io/controller-runtime"
	"sigs.k8s.io/controller-runtime/pkg/client"

	eventv1 "github.com/fluxcd/pkg/apis/event/v1beta1"
	"github.com/fluxcd/pkg/apis/meta"
	serror "github.com/fluxcd/source-controller/internal/error"
	"github.com/fluxcd/source-controller/internal/object"
	"github.com/fluxcd/source-controller/internal/reconcile"
)

// ResultProcessor processes the results of reconciliation (the object, result
// and error). Any errors during processing need not result in the
// reconciliation failure. The errors can be recorded as logs and events.
type ResultProcessor func(context.Context, kuberecorder.EventRecorder, client.Object, reconcile.Result, error)

// RecordReconcileReq is a ResultProcessor that checks the reconcile
// annotation value and sets it in the object status as
// status.lastHandledReconcileAt.
func RecordReconcileReq(ctx context.Context, recorder kuberecorder.EventRecorder, obj client.Object, _ reconcile.Result, _ error) {
	if v, ok := meta.ReconcileAnnotationValue(obj.GetAnnotations()); ok {
		object.SetStatusLastHandledReconcileAt(obj, v)
	}
}

// ErrorActionHandler is a ResultProcessor that handles all the actions
// configured in the given error. Logging and event recording are the handled
// actions at present. As more configurations are added to serror.Config, more
// action handlers can be added here.
func ErrorActionHandler(ctx context.Context, recorder kuberecorder.EventRecorder, obj client.Object, _ reconcile.Result, err error) {
	switch e := err.(type) {
	case *serror.Generic:
		if e.Log {
			logError(ctx, e.Config.Event, e, e.Error())
		}
		recordEvent(recorder, obj, e.Config.Event, e.Config.Notification, err, e.Reason)
	case *serror.Waiting:
		if e.Log {
			logError(ctx, e.Config.Event, e, "reconciliation waiting", "reason", e.Err, "duration", e.RequeueAfter)
		}
		recordEvent(recorder, obj, e.Config.Event, e.Config.Notification, err, e.Reason)
	case *serror.Stalling:
		if e.Log {
			logError(ctx, e.Config.Event, e, "reconciliation stalled")
		}
		recordEvent(recorder, obj, e.Config.Event, e.Config.Notification, err, e.Reason)
	}
}

// logError logs error based on the passed error configurations.
func logError(ctx context.Context, eventType string, err error, msg string, keysAndValues ...interface{}) {
	switch eventType {
	case corev1.EventTypeNormal, serror.EventTypeNone:
		ctrl.LoggerFrom(ctx).Info(msg, keysAndValues...)
	case corev1.EventTypeWarning:
		ctrl.LoggerFrom(ctx).Error(err, msg, keysAndValues...)
	}
}

// recordEvent records events based on the passed error configurations.
func recordEvent(recorder kuberecorder.EventRecorder, obj client.Object, eventType string, notification bool, err error, reason string) {
	if eventType == serror.EventTypeNone {
		return
	}
	switch eventType {
	case corev1.EventTypeNormal:
		if notification {
			// K8s native event and notification-controller event.
			recorder.Eventf(obj, corev1.EventTypeNormal, reason, err.Error())
		} else {
			// K8s native event only.
			recorder.Eventf(obj, eventv1.EventTypeTrace, reason, err.Error())
		}
	case corev1.EventTypeWarning:
		// TODO: Due to the current implementation of the event recorder, all
		// the K8s warning events are also sent as notification controller
		// notifications. Once the recorder becomes capable of separating the
		// two, conditionally record events.
		recorder.Eventf(obj, corev1.EventTypeWarning, reason, err.Error())
	}
}