impl: enhanced workflow for network disruptions

CHANGELOG.md

@@ -2,6 +2,10 @@
 
 ## Unreleased
 
+### Changed
+
+- improved workflow when network connection is flaky
+
 ## 0.5.2 - 2025-07-22
 
 ### Fixed

src/main/kotlin/com/coder/toolbox/CoderRemoteEnvironment.kt

@@ -68,6 +68,13 @@ class CoderRemoteEnvironment(
     private val proxyCommandHandle = SshCommandProcessHandle(context)
     private var pollJob: Job? = null
 
+    init {
+        if (context.settingsStore.shouldAutoConnect(id)) {
+            context.logger.info("resuming SSH connection to $id — last session was still active.")
+            startSshConnection()
+        }
+    }
+
     fun asPairOfWorkspaceAndAgent(): Pair<Workspace, WorkspaceAgent> = Pair(workspace, agent)
 
     private fun getAvailableActions(): List<ActionDescription> {
@@ -158,6 +165,7 @@ class CoderRemoteEnvironment(
     override fun beforeConnection() {
         context.logger.info("Connecting to $id...")
         isConnected.update { true }
+        context.settingsStore.updateAutoConnect(this.id, true)
         pollJob = pollNetworkMetrics()
     }
 
@@ -180,12 +188,9 @@ class CoderRemoteEnvironment(
             }
             context.logger.debug("Loading metrics from ${metricsFile.absolutePath} for $id")
             try {
-                val metrics = networkMetricsMarshaller.fromJson(metricsFile.readText())
-                if (metrics == null) {
-                    return@launch
-                }
+                val metrics = networkMetricsMarshaller.fromJson(metricsFile.readText()) ?: return@launch
                 context.logger.debug("$id metrics: $metrics")
-                additionalEnvironmentInformation.put(context.i18n.ptrl("Network Status"), metrics.toPretty())
+                additionalEnvironmentInformation[context.i18n.ptrl("Network Status")] = metrics.toPretty()
             } catch (e: Exception) {
                 context.logger.error(
                     e,
@@ -203,6 +208,10 @@ class CoderRemoteEnvironment(
         pollJob?.cancel()
         this.connectionRequest.update { false }
         isConnected.update { false }
+        if (isManual) {
+            // if the user manually disconnects the ssh connection we should not connect automatically
+            context.settingsStore.updateAutoConnect(this.id, false)
+        }
         context.logger.info("Disconnected from $id")
     }
 

src/main/kotlin/com/coder/toolbox/CoderRemoteProvider.kt

@@ -166,17 +166,17 @@ class CoderRemoteProvider(
                     context.logger.error(ex, "workspace polling error encountered, trying to auto-login")
                     if (ex is APIResponseException && ex.isTokenExpired) {
                         WorkspaceConnectionManager.shouldEstablishWorkspaceConnections = true
+                        close()
+                        // force auto-login
+                        firstRun = true
+                        context.envPageManager.showPluginEnvironmentsPage()
+                        break
                     }
-                    close()
-                    // force auto-login
-                    firstRun = true
-                    context.envPageManager.showPluginEnvironmentsPage()
-                    break
                 }
             }
 
             // TODO: Listening on a web socket might be better?
-            select<Unit> {
+            select {
                 onTimeout(POLL_INTERVAL) {
                     context.logger.trace("workspace poller waked up by the $POLL_INTERVAL timeout")
                 }

src/main/kotlin/com/coder/toolbox/settings/ReadOnlyCoderSettings.kt

@@ -146,6 +146,11 @@ interface ReadOnlyCoderSettings {
      * Return the URL and token from the config, if they exist.
      */
     fun readConfig(dir: Path): Pair<String?, String?>
+
+    /**
+     * Returns whether the SSH connection should be automatically established.
+     */
+    fun shouldAutoConnect(workspaceId: String): Boolean
 }
 
 /**

src/main/kotlin/com/coder/toolbox/store/CoderSettingsStore.kt

@@ -142,6 +142,10 @@ class CoderSettingsStore(
                 }
     }
 
+    override fun shouldAutoConnect(workspaceId: String): Boolean {
+        return store["$SSH_AUTO_CONNECT_PREFIX$workspaceId"]?.toBooleanStrictOrNull() ?: false
+    }
+
     // a readonly cast
     fun readOnly(): ReadOnlyCoderSettings = this
 
@@ -213,6 +217,10 @@ class CoderSettingsStore(
         store[SSH_CONFIG_OPTIONS] = options
     }
 
+    fun updateAutoConnect(workspaceId: String, autoConnect: Boolean) {
+        store["$SSH_AUTO_CONNECT_PREFIX$workspaceId"] = autoConnect.toString()
+    }
+
     private fun getDefaultGlobalDataDir(): Path {
         return when (getOS()) {
             OS.WINDOWS -> Paths.get(env.get("LOCALAPPDATA"), "coder-toolbox")

src/main/kotlin/com/coder/toolbox/store/StoreKeys.kt

@@ -42,3 +42,5 @@ internal const val SSH_CONFIG_OPTIONS = "sshConfigOptions"
 
 internal const val NETWORK_INFO_DIR = "networkInfoDir"
 
+internal const val SSH_AUTO_CONNECT_PREFIX = "ssh_auto_connect_"
+