fix: reorder Reconciler methods for funcorder linter

Place exported methods (Reconcile, SetupWithManager) before unexported
(buildEnqueueMapFunc, enqueueableNamespace, processReconcileRequest, cleanUp).

Made-with: Cursor

Author: Anand Kumar

pkg/controller/istiocsr/controller.go

@@ -67,59 +67,47 @@ func New(mgr ctrl.Manager) (*Reconciler, error) {
 	}, nil
 }
 
-// buildEnqueueMapFunc returns the map function used to enqueue reconcile requests
-// when watched resources change.
-func (r *Reconciler) buildEnqueueMapFunc() func(ctx context.Context, obj client.Object) []reconcile.Request {
-	return func(_ context.Context, obj client.Object) []reconcile.Request {
-		r.log.V(4).Info("received reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
+// Reconcile function to compare the state specified by the IstioCSR object against the actual cluster state,
+// and to make the cluster state reflect the state specified by the user.
+func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	r.log.V(1).Info("reconciling", "request", req)
 
-		objLabels := obj.GetLabels()
-		if objLabels == nil {
-			r.log.V(4).Info("object not of interest, ignoring reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
-			return []reconcile.Request{}
+	// Fetch the istiocsr.openshift.operator.io CR
+	istiocsr := &v1alpha1.IstioCSR{}
+	if err := r.Get(ctx, req.NamespacedName, istiocsr); err != nil {
+		if errors.IsNotFound(err) {
+			// NotFound errors, since they can't be fixed by an immediate
+			// requeue (have to wait for a new notification), and can be processed
+			// on deleted requests.
+			r.log.V(1).Info("istiocsr.openshift.operator.io object not found, skipping reconciliation", "request", req)
+			return ctrl.Result{}, nil
 		}
+		return ctrl.Result{}, fmt.Errorf("failed to fetch istiocsr.openshift.operator.io %q during reconciliation: %w", req.NamespacedName, err)
+	}
 
-		// will look for custom label set on objects not created in istiocsr namespace, and if it exists,
-		// namespace in the reconcile request will be set same, else since label check matches is an object
-		// created by controller, and we safely assume, it's in the istiocsr namespace.
-		namespace := objLabels[istiocsrNamespaceMappingLabelName]
-		if namespace == "" {
-			namespace = obj.GetNamespace()
+	if !istiocsr.DeletionTimestamp.IsZero() {
+		r.log.V(1).Info("istiocsr.openshift.operator.io is marked for deletion", "namespace", req.NamespacedName)
+
+		if requeue, err := r.cleanUp(istiocsr); err != nil {
+			return ctrl.Result{}, fmt.Errorf("clean up failed for %q istiocsr.openshift.operator.io instance deletion: %w", req.NamespacedName, err)
+		} else if requeue {
+			return ctrl.Result{RequeueAfter: defaultRequeueTime}, nil
 		}
 
-		if ok, ns := r.enqueueableNamespace(objLabels, obj, namespace); ok && ns != "" {
-			return []reconcile.Request{
-				{
-					NamespacedName: types.NamespacedName{
-						Name:      istiocsrObjectName,
-						Namespace: ns,
-					},
-				},
-			}
+		if err := r.removeFinalizer(ctx, istiocsr, finalizer); err != nil {
+			return ctrl.Result{}, err
 		}
 
-		r.log.V(4).Info("object not of interest, ignoring reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
-		return []reconcile.Request{}
+		r.log.V(1).Info("removed finalizer, cleanup complete", "request", req.NamespacedName)
+		return ctrl.Result{}, nil
 	}
-}
 
-// enqueueableNamespace checks whether the object's labels indicate it should
-// trigger a reconcile and returns the resolved namespace. The defaultNS is used
-// when no watch-label override is present.
-func (r *Reconciler) enqueueableNamespace(objLabels map[string]string, obj client.Object, defaultNS string) (bool, string) {
-	if objLabels[common.ManagedResourceLabelKey] == RequestEnqueueLabelValue {
-		return true, defaultNS
-	}
-	value := objLabels[IstiocsrResourceWatchLabelName]
-	if value == "" {
-		return false, ""
-	}
-	key := strings.Split(value, "_")
-	if len(key) != 2 {
-		r.log.Error(errInvalidLabelFormat, "%s label value(%s) not in expected format on %s resource", IstiocsrResourceWatchLabelName, value, obj.GetName())
-		return false, ""
+	// Set finalizers on the istiocsr.openshift.operator.io resource
+	if err := r.addFinalizer(ctx, istiocsr); err != nil {
+		return ctrl.Result{}, fmt.Errorf("failed to update %q istiocsr.openshift.operator.io with finalizers: %w", req.NamespacedName, err)
 	}
-	return true, key[0]
+
+	return r.processReconcileRequest(istiocsr, req.NamespacedName)
 }
 
 // SetupWithManager sets up the controller with the Manager.
@@ -168,49 +156,6 @@ func (r *Reconciler) SetupWithManager(mgr ctrl.Manager) error {
 		Complete(r)
 }
 
-// Reconcile function to compare the state specified by the IstioCSR object against the actual cluster state,
-// and to make the cluster state reflect the state specified by the user.
-func (r *Reconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
-	r.log.V(1).Info("reconciling", "request", req)
-
-	// Fetch the istiocsr.openshift.operator.io CR
-	istiocsr := &v1alpha1.IstioCSR{}
-	if err := r.Get(ctx, req.NamespacedName, istiocsr); err != nil {
-		if errors.IsNotFound(err) {
-			// NotFound errors, since they can't be fixed by an immediate
-			// requeue (have to wait for a new notification), and can be processed
-			// on deleted requests.
-			r.log.V(1).Info("istiocsr.openshift.operator.io object not found, skipping reconciliation", "request", req)
-			return ctrl.Result{}, nil
-		}
-		return ctrl.Result{}, fmt.Errorf("failed to fetch istiocsr.openshift.operator.io %q during reconciliation: %w", req.NamespacedName, err)
-	}
-
-	if !istiocsr.DeletionTimestamp.IsZero() {
-		r.log.V(1).Info("istiocsr.openshift.operator.io is marked for deletion", "namespace", req.NamespacedName)
-
-		if requeue, err := r.cleanUp(istiocsr); err != nil {
-			return ctrl.Result{}, fmt.Errorf("clean up failed for %q istiocsr.openshift.operator.io instance deletion: %w", req.NamespacedName, err)
-		} else if requeue {
-			return ctrl.Result{RequeueAfter: defaultRequeueTime}, nil
-		}
-
-		if err := r.removeFinalizer(ctx, istiocsr, finalizer); err != nil {
-			return ctrl.Result{}, err
-		}
-
-		r.log.V(1).Info("removed finalizer, cleanup complete", "request", req.NamespacedName)
-		return ctrl.Result{}, nil
-	}
-
-	// Set finalizers on the istiocsr.openshift.operator.io resource
-	if err := r.addFinalizer(ctx, istiocsr); err != nil {
-		return ctrl.Result{}, fmt.Errorf("failed to update %q istiocsr.openshift.operator.io with finalizers: %w", req.NamespacedName, err)
-	}
-
-	return r.processReconcileRequest(istiocsr, req.NamespacedName)
-}
-
 func (r *Reconciler) processReconcileRequest(istiocsr *v1alpha1.IstioCSR, req types.NamespacedName) (ctrl.Result, error) {
 	istioCSRCreateRecon := false
 	if !containsProcessedAnnotation(istiocsr) && reflect.DeepEqual(istiocsr.Status, v1alpha1.IstioCSRStatus{}) {
@@ -252,3 +197,58 @@ func (r *Reconciler) cleanUp(istiocsr *v1alpha1.IstioCSR) (bool, error) {
 	r.eventRecorder.Eventf(istiocsr, corev1.EventTypeWarning, "RemoveDeployment", "%s/%s istiocsr marked for deletion, remove reference in istiod deployment and remove all resources created for istiocsr deployment", istiocsr.GetNamespace(), istiocsr.GetName())
 	return false, nil
 }
+
+// buildEnqueueMapFunc returns the map function used to enqueue reconcile requests
+// when watched resources change.
+func (r *Reconciler) buildEnqueueMapFunc() func(ctx context.Context, obj client.Object) []reconcile.Request {
+	return func(_ context.Context, obj client.Object) []reconcile.Request {
+		r.log.V(4).Info("received reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
+
+		objLabels := obj.GetLabels()
+		if objLabels == nil {
+			r.log.V(4).Info("object not of interest, ignoring reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
+			return []reconcile.Request{}
+		}
+
+		// will look for custom label set on objects not created in istiocsr namespace, and if it exists,
+		// namespace in the reconcile request will be set same, else since label check matches is an object
+		// created by controller, and we safely assume, it's in the istiocsr namespace.
+		namespace := objLabels[istiocsrNamespaceMappingLabelName]
+		if namespace == "" {
+			namespace = obj.GetNamespace()
+		}
+
+		if ok, ns := r.enqueueableNamespace(objLabels, obj, namespace); ok && ns != "" {
+			return []reconcile.Request{
+				{
+					NamespacedName: types.NamespacedName{
+						Name:      istiocsrObjectName,
+						Namespace: ns,
+					},
+				},
+			}
+		}
+
+		r.log.V(4).Info("object not of interest, ignoring reconcile event", "object", fmt.Sprintf("%T", obj), "name", obj.GetName(), "namespace", obj.GetNamespace())
+		return []reconcile.Request{}
+	}
+}
+
+// enqueueableNamespace checks whether the object's labels indicate it should
+// trigger a reconcile and returns the resolved namespace. The defaultNS is used
+// when no watch-label override is present.
+func (r *Reconciler) enqueueableNamespace(objLabels map[string]string, obj client.Object, defaultNS string) (bool, string) {
+	if objLabels[common.ManagedResourceLabelKey] == RequestEnqueueLabelValue {
+		return true, defaultNS
+	}
+	value := objLabels[IstiocsrResourceWatchLabelName]
+	if value == "" {
+		return false, ""
+	}
+	key := strings.Split(value, "_")
+	if len(key) != 2 {
+		r.log.Error(errInvalidLabelFormat, "%s label value(%s) not in expected format on %s resource", IstiocsrResourceWatchLabelName, value, obj.GetName())
+		return false, ""
+	}
+	return true, key[0]
+}