Extract setting source description

code-asher · code-asher · commit aefcc31e08a0 · 2024-09-10T12:43:45.000-08:00
This will let us use it in auth flows that are not dialog-based like the
current auth flow.  In the future both flows might be refactored to
share a code path but holding off on that until it becomes apparent
there is a good interface for that.
diff --git a/src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt b/src/main/kotlin/com/coder/gateway/settings/CoderSettings.kt
@@ -28,6 +28,20 @@ enum class Source {
     QUERY,             // From the Gateway link as a query parameter.
     SETTINGS,          // Pulled from settings.
     USER,              // Input by the user.
+    ;
+
+    /**
+     * Return a description of the source.
+     */
+    fun description(name: String, url: URL): String = when (this) {
+        CONFIG ->  "This $name was pulled from your global CLI config."
+        DEPLOYMENT_CONFIG -> "This $name was pulled from your CLI config for ${url.host}."
+        LAST_USED -> "This last used $name for ${url.host}."
+        QUERY -> "This $name was pulled from the Gateway link from ${url.host}."
+        USER -> "The last used $name for ${url.host}."
+        ENVIRONMENT -> "This $name was pulled from an environment variable."
+        SETTINGS -> "This $name was pulled from your settings for Coder Gateway."
+    }
 }
 
 open class CoderSettingsState(
diff --git a/src/main/kotlin/com/coder/gateway/util/Dialogs.kt b/src/main/kotlin/com/coder/gateway/util/Dialogs.kt
@@ -185,7 +185,6 @@ class DialogUi(
         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
@@ -199,7 +198,7 @@ class DialogUi(
                 // 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) {
+                if (tryToken != null && tryToken.first != token?.first) {
                     return tryToken
                 }
             }
@@ -212,29 +211,19 @@ class DialogUi(
                 title = "Session Token",
                 description = if (isRetry) {
                     "This token was rejected by ${url.host}."
-                } else if (tokenSource == Source.CONFIG) {
-                    "This token was pulled from your global CLI config."
-                } else if (tokenSource == Source.DEPLOYMENT_CONFIG) {
-                    "This token was pulled from your CLI config for ${url.host}."
-                } else if (tokenSource == Source.LAST_USED) {
-                    "This token was the last used token for ${url.host}."
-                } else if (tokenSource == Source.QUERY) {
-                    "This token was pulled from the Gateway link from ${url.host}."
-                } else if (existingToken.isNotBlank()) {
-                    "The last used token for ${url.host} is shown above."
                 } else {
-                    "No existing token for ${url.host} found."
+                    token?.second?.description("token", url)
+                        ?: "No existing token for ${url.host} found."
                 },
-                placeholder = existingToken,
+                placeholder = token?.first,
                 link = Pair("Session Token:", getTokenUrl.toString()),
                 isError = isRetry,
             )
         if (tokenFromUser.isNullOrBlank()) {
             return null
         }
-        if (tokenFromUser != existingToken) {
-            tokenSource = Source.USER
-        }
-        return Pair(tokenFromUser, tokenSource)
+        // If the user submitted the same token, keep the same source too.
+        val source = if (tokenFromUser == token?.first) token.second else Source.USER
+        return Pair(tokenFromUser, source)
     }
 }
