fix: don't create new environment instances every time we poll (#239)

The polling logic has a list of "environments" which is updated by the
poll loop. The loop retrieves a list of workspaces and agents from the
backend, and then it looks if the pairs are already part of the existing
environments. This is where we have an issue: we look by temporarily
creating a new "RemoteEnvironment" and use the id of the temporary env.
to search in the existing collection. Besides creating a lot of
temporary objects every 5 seconds, the logic has another flaw: the
constructor of the RemoteEnvironment triggers the ssh connection for
that workspace if it was marked in the settings store as connected in
the previous state. Asking to establish the ssh connection every 5
seconds is completely unnecessary, from my testings the newer versions
of Toolbox are able to remember in the same session that a connection
was opened, and it needs to be re-established again if it fails during
that session.

From now on the constructor for the RemoteEnvironment will request it
only for new login sessions, from then on it is up to TBX to remember
the connection state. In the early versions we added custom logic to
retrigger the ssh connection when API keys expired. Turns out that is
also no longer necessary to do. When an API key expires the user will
have to go again through the login sequence, which means starting with a
clean sheet of "environments". At the first poll run the
RemoteEnvironment constructor will request TBX to establish the ssh
connection again.

Author: fioan89

CHANGELOG.md

@@ -6,6 +6,10 @@
 
 - the proxy command now always logs in verbose mode when the log directory is enabled
 
+### Fixed
+
+- no longer spam Toolbox with requests to establish the SSH connections every 5 seconds
+
 ## 0.8.1 - 2025-12-11
 
 ### Changed

gradle.properties

@@ -1,3 +1,3 @@
-version=0.8.1
+version=0.8.2
 group=com.coder.toolbox
 name=coder-toolbox

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

@@ -73,7 +73,7 @@ class CoderRemoteEnvironment(
 
     init {
         if (context.settingsStore.shouldAutoConnect(id)) {
-            context.logger.info("resuming SSH connection to $id — last session was still active.")
+            context.logger.info("Last session to $id was still active, trying to establish SSH connection")
             startSshConnection()
         }
         refreshAvailableActions()
@@ -304,18 +304,15 @@ class CoderRemoteEnvironment(
     }
 
     /**
-     * Launches the SSH connection if the workspace is ready and there is no connection already established.
-     *
-     * Returns true if the SSH connection was scheduled to start, false otherwise.
+     * Schedules the SSH connection to start as soon as possible if the workspace is ready and there is no connection already established.
      */
-    fun startSshConnection(): Boolean {
+    fun startSshConnection() {
         if (environmentStatus.ready() && !isConnected.value) {
             connectionRequest.update {
                 true
             }
-            return true
+            context.logger.info("Workspace status is ready and there is no existing connection, resuming SSH connection to $id")
         }
-        return false
     }
 
     override val deleteActionFlow: StateFlow<(() -> Unit)?> = MutableStateFlow(null)

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

@@ -131,15 +131,14 @@ class CoderRemoteProvider(
                                 //       different information?
                                 it.name
                             }?.map { agent ->
-                                // If we have an environment already, update that.
-                                val env = CoderRemoteEnvironment(context, client, cli, ws, agent)
-                                lastEnvironments.firstOrNull { it == env }?.let {
-                                    it.update(ws, agent)
-                                    it
-                                } ?: env
+                                lastEnvironments.firstOrNull { it.id == "${ws.name}.${agent.name}" }
+                                    ?.also {
+                                        // If we have an environment already, update that.
+                                        it.update(ws, agent)
+                                    } ?: CoderRemoteEnvironment(context, client, cli, ws, agent)
                             } ?: emptyList()
                         }
-                    }.toSet()
+                    }.toSet().sortedBy { it.id }
 
                     // In case we logged out while running the query.
                     if (!isActive) {
@@ -153,7 +152,7 @@ class CoderRemoteProvider(
                     }
 
                     environments.update {
-                        LoadableState.Value(resolvedEnvironments.toList())
+                        LoadableState.Value(resolvedEnvironments)
                     }
                     if (!isInitialized.value) {
                         context.logger.info("Environments for ${client.url} are now initialized")
@@ -163,23 +162,8 @@ class CoderRemoteProvider(
                     }
                     lastEnvironments.apply {
                         clear()
-                        addAll(resolvedEnvironments.sortedBy { it.id })
+                        addAll(resolvedEnvironments)
                     }
-
-                    if (WorkspaceConnectionManager.shouldEstablishWorkspaceConnections) {
-                        WorkspaceConnectionManager.allConnected().forEach { wsId ->
-                            val env = lastEnvironments.firstOrNull() { it.id == wsId }
-                            if (env != null && !env.isConnected()) {
-                                context.logger.info("Establishing lost SSH connection for workspace with id $wsId")
-                                if (!env.startSshConnection()) {
-                                    context.logger.info("Can't establish lost SSH connection for workspace with id $wsId")
-                                }
-                            }
-                        }
-                        WorkspaceConnectionManager.reset()
-                    }
-
-                    WorkspaceConnectionManager.collectStatuses(lastEnvironments)
                 } catch (_: CancellationException) {
                     context.logger.debug("${client.url} polling loop canceled")
                     break
@@ -190,7 +174,6 @@ class CoderRemoteProvider(
                     } else {
                         context.logger.error(ex, "workspace polling error encountered")
                         if (ex is APIResponseException && ex.isTokenExpired) {
-                            WorkspaceConnectionManager.shouldEstablishWorkspaceConnections = true
                             close()
                             context.envPageManager.showPluginEnvironmentsPage()
                             errorBuffer.add(ex)
@@ -225,7 +208,6 @@ class CoderRemoteProvider(
      */
     private fun logout() {
         context.logger.info("Logging out ${client?.me?.username}...")
-        WorkspaceConnectionManager.reset()
         close()
         context.logger.info("User ${client?.me?.username} logged out successfully")
     }