Return VolumeSnapshotContent from removeAnnVolumeSnapshotBeingCreated

Signed-off-by: Grant Griffiths <ggriffiths@purestorage.com>

pkg/sidecar-controller/snapshot_controller.go

@@ -79,9 +79,11 @@ func (ctrl *csiSnapshotSideCarController) syncContent(content *crdv1.VolumeSnaps
 	// already true. We don't want to keep calling CreateSnapshot
 	// or ListSnapshots CSI methods over and over again for
 	// performance reasons.
+	var err error
 	if content.Status != nil && content.Status.ReadyToUse != nil && *content.Status.ReadyToUse == true {
 		// Try to remove AnnVolumeSnapshotBeingCreated if it is not removed yet for some reason
-		return ctrl.removeAnnVolumeSnapshotBeingCreated(content)
+		_, err = ctrl.removeAnnVolumeSnapshotBeingCreated(content)
+		return err
 	}
 	return ctrl.checkandUpdateContentStatus(content)
 }
@@ -307,8 +309,8 @@ func (ctrl *csiSnapshotSideCarController) createSnapshotWrapper(content *crdv1.V
 		// storage system has responded with an error
 		klog.Infof("createSnapshotWrapper: CreateSnapshot for content %s returned error: %v", content.Name, err)
 		if isCSIFinalError(err) {
-			if removeAnnotationErr := ctrl.removeAnnVolumeSnapshotBeingCreated(content); removeAnnotationErr != nil {
-				return nil, fmt.Errorf("failed to remove VolumeSnapshotBeingCreated annotation from the content %s: %s", content.Name, removeAnnotationErr)
+			if content, removeAnnotationErr := ctrl.removeAnnVolumeSnapshotBeingCreated(content); removeAnnotationErr != nil {
+				return content, fmt.Errorf("failed to remove VolumeSnapshotBeingCreated annotation from the content %s: %s", content.Name, removeAnnotationErr)
 			}
 		}
 
@@ -331,7 +333,7 @@ func (ctrl *csiSnapshotSideCarController) createSnapshotWrapper(content *crdv1.V
 	// NOTE(xyang): handle create timeout
 	// Remove annotation to indicate storage system has successfully
 	// cut the snapshot
-	err = ctrl.removeAnnVolumeSnapshotBeingCreated(content)
+	content, err = ctrl.removeAnnVolumeSnapshotBeingCreated(content)
 	if err != nil {
 		return nil, fmt.Errorf("failed to remove VolumeSnapshotBeingCreated annotation on the content %s: %q", content.Name, err)
 	}
@@ -602,27 +604,25 @@ func (ctrl *csiSnapshotSideCarController) setAnnVolumeSnapshotBeingCreated(conte
 
 // removeAnnVolumeSnapshotBeingCreated removes the VolumeSnapshotBeingCreated
 // annotation from a content if there exists one.
-func (ctrl csiSnapshotSideCarController) removeAnnVolumeSnapshotBeingCreated(content *crdv1.VolumeSnapshotContent) error {
+func (ctrl csiSnapshotSideCarController) removeAnnVolumeSnapshotBeingCreated(content *crdv1.VolumeSnapshotContent) (*crdv1.VolumeSnapshotContent, error) {
 	if !metav1.HasAnnotation(content.ObjectMeta, utils.AnnVolumeSnapshotBeingCreated) {
 		// the annotation does not exist, return directly
-		return nil
+		return content, nil
 	}
 	contentClone := content.DeepCopy()
 	delete(contentClone.ObjectMeta.Annotations, utils.AnnVolumeSnapshotBeingCreated)
 
 	updatedContent, err := ctrl.clientset.SnapshotV1().VolumeSnapshotContents().Update(context.TODO(), contentClone, metav1.UpdateOptions{})
 	if err != nil {
-		return newControllerUpdateError(content.Name, err.Error())
+		return content, newControllerUpdateError(content.Name, err.Error())
 	}
-	// update content if update is successful
-	content = updatedContent
 
 	klog.V(5).Infof("Removed VolumeSnapshotBeingCreated annotation from volume snapshot content %s", content.Name)
-	_, err = ctrl.storeContentUpdate(content)
+	_, err = ctrl.storeContentUpdate(updatedContent)
 	if err != nil {
 		klog.Errorf("failed to update content store %v", err)
 	}
-	return nil
+	return updatedContent, nil
 }
 
 // This function checks if the error is final