fix: Gateway plugin should list the workspaces created from a custom editor definition

vrubezhny · adietish · commit 09f7223ee654 · 2025-10-16T10:39:10.000+02:00
The DevWorkspaceTemplate object is used to detect if the JetBrains Idea based editor was used to create a WS Fixes: eclipse-che/che#23610 Signed-off-by: Victor Rubezhny <vrubezhny@redhat.com>
diff --git a/src/main/kotlin/com/redhat/devtools/gateway/openshift/DevWorkspace.kt b/src/main/kotlin/com/redhat/devtools/gateway/openshift/DevWorkspace.kt
@@ -28,6 +28,11 @@ data class DevWorkspace(
             return metadata.name
         }
 
+    val uid: String
+        get() {
+            return metadata.uid
+        }
+
     val started: Boolean
         get() {
             return spec.started
@@ -43,9 +48,9 @@ data class DevWorkspace(
             return status.running
         }
 
-    val editor: String
+    val cheEditor: String?
         get() {
-            return metadata.editor
+            return metadata.cheEditor
         }
 
     companion object {
@@ -70,7 +75,7 @@ data class DevWorkspace(
 
         if (metadata.name != other.metadata.name) return false
         if (metadata.namespace != other.metadata.namespace) return false
-        if (metadata.editor != other.metadata.editor) return false
+        if (metadata.cheEditor != other.metadata.cheEditor) return false
 
         return true
     }
@@ -86,18 +91,21 @@ data class DevWorkspace(
 data class DevWorkspaceObjectMeta(
     val name: String,
     val namespace: String,
-    val editor: String
+    val uid: String,
+    val cheEditor: String?
 ) {
     companion object {
         fun from(map: Any) = object {
             val name = Utils.getValue(map, arrayOf("name"))
             val namespace = Utils.getValue(map, arrayOf("namespace"))
-            val editor = Utils.getValue(map, arrayOf("annotations", "che.eclipse.org/che-editor")) ?: "unknown"
+            val uid = Utils.getValue(map, arrayOf("uid"))
+            val cheEditor = Utils.getValue(map, arrayOf("annotations", "che.eclipse.org/che-editor"))
 
             val data = DevWorkspaceObjectMeta(
                 name as String,
                 namespace as String,
-                editor as String
+                uid as String,
+                cheEditor as String?
             )
         }.data
     }
diff --git a/src/main/kotlin/com/redhat/devtools/gateway/openshift/DevWorkspaceTemplate.kt b/src/main/kotlin/com/redhat/devtools/gateway/openshift/DevWorkspaceTemplate.kt
@@ -0,0 +1,137 @@
+/*
+ * Copyright (c) 2025 Red Hat, Inc.
+ * This program and the accompanying materials are made
+ * available under the terms of the Eclipse Public License 2.0
+ * which is available at https://www.eclipse.org/legal/epl-2.0/
+ *
+ * SPDX-License-Identifier: EPL-2.0
+ *
+ * Contributors:
+ *   Red Hat, Inc. - initial API and implementation
+ */
+package com.redhat.devtools.gateway.openshift
+
+import java.util.Collections
+
+data class DevWorkspaceTemplate (
+    private val metadata: DevWorkspaceTemplateMetadata,
+    private val spec: DevWorkspaceTemplateSpec,
+) {
+    val namespace: String
+        get() {
+            return metadata.namespace
+        }
+
+    val name: String
+        get() {
+            return metadata.name
+        }
+
+    val ownerRefencesUids: List<String>
+        get() {
+            return metadata.ownerRefencesUids
+        }
+
+    val components: Any
+        get() {
+            return spec.components
+        }
+
+    val pluginRegistryUrl: String?
+        get() {
+            return metadata.pluginRegistryUrl
+        }
+
+
+    companion object {
+        fun from(map: Any?) = object {
+            val metadata = Utils.getValue(map, arrayOf("metadata")) ?: Collections.emptyMap<String, Any>()
+            val spec = Utils.getValue(map, arrayOf("spec")) ?: Collections.emptyMap<String, Any>()
+
+            val data = DevWorkspaceTemplate(
+                DevWorkspaceTemplateMetadata.from(metadata),
+                DevWorkspaceTemplateSpec.from(spec)
+            )
+        }.data
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+
+        other as DevWorkspaceTemplate
+
+        if (metadata.name != other.name) return false
+        if (metadata.namespace != other.namespace) return false
+        if (metadata.pluginRegistryUrl != other.pluginRegistryUrl) return false
+        if (metadata.ownerRefencesUids != other.ownerRefencesUids) return false
+
+        return true
+    }
+
+    override fun hashCode(): Int {
+        var result = metadata.hashCode()
+        result = 31 * result + spec.hashCode()
+        return result
+    }
+}
+
+data class DevWorkspaceTemplateMetadata(
+    val name: String,
+    val namespace: String,
+    val pluginRegistryUrl: String?,
+    val ownerRefencesUids: List<String>
+) {
+    companion object {
+        fun from(map: Any) = object {
+            val name = Utils.getValue(map, arrayOf("name"))
+            val namespace = Utils.getValue(map, arrayOf("namespace"))
+            val pluginRegistryUrl = Utils.getValue(map, arrayOf("annotations", "che.eclipse.org/plugin-registry-url"))
+
+            @Suppress("UNCHECKED_CAST")
+            val ownerRefs = Utils.getValue(map, arrayOf("ownerReferences")) as? List<Map<String, Any>>
+            val ownerRefUids: List<String> = ownerRefs
+                ?.filter {
+                    (it["apiVersion"] as? String)?.equals("workspace.devfile.io/v1alpha2", ignoreCase = true) == true &&
+                            (it["kind"] as? String)?.equals("DevWorkspace", ignoreCase = true) == true
+                }
+                ?.mapNotNull { it["uid"] as? String }
+                ?: emptyList()
+
+            val data = DevWorkspaceTemplateMetadata(
+                name as String,
+                namespace as String,
+                pluginRegistryUrl as String?,
+                ownerRefUids
+            )
+        }.data
+    }
+}
+
+data class DevWorkspaceTemplateSpec(
+    val components: List<Map<String, Any>>
+) {
+    companion object {
+        fun from(map: Any) = object {
+            val rawComponents: Any? = Utils.getValue(map, arrayOf("components"))
+            val components = if (rawComponents is List<*>) {
+                rawComponents.filterIsInstance<Map<String, Any>>()
+            } else {
+                emptyList()
+            }
+            val data = DevWorkspaceTemplateSpec(components)
+        }.data
+    }
+
+    override fun equals(other: Any?): Boolean {
+        if (this === other) return true
+        if (javaClass != other?.javaClass) return false
+        if (other !is DevWorkspaceTemplateSpec) return false
+
+        return components == other.components
+    }
+
+    override fun hashCode(): Int {
+        return components.hashCode()
+    }
+}
diff --git a/src/main/kotlin/com/redhat/devtools/gateway/openshift/DevWorkspaces.kt b/src/main/kotlin/com/redhat/devtools/gateway/openshift/DevWorkspaces.kt
@@ -25,7 +25,11 @@ import java.util.concurrent.Executors
 import java.util.concurrent.TimeUnit
 
 class DevWorkspaces(private val client: ApiClient) {
+    private val customApi = CustomObjectsApi(client)
+
     companion object {
+        private val CHE_EDITOR_ID_REGEX = Regex("che-.*-server", RegexOption.IGNORE_CASE)
+
         val FAILED: String = "Failed"
         val RUNNING: String = "Running"
         val STOPPED: String = "Stopped"
@@ -35,25 +39,22 @@ class DevWorkspaces(private val client: ApiClient) {
 
     @Throws(ApiException::class)
     fun list(namespace: String): List<DevWorkspace> {
-        val customApi = CustomObjectsApi(client)
-        try {
+       try {
             val response = customApi.listNamespacedCustomObject(
                 "workspace.devfile.io",
                 "v1alpha2",
                 namespace,
                 "devworkspaces"
             ).execute()
 
+            val devWorkspaceTemplateMap = getDevWorkspaceTemplateMap(namespace)
             val dwItems = Utils.getValue(response, arrayOf("items")) as List<*>
             return dwItems
                 .stream()
                 .map { dwItem -> DevWorkspace.from(dwItem) }
-                .filter {
-                    val parts = it.editor.split("/")
-                    val segment = parts.getOrNull(1) ?: return@filter false
-                    Regex("che-.*-server").matches(segment)
-                }
+                .filter { isIdeaEditorBased(it, devWorkspaceTemplateMap) }
                 .toList()
+
         } catch (e: ApiException) {
             thisLogger().info(e.message)
 
@@ -72,8 +73,29 @@ class DevWorkspaces(private val client: ApiClient) {
         }
     }
 
+    fun isIdeaEditorBased(devWorkspace: DevWorkspace, devWorkspaceTemplateMap: Map<String, List<DevWorkspaceTemplate>>): Boolean {
+        // Quick editor ID check
+        val segment = devWorkspace.cheEditor?.split("/")?.getOrNull(1)
+        if (segment != null && CHE_EDITOR_ID_REGEX.matches(segment)) {
+             return true
+        }
+
+        // DevWorkspace Template check
+        val templates = devWorkspaceTemplateMap[devWorkspace.uid] ?: return false
+        return templates.any { template ->
+            @Suppress("UNCHECKED_CAST")
+            val components = template.components as? List<Any> ?: return@any false
+            components.any { component: Any ->
+                val map = component as? Map<*, *> ?: return@any false
+                val volume = map["volume"] as? Map<*, *>
+                // Check 'volume.name' first (v1alpha1), fallback to top-level 'name' (v1alpha2)
+                val name = volume?.get("name") as? String ?: map["name"] as? String
+                name.equals("idea-server", ignoreCase = true)
+            }
+        }
+    }
+
     fun get(namespace: String, name: String): DevWorkspace {
-        val customApi = CustomObjectsApi(client)
         val dwObj = customApi.getNamespacedCustomObject(
             "workspace.devfile.io",
             "v1alpha2",
@@ -84,6 +106,29 @@ class DevWorkspaces(private val client: ApiClient) {
         return DevWorkspace.from(dwObj)
     }
 
+    // Returns a map of DW Owner UID tp list of DW Templates
+    fun getDevWorkspaceTemplateMap(namespace: String): Map<String, List<DevWorkspaceTemplate>> {
+        val dwTemplateList = customApi
+            .listNamespacedCustomObject(
+                "workspace.devfile.io",
+                "v1alpha2",
+                namespace,
+                "devworkspacetemplates",
+            )
+            .execute()
+
+        val items = Utils.getValue(dwTemplateList, arrayOf("items")) as? List<*> ?: emptyList<Any>()
+        return items
+            .map { DevWorkspaceTemplate.from(it) }
+            .flatMap { templ ->
+                templ.ownerRefencesUids.map { uid -> uid to templ }
+            }
+            .groupBy(
+                keySelector = { it.first },   // UID
+                valueTransform = { it.second } // DevWorkspaceTemplate
+            )
+    }
+
     @Throws(ApiException::class)
     fun start(namespace: String, name: String) {
         val patch = arrayOf(mapOf("op" to "replace", "path" to "/spec/started", "value" to true))
@@ -140,7 +185,6 @@ class DevWorkspaces(private val client: ApiClient) {
     // https://github.com/kubernetes-client/java/blob/master/examples/examples-release-20/src/main/java/io/kubernetes/client/examples/PatchExample.java
     @Throws(ApiException::class)
     private fun doPatch(namespace: String, name: String, body: Any) {
-        val customApi = CustomObjectsApi(client)
         PatchUtils.patch(
             DevWorkspace.javaClass,
             {
@@ -161,10 +205,9 @@ class DevWorkspaces(private val client: ApiClient) {
     // Example:
     // https://github.com/kubernetes-client/java/blob/master/examples/examples-release-20/src/main/java/io/kubernetes/client/examples/WatchExample.java
     private fun createWatcher(namespace: String, fieldSelector: String = "", labelSelector: String = ""): Watch<Any> {
-        val customObjectsApi = CustomObjectsApi(client)
         return Watch.createWatch(
             client,
-            customObjectsApi.listNamespacedCustomObject(
+            customApi.listNamespacedCustomObject(
                 "workspace.devfile.io",
                 "v1alpha2",
                 namespace,
diff --git a/src/main/kotlin/com/redhat/devtools/gateway/openshift/Utils.kt b/src/main/kotlin/com/redhat/devtools/gateway/openshift/Utils.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 Red Hat, Inc.
+ * Copyright (c) 2024-2025 Red Hat, Inc.
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
  * which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -20,7 +20,7 @@ object Utils {
 
         var value = obj
         for (s in path) {
-            value = (value as Map<*, *>)[s]
+            value = (value as Map<*, *>)[s] ?: return null
         }
 
         return value
diff --git a/src/main/kotlin/com/redhat/devtools/gateway/view/steps/DevSpacesWorkspacesStepView.kt b/src/main/kotlin/com/redhat/devtools/gateway/view/steps/DevSpacesWorkspacesStepView.kt
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2024 Red Hat, Inc.
+ * Copyright (c) 2024-2025 Red Hat, Inc.
  * This program and the accompanying materials are made
  * available under the terms of the Eclipse Public License 2.0
  * which is available at https://www.eclipse.org/legal/epl-2.0/
@@ -116,6 +116,7 @@ class DevSpacesWorkspacesStepView(
                     doRefreshAllDevWorkspaces()
                     enableButtons()
                 } catch (e: Exception) {
+                    thisLogger().error("Refreshing workspaces failed.", e)
                     Dialogs.error("Could not refresh workspaces: " + e.messageWithoutPrefix(), "Error Refreshing")
                 }
             },
