fix: mark the deployment as busy

During URI handling we can wait for workspaces to start up. The existing implementation
had no visual feedback that we are waiting/doing anything. With this PR the header bar shows
a nice work in progress visual. Additionally, the deployment URL was not properly refreshed
when switching between different urls via URI handling. This is also fixed by forcing TBX
to render a blank page for a very short period of time and then going back to the main page.

Author: fioan89

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

@@ -9,7 +9,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
@@ -269,12 +268,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)
         }
@@ -332,7 +344,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 ?: ""
@@ -344,8 +356,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<RemoteProviderEnvironment>>>.showLoadingMessage() {

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

@@ -3,6 +3,7 @@ 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
@@ -13,8 +14,10 @@ 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(
@@ -88,4 +91,13 @@ data class CoderToolboxContext(
             i18n.ptrl("OK")
         )
     }
+
+    /**
+     * Forces the title bar on the main page to be refreshed
+     */
+    suspend fun refreshMainPage() {
+        ui.showUiPage(CoderPage.emptyPage(this))
+        delay(10.milliseconds)
+        envPageManager.showPluginEnvironmentsPage()
+    }
 }

src/main/kotlin/com/coder/toolbox/util/CoderProtocolHandler.kt

@@ -43,6 +43,8 @@ open class CoderProtocolHandler(
     suspend fun handle(
         uri: URI,
         shouldWaitForAutoLogin: Boolean,
+        markAsBusy: () -> Unit,
+        unmarkAsBusy: () -> Unit,
         reInitialize: suspend (CoderRestClient, CoderCLIManager) -> Unit
     ) {
         val params = uri.toQueryParameters()
@@ -62,16 +64,22 @@ open class CoderProtocolHandler(
         val workspaceName = resolveWorkspaceName(params) ?: return
         val restClient = buildRestClient(deploymentURL, token) ?: return
         val workspace = restClient.workspaces().matchName(workspaceName, deploymentURL) ?: return
-        if (!prepareWorkspace(workspace, restClient, workspaceName, deploymentURL)) return
-
-        // we resolve the agent after the workspace is started otherwise we can get misleading
-        // errors like: no agent available while workspace is starting or stopping
-        val agent = resolveAgent(params, workspace) ?: return
-        if (!ensureAgentIsReady(workspace, agent)) return
 
         val cli = configureCli(deploymentURL, restClient)
         reInitialize(restClient, cli)
 
+        var agent: WorkspaceAgent
+        try {
+            markAsBusy()
+            context.refreshMainPage()
+            if (!prepareWorkspace(workspace, restClient, workspaceName, deploymentURL)) return
+            // we resolve the agent after the workspace is started otherwise we can get misleading
+            // errors like: no agent available while workspace is starting or stopping
+            agent = resolveAgent(params, workspace) ?: return
+            if (!ensureAgentIsReady(workspace, agent)) return
+        } finally {
+            unmarkAsBusy()
+        }
         val environmentId = "${workspace.name}.${agent.name}"
         context.showEnvironmentPage(environmentId)
 
@@ -432,6 +440,7 @@ open class CoderProtocolHandler(
     }
 }
 
+
 private fun CoderToolboxContext.popupPluginMainPage() {
     this.ui.showWindow()
     this.envPageManager.showPluginEnvironmentsPage(true)

src/main/kotlin/com/coder/toolbox/views/AuthWizardPage.kt

@@ -16,7 +16,7 @@ class AuthWizardPage(
     private val context: CoderToolboxContext,
     private val settingsPage: CoderSettingsPage,
     initialAutoLogin: Boolean = false,
-    onConnect: (
+    onConnect: suspend (
         client: CoderRestClient,
         cli: CoderCLIManager,
     ) -> Unit,

src/main/kotlin/com/coder/toolbox/views/CoderPage.kt

@@ -6,6 +6,7 @@ import com.jetbrains.toolbox.api.core.ui.icons.SvgIcon.IconType
 import com.jetbrains.toolbox.api.localization.LocalizableString
 import com.jetbrains.toolbox.api.ui.actions.RunnableActionDescription
 import com.jetbrains.toolbox.api.ui.components.UiPage
+import kotlinx.coroutines.flow.MutableStateFlow
 import kotlinx.coroutines.launch
 import java.util.UUID
 
@@ -39,6 +40,8 @@ abstract class CoderPage(
         SvgIcon(byteArrayOf(), type = IconType.Masked)
     }
 
+    override val isBusyCreatingNewEnvironment: MutableStateFlow<Boolean> = MutableStateFlow(false)
+
     /**
      * Show an error as a popup on this page.
      */

src/main/kotlin/com/coder/toolbox/views/ConnectStep.kt

@@ -28,7 +28,7 @@ class ConnectStep(
     private val shouldAutoLogin: StateFlow<Boolean>,
     private val notify: (String, Throwable) -> Unit,
     private val refreshWizard: () -> Unit,
-    private val onConnect: (
+    private val onConnect: suspend (
         client: CoderRestClient,
         cli: CoderCLIManager,
     ) -> Unit,