Refactor event filter (#1018)

* Refactor event filter

* Fix

* Rename package

Author: int128

internal/controller/applicationdeletiondeployment_controller.go

@@ -22,7 +22,7 @@ import (
 	argocdv1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
 	"github.com/argoproj/gitops-engine/pkg/health"
 	"github.com/int128/argocd-commenter/internal/argocd"
-	"github.com/int128/argocd-commenter/internal/controller/predicates"
+	"github.com/int128/argocd-commenter/internal/controller/eventfilter"
 	"github.com/int128/argocd-commenter/internal/notification"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -75,16 +75,6 @@ func (r *ApplicationDeletionDeploymentReconciler) Reconcile(ctx context.Context,
 	return ctrl.Result{}, nil
 }
 
-// SetupWithManager sets up the controller with the Manager.
-func (r *ApplicationDeletionDeploymentReconciler) SetupWithManager(mgr ctrl.Manager) error {
-	r.Recorder = mgr.GetEventRecorderFor("application-deletion-deployment")
-	return ctrl.NewControllerManagedBy(mgr).
-		Named("applicationDeletionDeployment").
-		For(&argocdv1alpha1.Application{}).
-		WithEventFilter(predicates.ApplicationUpdate(applicationDeletionDeploymentFilter{})).
-		Complete(r)
-}
-
 func isApplicationDeleting(app argocdv1alpha1.Application) bool {
 	if !app.DeletionTimestamp.IsZero() {
 		return true
@@ -95,22 +85,29 @@ func isApplicationDeleting(app argocdv1alpha1.Application) bool {
 	return false
 }
 
-type applicationDeletionDeploymentFilter struct{}
+// SetupWithManager sets up the controller with the Manager.
+func (r *ApplicationDeletionDeploymentReconciler) SetupWithManager(mgr ctrl.Manager) error {
+	r.Recorder = mgr.GetEventRecorderFor("application-deletion-deployment")
+	return ctrl.NewControllerManagedBy(mgr).
+		Named("applicationDeletionDeployment").
+		For(&argocdv1alpha1.Application{}).
+		WithEventFilter(eventfilter.ApplicationChanged(filterApplicationDeletionForDeploymentStatus)).
+		Complete(r)
+}
 
-func (applicationDeletionDeploymentFilter) Compare(applicationOld, applicationNew argocdv1alpha1.Application) bool {
-	if argocd.GetDeploymentURL(applicationNew) == "" {
+func filterApplicationDeletionForDeploymentStatus(appOld, appNew argocdv1alpha1.Application) bool {
+	if argocd.GetDeploymentURL(appNew) == "" {
 		return false
 	}
 
-	// deletion timestamp has been set
-	if applicationOld.DeletionTimestamp != applicationNew.DeletionTimestamp &&
-		!applicationNew.DeletionTimestamp.IsZero() {
+	// DeletionTimestamp has been set
+	if appOld.DeletionTimestamp != appNew.DeletionTimestamp && !appNew.DeletionTimestamp.IsZero() {
 		return true
 	}
 
-	// health status has been changed to missing
-	if applicationOld.Status.Health.Status != applicationNew.Status.Health.Status &&
-		applicationNew.Status.Health.Status == health.HealthStatusMissing {
+	// The health status has been changed to missing
+	healthOld, healthNew := appOld.Status.Health.Status, appNew.Status.Health.Status
+	if healthOld != healthNew && healthNew == health.HealthStatusMissing {
 		return true
 	}
 

internal/controller/applicationhealthcomment_controller.go

@@ -24,7 +24,7 @@ import (
 	"github.com/argoproj/gitops-engine/pkg/health"
 	argocdcommenterv1 "github.com/int128/argocd-commenter/api/v1"
 	"github.com/int128/argocd-commenter/internal/argocd"
-	"github.com/int128/argocd-commenter/internal/controller/predicates"
+	"github.com/int128/argocd-commenter/internal/controller/eventfilter"
 	"github.com/int128/argocd-commenter/internal/notification"
 	corev1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -126,16 +126,15 @@ func (r *ApplicationHealthCommentReconciler) SetupWithManager(mgr ctrl.Manager)
 	return ctrl.NewControllerManagedBy(mgr).
 		Named("applicationHealthComment").
 		For(&argocdv1alpha1.Application{}).
-		WithEventFilter(predicates.ApplicationUpdate(applicationHealthCommentFilter{})).
+		WithEventFilter(eventfilter.ApplicationChanged(filterApplicationHealthStatusForComment)).
 		Complete(r)
 }
 
-type applicationHealthCommentFilter struct{}
-
-func (applicationHealthCommentFilter) Compare(applicationOld, applicationNew argocdv1alpha1.Application) bool {
-	if applicationOld.Status.Health.Status == applicationNew.Status.Health.Status {
+func filterApplicationHealthStatusForComment(appOld, appNew argocdv1alpha1.Application) bool {
+	healthOld, healthNew := appOld.Status.Health.Status, appNew.Status.Health.Status
+	if healthOld == healthNew {
 		return false
 	}
 
-	return slices.Contains(notification.HealthStatusesForComment, applicationNew.Status.Health.Status)
+	return slices.Contains(notification.HealthStatusesForComment, healthNew)
 }

internal/controller/applicationhealthdeployment_controller.go

@@ -23,7 +23,7 @@ import (
 
 	argocdv1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
 	"github.com/int128/argocd-commenter/internal/argocd"
-	"github.com/int128/argocd-commenter/internal/controller/predicates"
+	"github.com/int128/argocd-commenter/internal/controller/eventfilter"
 	"github.com/int128/argocd-commenter/internal/notification"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -116,19 +116,19 @@ func (r *ApplicationHealthDeploymentReconciler) SetupWithManager(mgr ctrl.Manage
 	return ctrl.NewControllerManagedBy(mgr).
 		Named("applicationHealthDeployment").
 		For(&argocdv1alpha1.Application{}).
-		WithEventFilter(predicates.ApplicationUpdate(applicationHealthDeploymentFilter{})).
+		WithEventFilter(eventfilter.ApplicationChanged(filterApplicationHealthStatusForDeploymentStatus)).
 		Complete(r)
 }
 
-type applicationHealthDeploymentFilter struct{}
-
-func (applicationHealthDeploymentFilter) Compare(applicationOld, applicationNew argocdv1alpha1.Application) bool {
-	if applicationOld.Status.Health.Status == applicationNew.Status.Health.Status {
+func filterApplicationHealthStatusForDeploymentStatus(appOld, appNew argocdv1alpha1.Application) bool {
+	if argocd.GetDeploymentURL(appNew) == "" {
 		return false
 	}
-	if argocd.GetDeploymentURL(applicationNew) == "" {
+
+	healthOld, healthNew := appOld.Status.Health.Status, appNew.Status.Health.Status
+	if healthOld == healthNew {
 		return false
 	}
 
-	return slices.Contains(notification.HealthStatusesForDeploymentStatus, applicationNew.Status.Health.Status)
+	return slices.Contains(notification.HealthStatusesForDeploymentStatus, healthNew)
 }

internal/controller/applicationphasecomment_controller.go

@@ -22,7 +22,7 @@ import (
 
 	argocdv1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
 	"github.com/int128/argocd-commenter/internal/argocd"
-	"github.com/int128/argocd-commenter/internal/controller/predicates"
+	"github.com/int128/argocd-commenter/internal/controller/eventfilter"
 	"github.com/int128/argocd-commenter/internal/notification"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -81,14 +81,12 @@ func (r *ApplicationPhaseCommentReconciler) SetupWithManager(mgr ctrl.Manager) e
 	return ctrl.NewControllerManagedBy(mgr).
 		Named("applicationPhaseComment").
 		For(&argocdv1alpha1.Application{}).
-		WithEventFilter(predicates.ApplicationUpdate(applicationPhaseCommentFilter{})).
+		WithEventFilter(eventfilter.ApplicationChanged(filterApplicationSyncOperationPhaseForComment)).
 		Complete(r)
 }
 
-type applicationPhaseCommentFilter struct{}
-
-func (applicationPhaseCommentFilter) Compare(applicationOld, applicationNew argocdv1alpha1.Application) bool {
-	phaseOld, phaseNew := argocd.GetSyncOperationPhase(applicationOld), argocd.GetSyncOperationPhase(applicationNew)
+func filterApplicationSyncOperationPhaseForComment(appOld, appNew argocdv1alpha1.Application) bool {
+	phaseOld, phaseNew := argocd.GetSyncOperationPhase(appOld), argocd.GetSyncOperationPhase(appNew)
 	if phaseNew == "" {
 		return false
 	}

internal/controller/applicationphasedeployment_controller.go

@@ -23,7 +23,7 @@ import (
 
 	argocdv1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
 	"github.com/int128/argocd-commenter/internal/argocd"
-	"github.com/int128/argocd-commenter/internal/controller/predicates"
+	"github.com/int128/argocd-commenter/internal/controller/eventfilter"
 	"github.com/int128/argocd-commenter/internal/notification"
 	corev1 "k8s.io/api/core/v1"
 	"k8s.io/apimachinery/pkg/runtime"
@@ -106,23 +106,22 @@ func (r *ApplicationPhaseDeploymentReconciler) SetupWithManager(mgr ctrl.Manager
 	return ctrl.NewControllerManagedBy(mgr).
 		Named("applicationPhaseDeployment").
 		For(&argocdv1alpha1.Application{}).
-		WithEventFilter(predicates.ApplicationUpdate(applicationPhaseDeploymentFilter{})).
+		WithEventFilter(eventfilter.ApplicationChanged(filterApplicationSyncOperationPhaseForDeploymentStatus)).
 		Complete(r)
 }
 
-type applicationPhaseDeploymentFilter struct{}
+func filterApplicationSyncOperationPhaseForDeploymentStatus(appOld, appNew argocdv1alpha1.Application) bool {
+	if argocd.GetDeploymentURL(appNew) == "" {
+		return false
+	}
 
-func (applicationPhaseDeploymentFilter) Compare(applicationOld, applicationNew argocdv1alpha1.Application) bool {
-	phaseOld, phaseNew := argocd.GetSyncOperationPhase(applicationOld), argocd.GetSyncOperationPhase(applicationNew)
+	phaseOld, phaseNew := argocd.GetSyncOperationPhase(appOld), argocd.GetSyncOperationPhase(appNew)
 	if phaseNew == "" {
 		return false
 	}
 	if phaseOld == phaseNew {
 		return false
 	}
-	if argocd.GetDeploymentURL(applicationNew) == "" {
-		return false
-	}
 
 	return slices.Contains(notification.SyncOperationPhasesForDeploymentStatus, phaseNew)
 }

internal/controller/eventfilter/application.go

@@ -0,0 +1,38 @@
+package eventfilter
+
+import (
+	argocdv1alpha1 "github.com/argoproj/argo-cd/v2/pkg/apis/application/v1alpha1"
+	"sigs.k8s.io/controller-runtime/pkg/event"
+	"sigs.k8s.io/controller-runtime/pkg/predicate"
+)
+
+// ApplicationChangedFunc is a function to compare the application.
+// It must return true if the application is changed.
+type ApplicationChangedFunc func(appOld, appNew argocdv1alpha1.Application) bool
+
+// ApplicationChanged is an event filter triggering when the application is changed.
+type ApplicationChanged ApplicationChangedFunc
+
+var _ predicate.Predicate = ApplicationChanged(func(_, _ argocdv1alpha1.Application) bool { return false })
+
+func (f ApplicationChanged) Update(e event.UpdateEvent) bool {
+	appOld, ok := e.ObjectOld.(*argocdv1alpha1.Application)
+	if !ok {
+		return false
+	}
+	appNew, ok := e.ObjectNew.(*argocdv1alpha1.Application)
+	if !ok {
+		return false
+	}
+	return f(*appOld, *appNew)
+}
+
+func (ApplicationChanged) Create(event.CreateEvent) bool {
+	return false
+}
+func (ApplicationChanged) Delete(event.DeleteEvent) bool {
+	return false
+}
+func (ApplicationChanged) Generic(event.GenericEvent) bool {
+	return false
+}