[GW] send additional hb on gateway plugin

Author: mustard-mh

components/ide/jetbrains/gateway-plugin/src/main/kotlin/io/gitpod/jetbrains/gateway/GatewayGitpodClient.kt

@@ -11,6 +11,7 @@ import com.jetbrains.rd.util.concurrentMapOf
 import com.jetbrains.rd.util.lifetime.Lifetime
 import com.jetbrains.rd.util.lifetime.LifetimeDefinition
 import io.gitpod.gitpodprotocol.api.GitpodClient
+import io.gitpod.gitpodprotocol.api.entities.SendHeartBeatOptions
 import io.gitpod.gitpodprotocol.api.entities.WorkspaceInfo
 import io.gitpod.gitpodprotocol.api.entities.WorkspaceInstance
 import kotlinx.coroutines.*
@@ -115,6 +116,10 @@ class GatewayGitpodClient(
         return listener
     }
 
+    suspend fun sendHeartbeat(workspaceId: String) {
+        server.sendHeartBeat(SendHeartBeatOptions(workspaceId)).await()
+    }
+
     private suspend fun removeListener(workspaceId: String, listener: Channel<WorkspaceInstance>) {
         mutex.withLock {
             val listeners = this.listeners[workspaceId]

components/ide/jetbrains/gateway-plugin/src/main/kotlin/io/gitpod/jetbrains/gateway/GitpodConnectionProvider.kt

@@ -47,7 +47,6 @@ import io.gitpod.jetbrains.gateway.common.GitpodConnectionHandleFactory
 import io.gitpod.jetbrains.icons.GitpodIcons
 import kotlinx.coroutines.*
 import kotlinx.coroutines.future.await
-import java.awt.Component
 import java.net.URL
 import java.net.http.HttpClient
 import java.net.http.HttpRequest
@@ -58,6 +57,7 @@ import javax.swing.JLabel
 import kotlin.coroutines.coroutineContext
 import kotlin.io.path.absolutePathString
 import kotlin.io.path.writeText
+import kotlin.random.Random.Default.nextInt
 
 @Suppress("UnstableApiUsage", "OPT_IN_USAGE")
 class GitpodConnectionProvider : GatewayConnectionProvider {
@@ -202,6 +202,27 @@ class GitpodConnectionProvider : GatewayConnectionProvider {
 
             var lastUpdate: WorkspaceInstance? = null
             var canceledByGitpod = false
+
+            if (settings.additionalHeartbeat) {
+                thisLogger().info("gitpod: additional heartbeat enabled for ${connectParams.resolvedWorkspaceId}")
+                connectionLifetime.launch {
+                    while (isActive) {
+                        val delaySeconds = 30 + nextInt(5, 15)
+                        try {
+                            if (lastUpdate?.status?.phase == "running") {
+                                client.sendHeartbeat(connectParams.actualWorkspaceId)
+                            }
+                        } catch (t: Throwable) {
+                            thisLogger().error(
+                                "gitpod: failed to send additional heartbeat for ${connectParams.resolvedWorkspaceId}",
+                                t
+                            )
+                        }
+                        delay(delaySeconds * 1000L)
+                    }
+                }
+            }
+
             try {
                 for (update in updates) {
                     try {

components/ide/jetbrains/gateway-plugin/src/main/kotlin/io/gitpod/jetbrains/gateway/GitpodSettingsConfigurable.kt

@@ -31,6 +31,11 @@ class GitpodSettingsConfigurable : BoundConfigurable("Gitpod") {
                     .comment("Helpful if you are behind a firewall/proxy that blocks SSH or " +
                             "have complicated SSH setup (bastions, proxy jumps, etc.)")
             }
+            row {
+                checkBox("Additional heartbeat")
+                    .bindSelected(state::additionalHeartbeat)
+                    .comment("Additional heartbeat when connection is connected, helps to keep the workspace alive more reliably")
+            }
 
         }
     }

components/ide/jetbrains/gateway-plugin/src/main/kotlin/io/gitpod/jetbrains/gateway/GitpodSettingsState.kt

@@ -45,6 +45,15 @@ class GitpodSettingsState : PersistentStateComponent<GitpodSettingsState> {
             dispatcher.multicaster.didChange()
         }
 
+    var additionalHeartbeat: Boolean = false
+        set(value) {
+            if (value == field) {
+                return
+            }
+            field = value
+            dispatcher.multicaster.didChange()
+        }
+
     private interface Listener : EventListener {
         fun didChange()
     }