Merge branch 'main' into fix-auto-connect-when-token-expires

Author: fioan89

CHANGELOG.md

@@ -9,8 +9,16 @@
 
 ### Fixed
 
+- `Stop` action is now available for running workspaces that have an out of date template.
+- outdated and stopped workspaces are now updated and started when handling URI
 - show errors when the Toolbox is visible again after being minimized.
 
+## 0.3.0 - 2025-06-10
+
+### Added
+
+- support for Toolbox 2.6.3 with improved URI handling
+
 ## 0.2.3 - 2025-05-26
 
 ### Changed

README.md

@@ -101,6 +101,13 @@ If `ide_product_code` and `ide_build_number` is missing, Toolbox will only open
 page. Coder Toolbox will attempt to start the workspace if it’s not already running; however, for the most reliable
 experience, it’s recommended to ensure the workspace is running prior to initiating the connection.
 
+> ⚠️ Note: `folder` should point to a remote IDEA project that has already been opened and appears in the `Projects`
+> tab.
+> If the path refers to a project that doesn't exist, the remote IDE won’t start or load it.
+
+> Until [TBX-14952](https://youtrack.jetbrains.com/issue/TBX-14952/) is fixed, it's best to either use a path to a
+> previously opened project or leave it empty.
+
 ## Configuring and Testing workspace polling with HTTP & SOCKS5 Proxy
 
 This section explains how to set up a local proxy (without authentication which is not yet supported) and verify that
@@ -139,11 +146,11 @@ mitmproxy can do HTTP and SOCKS5 proxying. To configure one or the other:
 
 ## Debugging and Reporting issues
 
-Enabling debug logging is essential for diagnosing issues with the Toolbox plugin, especially when SSH 
-connections to the remote environment fail — it provides detailed output that includes SSH negotiation 
+Enabling debug logging is essential for diagnosing issues with the Toolbox plugin, especially when SSH
+connections to the remote environment fail — it provides detailed output that includes SSH negotiation
 and command execution, which is not visible at the default log level.
 
-If you encounter a problem with Coder's JetBrains Toolbox plugin, follow the steps below to gather more 
+If you encounter a problem with Coder's JetBrains Toolbox plugin, follow the steps below to gather more
 information and help us diagnose and resolve it quickly.
 
 ### Enable Debug Logging
@@ -159,46 +166,48 @@ Steps to enable debug logging:
 
 3. In the screen that appears, select _DEBUG_ for the `Log level:` section.
 
-4. Hit the back button at the top. 
+4. Hit the back button at the top.
 
 There is no need to restart Toolbox, as it will begin logging at the __DEBUG__ level right away.
 
 > ⚠️ **Attention:** Toolbox does not persist log level configuration between restarts.
 
 #### Viewing the Logs
 
-Once enabled, debug logs will be written to the Toolbox log files. You can access logs directly 
+Once enabled, debug logs will be written to the Toolbox log files. You can access logs directly
 via Toolbox App Menu > About > Show log files.
 
-Alternatively, you can generate a ZIP file using the Workspace action menu, available either on the main 
+Alternatively, you can generate a ZIP file using the Workspace action menu, available either on the main
 Workspaces page in Coder or within the individual workspace view, under the option labeled _Collect logs_.
 
 ## Coder Settings
 
 The Coder Settings allows users to control CLI download behavior, SSH configuration, TLS parameters, and data
 storage paths. The options can be configured from the plugin's main Workspaces page > deployment action menu > Settings.
 
-### CLI related settings 
+### CLI related settings
 
 ```Binary source``` specifies the source URL or relative path from which the Coder CLI should be downloaded.
 If a relative path is provided, it is resolved against the deployment domain.
 
 ```Enable downloads``` allows automatic downloading of the CLI if the current version is missing or outdated.
 
-```Binary directory``` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data directory.
+```Binary directory``` specifies the directory where CLI binaries are stored. If omitted, it defaults to the data
+directory.
 
 ```Enable binary directory fallback``` if enabled, falls back to the data directory when the specified binary
 directory is not writable.
 
-```Data directory``` directory where plugin-specific data such as session tokens and binaries are stored if not 
+```Data directory``` directory where plugin-specific data such as session tokens and binaries are stored if not
 overridden by the binary directory setting.
 
 ```Header command``` command that outputs additional HTTP headers. Each line of output must be in the format key=value.
 The environment variable CODER_URL will be available to the command process.
 
 ### TLS settings
 
-The following options control the secure communication behavior of the plugin with Coder deployment and its available API.
+The following options control the secure communication behavior of the plugin with Coder deployment and its available
+API.
 
 ```TLS cert path``` path to a client certificate file for TLS authentication with Coder deployment.
 The certificate should be in X.509 PEM format.
@@ -210,7 +219,7 @@ The certificate should be in X.509 PEM format.
 certs returned by the Coder deployment. The file should be in X.509 PEM format. This option can also be used to verify
 proxy certificates.
 
-```TLS alternate hostname``` overrides the hostname used in TLS verification. This is useful when the hostname 
+```TLS alternate hostname``` overrides the hostname used in TLS verification. This is useful when the hostname
 used to connect to the Coder deployment does not match the hostname in the TLS certificate.
 
 ### SSH settings
@@ -227,11 +236,13 @@ rules for matching multiple workspaces.
 
 ```SSH network metrics directory``` directory where network information used by the SSH proxy is stored.
 
-```Extra SSH options``` additional options appended to the SSH configuration. Can be used to customize the behavior of SSH connections.
+```Extra SSH options``` additional options appended to the SSH configuration. Can be used to customize the behavior of
+SSH connections.
 
 ### Saving Changes
 
-Changes made in the settings page are saved by clicking the Save button. Some changes, like toggling SSH wildcard support,
+Changes made in the settings page are saved by clicking the Save button. Some changes, like toggling SSH wildcard
+support,
 may trigger regeneration of SSH configurations.
 
 ### Security considerations

gradle.properties

@@ -1,3 +1,3 @@
-version=0.2.3
+version=0.3.0
 group=com.coder.toolbox
 name=coder-toolbox

gradle/libs.versions.toml

@@ -1,6 +1,6 @@
 [versions]
-toolbox-plugin-api = "1.0.38881"
-kotlin = "2.1.0"
+toolbox-plugin-api = "1.1.41749"
+kotlin = "2.1.10"
 coroutines = "1.10.1"
 serialization = "1.8.0"
 okhttp = "4.12.0"
@@ -9,11 +9,11 @@ marketplace-client = "2.0.46"
 gradle-wrapper = "0.14.0"
 exec = "1.12"
 moshi = "1.15.2"
-ksp = "2.1.0-1.0.29"
+ksp = "2.1.10-1.0.31"
 retrofit = "2.11.0"
 changelog = "2.2.1"
 gettext = "0.7.0"
-plugin-structure = "3.306"
+plugin-structure = "3.307"
 mockk = "1.14.2"
 
 [libraries]

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

@@ -27,6 +27,7 @@ import com.squareup.moshi.Moshi
 import kotlinx.coroutines.Job
 import kotlinx.coroutines.delay
 import kotlinx.coroutines.flow.MutableStateFlow
+import kotlinx.coroutines.flow.StateFlow
 import kotlinx.coroutines.flow.update
 import kotlinx.coroutines.isActive
 import kotlinx.coroutines.launch
@@ -125,16 +126,15 @@ class CoderRemoteEnvironment(
                         update(workspace.copy(latestBuild = build), agent)
                     }
                 })
