feat: Gateway: The workspaces listed in the "Connect to Dev Spaces" wizard should have their states updated automatically #23653

Fixes: eclipse-che/che#23653

Signed-off-by: Victor Rubezhny <[email protected]>
Assisted by: OpenAI ChatGPT

Author: vrubezhny

build.gradle.kts

@@ -40,8 +40,16 @@ dependencies {
     testImplementation("io.mockk:mockk:1.14.6")
     testImplementation("io.mockk:mockk-agent-jvm:1.14.6")
 
-    implementation("org.jetbrains.kotlinx:kotlinx-coroutines-core:1.10.2")
-    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.10.2")
+    // Do NOT bundle kotlinx-coroutines: IntelliJ/Gateway provides its own version.
+    // Adding another copy causes classloader conflicts, broken cancellation, and runtime errors.
+    testImplementation("org.jetbrains.kotlinx:kotlinx-coroutines-test:1.10.2") {
+        // prevent coroutines-core from ending up inside the plugin
+        exclude(group = "org.jetbrains.kotlinx", module = "kotlinx-coroutines-core")
+    }
+    configurations.all {
+        // prevent coroutines-core from ending up inside the plugin
+        exclude(group = "org.jetbrains.kotlinx", module = "kotlinx-coroutines-core")
+    }
 
     // IntelliJ Platform Gradle Plugin Dependencies Extension - read more: https://plugins.jetbrains.com/docs/intellij/tools-intellij-platform-gradle-plugin-dependencies-extension.html
     intellijPlatform {

src/main/kotlin/com/redhat/devtools/gateway/openshift/DevWorkspaceWatcher.kt

@@ -0,0 +1,103 @@
+/*
+ * 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 com.intellij.openapi.application.EDT
+import io.kubernetes.client.openapi.ApiClient
+import io.kubernetes.client.util.Watch
+import kotlinx.coroutines.*
+
+interface DevWorkspaceListener {
+    fun onAdded(dw: DevWorkspace)
+    fun onUpdated(dw: DevWorkspace)
+    fun onDeleted(dw: DevWorkspace)
+}
+
+class DevWorkspaceWatcher(
+    private val namespace: String,
+    private val createWatcher: (namespace: String, latestResourceVersion: String?) -> Watch<Any>,
+    private val createFilter: (String) -> ((DevWorkspace) -> Boolean),
+    private val listener: DevWorkspaceListener,
+    private val scope: CoroutineScope,
+) {
+    private var job: Job? = null
+
+    fun start(latestResourceVersion: String? = null) {
+        job = scope.launch {
+            watchLoop(latestResourceVersion)
+        }
+    }
+
+    fun stop() {
+        job?.cancel()
+        job = null
+    }
+
+    private suspend fun watchLoop(latestResourceVersion: String? = null) {
+        while (scope.isActive) {
+            val watcher = createWatcher(namespace, latestResourceVersion)
+            val matches = createFilter(namespace)
+
+            try {
+                for (event in watcher) {
+                    if (!scope.isActive) break
+
+                    val dw = DevWorkspace.from(event.`object`)
+                    withContext(Dispatchers.EDT) {
+                        when (event.type) {
+                            "ADDED"    -> if(matches(dw)) listener.onAdded(dw)
+                            "MODIFIED" -> if(matches(dw)) listener.onUpdated(dw) else listener.onDeleted(dw)
+                            "DELETED"  -> listener.onDeleted(dw)
+                        }
+                    }
+                }
+            } catch (_: Exception) {
+                // connection dropped or closed — reconnect
+            } finally {
+                watcher.close()
+            }
+
+            delay(100)
+        }
+    }
+}
+
+class DevWorkspaceWatchManager(
+    private val client: ApiClient,
+    private val createWatcher: (String, String?) -> Watch<Any>,
+    private val createFilter: (String) -> ((DevWorkspace) -> Boolean),
+    private val listener: DevWorkspaceListener,
+    private val scope: CoroutineScope = CoroutineScope(SupervisorJob() + Dispatchers.IO)
+) {
+    private val watchers = mutableListOf<DevWorkspaceWatcher>()
+
+    fun start(lastResourceVersions: Map<String, String?>? = null) {
+        Projects(client).list().onEach { project ->
+            val ns = Utils.getValue(project, arrayOf("metadata","name")) as String
+            val w = DevWorkspaceWatcher(
+                namespace = ns,
+                createWatcher = createWatcher,
+                createFilter = createFilter,
+                listener = listener,
+                scope = scope
+            )
+            watchers += w
+            w.start(lastResourceVersions?.get(ns))
+        }
+    }
+
+    fun stop() {
+        watchers.forEach { it.stop() }
+        watchers.clear()
+    }
+}
+

src/main/kotlin/com/redhat/devtools/gateway/openshift/DevWorkspaces.kt

@@ -26,6 +26,11 @@ import java.io.IOException
 import java.util.concurrent.CancellationException
 import kotlin.time.Duration.Companion.seconds
 
+data class DevWorkspaceListResult(
+    val items: List<DevWorkspace>,
+    val resourceVersion: String?
+)
+
 class DevWorkspaces(private val client: ApiClient) {
     private val customApi = CustomObjectsApi(client)
 
@@ -41,8 +46,8 @@ class DevWorkspaces(private val client: ApiClient) {
     }
 
     @Throws(ApiException::class)
-    fun list(namespace: String): List<DevWorkspace> {
-       try {
+    fun listWithResult(namespace: String): DevWorkspaceListResult {
+        try {
             val response = customApi.listNamespacedCustomObject(
                 "workspace.devfile.io",
                 "v1alpha2",
@@ -52,12 +57,12 @@ class DevWorkspaces(private val client: ApiClient) {
 
             val devWorkspaceTemplateMap = getDevWorkspaceTemplateMap(namespace)
             val dwItems = Utils.getValue(response, arrayOf("items")) as List<*>
-            return dwItems
-                .stream()
+            val dwList = dwItems
                 .map { dwItem -> DevWorkspace.from(dwItem) }
                 .filter { isIdeaEditorBased(it, devWorkspaceTemplateMap) }
-                .toList()
+            val lastResourceVersion = (Utils.getValue(response, arrayOf("metadata", "resourceVersion")) as String?)
 
+            return DevWorkspaceListResult(dwList, lastResourceVersion)
         } catch (e: ApiException) {
             thisLogger().info(e.message)
 
@@ -67,7 +72,7 @@ class DevWorkspaces(private val client: ApiClient) {
             // It doesn't make sense to show an error to the user in such cases,
             // so let's skip it silently.
             if ((response["code"] as Double) == 403.0) {
-                return emptyList()
+                return DevWorkspaceListResult(emptyList(), null)
             } else {
                 // The error will be shown in the Gateway UI.
                 thisLogger().error(e.message)
@@ -76,6 +81,11 @@ class DevWorkspaces(private val client: ApiClient) {
         }
     }
 
+    @Throws(ApiException::class)
+    fun list(namespace: String): List<DevWorkspace> {
+       return listWithResult(namespace).items
+    }
+
     fun isIdeaEditorBased(devWorkspace: DevWorkspace, devWorkspaceTemplateMap: Map<String, List<DevWorkspaceTemplate>>): Boolean {
         // Quick editor ID check
         val segment = devWorkspace.cheEditor?.split("/")?.getOrNull(1)
@@ -98,6 +108,16 @@ class DevWorkspaces(private val client: ApiClient) {
         }
     }
 
+    // Creates a filter for the Idea-based DevWorkspaces
+    fun createFilter(
+        namespace: String
+    ): (DevWorkspace) -> Boolean {
+        val templateMap = getDevWorkspaceTemplateMap(namespace)
+        return { dw: DevWorkspace ->
+            isIdeaEditorBased(dw, templateMap)
+        }
+    }
+
     fun get(namespace: String, name: String): DevWorkspace {
         val dwObj = customApi.getNamespacedCustomObject(
             "workspace.devfile.io",
@@ -155,7 +175,7 @@ class DevWorkspaces(private val client: ApiClient) {
         return withTimeoutOrNull(timeout.seconds) {
             while (true) {
                 checkCancelled?.invoke()
-                val watcher = createWatcher(namespace, "metadata.name=$name")
+                val watcher = createWatcher(namespace, "metadata.name=$name", latestResourceVersion = null)
                 try {
                     while (true) {
                         checkCancelled?.invoke()
@@ -178,7 +198,7 @@ class DevWorkspaces(private val client: ApiClient) {
                     watcher.close()
                 }
 
-                // Watch ended because server closed the stream → retry a new watch
+                // Watch ended because server closed the stream - retry a new watch
                 delay(200)
             }
 
@@ -199,7 +219,7 @@ class DevWorkspaces(private val client: ApiClient) {
         return withTimeoutOrNull(timeout.seconds) {
             while (true) {
                 checkCancelled?.invoke()
-                val watcher = createWatcher(namespace, "metadata.name=$name")
+                val watcher = createWatcher(namespace, "metadata.name=$name", latestResourceVersion = null)
                 try {
                     while (true) {
                         checkCancelled?.invoke()
@@ -218,7 +238,7 @@ class DevWorkspaces(private val client: ApiClient) {
                     watcher.close()
                 }
 
-                // Watch ended because server closed the stream → retry a new watch
+                // Watch ended because server closed the stream - retry a new watch
                 delay(200)
             }
 
@@ -250,7 +270,7 @@ 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> {
+    fun createWatcher(namespace: String, fieldSelector: String = "", labelSelector: String = "", latestResourceVersion: String? = null): Watch<Any> {
         return Watch.createWatch(
             client,
             customApi.listNamespacedCustomObject(
@@ -260,6 +280,7 @@ class DevWorkspaces(private val client: ApiClient) {
                 "devworkspaces"
             ).fieldSelector(fieldSelector)
                 .labelSelector(labelSelector)
+                .resourceVersion(latestResourceVersion)
                 .watch(true)
                 .buildCall(null),
             object : TypeToken<Watch.Response<Any>>() {}.type

src/main/kotlin/com/redhat/devtools/gateway/view/steps/DevSpacesServerStepView.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/
@@ -66,6 +66,7 @@ class DevSpacesServerStepView(
             addItemListener(::onClusterSelected)
             PasteClipboardMenu.addTo(this.editor.editorComponent as JTextField)
         }
+
     override val component = panel {
         row {
             label(DevSpacesBundle.message("connector.wizard_step.openshift_connection.title")).applyToComponent {
@@ -141,7 +142,7 @@ class DevSpacesServerStepView(
         ProgressManager.getInstance().runProcessWithProgressSynchronously(
             {
                 try {
-                    Projects(client).list()
+                    Projects(client).isAuthenticated()
                     success = true
                 } catch (e: Exception) {
                     Dialogs.error(e.message(), "Connection failed")