Merge pull request #9046 from blackpiglet/9032_fix

Make the backup repository controller doesn't invalidate the BSL on restart

Author: blackpiglet

changelogs/unreleased/9046-blackpiglet

@@ -0,0 +1 @@
+Make the backup repository controller doesn't invalidate the BSL on restart

pkg/controller/backup_repository_controller.go

@@ -28,6 +28,7 @@ import (
 	"github.com/petar/GoLLRB/llrb"
 	"github.com/pkg/errors"
 	"github.com/sirupsen/logrus"
+	corev1api "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
 	metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
 	"k8s.io/apimachinery/pkg/labels"
@@ -38,8 +39,6 @@ import (
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
 
-	corev1api "k8s.io/api/core/v1"
-
 	velerov1api "github.com/vmware-tanzu/velero/pkg/apis/velero/v1"
 	"github.com/vmware-tanzu/velero/pkg/constant"
 	"github.com/vmware-tanzu/velero/pkg/label"
@@ -119,7 +118,22 @@ func (r *BackupRepoReconciler) SetupWithManager(mgr ctrl.Manager) error {
 			// BSL may be recreated after deleting, so also include the create event
 			&velerov1api.BackupStorageLocation{},
 			kube.EnqueueRequestsFromMapUpdateFunc(r.invalidateBackupReposForBSL),
-			builder.WithPredicates(kube.NewUpdateEventPredicate(r.needInvalidBackupRepo)),
+			builder.WithPredicates(
+				// Combine three predicates together to guarantee
+				// only BSL's Delete Event and Update Event can enqueue.
+				// We don't care about BSL's Generic Event and Create Event,
+				// because BSL's periodical enqueue triggers Generic Event,
+				// and the BackupRepository controller restart will triggers BSL create event.
+				kube.NewUpdateEventPredicate(
+					r.needInvalidBackupRepo,
+				),
+				kube.NewGenericEventPredicate(
+					func(client.Object) bool { return false },
+				),
+				kube.NewCreateEventPredicate(
+					func(client.Object) bool { return false },
+				),
+			),
 		).
 		Complete(r)
 }

pkg/util/kube/predicate.go

@@ -98,10 +98,22 @@ func NewGenericEventPredicate(f func(object client.Object) bool) predicate.Predi
 }
 
 // NewUpdateEventPredicate creates a new Predicate that checks the Update event with the provided func
-func NewUpdateEventPredicate(f func(objectOld client.Object, objectNew client.Object) bool) predicate.Predicate {
+func NewUpdateEventPredicate(
+	f func(objectOld client.Object, objectNew client.Object) bool,
+) predicate.Predicate {
 	return predicate.Funcs{
 		UpdateFunc: func(event event.UpdateEvent) bool {
 			return f(event.ObjectOld, event.ObjectNew)
 		},
 	}
 }
+
+func NewCreateEventPredicate(
+	f func(object client.Object) bool,
+) predicate.Predicate {
+	return predicate.Funcs{
+		CreateFunc: func(event event.CreateEvent) bool {
+			return f(event.Object)
+		},
+	}
+}

pkg/util/kube/predicate_test.go

@@ -202,12 +202,27 @@ func TestNewGenericEventPredicate(t *testing.T) {
 }
 
 func TestNewUpdateEventPredicate(t *testing.T) {
-	predicate := NewUpdateEventPredicate(func(client.Object, client.Object) bool {
-		return false
-	})
+	predicate := NewUpdateEventPredicate(
+		func(client.Object, client.Object) bool {
+			return false
+		},
+	)
 
 	assert.False(t, predicate.Update(event.UpdateEvent{}))
 	assert.True(t, predicate.Create(event.CreateEvent{}))
 	assert.True(t, predicate.Delete(event.DeleteEvent{}))
 	assert.True(t, predicate.Generic(event.GenericEvent{}))
 }
+
+func TestNewCreateEventPredicate(t *testing.T) {
+	predicate := NewCreateEventPredicate(
+		func(client.Object) bool {
+			return false
+		},
+	)
+
+	assert.False(t, predicate.Create(event.CreateEvent{}))
+	assert.True(t, predicate.Update(event.UpdateEvent{}))
+	assert.True(t, predicate.Generic(event.GenericEvent{}))
+	assert.True(t, predicate.Delete(event.DeleteEvent{}))
+}