Ignore but requeue conflict errors

Author: NickCao

internal/controller/client_controller.go

@@ -45,6 +45,8 @@ type ClientReconciler struct {
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.18.2/pkg/reconcile
 func (r *ClientReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	logger := log.FromContext(ctx).WithValues("client", req.NamespacedName)
+
 	var client jumpstarterdevv1alpha1.Client
 	if err := r.Get(ctx, req.NamespacedName, &client); err != nil {
 		return ctrl.Result{}, kclient.IgnoreNotFound(
@@ -63,7 +65,7 @@ func (r *ClientReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctr
 	}
 
 	if err := r.Status().Patch(ctx, &client, original); err != nil {
-		return ctrl.Result{}, err
+		return RequeueConflict(logger, ctrl.Result{}, err)
 	}
 
 	return ctrl.Result{}, nil

internal/controller/errors.go

@@ -0,0 +1,16 @@
+package controller
+
+import (
+	"github.com/go-logr/logr"
+	apierrors "k8s.io/apimachinery/pkg/api/errors"
+	ctrl "sigs.k8s.io/controller-runtime"
+)
+
+func RequeueConflict(logger logr.Logger, result ctrl.Result, err error) (ctrl.Result, error) {
+	if apierrors.IsConflict(err) {
+		logger.V(1).Info("Ignoring conflict error but requeuing the reconcilation request", "error", err)
+		return ctrl.Result{Requeue: true}, nil
+	} else {
+		return result, err
+	}
+}

internal/controller/exporter_controller.go

@@ -52,6 +52,8 @@ type ExporterReconciler struct {
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.18.2/pkg/reconcile
 func (r *ExporterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	logger := log.FromContext(ctx).WithValues("exporter", req.NamespacedName)
+
 	var exporter jumpstarterdevv1alpha1.Exporter
 	if err := r.Get(ctx, req.NamespacedName, &exporter); err != nil {
 		return ctrl.Result{}, client.IgnoreNotFound(
@@ -74,7 +76,7 @@ func (r *ExporterReconciler) Reconcile(ctx context.Context, req ctrl.Request) (c
 	}
 
 	if err := r.Status().Patch(ctx, &exporter, original); err != nil {
-		return ctrl.Result{}, err
+		return RequeueConflict(logger, ctrl.Result{}, err)
 	}
 
 	return ctrl.Result{}, nil

internal/controller/lease_controller.go

@@ -54,6 +54,8 @@ type LeaseReconciler struct {
 // For more details, check Reconcile and its Result here:
 // - https://pkg.go.dev/sigs.k8s.io/controller-runtime@v0.18.4/pkg/reconcile
 func (r *LeaseReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
+	logger := log.FromContext(ctx).WithValues("lease", req.NamespacedName)
+
 	var lease jumpstarterdevv1alpha1.Lease
 	if err := r.Get(ctx, req.NamespacedName, &lease); err != nil {
 		return ctrl.Result{}, client.IgnoreNotFound(
@@ -75,7 +77,7 @@ func (r *LeaseReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl
 	}
 
 	if err := r.Status().Update(ctx, &lease); err != nil {
-		return result, err
+		return RequeueConflict(logger, result, err)
 	}
 
 	if lease.Labels == nil {
@@ -99,7 +101,7 @@ func (r *LeaseReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl
 	}
 
 	if err := r.Update(ctx, &lease); err != nil {
-		return result, fmt.Errorf("Reconcile: failed to update lease metadata: %w", err)
+		return RequeueConflict(logger, result, fmt.Errorf("Reconcile: failed to update lease metadata: %w", err))
 	}
 
 	return result, nil