chore: simplify uri handling implementation (1)

Refactored code around uri, token, workspace and rest client resolving by
encapsulating code in clearly named methods. Rest client resolving was overly-complicated
(code inherited from Gateway), with token being a mandatory parameter. Removed a lot of code
that asked the token from the user if it was missing.

Also, I decided to use a snackbar to show errors because of attached regression in TBX.
A bottom simple dialog is more pleasing to the eye than a dialog in the middle of a page.

https://youtrack.jetbrains.com/issue/TBX-14944/Pop-up-dialogs-are-only-displayed-on-the-main-envs-page

Author: fioan89

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

@@ -14,6 +14,7 @@ import com.jetbrains.toolbox.api.remoteDev.ui.EnvironmentUiPageManager
 import com.jetbrains.toolbox.api.ui.ToolboxUi
 import kotlinx.coroutines.CoroutineScope
 import java.net.URL
+import java.util.UUID
 
 @Suppress("UnstableApiUsage")
 data class CoderToolboxContext(
@@ -47,4 +48,14 @@ 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")
+        )
+    }
 }

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

@@ -25,6 +25,8 @@ import kotlin.time.Duration.Companion.minutes
 import kotlin.time.Duration.Companion.seconds
 import kotlin.time.toJavaDuration
 
+private const val CAN_T_HANDLE_URI_TITLE = "Can't handle URI"
+
 @Suppress("UnstableApiUsage")
 open class CoderProtocolHandler(
     private val context: CoderToolboxContext,
@@ -46,35 +48,18 @@ open class CoderProtocolHandler(
         reInitialize: suspend (CoderRestClient, CoderCLIManager) -> Unit
     ) {
         context.popupPluginMainPage()
+        context.logger.info("Handling $uri...")
         val params = uri.toQueryParameters()
         if (params.isEmpty()) {
             // probably a plugin installation scenario
             return
         }
 
-        val deploymentURL = params.url() ?: askUrl()
-        if (deploymentURL.isNullOrBlank()) {
-            context.logger.error("Query parameter \"$URL\" is missing from URI $uri")
-            context.showErrorPopup(MissingArgumentException("Can't handle URI because query parameter \"$URL\" is missing"))
-            return
-        }
-
-        val queryToken = params.token()
-        val restClient = try {
-            authenticate(deploymentURL, queryToken)
-        } catch (ex: Exception) {
-            context.logger.error(ex, "Query parameter \"$TOKEN\" is missing from URI $uri")
-            context.showErrorPopup(IllegalStateException(humanizeConnectionError(deploymentURL.toURL(), true, ex)))
-            return
-        }
-
+        val deploymentURL = resolveDeploymentUrl(params) ?: return
+        val token = resolveToken(params) ?: return
         // TODO: Show a dropdown and ask for the workspace if missing. Right now it's not possible because dialogs are quite limited
-        val workspaceName = params.workspace()
-        if (workspaceName.isNullOrBlank()) {
-            context.logger.error("Query parameter \"$WORKSPACE\" is missing from URI $uri")
-            context.showErrorPopup(MissingArgumentException("Can't handle URI because query parameter \"$WORKSPACE\" is missing"))
-            return
-        }
+        val workspaceName = resolveWorkspace(params) ?: return
+        val restClient = buildRestClient(deploymentURL, token) ?: return
 
         val workspaces = restClient.workspaces()
         val workspace = workspaces.firstOrNull { it.name == workspaceName }
@@ -244,6 +229,56 @@ open class CoderProtocolHandler(
         }
     }
 
+    private suspend fun resolveDeploymentUrl(params: Map<String, String>): String? {
+        val deploymentURL = params.url() ?: askUrl()
+        if (deploymentURL.isNullOrBlank()) {
+            context.logAndShowError(CAN_T_HANDLE_URI_TITLE, "Query parameter \"$URL\" is missing from URI")
+            return null
+        }
+        return deploymentURL
+    }
+
+    private suspend fun resolveToken(params: Map<String, String>): String? {
+        val token = params.token()
+        if (token.isNullOrBlank()) {
+            context.logAndShowError(CAN_T_HANDLE_URI_TITLE, "Query parameter \"$TOKEN\" is missing from URI")
+            return null
+        }
+        return token
+    }
+
+    private suspend fun resolveWorkspace(params: Map<String, String>): String? {
+        val workspace = params.workspace()
+        if (workspace.isNullOrBlank()) {
+            context.logAndShowError(CAN_T_HANDLE_URI_TITLE, "Query parameter \"$WORKSPACE\" is missing from URI")
+            return null
+        }
+        return workspace
+    }
+
+    private suspend fun buildRestClient(deploymentURL: String, token: String): CoderRestClient? {
+        try {
+            return authenticate(deploymentURL, token)
+        } catch (ex: Exception) {
+            context.logAndShowError(CAN_T_HANDLE_URI_TITLE, humanizeConnectionError(deploymentURL.toURL(), true, ex))
+            return null
+        }
+    }
+
+    /**
+     * Returns an authenticated Coder CLI.
+     */
+    private suspend fun authenticate(deploymentURL: String, token: String): CoderRestClient {
+        val client = CoderRestClient(
+            context,
+            deploymentURL.toURL(),
+            if (settings.requireTokenAuth) token else null,
+            PluginManager.pluginInfo.version
+        )
+        client.authenticate()
+        return client
+    }
+
     private suspend fun CoderRestClient.waitForReady(workspace: Workspace): Boolean {
         var status = workspace.latestBuild.status
         try {
@@ -285,43 +320,6 @@ open class CoderProtocolHandler(
             context.i18n.ptrl("Enter the full URL of your Coder deployment")
         )
     }
-
-    /**
-     * Return an authenticated Coder CLI, asking for the token.
-     * Throw MissingArgumentException if the user aborts. Any network or invalid
-     * token error may also be thrown.
-     */
-    private suspend fun authenticate(
-        deploymentURL: String,
-        tryToken: String?
-    ): CoderRestClient {
-        val token =
-            if (settings.requireTokenAuth) {
-                // Try the provided token immediately on the first attempt.
-                if (!tryToken.isNullOrBlank()) {
-                    tryToken
-                } else {
-                    context.popupPluginMainPage()
-                    // Otherwise ask for a new token, showing the previous token.
-                    dialogUi.askToken(deploymentURL.toURL())
-                }
-            } else {
-                null
-            }
-
-        if (settings.requireTokenAuth && token == null) { // User aborted.
-            throw MissingArgumentException("Token is required")
-        }
-        val client = CoderRestClient(
-            context,
-            deploymentURL.toURL(),
-            token,
-            PluginManager.pluginInfo.version
-        )
-        client.authenticate()
-        return client
-    }
-
 }
 
 /**

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

@@ -1,10 +1,8 @@
 package com.coder.toolbox.util
 
 import com.coder.toolbox.CoderToolboxContext
-import com.coder.toolbox.browser.browse
 import com.jetbrains.toolbox.api.localization.LocalizableString
 import com.jetbrains.toolbox.api.ui.components.TextType
-import java.net.URL
 
 /**
  * Dialog implementation for standalone Gateway.
@@ -26,34 +24,4 @@ class DialogUi(private val context: CoderToolboxContext) {
             title, description, placeholder, TextType.General, context.i18n.ptrl("OK"), context.i18n.ptrl("Cancel")
         )
     }
-
-    suspend fun askPassword(
-        title: LocalizableString,
-        description: LocalizableString,
-        placeholder: LocalizableString? = null,
-    ): String? {
-        return context.ui.showTextInputPopup(
-            title, description, placeholder, TextType.Password, context.i18n.ptrl("OK"), context.i18n.ptrl("Cancel")
-        )
-    }
-
-    private suspend fun openUrl(url: URL) {
-        context.desktop.browse(url.toString()) {
-            context.ui.showErrorInfoPopup(it)
-        }
-    }
-
-    /**
-     * Open a dialog for providing the token.
-     */
-    suspend fun askToken(
-        url: URL,
-    ): String? {
-        openUrl(url.withPath("/login?redirect=%2Fcli-auth"))
-        return askPassword(
-            title = context.i18n.ptrl("Session Token"),
-            description = context.i18n.pnotr("Please paste the session token from the web-page"),
-            placeholder = context.i18n.pnotr("")
-        )
-    }
 }