-            } else {
-                actions.add(Action(context.i18n.ptrl("Stop")) {
-                    context.cs.launch {
-                        tryStopSshConnection()
-
-                        val build = client.stopWorkspace(workspace)
-                        update(workspace.copy(latestBuild = build), agent)
-                    }
-                })
             }
+            actions.add(Action(context.i18n.ptrl("Stop")) {
+                context.cs.launch {
+                    tryStopSshConnection()
+
+                    val build = client.stopWorkspace(workspace)
+                    update(workspace.copy(latestBuild = build), agent)
+                }
+            })
         }
         return actions
     }
@@ -203,7 +203,7 @@ class CoderRemoteEnvironment(
 
     private fun File.doesNotExists(): Boolean = !this.exists()
 
-    override fun afterDisconnect() {
+    override fun afterDisconnect(isManual: Boolean) {
         context.logger.info("Stopping the network metrics poll job for $id")
         pollJob?.cancel()
         this.connectionRequest.update { false }
@@ -279,7 +279,7 @@ class CoderRemoteEnvironment(
         }
     }
 
-    override fun onDelete() {
+    override val deleteActionFlow: StateFlow<(() -> Unit)?> = MutableStateFlow {
         context.cs.launch {
             try {
                 client.removeWorkspace(workspace)

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

@@ -10,7 +10,6 @@ import com.coder.toolbox.util.DialogUi
 import com.coder.toolbox.util.withPath
 import com.coder.toolbox.views.Action
 import com.coder.toolbox.views.AuthWizardPage
-import com.coder.toolbox.views.CoderPage
 import com.coder.toolbox.views.CoderSettingsPage
 import com.coder.toolbox.views.NewEnvironmentPage
 import com.coder.toolbox.views.state.AuthWizardState
@@ -118,7 +117,6 @@ class CoderRemoteProvider(
                     return@launch
                 }
 
-
                 // Reconfigure if environments changed.
                 if (lastEnvironments.size != resolvedEnvironments.size || lastEnvironments != resolvedEnvironments) {
                     context.logger.info("Workspaces have changed, reconfiguring CLI: $resolvedEnvironments")
@@ -302,12 +300,25 @@ class CoderRemoteProvider(
      * Handle incoming links (like from the dashboard).
      */
     override suspend fun handleUri(uri: URI) {
-        linkHandler.handle(uri, shouldDoAutoLogin()) { restClient, cli ->
+        linkHandler.handle(
+            uri, shouldDoAutoLogin(),
+            {
+                coderHeaderPage.isBusyCreatingNewEnvironment.update {
+                    true
+                }
+            },
+            {
+                coderHeaderPage.isBusyCreatingNewEnvironment.update {
+                    false
+                }
+            }
+        ) { restClient, cli ->
             // stop polling and de-initialize resources
             close()
             // start initialization with the new settings
             this@CoderRemoteProvider.client = restClient
             coderHeaderPage = NewEnvironmentPage(context, context.i18n.pnotr(restClient.url.toString()))
+
             environments.showLoadingMessage()
             pollJob = poll(restClient, cli)
         }
@@ -365,7 +376,7 @@ class CoderRemoteProvider(
 
     private fun shouldDoAutoLogin(): Boolean = firstRun && context.secrets.rememberMe == true
 
-    private fun onConnect(client: CoderRestClient, cli: CoderCLIManager) {
+    private suspend fun onConnect(client: CoderRestClient, cli: CoderCLIManager) {
         // Store the URL and token for use next time.
         context.secrets.lastDeploymentURL = client.url.toString()
         context.secrets.lastToken = client.token ?: ""
@@ -377,8 +388,7 @@ class CoderRemoteProvider(
         environments.showLoadingMessage()
         coderHeaderPage = NewEnvironmentPage(context, context.i18n.pnotr(client.url.toString()))
         pollJob = poll(client, cli)
-        context.ui.showUiPage(CoderPage.emptyPage(context))
-        goToEnvironmentsPage()
+        context.refreshMainPage()
     }
 
     private fun MutableStateFlow<LoadableState<List<CoderRemoteEnvironment>>>.showLoadingMessage() {

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

@@ -3,22 +3,29 @@ package com.coder.toolbox
 import com.coder.toolbox.store.CoderSecretsStore
 import com.coder.toolbox.store.CoderSettingsStore
 import com.coder.toolbox.util.toURL
+import com.coder.toolbox.views.CoderPage
 import com.jetbrains.toolbox.api.core.diagnostics.Logger
 import com.jetbrains.toolbox.api.core.os.LocalDesktopManager
 import com.jetbrains.toolbox.api.localization.LocalizableStringFactory
 import com.jetbrains.toolbox.api.remoteDev.connection.ClientHelper
+import com.jetbrains.toolbox.api.remoteDev.connection.RemoteToolsHelper
 import com.jetbrains.toolbox.api.remoteDev.connection.ToolboxProxySettings
 import com.jetbrains.toolbox.api.remoteDev.states.EnvironmentStateColorPalette
 import com.jetbrains.toolbox.api.remoteDev.ui.EnvironmentUiPageManager
 import com.jetbrains.toolbox.api.ui.ToolboxUi
 import kotlinx.coroutines.CoroutineScope
+import kotlinx.coroutines.delay
 import java.net.URL
+import java.util.UUID
+import kotlin.time.Duration.Companion.milliseconds
 
+@Suppress("UnstableApiUsage")
 data class CoderToolboxContext(
     val ui: ToolboxUi,
     val envPageManager: EnvironmentUiPageManager,
     val envStateColorPalette: EnvironmentStateColorPalette,
-    val ideOrchestrator: ClientHelper,
+    val remoteIdeOrchestrator: RemoteToolsHelper,
+    val jbClientOrchestrator: ClientHelper,
     val desktop: LocalDesktopManager,
     val cs: CoroutineScope,
     val logger: Logger,
@@ -44,4 +51,66 @@ data class CoderToolboxContext(
             }
             return this.settingsStore.defaultURL.toURL()
         }
+
+    suspend fun logAndShowError(title: String, error: String) {
+        logger.error(error)
+        ui.showSnackbar(
+            UUID.randomUUID().toString(),
+            i18n.pnotr(title),
+            i18n.pnotr(error),
+            i18n.ptrl("OK")
+        )
+    }
+
+    suspend fun logAndShowError(title: String, error: String, exception: Exception) {
+        logger.error(exception, error)
+        ui.showSnackbar(
+            UUID.randomUUID().toString(),
+            i18n.pnotr(title),
+            i18n.pnotr(error),
+            i18n.ptrl("OK")
+        )
+    }
+
+    suspend fun logAndShowWarning(title: String, warning: String) {
+        logger.warn(warning)
+        ui.showSnackbar(
+            UUID.randomUUID().toString(),
+            i18n.pnotr(title),
+            i18n.pnotr(warning),
+            i18n.ptrl("OK")
+        )
+    }
+
+    suspend fun logAndShowInfo(title: String, info: String) {
+        logger.info(info)
+        ui.showSnackbar(
+            UUID.randomUUID().toString(),
+            i18n.pnotr(title),
+            i18n.pnotr(info),
+            i18n.ptrl("OK")
+        )
+    }
+
+    /**
+     * Forces the title bar on the main page to be refreshed
+     */
+    suspend fun refreshMainPage() {
+        // the url/title on the main page is only refreshed if
+        // we're navigating to the main env page from another page.
+        // If TBX is already on the main page the title is not refreshed
+        // hence we force a navigation from a blank page.
+        ui.showUiPage(CoderPage.emptyPage(this))
+
+
+        // Toolbox uses an internal shared flow with a buffer of 4 items and a DROP_OLDEST strategy.
+        // Both showUiPage and showPluginEnvironmentsPage send events to this flow.
+        // If we emit two events back-to-back, the first one often gets dropped and only the second is shown.
+        // To reduce this risk, we add a small delay to let the UI coroutine process the first event.
+        // Simply yielding the coroutine isn't reliable, especially right after Toolbox starts via URI handling.
+        // Based on my testing, a 5–10 ms delay is enough to ensure the blank page is processed,
+        // while still short enough to be invisible to users.
+        delay(10.milliseconds)
+        envPageManager.showPluginEnvironmentsPage()
+    }
 }

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

@@ -13,6 +13,7 @@ import com.jetbrains.toolbox.api.localization.LocalizableStringFactory
 import com.jetbrains.toolbox.api.remoteDev.RemoteDevExtension
 import com.jetbrains.toolbox.api.remoteDev.RemoteProvider
 import com.jetbrains.toolbox.api.remoteDev.connection.ClientHelper
+import com.jetbrains.toolbox.api.remoteDev.connection.RemoteToolsHelper
 import com.jetbrains.toolbox.api.remoteDev.connection.ToolboxProxySettings
 import com.jetbrains.toolbox.api.remoteDev.states.EnvironmentStateColorPalette
 import com.jetbrains.toolbox.api.remoteDev.ui.EnvironmentUiPageManager
@@ -31,6 +32,7 @@ class CoderToolboxExtension : RemoteDevExtension {
                 serviceLocator.getService<ToolboxUi>(),
                 serviceLocator.getService<EnvironmentUiPageManager>(),
                 serviceLocator.getService<EnvironmentStateColorPalette>(),
+                serviceLocator.getService<RemoteToolsHelper>(),
                 serviceLocator.getService<ClientHelper>(),
                 serviceLocator.getService<LocalDesktopManager>(),
                 serviceLocator.getService<CoroutineScope>(),