Add setting for default URL

Closes #395.

This also consolidates some logic for getting the default token.

Author: code-asher

CHANGELOG.md

@@ -9,7 +9,7 @@
 - Sort IDEs by version (latest first).
 - Recent connections window will try to recover after encountering an error.
   There is still a known issue where if a token expires there is no way to enter
-  a new one except to go back through the "Connect with Coder" flow.
+  a new one except to go back through the "Connect to Coder" flow.
 - Header command ignores stderr and does not error if nothing is output.  It
   will still error if any blank lines are output.
 - Remove "from jetbrains.com" from the download text since the download source
@@ -27,6 +27,8 @@
   instead of hiding them in tooltips.
 - Truncate the path in the recents window if it is too long to prevent
   needing to scroll to press the workspace actions.
+- If there is no default URL, coder.example.com will no longer be used. The
+  field will just be blank, to remove the need to first delete the example URL.
 
 ### Added
 
@@ -37,6 +39,9 @@
 - New setting for extra SSH options.  This is arbitrary text and is not
   validated in any way.  If this setting is left empty, the environment variable
   CODER_SSH_CONFIG_OPTIONS will be used if set.
+- New setting for the default URL. If this setting is left empty, the
+  environment variable CODER_URL will be used. If CODER_URL is also empty, the
+  URL in the global CLI config directory will be used, if it exists.
 
 ## 2.10.0 - 2024-03-12
 

gradle.properties

@@ -3,7 +3,7 @@
 pluginGroup=com.coder.gateway
 pluginName=coder-gateway
 # SemVer format -> https://semver.org
-pluginVersion=2.11.1
+pluginVersion=2.11.2
 # See https://plugins.jetbrains.com/docs/intellij/build-number-ranges.html
 # for insight into build numbers and IntelliJ Platform versions.
 pluginSinceBuild=233.6745

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

@@ -7,7 +7,6 @@ import com.coder.gateway.cli.ensureCLI
 import com.coder.gateway.models.AGENT_ID
 import com.coder.gateway.models.AGENT_NAME
 import com.coder.gateway.models.TOKEN
-import com.coder.gateway.models.TokenSource
 import com.coder.gateway.models.URL
 import com.coder.gateway.models.WORKSPACE
 import com.coder.gateway.models.WorkspaceAndAgentStatus
@@ -30,6 +29,7 @@ import com.coder.gateway.sdk.v2.models.WorkspaceAgent
 import com.coder.gateway.sdk.v2.models.WorkspaceStatus
 import com.coder.gateway.services.CoderRestClientService
 import com.coder.gateway.services.CoderSettingsService
+import com.coder.gateway.settings.Source
 import com.coder.gateway.util.toURL
 import com.coder.gateway.views.steps.CoderWorkspaceProjectIDEStepView
 import com.coder.gateway.views.steps.CoderWorkspacesStepSelection
