Fix setting finalizer on workspaces

Fix the check for whether a finalizer is necessary to use the flattened
workspace. Otherwise, we may miss some components that need storage (and
so need to be finalized) if they are defined as plugins.

Signed-off-by: Angel Misevski <[email protected]>

Author: amisevsk

controllers/workspace/devworkspace_controller.go

@@ -132,13 +132,6 @@ func (r *DevWorkspaceReconciler) Reconcile(req ctrl.Request) (reconcileResult ct
 		return r.stopWorkspace(workspace, reqLogger)
 	}
 
-	// Set finalizer on DevWorkspace if necessary
-	if ok, err := r.setFinalizer(ctx, workspace); err != nil {
-		return reconcile.Result{}, err
-	} else if !ok {
-		return reconcile.Result{Requeue: true}, nil
-	}
-
 	// Prepare handling workspace status and condition
 	reconcileStatus := currentStatus{
 		Conditions: map[devworkspace.WorkspaceConditionType]string{},
@@ -194,6 +187,15 @@ func (r *DevWorkspaceReconciler) Reconcile(req ctrl.Request) (reconcileResult ct
 		return reconcile.Result{}, nil
 	}
 	workspace.Spec.Template = *flattenedWorkspace
+	// Set finalizer on DevWorkspace if necessary
+	// Note: we need to check the flattened workspace to see if a finalizer is needed, as plugins could require storage
+	if isFinalizerNecessary(workspace) {
+		if ok, err := r.setFinalizer(ctx, clusterWorkspace); err != nil {
+			return reconcile.Result{}, err
+		} else if !ok {
+			return reconcile.Result{Requeue: true}, nil
+		}
+	}
 
 	devfilePodAdditions, err := containerlib.GetKubeContainersFromDevfile(workspace.Spec.Template)
 	if err != nil {

controllers/workspace/finalize.go

@@ -51,8 +51,10 @@ var (
 	PVCCleanupPodMemoryLimit = resource.MustParse("32Mi")
 )
 
+// setFinalizer sets a finalizer on the workspace and syncs the changes to the cluster. No-op if the workspace already
+// has the finalizer set.
 func (r *DevWorkspaceReconciler) setFinalizer(ctx context.Context, workspace *v1alpha2.DevWorkspace) (ok bool, err error) {
-	if !isFinalizerNecessary(workspace) || hasFinalizer(workspace) {
+	if hasFinalizer(workspace) {
 		return true, nil
 	}
 	workspace.SetFinalizers(append(workspace.Finalizers, pvcCleanupFinalizer))