Refactor link handler for Toolbox

In Toolbox, you get a ToolboxUi object that lets you show dialogs so we
now have a dialog class for that which can be refactored to use
ToolboxUi more easily.  Also passed in the http client since we will
need that in Toolbox to construct the client.

Author: code-asher

src/main/kotlin/com/coder/gateway/CoderGatewayConnectionProvider.kt

@@ -3,7 +3,8 @@
 package com.coder.gateway
 
 import com.coder.gateway.services.CoderSettingsService
-import com.coder.gateway.util.handleLink
+import com.coder.gateway.util.DialogUi
+import com.coder.gateway.util.LinkHandler
 import com.coder.gateway.util.isCoder
 import com.intellij.openapi.components.service
 import com.intellij.openapi.diagnostic.Logger
@@ -13,16 +14,16 @@ import com.jetbrains.gateway.api.GatewayConnectionProvider
 
 // CoderGatewayConnectionProvider handles connecting via a Gateway link such as
 // jetbrains-gateway://connect#type=coder.
-class CoderGatewayConnectionProvider : GatewayConnectionProvider {
-    private val settings: CoderSettingsService = service<CoderSettingsService>()
-
+class CoderGatewayConnectionProvider :
+    LinkHandler(service<CoderSettingsService>(), null, DialogUi(service<CoderSettingsService>())),
+    GatewayConnectionProvider {
     override suspend fun connect(
         parameters: Map<String, String>,
         requestor: ConnectionRequestor,
     ): GatewayConnectionHandle? {
         CoderRemoteConnectionHandle().connect { indicator ->
             logger.debug("Launched Coder link handler", parameters)
-            handleLink(parameters, settings) {
+            handle(parameters) {
                 indicator.text = it
             }
         }

src/main/kotlin/com/coder/gateway/CoderRemoteConnectionHandle.kt

@@ -9,8 +9,8 @@ import com.coder.gateway.models.toRawString
 import com.coder.gateway.models.withWorkspaceProject
 import com.coder.gateway.services.CoderRecentWorkspaceConnectionsService
 import com.coder.gateway.services.CoderSettingsService
+import com.coder.gateway.util.DialogUi
 import com.coder.gateway.util.SemVer
-import com.coder.gateway.util.confirm
 import com.coder.gateway.util.humanizeDuration
 import com.coder.gateway.util.isCancellation
 import com.coder.gateway.util.isWorkerTimeout
@@ -63,6 +63,7 @@ class CoderRemoteConnectionHandle {
     private val settings = service<CoderSettingsService>()
 
     private val localTimeFormatter = DateTimeFormatter.ofPattern("yyyy-MMM-dd HH:mm")
+    private val dialogUi = DialogUi(settings)
 
     fun connect(getParameters: (indicator: ProgressIndicator) -> WorkspaceProjectIDE) {
         val clientLifetime = LifetimeDefinition()
@@ -198,7 +199,7 @@ class CoderRemoteConnectionHandle {
             .minOfOrNull { it.toIdeWithStatus() }
         if (latest != null && SemVer.parse(latest.buildNumber) > SemVer.parse(workspace.ideBuildNumber)) {
             logger.info("Got newer version: ${latest.buildNumber} versus current ${workspace.ideBuildNumber}")
-            if (confirm("Update IDE", "There is a new version of this IDE: ${latest.buildNumber}", "Would you like to update?")) {
+            if (dialogUi.confirm("Update IDE", "There is a new version of this IDE: ${latest.buildNumber}. Would you like to update?")) {
                 return latest
             }
         }

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

@@ -70,180 +70,171 @@ private class CoderWorkspaceStepDialog(
     }
 }
 
-/**
- * Generic function to ask for consent.
- */
-fun confirm(
-    title: String,
-    comment: String,
-    details: String,
-): Boolean {
-    var inputFromUser = false
-    ApplicationManager.getApplication().invokeAndWait({
-        val panel =
-            panel {
-                row {
-                    label(comment)
-                }
-                row {
-                    label(details)
-                }
-            }
-        AppIcon.getInstance().requestAttention(null, true)
-        if (!dialog(
-                title = title,
-                panel = panel,
-            ).showAndGet()
-        ) {
-            return@invokeAndWait
-        }
-        inputFromUser = true
-    }, ModalityState.defaultModalityState())
-    return inputFromUser
+fun askIDE(
+    name: String,
+    agent: WorkspaceAgent,
+    workspace: Workspace,
+    cli: CoderCLIManager,
+    client: CoderRestClient,
+    workspaces: List<Workspace>,
+): WorkspaceProjectIDE? {
+    var data: WorkspaceProjectIDE? = null
+    ApplicationManager.getApplication().invokeAndWait {
+        val dialog =
+            CoderWorkspaceStepDialog(
+                name,
+                CoderWorkspacesStepSelection(agent, workspace, cli, client, workspaces),
+            )
+        data = dialog.showAndGetData()
+    }
+    return data
 }
 
 /**
- * Generic function to ask for input.
+ * Dialog implementation for standalone Gateway.
+ *
+ * This is meant to mimic ToolboxUi.
  */
-fun ask(
-    comment: String,
-    isError: Boolean = false,
-    link: Pair<String, String>? = null,
-    default: String? = null,
-): String? {
-    var inputFromUser: String? = null
-    ApplicationManager.getApplication().invokeAndWait({
-        lateinit var inputTextField: JBTextField
-        val panel =
-            panel {
-                row {
-                    if (link != null) browserLink(link.first, link.second)
-                    inputTextField =
-                        textField()
-                            .applyToComponent {
-                                text = default ?: ""
-                                minimumSize = Dimension(520, -1)
-                            }.component
-                }.layout(RowLayout.PARENT_GRID)
-                row {
-                    cell() // To align with the text box.
-                    cell(
-                        ComponentPanelBuilder.createCommentComponent(comment, false, -1, true)
-                            .applyIf(isError) {
-                                apply {
-                                    foreground = UIUtil.getErrorForeground()
-                                }
-                            },
-                    )
-                }.layout(RowLayout.PARENT_GRID)
+class DialogUi(
+    private val settings: CoderSettings,
+) {
+    fun confirm(title: String, description: String): Boolean {
+        var inputFromUser = false
+        ApplicationManager.getApplication().invokeAndWait({
+            AppIcon.getInstance().requestAttention(null, true)
+            if (!dialog(
+                    title = title,
+                    panel = panel {
+                        row {
+                            label(description)
+                        }
+                    },
+                ).showAndGet()
+            ) {
+                return@invokeAndWait
             }
-        AppIcon.getInstance().requestAttention(null, true)
-        if (!dialog(
-                comment,
-                panel = panel,
-                focusedComponent = inputTextField,
-            ).showAndGet()
-        ) {
-            return@invokeAndWait
-        }
-        inputFromUser = inputTextField.text
-    }, ModalityState.any())
-    return inputFromUser
-}
+            inputFromUser = true
+        }, ModalityState.defaultModalityState())
+        return inputFromUser
+    }
 
-/**
- * Open a dialog for providing the token.  Show any existing token so
- * the user can validate it if a previous connection failed.
- *
- * If we are not retrying and the user has not checked the existing
- * token box then also open a browser to the auth page.
- *
- * If the user has checked the existing token box then return the token
- * on disk immediately and skip the dialog (this will overwrite any
- * other existing token) unless this is a retry to avoid clobbering the
- * token that just failed.
- */
-fun askToken(
-    url: URL,
-    token: Pair<String, Source>?,
-    isRetry: Boolean,
-    useExisting: Boolean,
-    settings: CoderSettings,
-): Pair<String, Source>? {
-    var (existingToken, tokenSource) = token ?: Pair("", Source.USER)
-    val getTokenUrl = url.withPath("/login?redirect=%2Fcli-auth")
+    fun ask(
+        title: String,
+        description: String,
+        placeholder: String? = null,
+        isError: Boolean = false,
+        link: Pair<String, String>? = null,
+    ): String? {
+        var inputFromUser: String? = null
+        ApplicationManager.getApplication().invokeAndWait({
+            lateinit var inputTextField: JBTextField
+            AppIcon.getInstance().requestAttention(null, true)
+            if (!dialog(
+                    title = title,
+                    panel = panel {
+                        row {
+                            if (link != null) browserLink(link.first, link.second)
+                            inputTextField =
+                                textField()
+                                    .applyToComponent {
+                                        this.text = placeholder
+                                        minimumSize = Dimension(520, -1)
+                                    }.component
+                        }.layout(RowLayout.PARENT_GRID)
+                        row {
+                            cell() // To align with the text box.
+                            cell(
+                                ComponentPanelBuilder.createCommentComponent(description, false, -1, true)
+                                    .applyIf(isError) {
+                                        apply {
+                                            foreground = UIUtil.getErrorForeground()
+                                        }
+                                    },
+                            )
+                        }.layout(RowLayout.PARENT_GRID)
+                    },
+                    focusedComponent = inputTextField,
+                ).showAndGet()
+            ) {
+                return@invokeAndWait
+            }
+            inputFromUser = inputTextField.text
+        }, ModalityState.any())
+        return inputFromUser
+    }
+
+    private fun openUrl(url: URL) {
+        BrowserUtil.browse(url)
+    }
+
+    /**
+     * Open a dialog for providing the token.  Show any existing token so
+     * the user can validate it if a previous connection failed.
+     *
+     * If we are not retrying and the user has not checked the existing
+     * token box then also open a browser to the auth page.
+     *
+     * If the user has checked the existing token box then return the token
+     * on disk immediately and skip the dialog (this will overwrite any
+     * other existing token) unless this is a retry to avoid clobbering the
+     * token that just failed.
+     */
+    fun askToken(
+        url: URL,
+        token: Pair<String, Source>?,
+        isRetry: Boolean,
+        useExisting: Boolean,
+    ): Pair<String, Source>? {
+        var (existingToken, tokenSource) = token ?: Pair("", Source.USER)
+        val getTokenUrl = url.withPath("/login?redirect=%2Fcli-auth")
 
-    // On the first run either open a browser to generate a new token
-    // or, if using an existing token, use the token on disk if it
-    // exists otherwise assume the user already copied an existing
-    // token and they will paste in.
-    if (!isRetry) {
-        if (!useExisting) {
-            BrowserUtil.browse(getTokenUrl)
-        } else {
-            // Look on disk in case we already have a token, either in
-            // the deployment's config or the global config.
-            val tryToken = settings.token(url)
-            if (tryToken != null && tryToken.first != existingToken) {
-                return tryToken
+        // On the first run either open a browser to generate a new token
+        // or, if using an existing token, use the token on disk if it
+        // exists otherwise assume the user already copied an existing
+        // token and they will paste in.
+        if (!isRetry) {
+            if (!useExisting) {
+                openUrl(getTokenUrl)
+            } else {
+                // Look on disk in case we already have a token, either in
+                // the deployment's config or the global config.
+                val tryToken = settings.token(url)
+                if (tryToken != null && tryToken.first != existingToken) {
+                    return tryToken
+                }
             }
         }
-    }
 
-    // On subsequent tries or if not using an existing token, ask the user
-    // for the token.
-    val tokenFromUser =
-        ask(
-            CoderGatewayBundle.message(
-                if (isRetry) {
-                    "gateway.connector.view.workspaces.token.rejected"
+        // On subsequent tries or if not using an existing token, ask the user
+        // for the token.
+        val tokenFromUser =
+            ask(
+                title = "Session Token",
+                description = if (isRetry) {
+                    "This token was rejected by ${url.host}."
                 } else if (tokenSource == Source.CONFIG) {
-                    "gateway.connector.view.workspaces.token.injected-global"
+                    "This token was pulled from your global CLI config."
                 } else if (tokenSource == Source.DEPLOYMENT_CONFIG) {
-                    "gateway.connector.view.workspaces.token.injected"
+                    "This token was pulled from your CLI config for ${url.host}."
                 } else if (tokenSource == Source.LAST_USED) {
-                    "gateway.connector.view.workspaces.token.last-used"
+                    "This token was the last used token for ${url.host}."
                 } else if (tokenSource == Source.QUERY) {
-                    "gateway.connector.view.workspaces.token.query"
+                    "This token was pulled from the Gateway link from ${url.host}."
                 } else if (existingToken.isNotBlank()) {
-                    "gateway.connector.view.workspaces.token.comment"
+                    "The last used token for ${url.host} is shown above."
                 } else {
-                    "gateway.connector.view.workspaces.token.none"
+                    "No existing token for ${url.host} found."
                 },
-                url.host,
-            ),
-            isRetry,
-            Pair(
-                CoderGatewayBundle.message("gateway.connector.view.login.token.label"),
-                getTokenUrl.toString(),
-            ),
-            existingToken,
-        )
-    if (tokenFromUser.isNullOrBlank()) {
-        return null
-    }
-    if (tokenFromUser != existingToken) {
-        tokenSource = Source.USER
-    }
-    return Pair(tokenFromUser, tokenSource)
-}
-
-fun askIDE(
-    name: String,
-    agent: WorkspaceAgent,
-    workspace: Workspace,
-    cli: CoderCLIManager,
-    client: CoderRestClient,
-    workspaces: List<Workspace>,
-): WorkspaceProjectIDE? {
-    var data: WorkspaceProjectIDE? = null
-    ApplicationManager.getApplication().invokeAndWait {
-        val dialog =
-            CoderWorkspaceStepDialog(
-                name,
-                CoderWorkspacesStepSelection(agent, workspace, cli, client, workspaces),
+                placeholder = existingToken,
+                link = Pair("Session Token:", getTokenUrl.toString()),
+                isError = isRetry,
             )
-        data = dialog.showAndGetData()
+        if (tokenFromUser.isNullOrBlank()) {
+            return null
+        }
+        if (tokenFromUser != existingToken) {
+            tokenSource = Source.USER
+        }
+        return Pair(tokenFromUser, tokenSource)
     }
-    return data
 }