@@ -193,12 +193,12 @@ class CoderGatewayConnectionProvider : GatewayConnectionProvider {
      * continues to result in an authentication failure and token authentication
      * is required.
      */
-    private fun authenticate(deploymentURL: String, queryToken: String?, lastToken: Pair<String, TokenSource>? = null): CoderRestClient {
+    private fun authenticate(deploymentURL: String, queryToken: String?, lastToken: Pair<String, Source>? = null): CoderRestClient {
         val token = if (settings.requireTokenAuth) {
             // Use the token from the query, unless we already tried that.
             val isRetry = lastToken != null
             if (!queryToken.isNullOrBlank() && !isRetry)
-                Pair(queryToken, TokenSource.QUERY)
+                Pair(queryToken, Source.QUERY)
             else CoderRemoteConnectionHandle.askToken(
                 deploymentURL.toURL(),
                 lastToken,

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

@@ -2,11 +2,11 @@
 
 package com.coder.gateway
 
-import com.coder.gateway.models.TokenSource
 import com.coder.gateway.models.WorkspaceProjectIDE
 import com.coder.gateway.services.CoderRecentWorkspaceConnectionsService
 import com.coder.gateway.services.CoderSettingsService
 import com.coder.gateway.settings.CoderSettings
+import com.coder.gateway.settings.Source
 import com.coder.gateway.util.humanizeDuration
 import com.coder.gateway.util.isCancellation
 import com.coder.gateway.util.isWorkerTimeout
@@ -197,12 +197,12 @@ class CoderRemoteConnectionHandle {
         @JvmStatic
         fun askToken(
             url: URL,
-            token: Pair<String, TokenSource>?,
+            token: Pair<String, Source>?,
             isRetry: Boolean,
             useExisting: Boolean,
             settings: CoderSettings,
-        ): Pair<String, TokenSource>? {
-            var (existingToken, tokenSource) = token ?: Pair("", TokenSource.USER)
+        ): 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
@@ -213,10 +213,12 @@ class CoderRemoteConnectionHandle {
                 if (!useExisting) {
                     BrowserUtil.browse(getTokenUrl)
                 } else {
-                    val (u, t) = settings.readConfig(settings.coderConfigDir)
-                    if (url.toString() == u && !t.isNullOrBlank() && t != existingToken) {
-                        logger.info("Injecting token for $url from CLI config")
-                        return Pair(t, TokenSource.CONFIG)
+                    // Look on disk in case we already have a token, either in
+                    // the deployment's config or the global config.
+                    val token = settings.token(url.toString())
+                    if (token != null && token.first != existingToken) {
+                        logger.info("Injecting token for $url from ${token.second}")
+                        return token
                     }
                 }
             }
@@ -226,9 +228,10 @@ class CoderRemoteConnectionHandle {
             val tokenFromUser = ask(
                 CoderGatewayBundle.message(
                     if (isRetry) "gateway.connector.view.workspaces.token.rejected"
-                    else if (tokenSource == TokenSource.CONFIG) "gateway.connector.view.workspaces.token.injected"
-                    else if (tokenSource == TokenSource.QUERY) "gateway.connector.view.workspaces.token.query"
-                    else if (tokenSource == TokenSource.LAST_USED) "gateway.connector.view.workspaces.token.last-used"
+                    else if (tokenSource == Source.CONFIG) "gateway.connector.view.workspaces.token.injected-global"
+                    else if (tokenSource == Source.DEPLOYMENT_CONFIG) "gateway.connector.view.workspaces.token.injected"
+                    else if (tokenSource == Source.LAST_USED) "gateway.connector.view.workspaces.token.last-used"
+                    else if (tokenSource == Source.QUERY) "gateway.connector.view.workspaces.token.query"
                     else if (existingToken.isNotBlank()) "gateway.connector.view.workspaces.token.comment"
                     else "gateway.connector.view.workspaces.token.none",
                     url.host,
@@ -244,7 +247,7 @@ class CoderRemoteConnectionHandle {
                 return null
             }
             if (tokenFromUser != existingToken) {
-                tokenSource = TokenSource.USER
+                tokenSource = Source.USER
             }
             return Pair(tokenFromUser, tokenSource)
         }

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

@@ -132,6 +132,13 @@ class CoderSettingsConfigurable : BoundConfigurable("Coder") {
                         CoderGatewayBundle.message("gateway.connector.settings.ignore-setup-failure.comment")
                     )
             }.layout(RowLayout.PARENT_GRID)
+            row(CoderGatewayBundle.message("gateway.connector.settings.default-url.title")) {
+                textField().resizableColumn().align(AlignX.FILL)
+                    .bindText(state::defaultURL)
+                    .comment(
+                        CoderGatewayBundle.message("gateway.connector.settings.setup-command.comment")
+                    )
+            }.layout(RowLayout.PARENT_GRID)
         }
     }
 

src/main/kotlin/com/coder/gateway/cli/CoderCLIManager.kt

@@ -110,7 +110,7 @@ fun ensureCLI(
 /**
  * The supported features of the CLI.
  */
-data class Features(
+data class Features (
     val disableAutostart: Boolean = false,
 )
 

src/main/kotlin/com/coder/gateway/models/TokenSource.kt

@@ -15,6 +15,20 @@ import java.nio.file.Path
 import java.nio.file.Paths
 
 const val CODER_SSH_CONFIG_OPTIONS = "CODER_SSH_CONFIG_OPTIONS"
+const val CODER_URL = "CODER_URL"
+
+/**
+ * Describes where a setting came from.
+ */
+enum class Source {
+    CONFIG,            // Pulled from the global Coder CLI config.
+    DEPLOYMENT_CONFIG, // Pulled from the config for a deployment.
+    ENVIRONMENT,       // Pulled from environment variables.
+    LAST_USED,         // Last used token.
+    QUERY,             // From the Gateway link as a query parameter.
+    SETTINGS,          // Pulled from settings.
+    USER,              // Input by the user.
+}
 
 open class CoderSettingsState(
     // Used to download the Coder CLI which is necessary to proxy SSH
@@ -66,6 +80,8 @@ open class CoderSettingsState(
     open var setupCommand: String = "",
     // Whether to ignore setup command failures.
     open var ignoreSetupFailure: Boolean = false,
+    // Default URL to show in the connection window.
+    open var defaultURL: String = "",
 )
 
 /**
@@ -140,6 +156,53 @@ open class CoderSettings(
     val ignoreSetupFailure: Boolean
         get() = state.ignoreSetupFailure
 
+    /**
+     * The default URL to show in the connection window.
+     */
+    fun defaultURL(): Pair<String, Source>? {
+        val defaultURL = state.defaultURL
+        val envURL = env.get(CODER_URL)
+        if (!defaultURL.isBlank()) {
+            return defaultURL to Source.SETTINGS
+        } else if (!envURL.isBlank()) {
+            return envURL to Source.ENVIRONMENT
+        } else {
+            val (configUrl, _) = readConfig(coderConfigDir)
+            if (!configUrl.isNullOrBlank()) {
+                return configUrl to Source.CONFIG
+            }
+        }
+        return null
+    }
+
+    /**
+     * Given a deployment URL, try to find a token for it if required.
+     */
+    fun token(url: String): Pair<String, Source>? {
+        // No need to bother if we do not need token auth anyway.
+        if (!requireTokenAuth) {
+            return null
+        }
+        // Try the deployment's config directory.  This could exist if someone
+        // has entered a URL that they are not currently connected to, but have
+        // connected to in the past.
+        try {
+            val (_, deploymentToken) = readConfig(dataDir(url.toURL()).resolve("config"))
+            if (!deploymentToken.isNullOrBlank()) {
+                return deploymentToken to Source.DEPLOYMENT_CONFIG
+            }
+        } catch (ex: Exception) {
+            // URL is invalid.
+        }
+        // Try the global config directory, in case they previously set up the
+        // CLI with this URL.
+        val (configUrl, configToken) = readConfig(coderConfigDir)
+        if (configUrl == url && !configToken.isNullOrBlank()) {
+            return configToken to Source.CONFIG
+        }
+        return null
+    }
+
     /**
      * Where the specified deployment should put its data.
      */
@@ -183,18 +246,20 @@ open class CoderSettings(
     }
 
     /**
-     * Return the URL and token from the config, if it exists.  Both the url and
-     * session files must exist if using token auth, otherwise only url must
-     * exist.
+     * Return the URL and token from the config, if they exist.
      */
     fun readConfig(dir: Path): Pair<String?, String?> {
         logger.info("Reading config from $dir")
         return try {
-            val token = if (requireTokenAuth) Files.readString(dir.resolve("session")) else null
-            Files.readString(dir.resolve("url")) to token
+            Files.readString(dir.resolve("url"))
+        } catch (e: Exception) {
+            // SSH has not been configured yet, or using some other authorization mechanism.
+            null
+        } to try {
+            Files.readString(dir.resolve("session"))
         } catch (e: Exception) {
             // SSH has not been configured yet, or using some other authorization mechanism.
-            null to null
+            null
         }
     }
 

src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt

@@ -5,7 +5,6 @@ package com.coder.gateway.views
 import com.coder.gateway.CoderGatewayBundle
 import com.coder.gateway.CoderGatewayConstants
 import com.coder.gateway.CoderRemoteConnectionHandle
-import com.coder.gateway.cli.CoderCLIManager
 import com.coder.gateway.icons.CoderIcons
 import com.coder.gateway.models.WorkspaceAgentListModel
 import com.coder.gateway.models.WorkspaceProjectIDE
@@ -317,9 +316,8 @@ class CoderGatewayRecentWorkspaceConnectionsView(private val setContentCallback:
                 .map { Triple(it.key, deployments.getOrPut(it.key) { DeploymentInfo() }, it.value) }
             connections.forEach { (deploymentURL, deployment, workspaces) ->
                 val client = deployment.client ?: try {
-                    val cli = CoderCLIManager(deploymentURL.toURL())
-                    val (_, token) = settings.readConfig(cli.coderConfigPath)
-                    deployment.client = CoderRestClientService(deploymentURL.toURL(), token)
+                    val token = settings.token(deploymentURL)
+                    deployment.client = CoderRestClientService(deploymentURL.toURL(), token?.first)
                     deployment.error = null
                     deployment.client
                 } catch (e: Exception) {