chore: refactor check for enabling home persistence

Signed-off-by: Andrew Obuchowicz <aobuchow@redhat.com>
devfile · Mar 15, 2024 · 60d584c · 60d584c
1 parent 7e53503
commit 60d584c
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 9 deletions.
diff --git a/controllers/workspace/devworkspace_controller.go b/controllers/workspace/devworkspace_controller.go
@@ -291,7 +291,7 @@ func (r *DevWorkspaceReconciler) Reconcile(ctx context.Context, req ctrl.Request
 		return r.failWorkspace(workspace, fmt.Sprintf("Error provisioning storage: %s", err), metrics.ReasonBadRequest, reqLogger, &reconcileStatus), nil
 	}
 
-	if home.StorageStrategySupportsPersistentHome(workspace) && home.NeedsPersistentHomeDirectory(workspace) {
+	if home.NeedsPersistentHomeDirectory(workspace) {
 		workspaceWithHomeVolume, err := home.AddPersistentHomeVolume(workspace)
 		if err != nil {
 			reconcileStatus.addWarning(fmt.Sprintf("Info: default persistentHome volume is not being used: %s", err.Error()))

diff --git a/pkg/library/home/persistentHome.go b/pkg/library/home/persistentHome.go
@@ -60,23 +60,19 @@ func AddPersistentHomeVolume(workspace *common.DevWorkspaceWithConfig) (*v1alpha
 	return dwTemplateSpecCopy, nil
 }
 
-// Returns true if the workspace's storage strategy supports persisting the user home directory.
-// The storage strategies which support home persistence are: per-user/common, per-workspace & async.
-// The ephemeral storage strategy does not support home persistence.
-func StorageStrategySupportsPersistentHome(workspace *common.DevWorkspaceWithConfig) bool {
-	storageClass := workspace.Spec.Template.Attributes.GetString(constants.DevWorkspaceStorageTypeAttribute, nil)
-	return storageClass != constants.EphemeralStorageClassType
-}
-
 // Returns true if the following criteria is met:
 // - `persistUserHome` is enabled in the DevWorkspaceOperatorConfig
+// - The storage strategy used by the DevWorkspace supports home persistence
 // - None of the container components in the DevWorkspace mount a volume to `/home/user/`.
 // - Persistent storage is required for the DevWorkspace
 // Returns false otherwise.
 func NeedsPersistentHomeDirectory(workspace *common.DevWorkspaceWithConfig) bool {
 	if !pointer.BoolDeref(workspace.Config.Workspace.PersistUserHome.Enabled, false) {
 		return false
 	}
+	if !storageStrategySupportsPersistentHome(workspace) {
+		return false
+	}
 	for _, component := range workspace.Spec.Template.Components {
 		if component.Container == nil {
 			continue
@@ -91,3 +87,11 @@ func NeedsPersistentHomeDirectory(workspace *common.DevWorkspaceWithConfig) bool
 	}
 	return storage.WorkspaceNeedsStorage(&workspace.Spec.Template)
 }
+
+// Returns true if the workspace's storage strategy supports persisting the user home directory.
+// The storage strategies which support home persistence are: per-user/common, per-workspace & async.
+// The ephemeral storage strategy does not support home persistence.
+func storageStrategySupportsPersistentHome(workspace *common.DevWorkspaceWithConfig) bool {
+	storageClass := workspace.Spec.Template.Attributes.GetString(constants.DevWorkspaceStorageTypeAttribute, nil)
+	return storageClass != constants.EphemeralStorageClassType
+}