From 28d044d0f91c925eda87e57a2b81974b02fb7b86 Mon Sep 17 00:00:00 2001 From: Asher Date: Wed, 1 Mar 2023 13:02:29 -0900 Subject: [PATCH 1/2] Read URL and token from config on launch In case the user has already configured the CLI. This will only happen without user input until the first successful connection. After that the "use existing token" checkbox must be used to read the token from the config. It will only be used if it matches the URL. A secondary effect of the checkbox is that it will not open the browser window so it can also be used in the case where you already have a token you want to use but it is not in the CLI config. Lastly I removed some padding in an attempt to regain the space lost by the additions. --- .../models/CoderWorkspacesWizardModel.kt | 5 +- .../views/steps/CoderWorkspacesStepView.kt | 97 ++++++++++++++++--- .../messages/CoderGatewayBundle.properties | 4 +- 3 files changed, 89 insertions(+), 17 deletions(-) diff --git a/src/main/kotlin/com/coder/gateway/models/CoderWorkspacesWizardModel.kt b/src/main/kotlin/com/coder/gateway/models/CoderWorkspacesWizardModel.kt index 19ae9b4b..cdf9db22 100644 --- a/src/main/kotlin/com/coder/gateway/models/CoderWorkspacesWizardModel.kt +++ b/src/main/kotlin/com/coder/gateway/models/CoderWorkspacesWizardModel.kt @@ -5,5 +5,6 @@ data class CoderWorkspacesWizardModel( var token: String = "", var buildVersion: String = "", var localCliPath: String = "", - var selectedWorkspace: WorkspaceAgentModel? = null -) \ No newline at end of file + var selectedWorkspace: WorkspaceAgentModel? = null, + var useExistingToken: Boolean = false +) diff --git a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt index cf262a21..050813a8 100644 --- a/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt +++ b/src/main/kotlin/com/coder/gateway/views/steps/CoderWorkspacesStepView.kt @@ -46,13 +46,7 @@ import com.intellij.ui.RelativeFont import com.intellij.ui.ToolbarDecorator import com.intellij.ui.components.JBTextField import com.intellij.ui.components.dialog -import com.intellij.ui.dsl.builder.AlignX -import com.intellij.ui.dsl.builder.AlignY -import com.intellij.ui.dsl.builder.BottomGap -import com.intellij.ui.dsl.builder.RightGap -import com.intellij.ui.dsl.builder.TopGap -import com.intellij.ui.dsl.builder.bindText -import com.intellij.ui.dsl.builder.panel +import com.intellij.ui.dsl.builder.* import com.intellij.ui.table.TableView import com.intellij.util.ui.ColumnInfo import com.intellij.util.ui.JBFont @@ -76,8 +70,12 @@ import java.awt.event.MouseListener import java.awt.event.MouseMotionListener import java.awt.font.TextAttribute import java.awt.font.TextAttribute.UNDERLINE_ON +import java.nio.file.Files +import java.nio.file.Path +import java.nio.file.Paths import java.net.SocketTimeoutException import javax.swing.Icon +import javax.swing.JCheckBox import javax.swing.JTable import javax.swing.JTextField import javax.swing.ListSelectionModel @@ -100,6 +98,7 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) : private val appPropertiesService: PropertiesComponent = service() private var tfUrl: JTextField? = null + private var cbExistingToken: JCheckBox? = null private var listTableModelOfWorkspaces = ListTableModel( WorkspaceIconColumnInfo(""), WorkspaceNameColumnInfo("Name"), @@ -201,13 +200,13 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) : font = JBFont.h3().asBold() icon = CoderIcons.LOGO_16 } - }.topGap(TopGap.SMALL).bottomGap(BottomGap.MEDIUM) + }.topGap(TopGap.SMALL) row { cell(ComponentPanelBuilder.createCommentComponent(CoderGatewayBundle.message("gateway.connector.view.coder.workspaces.comment"), false, -1, true)) } row { browserLink(CoderGatewayBundle.message("gateway.connector.view.login.documentation.action"), "https://coder.com/docs/coder-oss/latest/workspaces") - }.bottomGap(BottomGap.MEDIUM) + } row(CoderGatewayBundle.message("gateway.connector.view.login.url.label")) { tfUrl = textField().resizableColumn().align(AlignX.FILL).gap(RightGap.SMALL).bindText(localWizardModel::coderURL).applyToComponent { addActionListener { @@ -223,6 +222,17 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) : } cell() } + row { + cbExistingToken = checkBox(CoderGatewayBundle.message("gateway.connector.view.login.existing-token.label")) + .bindSelected(localWizardModel::useExistingToken) + .component + } + row { + cell(ComponentPanelBuilder.createCommentComponent( + CoderGatewayBundle.message("gateway.connector.view.login.existing-token.tooltip", + CoderGatewayBundle.message("gateway.connector.view.login.existing-token.label")), + false, -1, true)) + } row { scrollCell(toolbar.createPanel().apply { add(notificationBanner.component.apply { isVisible = false }, "South") @@ -313,18 +323,71 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) : if (localWizardModel.coderURL.isNotBlank() && localWizardModel.token.isNotBlank()) { triggerWorkspacePolling() } else { - val url = appPropertiesService.getValue(CODER_URL_KEY) - val token = appPropertiesService.getValue(SESSION_TOKEN) - if (!url.isNullOrBlank() && !token.isNullOrBlank()) { + val (url, token) = readStorageOrConfig() + if (!url.isNullOrBlank()) { localWizardModel.coderURL = url - localWizardModel.token = token tfUrl?.text = url + } + if (!token.isNullOrBlank()) { + localWizardModel.token = token + } + if (!url.isNullOrBlank() && !token.isNullOrBlank()) { loginAndLoadWorkspace(token, true) } } updateWorkspaceActions() } + /** + * Return the URL and token from storage or the CLI config. + */ + private fun readStorageOrConfig(): Pair { + val url = appPropertiesService.getValue(CODER_URL_KEY) + val token = appPropertiesService.getValue(SESSION_TOKEN) + if (!url.isNullOrBlank() && !token.isNullOrBlank()) { + return url to token + } + return readConfig() + } + + /** + * Return the URL and token from the CLI config. + */ + private fun readConfig(): Pair { + val configDir = getConfigDir() + logger.info("Reading config from $configDir") + try { + val url = Files.readString(configDir.resolve("url")) + val token = Files.readString(configDir.resolve("session")) + return url to token + } catch (e: Exception) { + return null to null // Probably has not configured the CLI yet. + } + } + + /** + * Return the config directory used by the CLI. + */ + private fun getConfigDir(): Path { + var dir = System.getenv("CODER_CONFIG_DIR") + if (!dir.isNullOrBlank()) { + return Path.of(dir) + } + // The Coder CLI uses https://github.com/kirsle/configdir so this should + // match how it behaves. + return when(getOS()) { + OS.WINDOWS -> Paths.get(System.getenv("APPDATA"), "coderv2") + OS.MAC -> Paths.get(System.getenv("HOME"), "Library/Application Support/coderv2") + else -> { + dir = System.getenv("XDG_CACHE_HOME") + if (!dir.isNullOrBlank()) { + return Paths.get(dir, "coderv2") + } + return Paths.get(System.getenv("HOME"), ".config/coderv2") + } + } + } + private fun updateWorkspaceActions() { goToDashboardAction.isEnabled = coderClient.isReady createWorkspaceAction.isEnabled = coderClient.isReady @@ -440,8 +503,14 @@ class CoderWorkspacesStepView(val enableNextButtonCallback: (Boolean) -> Unit) : private fun askToken(openBrowser: Boolean): String? { val getTokenUrl = localWizardModel.coderURL.toURL().withPath("/login?redirect=%2Fcli-auth") - if (openBrowser) { + if (openBrowser && !localWizardModel.useExistingToken) { BrowserUtil.browse(getTokenUrl) + } else if (localWizardModel.useExistingToken) { + val (url, token) = readConfig() + if (url == localWizardModel.coderURL && !token.isNullOrBlank()) { + logger.info("Injecting valid token from CLI config") + localWizardModel.token = token + } } var tokenFromUser: String? = null ApplicationManager.getApplication().invokeAndWait({ diff --git a/src/main/resources/messages/CoderGatewayBundle.properties b/src/main/resources/messages/CoderGatewayBundle.properties index 2c255a90..95b34a1b 100644 --- a/src/main/resources/messages/CoderGatewayBundle.properties +++ b/src/main/resources/messages/CoderGatewayBundle.properties @@ -3,6 +3,8 @@ gateway.connector.description=Connects to a Coder Workspace dev environment so t gateway.connector.action.text=Connect to Coder gateway.connector.view.login.documentation.action=Learn more about Coder gateway.connector.view.login.url.label=URL: +gateway.connector.view.login.existing-token.label=Use existing token +gateway.connector.view.login.existing-token.tooltip=Checking "{0}" will prevent the browser from being launched for generating a new token. Additionally, if a token is already configured for this URL via the CLI it will appear as the default and can be used as-is or replaced. gateway.connector.view.login.token.dialog=Paste your token here: gateway.connector.view.login.token.label=Session Token: gateway.connector.view.coder.workspaces.header.text=Coder Workspaces @@ -28,4 +30,4 @@ gateway.connector.recentconnections.title=Recent Coder Workspaces gateway.connector.recentconnections.new.wizard.button.tooltip=Open a new Coder Workspace gateway.connector.recentconnections.remove.button.tooltip=Remove from Recent Connections gateway.connector.recentconnections.terminal.button.tooltip=Open SSH Web Terminal -gateway.connector.coder.connection.provider.title=Connecting to Coder workspace... \ No newline at end of file +gateway.connector.coder.connection.provider.title=Connecting to Coder workspace... From d353e6a2ec91db8950b49f41a91c1520b2ab7f0b Mon Sep 17 00:00:00 2001 From: Asher Date: Thu, 2 Mar 2023 12:14:39 -0900 Subject: [PATCH 2/2] Update changelog: use existing token --- CHANGELOG.md | 1 + 1 file changed, 1 insertion(+) diff --git a/CHANGELOG.md b/CHANGELOG.md index 09c5e1ee..e8f061dd 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -7,6 +7,7 @@ ### Added - support for Gateway 2023 +- ability to use existing tokens rather than request a new one ## 2.1.7 - 2023-02-28