Improve port forwarding

Tool: gitpod/catfood.gitpod.cloud

Author: mustard-mh

components/ide/jetbrains/backend-plugin/src/main/kotlin/io/gitpod/jetbrains/remote/AbstractGitpodPortForwardingService.kt

@@ -47,6 +47,9 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
     // Last observed ports list, used to prevent duplicate processing
     private var lastPortsList = listOf<PortsStatus>()
 
+    // Debounce job for port updates
+    private var debounceJob: Job? = null
+
     init { start() }
 
     private fun start() {
@@ -98,15 +101,24 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
             }
 
             override fun onNext(response: Status.PortsStatusResponse) {
-                application.invokeLater {
-                    if (syncInProgress.compareAndSet(false, true)) {
-                        try {
-                            syncPortsListWithClient(response)
-                        } finally {
-                            syncInProgress.set(false)
+                // Cancel previous debounce job if exists
+                debounceJob?.cancel()
+
+                // Create new debounce job
+                debounceJob = runJob(lifetime) {
+                    delay(300) // 300ms debounce delay
+                    try {
+                        if (syncInProgress.compareAndSet(false, true)) {
+                            try {
+                                syncPortsListWithClient(response)
+                            } finally {
+                                syncInProgress.set(false)
+                            }
+                        } else {
+                            thisLogger().debug("gitpod: Sync already in progress, skipping update")
                         }
-                    } else {
-                        thisLogger().debug("gitpod: Sync already in progress, skipping update")
+                    } finally {
+                        debounceJob = null
                     }
                 }
             }
@@ -145,48 +157,55 @@ abstract class AbstractGitpodPortForwardingService : GitpodPortForwardingService
         val portsNumbersFromNonServedPorts = portsList.filter { !it.served }.map { it.localPort }
 
         // Clean up unused port lifetimes
-        val allCurrentPorts = perClientPortForwardingManager.getPorts()
         val allPortsToKeep = mutableSetOf<Int>()
 
-        // Find ports that need to start forwarding
         val servedPortsToStartForwarding = servedPorts.filter {
             perClientPortForwardingManager.getPorts(it.localPort).none { p -> p.labels.contains(FORWARDED_PORT_LABEL) }
         }
 
-        // Find ports that need to start exposing on client
         val exposedPortsToStartExposingOnClient = exposedPorts.filter {
             perClientPortForwardingManager.getPorts(it.localPort).none { p -> p.labels.contains(EXPOSED_PORT_LABEL) }
         }
 
-        // Find ports that need to stop forwarding
         val forwardedPortsToStopForwarding = perClientPortForwardingManager.getPorts(FORWARDED_PORT_LABEL)
             .map { it.hostPortNumber }
             .filter { portsNumbersFromNonServedPorts.contains(it) || !portsNumbersFromPortsList.contains(it) }
 
-        // Find ports that need to stop exposing on client
         val exposedPortsToStopExposingOnClient = perClientPortForwardingManager.getPorts(EXPOSED_PORT_LABEL)
             .map { it.hostPortNumber }
             .filter { portsNumbersFromNonServedPorts.contains(it) || !portsNumbersFromPortsList.contains(it) }
 
-        forwardedPortsToStopForwarding.forEach { stopForwarding(it) }
-        exposedPortsToStopExposingOnClient.forEach { stopExposingOnClient(it) }
+        // Process port changes in background
+        runJob(lifetime) {
+            try {
+                // Stop unnecessary ports first
+                forwardedPortsToStopForwarding.forEach { stopForwarding(it) }
+                exposedPortsToStopExposingOnClient.forEach { stopExposingOnClient(it) }
+
+                // Start necessary ports
+                servedPortsToStartForwarding.forEach {
+                    startForwarding(it)
+                    allPortsToKeep.add(it.localPort)
+                }
 
-        servedPortsToStartForwarding.forEach {
-            startForwarding(it)
-            allPortsToKeep.add(it.localPort)
-        }
+                exposedPortsToStartExposingOnClient.forEach {
+                    startExposingOnClient(it)
+                    allPortsToKeep.add(it.localPort)
+                }
 
-        exposedPortsToStartExposingOnClient.forEach {
-            startExposingOnClient(it)
-            allPortsToKeep.add(it.localPort)
-        }
+                // Update presentation for all ports
+                application.invokeLater {
+                    portsList.forEach {
+                        updatePortsPresentation(it)
+                        allPortsToKeep.add(it.localPort)
+                    }
+                }
 
-        portsList.forEach {
-            updatePortsPresentation(it)
-            allPortsToKeep.add(it.localPort)
+                cleanupUnusedLifetimes(allPortsToKeep)
+            } catch (e: Exception) {
+                thisLogger().error("gitpod: Error during port synchronization", e)
+            }
         }
-
-        cleanupUnusedLifetimes(allPortsToKeep)
     }
 
     private fun cleanupUnusedLifetimes(portsToKeep: Set<Int>) {