impl: persist last active SSH connections

fioan89 · fioan89 · commit f255edbae3d4 · 2025-07-23T19:01:57.000-03:00
Adds support for remembering SSH connections that were not manually disconnected by the user.
This allows the plugin to automatically restore those connections on the next startup
enabling remote IDEs that remained open to reconnect once the SSH link is re-established.
diff --git a/src/main/kotlin/com/coder/toolbox/CoderRemoteEnvironment.kt b/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")
     }
 
diff --git a/src/main/kotlin/com/coder/toolbox/settings/ReadOnlyCoderSettings.kt b/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
 }
 
 /**
diff --git a/src/main/kotlin/com/coder/toolbox/store/CoderSettingsStore.kt b/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")
diff --git a/src/main/kotlin/com/coder/toolbox/store/StoreKeys.kt b/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_"
+

Original file line number	Diff line number	Diff line change
`@@ -142,6 +142,10 @@ class CoderSettingsStore(`
`142`	`142`	`}`
`143`	`143`	`}`
`144`	`144`
	`145`	`+ override fun shouldAutoConnect(workspaceId: String): Boolean {`
	`146`	`+ return store["$SSH_AUTO_CONNECT_PREFIX$workspaceId"]?.toBooleanStrictOrNull() ?: false`
	`147`	`+ }`
	`148`	`+`
`145`	`149`	`// a readonly cast`
`146`	`150`	`fun readOnly(): ReadOnlyCoderSettings = this`
`147`	`151`
`@@ -213,6 +217,10 @@ class CoderSettingsStore(`
`213`	`217`	`store[SSH_CONFIG_OPTIONS] = options`
`214`	`218`	`}`
`215`	`219`
	`220`	`+ fun updateAutoConnect(workspaceId: String, autoConnect: Boolean) {`
	`221`	`+ store["$SSH_AUTO_CONNECT_PREFIX$workspaceId"] = autoConnect.toString()`
	`222`	`+ }`
	`223`	`+`
`216`	`224`	`private fun getDefaultGlobalDataDir(): Path {`
`217`	`225`	`return when (getOS()) {`
`218`	`226`	`OS.WINDOWS -> Paths.get(env.get("LOCALAPPDATA"), "coder-toolbox")`
Original file line number	Diff line number	Diff line change
`@@ -42,3 +42,5 @@ internal const val SSH_CONFIG_OPTIONS = "sshConfigOptions"`
`42`	`42`
`43`	`43`	`internal const val NETWORK_INFO_DIR = "networkInfoDir"`
`44`	`44`
	`45`	`+internal const val SSH_AUTO_CONNECT_PREFIX = "ssh_auto_connect_"`
	`46`	`+`