Use Patch() to update status of CnsRegisterVolume CR insteaf of Update()

Author: akankshapanse

pkg/syncer/cnsoperator/controller/cnsregistervolume/cnsregistervolume_controller.go

@@ -26,6 +26,7 @@ import (
 	"sync"
 	"time"
 
+	jsonpatch "github.com/evanphx/json-patch/v5"
 	cnstypes "github.com/vmware/govmomi/cns/types"
 	v1 "k8s.io/api/core/v1"
 	apierrors "k8s.io/apimachinery/pkg/api/errors"
@@ -1173,10 +1174,11 @@ func validateAndFixPVVolumeMode(ctx context.Context, k8sclient clientset.Interfa
 func setInstanceError(ctx context.Context, r *ReconcileCnsRegisterVolume,
 	instance *cnsregistervolumev1alpha1.CnsRegisterVolume, errMsg string) {
 	log := logger.GetLogger(ctx)
+	origInstance := instance.DeepCopy()
 	instance.Status.Error = errMsg
-	err := k8s.UpdateStatus(ctx, r.client, instance)
+	err := patchCnsRegisterVolumeStatus(ctx, r.client, origInstance, instance)
 	if err != nil {
-		log.Errorf("updateCnsRegisterVolume failed. err: %v", err)
+		log.Errorf("patchCnsRegisterVolumeStatus failed. err: %v", err)
 		return
 	}
 	recordEvent(ctx, r, instance, v1.EventTypeWarning, errMsg)
@@ -1205,11 +1207,12 @@ func setInstanceSuccess(ctx context.Context, r *ReconcileCnsRegisterVolume,
 		return err
 	}
 	// Now update the status subresource with the fresh object
+	origInstance := instance.DeepCopy()
 	instance.Status.Registered = true
 	instance.Status.Error = ""
-	err = k8s.UpdateStatus(ctx, r.client, instance)
+	err = patchCnsRegisterVolumeStatus(ctx, r.client, origInstance, instance)
 	if err != nil {
-		log.Errorf("updateCnsRegisterVolume status failed. err: %v", err)
+		log.Errorf("patchCnsRegisterVolumeStatus failed. err: %v", err)
 		return err
 	}
 	recordEvent(ctx, r, instance, v1.EventTypeNormal, msg)
@@ -1273,3 +1276,51 @@ func updateCnsRegisterVolume(ctx context.Context, client client.Client,
 	}
 	return err
 }
+
+func getPatchData(oldObj, newObj interface{}) ([]byte, error) {
+	oldData, err := json.Marshal(oldObj)
+	if err != nil {
+		return nil, fmt.Errorf("marshal old object failed: %v", err)
+	}
+	newData, err := json.Marshal(newObj)
+	if err != nil {
+		return nil, fmt.Errorf("marshal new object failed: %v", err)
+	}
+	patchBytes, err := jsonpatch.CreateMergePatch(oldData, newData)
+	if err != nil {
+		return nil, fmt.Errorf("CreateMergePatch failed: %v", err)
+	}
+	return patchBytes, nil
+}
+
+// patchCnsRegisterVolumeStatus patches status field of CnsRegisterVolume instance in K8S.
+func patchCnsRegisterVolumeStatus(ctx context.Context, cnsOperatorClient client.Client,
+	oldObj *cnsregistervolumev1alpha1.CnsRegisterVolume,
+	newObj *cnsregistervolumev1alpha1.CnsRegisterVolume) error {
+	log := logger.GetLogger(ctx)
+	patch, err := getPatchData(oldObj, newObj)
+	if err != nil {
+		log.Errorf("error fetching PatchData CnsRegisterVolume CR. err: %v", err)
+		return err
+	}
+	rawPatch := client.RawPatch(apitypes.MergePatchType, patch)
+	// Try to patch CnsRegisterVolume CR for 3 times
+	allowedRetries := 3
+	attempt := 0
+	for {
+		attempt++
+		err = cnsOperatorClient.Status().Patch(ctx, oldObj, rawPatch)
+		if err != nil && attempt >= allowedRetries {
+			log.Errorf("failed to patch CnsRegisterVolume instance %q on namespace %q, Error: %+v",
+				oldObj.Name, oldObj.Namespace, err)
+			return err
+		} else if err == nil {
+			log.Debugf("Successfully patched CnsRegisterVolume instance %q on namespace %q",
+				oldObj.Name, oldObj.Namespace)
+			return nil
+		}
+		log.Warnf("attempt %d, failed to patch CnsRegisterVolume instance %q on namespace %q with error %+v, "+
+			"will retry...", attempt, oldObj.Name, oldObj.Namespace, err)
+		time.Sleep(100 * time.Millisecond)
+	}
+}