Add BackupRepositories invalidation on BSL Create

Simplify comments

Signed-off-by: Tiger Kaovilai <tkaovila@redhat.com>

changelogs/unreleased/7380-kaovilai

@@ -0,0 +1 @@
+BackupRepositories associated with a BSL are invalidated when BSL is (re-)created.

pkg/controller/backup_repository_controller.go

@@ -76,7 +76,7 @@ func (r *BackupRepoReconciler) SetupWithManager(mgr ctrl.Manager) error {
 		For(&velerov1api.BackupRepository{}).
 		Watches(s, nil).
 		Watches(&source.Kind{Type: &velerov1api.BackupStorageLocation{}}, kube.EnqueueRequestsFromMapUpdateFunc(r.invalidateBackupReposForBSL),
-			builder.WithPredicates(kube.NewUpdateEventPredicate(r.needInvalidBackupRepo))).
+			builder.WithPredicates(kube.NewCreateOrUpdateEventPredicate(r.needInvalidBackupRepo))).
 		Complete(r)
 }
 
@@ -90,21 +90,30 @@ func (r *BackupRepoReconciler) invalidateBackupReposForBSL(bslObj client.Object)
 		}).AsSelector(),
 	}
 	if err := r.List(context.TODO(), list, options); err != nil {
-		r.logger.WithField("BSL", bsl.Name).WithError(err).Error("unable to list BackupRepositorys")
+		r.logger.WithField("BSL", bsl.Name).WithError(err).Error("unable to list BackupRepositories")
 		return []reconcile.Request{}
 	}
 
 	for i := range list.Items {
 		r.logger.WithField("BSL", bsl.Name).Infof("Invalidating Backup Repository %s", list.Items[i].Name)
-		if err := r.patchBackupRepository(context.Background(), &list.Items[i], repoNotReady("re-establish on BSL change")); err != nil {
+		if err := r.patchBackupRepository(context.Background(), &list.Items[i], repoNotReady("re-establish on BSL change or create")); err != nil {
 			r.logger.WithField("BSL", bsl.Name).WithError(err).Errorf("fail to patch BackupRepository %s", list.Items[i].Name)
 		}
 	}
 
 	return []reconcile.Request{}
 }
 
+// needInvalidBackupRepo returns true if the BSL's storage type, bucket, prefix, CACert, or config has changed or if BSL was created.
 func (r *BackupRepoReconciler) needInvalidBackupRepo(oldObj client.Object, newObj client.Object) bool {
+	if oldObj == nil {
+		// BSL was created because oldBSL is nil
+		// Return true so invalidateBackupReposForBSL is triggered
+		// BSL creationTimestamp should be newer than the BackupRepository's creationTimestamp if any.
+		// BSL was created after the BackupRepository, so we need to re-establish the BackupRepository on BSL creation.
+		return true
+	}
+
 	oldBSL := oldObj.(*velerov1api.BackupStorageLocation)
 	newBSL := newObj.(*velerov1api.BackupStorageLocation)
 

pkg/util/kube/event_handler.go

@@ -26,10 +26,8 @@ import (
 
 type MapUpdateFunc func(client.Object) []reconcile.Request
 
-// EnqueueRequestsFromMapUpdateFunc is for the same purpose with EnqueueRequestsFromMapFunc.
-// Merely, it is more friendly to updating the mapped objects in the MapUpdateFunc, because
-// on Update event, MapUpdateFunc is called for only once with the new object, so if MapUpdateFunc
-// does some update to the mapped objects, the update is done for once
+// EnqueueRequestsFromMapUpdateFunc has the same purpose with handler.EnqueueRequestsFromMapFunc.
+// MapUpdateFunc is simpler on Update event because mapAndEnqueue is called once with the new object. EnqueueRequestsFromMapFunc is called twice with the old and new object.
 func EnqueueRequestsFromMapUpdateFunc(fn MapUpdateFunc) handler.EventHandler {
 	return &enqueueRequestsFromMapFunc{
 		toRequests: fn,

pkg/util/kube/predicate.go

@@ -93,6 +93,25 @@ func NewUpdateEventPredicate(f func(client.Object, client.Object) bool) predicat
 	}
 }
 
+// NewCreateOrUpdateEventPredicate creates a new Predicate that checks the create or update events with the provided func
+// and ignore others
+func NewCreateOrUpdateEventPredicate(f func(client.Object, client.Object) bool) predicate.Predicate {
+	return predicate.Funcs{
+		UpdateFunc: func(event event.UpdateEvent) bool {
+			return f(event.ObjectOld, event.ObjectNew)
+		},
+		CreateFunc: func(event event.CreateEvent) bool {
+			return f(nil, event.Object)
+		},
+		DeleteFunc: func(event event.DeleteEvent) bool {
+			return false
+		},
+		GenericFunc: func(event event.GenericEvent) bool {
+			return false
+		},
+	}
+}
+
 // FalsePredicate always returns false for all kinds of events
 type FalsePredicate struct{}