Creates notify function to only emit events if artifacts changed

Signed-off-by: Renato Vassão <renato.vassao@mindbodyonline.com>

Author: renatovassaomb

go.mod

@@ -10,6 +10,7 @@ replace github.com/opencontainers/go-digest => github.com/opencontainers/go-dige
 
 require (
 	github.com/bmatcuk/doublestar/v4 v4.9.2
+	github.com/fluxcd/pkg/apis/event v0.22.0
 	github.com/fluxcd/pkg/apis/meta v1.25.0
 	github.com/fluxcd/pkg/artifact v0.7.0
 	github.com/fluxcd/pkg/http/fetch v0.22.0
@@ -49,7 +50,6 @@ require (
 	github.com/exponent-io/jsonpath v0.0.0-20210407135951-1de76d718b3f // indirect
 	github.com/fluxcd/cli-utils v0.37.1-flux.1 // indirect
 	github.com/fluxcd/pkg/apis/acl v0.9.0 // indirect
-	github.com/fluxcd/pkg/apis/event v0.22.0 // indirect
 	github.com/fluxcd/pkg/lockedfile v0.7.0 // indirect
 	github.com/fluxcd/pkg/oci v0.59.0 // indirect
 	github.com/fluxcd/pkg/sourceignore v0.16.0 // indirect

internal/controller/artifactgenerator_controller.go

@@ -35,6 +35,7 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 
+	eventv1 "github.com/fluxcd/pkg/apis/event/v1beta1"
 	gotkmeta "github.com/fluxcd/pkg/apis/meta"
 	gotkstroage "github.com/fluxcd/pkg/artifact/storage"
 	gotkfetch "github.com/fluxcd/pkg/http/fetch"
@@ -102,7 +103,7 @@ func (r *ArtifactGeneratorReconciler) Reconcile(ctx context.Context, req ctrl.Re
 	// Pause reconciliation if the object has the reconcile annotation set to 'disabled'.
 	if obj.IsDisabled() {
 		log.Error(errors.New("can't reconcile"), msgReconciliationDisabled)
-		r.Event(obj, corev1.EventTypeWarning, swapi.ReconciliationDisabledReason, msgReconciliationDisabled)
+		r.Event(obj, eventv1.EventTypeTrace, swapi.ReconciliationDisabledReason, msgReconciliationDisabled)
 		return ctrl.Result{}, nil
 	}
 
@@ -120,6 +121,7 @@ func (r *ArtifactGeneratorReconciler) reconcile(ctx context.Context,
 	obj *swapi.ArtifactGenerator,
 	patcher *gotkpatch.SerialPatcher) (ctrl.Result, error) {
 	log := ctrl.LoggerFrom(ctx)
+	oldObj := obj.DeepCopy()
 
 	// Create a temporary directory to fetch sources and build artifacts.
 	tmpDir, err := builder.MkdirTempAbs("", "ag-")
@@ -157,7 +159,7 @@ func (r *ArtifactGeneratorReconciler) reconcile(ctx context.Context,
 	if !hasDrifted {
 		msg := fmt.Sprintf("No drift detected, %d artifact(s) up to date", len(obj.Status.Inventory))
 		log.Info(msg)
-		r.Event(obj, corev1.EventTypeNormal, gotkmeta.ReadyCondition, msg)
+		r.Event(obj, eventv1.EventTypeTrace, gotkmeta.ReadyCondition, msg)
 		return ctrl.Result{RequeueAfter: obj.GetRequeueAfter()}, nil
 	}
 
@@ -252,11 +254,30 @@ func (r *ArtifactGeneratorReconciler) reconcile(ctx context.Context,
 		gotkmeta.ReadyCondition,
 		gotkmeta.SucceededReason,
 		"%s", msg)
-	r.Event(obj, corev1.EventTypeNormal, gotkmeta.ReadyCondition, msg)
+	r.Event(obj, eventv1.EventTypeTrace, gotkmeta.ReadyCondition, msg)
+
+	r.notify(oldObj, obj, eaRefs)
 
 	return ctrl.Result{RequeueAfter: gotkjitter.JitteredIntervalDuration(obj.GetRequeueAfter())}, nil
 }
 
+// notify emits notification related to the result of reconciliation. It will only send events if
+// there is a least one external artifact update
+func (r *ArtifactGeneratorReconciler) notify(oldObj, newObj *swapi.ArtifactGenerator, eaRefs []swapi.ExternalArtifactReference) {
+	eaChanged := make([]string, 0)
+
+	for _, eaRef := range eaRefs {
+		if !oldObj.HasArtifactInInventory(eaRef.Name, eaRef.Namespace, eaRef.Digest) {
+			eaChanged = append(eaChanged, fmt.Sprintf("%s/%s (%s)", eaRef.Namespace, eaRef.Name, eaRef.Digest))
+		}
+	}
+
+	if len(eaChanged) > 0 {
+		msg := fmt.Sprintf("external artifacts reconciled: %s", strings.Join(eaChanged, ", "))
+		r.Event(newObj, corev1.EventTypeNormal, gotkmeta.ReadyCondition, msg)
+	}
+}
+
 // observeSources retrieves the current state of sources,
 // including their artifact URLs, digests, and revisions.
 // It returns a map of source alias to observed state.
@@ -464,7 +485,7 @@ func (r *ArtifactGeneratorReconciler) reconcileExternalArtifact(ctx context.Cont
 		msg := fmt.Sprintf("%s/%s/%s reconciled with revision %s",
 			ea.Kind, ea.Namespace, ea.Name, artifact.Revision)
 		log.Info(msg)
-		r.Event(obj, corev1.EventTypeNormal, gotkmeta.ReadyCondition, msg)
+		r.Event(obj, eventv1.EventTypeTrace, gotkmeta.ReadyCondition, msg)
 	}
 
 	return &swapi.ExternalArtifactReference{