Controller improvements

Author: lucian-tosa

controllers/operator/clustermongodbrole_controller.go

@@ -5,18 +5,19 @@ import (
 	"encoding/json"
 	"fmt"
 	"strings"
-	"time"
 
 	"go.uber.org/zap"
 	"golang.org/x/xerrors"
+	"k8s.io/apimachinery/pkg/api/errors"
 	"k8s.io/apimachinery/pkg/fields"
+	"k8s.io/apimachinery/pkg/types"
+	"sigs.k8s.io/controller-runtime/pkg/builder"
 	"sigs.k8s.io/controller-runtime/pkg/client"
 	"sigs.k8s.io/controller-runtime/pkg/controller"
 	"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
 	"sigs.k8s.io/controller-runtime/pkg/handler"
 	"sigs.k8s.io/controller-runtime/pkg/manager"
 	"sigs.k8s.io/controller-runtime/pkg/reconcile"
-	"sigs.k8s.io/controller-runtime/pkg/source"
 
 	ctrl "sigs.k8s.io/controller-runtime"
 
@@ -47,10 +48,13 @@ func (r *ClusterMongoDBRoleReconciler) Reconcile(ctx context.Context, request ct
 	log := zap.S().With("ClusterMongoDBRole", request.NamespacedName)
 	log.Info("-> ClusterMongoDBRole.Reconcile")
 
-	role, err := r.getRole(ctx, request, log)
+	role := &rolev1.ClusterMongoDBRole{}
+	reconcileResult, err := r.prepareResourceForReconciliation(ctx, request, role, log)
 	if err != nil {
-		log.Warnf("error getting custom role %s", err)
-		return reconcile.Result{RequeueAfter: time.Second * util.RetryTimeSec}, nil
+		if errors.IsNotFound(err) {
+			return workflow.Invalid("Object for reconciliation not found").ReconcileResult()
+		}
+		return reconcileResult, err
 	}
 
 	log.Infow("ClusterMongoDBRole.Spec", "spec", role.Spec)
@@ -85,30 +89,25 @@ func (r *ClusterMongoDBRoleReconciler) Reconcile(ctx context.Context, request ct
 }
 
 func AddClusterMongoDBRoleController(ctx context.Context, mgr manager.Manager) error {
-	reconciler := newClusterMongoDBRoleReconciler(ctx, mgr.GetClient())
-	c, err := controller.New(util.ClusterMongoDbRoleController, mgr, controller.Options{Reconciler: reconciler, MaxConcurrentReconciles: env.ReadIntOrDefault(util.MaxConcurrentReconcilesEnv, 1)}) // nolint:forbidigo
-	if err != nil {
-		return err
-	}
-
-	// Watch for changes to ClusterMongoDBRole resources
-	// We don't need a Delete handler as there is nothing to do after removing the finalizer
-	// To not get into an infinite reconcile loop, we ignore the delete event since the cleanup was already performed
-	err = c.Watch(source.Kind[client.Object](mgr.GetCache(), &rolev1.ClusterMongoDBRole{}, &handler.EnqueueRequestForObject{}, watch.PredicatesForClusterRole()))
-	if err != nil {
-		return err
-	}
+	r := newClusterMongoDBRoleReconciler(ctx, mgr.GetClient())
 
-	if err = mgr.GetFieldIndexer().IndexField(ctx, &mdbv1.MongoDB{}, ClusterMongoDBRoleIndexForMdb, findRolesForMongoDB); err != nil {
+	if err := mgr.GetFieldIndexer().IndexField(ctx, &mdbv1.MongoDB{}, ClusterMongoDBRoleIndexForMdb, findRolesForMongoDB); err != nil {
 		return err
 	}
 
-	if err = mgr.GetFieldIndexer().IndexField(ctx, &mdbmultiv1.MongoDBMultiCluster{}, ClusterMongoDBRoleIndexForMdbMulti, findRolesForMongoDBMultiCluster); err != nil {
+	if err := mgr.GetFieldIndexer().IndexField(ctx, &mdbmultiv1.MongoDBMultiCluster{}, ClusterMongoDBRoleIndexForMdbMulti, findRolesForMongoDBMultiCluster); err != nil {
 		return err
 	}
 
 	zap.S().Infof("Registered controller %s", util.ClusterMongoDbRoleController)
-	return nil
+
+	return ctrl.NewControllerManagedBy(mgr).
+		Named(util.ClusterMongoDbRoleController).
+		For(&rolev1.ClusterMongoDBRole{}, builder.WithPredicates(watch.PredicatesForClusterRole())).
+		WithOptions(controller.Options{MaxConcurrentReconciles: env.ReadIntOrDefault(util.MaxConcurrentReconcilesEnv, 1)}). // nolint:forbidigo
+		Watches(&mdbv1.MongoDB{}, handler.EnqueueRequestsFromMapFunc(getReconcileRequestsForMongoDB)).
+		Watches(&mdbmultiv1.MongoDBMultiCluster{}, handler.EnqueueRequestsFromMapFunc(getReconcileRequestsForMongoDBMultiCluster)).
+		Complete(r)
 }
 
 func newClusterMongoDBRoleReconciler(ctx context.Context, kubeClient client.Client) *ClusterMongoDBRoleReconciler {
@@ -117,15 +116,6 @@ func newClusterMongoDBRoleReconciler(ctx context.Context, kubeClient client.Clie
 	}
 }
 
-func (r *ClusterMongoDBRoleReconciler) getRole(ctx context.Context, request reconcile.Request, log *zap.SugaredLogger) (*rolev1.ClusterMongoDBRole, error) {
-	role := &rolev1.ClusterMongoDBRole{}
-	if _, err := r.GetResource(ctx, request, role, log); err != nil {
-		return nil, err
-	}
-
-	return role, nil
-}
-
 // Delete handles the deletion of the ClusterMongoDBRole resource.
 // It ensures that no MongoDB or MongoDBMultiCluster resources are referencing this role.
 // If there are references, it moves the resource in a Pending phase with an appropriate message.
@@ -217,11 +207,12 @@ func getAnnotationsForCustomRoleResource(role *rolev1.ClusterMongoDBRole) (map[s
 // This is used to index the MongoDB resources by the ClusterMongoDBRole they reference.
 func findRolesForMongoDB(rawObj client.Object) []string {
 	mdb, ok := rawObj.(*mdbv1.MongoDB)
+	roles := make([]string, 0)
+
 	if !ok {
-		return nil
+		return roles
 	}
 
-	roles := make([]string, 0)
 	if mdb.Spec.Security == nil {
 		return roles
 	}
@@ -238,11 +229,12 @@ func findRolesForMongoDB(rawObj client.Object) []string {
 // This is used to index the MongoDBMultiCluster resources by the ClusterMongoDBRole they reference.
 func findRolesForMongoDBMultiCluster(rawObj client.Object) []string {
 	mdb, ok := rawObj.(*mdbmultiv1.MongoDBMultiCluster)
+	roles := make([]string, 0)
+
 	if !ok {
-		return nil
+		return roles
 	}
 
-	roles := make([]string, 0)
 	if mdb.Spec.Security == nil {
 		return roles
 	}
@@ -254,3 +246,25 @@ func findRolesForMongoDBMultiCluster(rawObj client.Object) []string {
 	}
 	return roles
 }
+
+// getReconcileRequestsForMongoDB returns reconcile requests for ClusterMongoDBRole resources based on the roles referenced in MongoDB resources.
+func getReconcileRequestsForMongoDB(ctx context.Context, rawObj client.Object) []reconcile.Request {
+	roles := findRolesForMongoDB(rawObj)
+	requests := []reconcile.Request{}
+
+	for _, role := range roles {
+		requests = append(requests, reconcile.Request{NamespacedName: types.NamespacedName{Name: role}})
+	}
+	return requests
+}
+
+// getReconcileRequestsForMongoDBMultiCluster returns reconcile requests for ClusterMongoDBRole resources based on the roles referenced in MongoDBMultiCluster resources.
+func getReconcileRequestsForMongoDBMultiCluster(ctx context.Context, rawObj client.Object) []reconcile.Request {
+	roles := findRolesForMongoDBMultiCluster(rawObj)
+	requests := []reconcile.Request{}
+
+	for _, role := range roles {
+		requests = append(requests, reconcile.Request{NamespacedName: types.NamespacedName{Name: role}})
+	}
+	return requests
+}